babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. get observers(): Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Check if the document object exists
  290. * @returns true if the document object exists
  291. */
  292. static IsDocumentAvailable(): boolean;
  293. /**
  294. * Extracts text content from a DOM element hierarchy
  295. * @param element defines the root element
  296. * @returns a string
  297. */
  298. static GetDOMTextContent(element: HTMLElement): string;
  299. }
  300. }
  301. declare module "babylonjs/Misc/logger" {
  302. /**
  303. * Logger used througouht the application to allow configuration of
  304. * the log level required for the messages.
  305. */
  306. export class Logger {
  307. /**
  308. * No log
  309. */
  310. static readonly NoneLogLevel: number;
  311. /**
  312. * Only message logs
  313. */
  314. static readonly MessageLogLevel: number;
  315. /**
  316. * Only warning logs
  317. */
  318. static readonly WarningLogLevel: number;
  319. /**
  320. * Only error logs
  321. */
  322. static readonly ErrorLogLevel: number;
  323. /**
  324. * All logs
  325. */
  326. static readonly AllLogLevel: number;
  327. private static _LogCache;
  328. /**
  329. * Gets a value indicating the number of loading errors
  330. * @ignorenaming
  331. */
  332. static errorsCount: number;
  333. /**
  334. * Callback called when a new log is added
  335. */
  336. static OnNewCacheEntry: (entry: string) => void;
  337. private static _AddLogEntry;
  338. private static _FormatMessage;
  339. private static _LogDisabled;
  340. private static _LogEnabled;
  341. private static _WarnDisabled;
  342. private static _WarnEnabled;
  343. private static _ErrorDisabled;
  344. private static _ErrorEnabled;
  345. /**
  346. * Log a message to the console
  347. */
  348. static Log: (message: string) => void;
  349. /**
  350. * Write a warning message to the console
  351. */
  352. static Warn: (message: string) => void;
  353. /**
  354. * Write an error message to the console
  355. */
  356. static Error: (message: string) => void;
  357. /**
  358. * Gets current log cache (list of logs)
  359. */
  360. static get LogCache(): string;
  361. /**
  362. * Clears the log cache
  363. */
  364. static ClearLogCache(): void;
  365. /**
  366. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  367. */
  368. static set LogLevels(level: number);
  369. }
  370. }
  371. declare module "babylonjs/Misc/typeStore" {
  372. /** @hidden */
  373. export class _TypeStore {
  374. /** @hidden */
  375. static RegisteredTypes: {
  376. [key: string]: Object;
  377. };
  378. /** @hidden */
  379. static GetClass(fqdn: string): any;
  380. }
  381. }
  382. declare module "babylonjs/Misc/stringTools" {
  383. /**
  384. * Helper to manipulate strings
  385. */
  386. export class StringTools {
  387. /**
  388. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  389. * @param str Source string
  390. * @param suffix Suffix to search for in the source string
  391. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  392. */
  393. static EndsWith(str: string, suffix: string): boolean;
  394. /**
  395. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  396. * @param str Source string
  397. * @param suffix Suffix to search for in the source string
  398. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  399. */
  400. static StartsWith(str: string, suffix: string): boolean;
  401. /**
  402. * Decodes a buffer into a string
  403. * @param buffer The buffer to decode
  404. * @returns The decoded string
  405. */
  406. static Decode(buffer: Uint8Array | Uint16Array): string;
  407. /**
  408. * Encode a buffer to a base64 string
  409. * @param buffer defines the buffer to encode
  410. * @returns the encoded string
  411. */
  412. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  413. /**
  414. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  415. * @param num the number to convert and pad
  416. * @param length the expected length of the string
  417. * @returns the padded string
  418. */
  419. static PadNumber(num: number, length: number): string;
  420. }
  421. }
  422. declare module "babylonjs/Misc/deepCopier" {
  423. /**
  424. * Class containing a set of static utilities functions for deep copy.
  425. */
  426. export class DeepCopier {
  427. /**
  428. * Tries to copy an object by duplicating every property
  429. * @param source defines the source object
  430. * @param destination defines the target object
  431. * @param doNotCopyList defines a list of properties to avoid
  432. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  433. */
  434. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  435. }
  436. }
  437. declare module "babylonjs/Misc/precisionDate" {
  438. /**
  439. * Class containing a set of static utilities functions for precision date
  440. */
  441. export class PrecisionDate {
  442. /**
  443. * Gets either window.performance.now() if supported or Date.now() else
  444. */
  445. static get Now(): number;
  446. }
  447. }
  448. declare module "babylonjs/Misc/devTools" {
  449. /** @hidden */
  450. export class _DevTools {
  451. static WarnImport(name: string): string;
  452. }
  453. }
  454. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  455. /**
  456. * Interface used to define the mechanism to get data from the network
  457. */
  458. export interface IWebRequest {
  459. /**
  460. * Returns client's response url
  461. */
  462. responseURL: string;
  463. /**
  464. * Returns client's status
  465. */
  466. status: number;
  467. /**
  468. * Returns client's status as a text
  469. */
  470. statusText: string;
  471. }
  472. }
  473. declare module "babylonjs/Misc/webRequest" {
  474. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  475. import { Nullable } from "babylonjs/types";
  476. /**
  477. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  478. */
  479. export class WebRequest implements IWebRequest {
  480. private _xhr;
  481. /**
  482. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  483. * i.e. when loading files, where the server/service expects an Authorization header
  484. */
  485. static CustomRequestHeaders: {
  486. [key: string]: string;
  487. };
  488. /**
  489. * Add callback functions in this array to update all the requests before they get sent to the network
  490. */
  491. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  492. private _injectCustomRequestHeaders;
  493. /**
  494. * Gets or sets a function to be called when loading progress changes
  495. */
  496. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  497. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  498. /**
  499. * Returns client's state
  500. */
  501. get readyState(): number;
  502. /**
  503. * Returns client's status
  504. */
  505. get status(): number;
  506. /**
  507. * Returns client's status as a text
  508. */
  509. get statusText(): string;
  510. /**
  511. * Returns client's response
  512. */
  513. get response(): any;
  514. /**
  515. * Returns client's response url
  516. */
  517. get responseURL(): string;
  518. /**
  519. * Returns client's response as text
  520. */
  521. get responseText(): string;
  522. /**
  523. * Gets or sets the expected response type
  524. */
  525. get responseType(): XMLHttpRequestResponseType;
  526. set responseType(value: XMLHttpRequestResponseType);
  527. /** @hidden */
  528. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  529. /** @hidden */
  530. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  531. /**
  532. * Cancels any network activity
  533. */
  534. abort(): void;
  535. /**
  536. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  537. * @param body defines an optional request body
  538. */
  539. send(body?: Document | BodyInit | null): void;
  540. /**
  541. * Sets the request method, request URL
  542. * @param method defines the method to use (GET, POST, etc..)
  543. * @param url defines the url to connect with
  544. */
  545. open(method: string, url: string): void;
  546. /**
  547. * Sets the value of a request header.
  548. * @param name The name of the header whose value is to be set
  549. * @param value The value to set as the body of the header
  550. */
  551. setRequestHeader(name: string, value: string): void;
  552. /**
  553. * Get the string containing the text of a particular header's value.
  554. * @param name The name of the header
  555. * @returns The string containing the text of the given header name
  556. */
  557. getResponseHeader(name: string): Nullable<string>;
  558. }
  559. }
  560. declare module "babylonjs/Misc/fileRequest" {
  561. import { Observable } from "babylonjs/Misc/observable";
  562. /**
  563. * File request interface
  564. */
  565. export interface IFileRequest {
  566. /**
  567. * Raised when the request is complete (success or error).
  568. */
  569. onCompleteObservable: Observable<IFileRequest>;
  570. /**
  571. * Aborts the request for a file.
  572. */
  573. abort: () => void;
  574. }
  575. }
  576. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  577. /**
  578. * Define options used to create a render target texture
  579. */
  580. export class RenderTargetCreationOptions {
  581. /**
  582. * Specifies is mipmaps must be generated
  583. */
  584. generateMipMaps?: boolean;
  585. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  586. generateDepthBuffer?: boolean;
  587. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  588. generateStencilBuffer?: boolean;
  589. /** Defines texture type (int by default) */
  590. type?: number;
  591. /** Defines sampling mode (trilinear by default) */
  592. samplingMode?: number;
  593. /** Defines format (RGBA by default) */
  594. format?: number;
  595. }
  596. }
  597. declare module "babylonjs/Engines/constants" {
  598. /** Defines the cross module used constants to avoid circular dependncies */
  599. export class Constants {
  600. /** Defines that alpha blending is disabled */
  601. static readonly ALPHA_DISABLE: number;
  602. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  603. static readonly ALPHA_ADD: number;
  604. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  605. static readonly ALPHA_COMBINE: number;
  606. /** Defines that alpha blending is DEST - SRC * DEST */
  607. static readonly ALPHA_SUBTRACT: number;
  608. /** Defines that alpha blending is SRC * DEST */
  609. static readonly ALPHA_MULTIPLY: number;
  610. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  611. static readonly ALPHA_MAXIMIZED: number;
  612. /** Defines that alpha blending is SRC + DEST */
  613. static readonly ALPHA_ONEONE: number;
  614. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  615. static readonly ALPHA_PREMULTIPLIED: number;
  616. /**
  617. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  618. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  619. */
  620. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  621. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  622. static readonly ALPHA_INTERPOLATE: number;
  623. /**
  624. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  625. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  626. */
  627. static readonly ALPHA_SCREENMODE: number;
  628. /**
  629. * Defines that alpha blending is SRC + DST
  630. * Alpha will be set to SRC ALPHA + DST ALPHA
  631. */
  632. static readonly ALPHA_ONEONE_ONEONE: number;
  633. /**
  634. * Defines that alpha blending is SRC * DST ALPHA + DST
  635. * Alpha will be set to 0
  636. */
  637. static readonly ALPHA_ALPHATOCOLOR: number;
  638. /**
  639. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  640. */
  641. static readonly ALPHA_REVERSEONEMINUS: number;
  642. /**
  643. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  644. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  645. */
  646. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  647. /**
  648. * Defines that alpha blending is SRC + DST
  649. * Alpha will be set to SRC ALPHA
  650. */
  651. static readonly ALPHA_ONEONE_ONEZERO: number;
  652. /**
  653. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  654. * Alpha will be set to DST ALPHA
  655. */
  656. static readonly ALPHA_EXCLUSION: number;
  657. /** Defines that alpha blending equation a SUM */
  658. static readonly ALPHA_EQUATION_ADD: number;
  659. /** Defines that alpha blending equation a SUBSTRACTION */
  660. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  661. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  662. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  663. /** Defines that alpha blending equation a MAX operation */
  664. static readonly ALPHA_EQUATION_MAX: number;
  665. /** Defines that alpha blending equation a MIN operation */
  666. static readonly ALPHA_EQUATION_MIN: number;
  667. /**
  668. * Defines that alpha blending equation a DARKEN operation:
  669. * It takes the min of the src and sums the alpha channels.
  670. */
  671. static readonly ALPHA_EQUATION_DARKEN: number;
  672. /** Defines that the ressource is not delayed*/
  673. static readonly DELAYLOADSTATE_NONE: number;
  674. /** Defines that the ressource was successfully delay loaded */
  675. static readonly DELAYLOADSTATE_LOADED: number;
  676. /** Defines that the ressource is currently delay loading */
  677. static readonly DELAYLOADSTATE_LOADING: number;
  678. /** Defines that the ressource is delayed and has not started loading */
  679. static readonly DELAYLOADSTATE_NOTLOADED: number;
  680. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  681. static readonly NEVER: number;
  682. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  683. static readonly ALWAYS: number;
  684. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  685. static readonly LESS: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  687. static readonly EQUAL: number;
  688. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  689. static readonly LEQUAL: number;
  690. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  691. static readonly GREATER: number;
  692. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  693. static readonly GEQUAL: number;
  694. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  695. static readonly NOTEQUAL: number;
  696. /** Passed to stencilOperation to specify that stencil value must be kept */
  697. static readonly KEEP: number;
  698. /** Passed to stencilOperation to specify that stencil value must be replaced */
  699. static readonly REPLACE: number;
  700. /** Passed to stencilOperation to specify that stencil value must be incremented */
  701. static readonly INCR: number;
  702. /** Passed to stencilOperation to specify that stencil value must be decremented */
  703. static readonly DECR: number;
  704. /** Passed to stencilOperation to specify that stencil value must be inverted */
  705. static readonly INVERT: number;
  706. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  707. static readonly INCR_WRAP: number;
  708. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  709. static readonly DECR_WRAP: number;
  710. /** Texture is not repeating outside of 0..1 UVs */
  711. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  712. /** Texture is repeating outside of 0..1 UVs */
  713. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  714. /** Texture is repeating and mirrored */
  715. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  716. /** ALPHA */
  717. static readonly TEXTUREFORMAT_ALPHA: number;
  718. /** LUMINANCE */
  719. static readonly TEXTUREFORMAT_LUMINANCE: number;
  720. /** LUMINANCE_ALPHA */
  721. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  722. /** RGB */
  723. static readonly TEXTUREFORMAT_RGB: number;
  724. /** RGBA */
  725. static readonly TEXTUREFORMAT_RGBA: number;
  726. /** RED */
  727. static readonly TEXTUREFORMAT_RED: number;
  728. /** RED (2nd reference) */
  729. static readonly TEXTUREFORMAT_R: number;
  730. /** RG */
  731. static readonly TEXTUREFORMAT_RG: number;
  732. /** RED_INTEGER */
  733. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  734. /** RED_INTEGER (2nd reference) */
  735. static readonly TEXTUREFORMAT_R_INTEGER: number;
  736. /** RG_INTEGER */
  737. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  738. /** RGB_INTEGER */
  739. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  740. /** RGBA_INTEGER */
  741. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  742. /** UNSIGNED_BYTE */
  743. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  744. /** UNSIGNED_BYTE (2nd reference) */
  745. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  746. /** FLOAT */
  747. static readonly TEXTURETYPE_FLOAT: number;
  748. /** HALF_FLOAT */
  749. static readonly TEXTURETYPE_HALF_FLOAT: number;
  750. /** BYTE */
  751. static readonly TEXTURETYPE_BYTE: number;
  752. /** SHORT */
  753. static readonly TEXTURETYPE_SHORT: number;
  754. /** UNSIGNED_SHORT */
  755. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  756. /** INT */
  757. static readonly TEXTURETYPE_INT: number;
  758. /** UNSIGNED_INT */
  759. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  760. /** UNSIGNED_SHORT_4_4_4_4 */
  761. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  762. /** UNSIGNED_SHORT_5_5_5_1 */
  763. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  764. /** UNSIGNED_SHORT_5_6_5 */
  765. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  766. /** UNSIGNED_INT_2_10_10_10_REV */
  767. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  768. /** UNSIGNED_INT_24_8 */
  769. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  770. /** UNSIGNED_INT_10F_11F_11F_REV */
  771. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  772. /** UNSIGNED_INT_5_9_9_9_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  774. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  775. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  776. /** nearest is mag = nearest and min = nearest and no mip */
  777. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  778. /** mag = nearest and min = nearest and mip = none */
  779. static readonly TEXTURE_NEAREST_NEAREST: number;
  780. /** Bilinear is mag = linear and min = linear and no mip */
  781. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  782. /** mag = linear and min = linear and mip = none */
  783. static readonly TEXTURE_LINEAR_LINEAR: number;
  784. /** Trilinear is mag = linear and min = linear and mip = linear */
  785. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  786. /** Trilinear is mag = linear and min = linear and mip = linear */
  787. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  788. /** mag = nearest and min = nearest and mip = nearest */
  789. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  790. /** mag = nearest and min = linear and mip = nearest */
  791. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  792. /** mag = nearest and min = linear and mip = linear */
  793. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  794. /** mag = nearest and min = linear and mip = none */
  795. static readonly TEXTURE_NEAREST_LINEAR: number;
  796. /** nearest is mag = nearest and min = nearest and mip = linear */
  797. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  798. /** mag = linear and min = nearest and mip = nearest */
  799. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  800. /** mag = linear and min = nearest and mip = linear */
  801. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  802. /** Bilinear is mag = linear and min = linear and mip = nearest */
  803. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  804. /** mag = linear and min = nearest and mip = none */
  805. static readonly TEXTURE_LINEAR_NEAREST: number;
  806. /** Explicit coordinates mode */
  807. static readonly TEXTURE_EXPLICIT_MODE: number;
  808. /** Spherical coordinates mode */
  809. static readonly TEXTURE_SPHERICAL_MODE: number;
  810. /** Planar coordinates mode */
  811. static readonly TEXTURE_PLANAR_MODE: number;
  812. /** Cubic coordinates mode */
  813. static readonly TEXTURE_CUBIC_MODE: number;
  814. /** Projection coordinates mode */
  815. static readonly TEXTURE_PROJECTION_MODE: number;
  816. /** Skybox coordinates mode */
  817. static readonly TEXTURE_SKYBOX_MODE: number;
  818. /** Inverse Cubic coordinates mode */
  819. static readonly TEXTURE_INVCUBIC_MODE: number;
  820. /** Equirectangular coordinates mode */
  821. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  822. /** Equirectangular Fixed coordinates mode */
  823. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  824. /** Equirectangular Fixed Mirrored coordinates mode */
  825. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  826. /** Offline (baking) quality for texture filtering */
  827. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  828. /** High quality for texture filtering */
  829. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  830. /** Medium quality for texture filtering */
  831. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  832. /** Low quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  834. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  835. static readonly SCALEMODE_FLOOR: number;
  836. /** Defines that texture rescaling will look for the nearest power of 2 size */
  837. static readonly SCALEMODE_NEAREST: number;
  838. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  839. static readonly SCALEMODE_CEILING: number;
  840. /**
  841. * The dirty texture flag value
  842. */
  843. static readonly MATERIAL_TextureDirtyFlag: number;
  844. /**
  845. * The dirty light flag value
  846. */
  847. static readonly MATERIAL_LightDirtyFlag: number;
  848. /**
  849. * The dirty fresnel flag value
  850. */
  851. static readonly MATERIAL_FresnelDirtyFlag: number;
  852. /**
  853. * The dirty attribute flag value
  854. */
  855. static readonly MATERIAL_AttributesDirtyFlag: number;
  856. /**
  857. * The dirty misc flag value
  858. */
  859. static readonly MATERIAL_MiscDirtyFlag: number;
  860. /**
  861. * The all dirty flag value
  862. */
  863. static readonly MATERIAL_AllDirtyFlag: number;
  864. /**
  865. * Returns the triangle fill mode
  866. */
  867. static readonly MATERIAL_TriangleFillMode: number;
  868. /**
  869. * Returns the wireframe mode
  870. */
  871. static readonly MATERIAL_WireFrameFillMode: number;
  872. /**
  873. * Returns the point fill mode
  874. */
  875. static readonly MATERIAL_PointFillMode: number;
  876. /**
  877. * Returns the point list draw mode
  878. */
  879. static readonly MATERIAL_PointListDrawMode: number;
  880. /**
  881. * Returns the line list draw mode
  882. */
  883. static readonly MATERIAL_LineListDrawMode: number;
  884. /**
  885. * Returns the line loop draw mode
  886. */
  887. static readonly MATERIAL_LineLoopDrawMode: number;
  888. /**
  889. * Returns the line strip draw mode
  890. */
  891. static readonly MATERIAL_LineStripDrawMode: number;
  892. /**
  893. * Returns the triangle strip draw mode
  894. */
  895. static readonly MATERIAL_TriangleStripDrawMode: number;
  896. /**
  897. * Returns the triangle fan draw mode
  898. */
  899. static readonly MATERIAL_TriangleFanDrawMode: number;
  900. /**
  901. * Stores the clock-wise side orientation
  902. */
  903. static readonly MATERIAL_ClockWiseSideOrientation: number;
  904. /**
  905. * Stores the counter clock-wise side orientation
  906. */
  907. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  908. /**
  909. * Nothing
  910. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_NothingTrigger: number;
  913. /**
  914. * On pick
  915. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnPickTrigger: number;
  918. /**
  919. * On left pick
  920. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnLeftPickTrigger: number;
  923. /**
  924. * On right pick
  925. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnRightPickTrigger: number;
  928. /**
  929. * On center pick
  930. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnCenterPickTrigger: number;
  933. /**
  934. * On pick down
  935. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  936. */
  937. static readonly ACTION_OnPickDownTrigger: number;
  938. /**
  939. * On double pick
  940. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  941. */
  942. static readonly ACTION_OnDoublePickTrigger: number;
  943. /**
  944. * On pick up
  945. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  946. */
  947. static readonly ACTION_OnPickUpTrigger: number;
  948. /**
  949. * On pick out.
  950. * This trigger will only be raised if you also declared a OnPickDown
  951. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPickOutTrigger: number;
  954. /**
  955. * On long press
  956. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnLongPressTrigger: number;
  959. /**
  960. * On pointer over
  961. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnPointerOverTrigger: number;
  964. /**
  965. * On pointer out
  966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnPointerOutTrigger: number;
  969. /**
  970. * On every frame
  971. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnEveryFrameTrigger: number;
  974. /**
  975. * On intersection enter
  976. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnIntersectionEnterTrigger: number;
  979. /**
  980. * On intersection exit
  981. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  982. */
  983. static readonly ACTION_OnIntersectionExitTrigger: number;
  984. /**
  985. * On key down
  986. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  987. */
  988. static readonly ACTION_OnKeyDownTrigger: number;
  989. /**
  990. * On key up
  991. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  992. */
  993. static readonly ACTION_OnKeyUpTrigger: number;
  994. /**
  995. * Billboard mode will only apply to Y axis
  996. */
  997. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  998. /**
  999. * Billboard mode will apply to all axes
  1000. */
  1001. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1002. /**
  1003. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1004. */
  1005. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1006. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1007. * Test order :
  1008. * Is the bounding sphere outside the frustum ?
  1009. * If not, are the bounding box vertices outside the frustum ?
  1010. * It not, then the cullable object is in the frustum.
  1011. */
  1012. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1013. /** Culling strategy : Bounding Sphere Only.
  1014. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1015. * It's also less accurate than the standard because some not visible objects can still be selected.
  1016. * Test : is the bounding sphere outside the frustum ?
  1017. * If not, then the cullable object is in the frustum.
  1018. */
  1019. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1020. /** Culling strategy : Optimistic Inclusion.
  1021. * This in an inclusion test first, then the standard exclusion test.
  1022. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1023. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1024. * Anyway, it's as accurate as the standard strategy.
  1025. * Test :
  1026. * Is the cullable object bounding sphere center in the frustum ?
  1027. * If not, apply the default culling strategy.
  1028. */
  1029. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1030. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1031. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1032. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1033. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1034. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1035. * Test :
  1036. * Is the cullable object bounding sphere center in the frustum ?
  1037. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1038. */
  1039. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1040. /**
  1041. * No logging while loading
  1042. */
  1043. static readonly SCENELOADER_NO_LOGGING: number;
  1044. /**
  1045. * Minimal logging while loading
  1046. */
  1047. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1048. /**
  1049. * Summary logging while loading
  1050. */
  1051. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1052. /**
  1053. * Detailled logging while loading
  1054. */
  1055. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1056. /**
  1057. * Prepass texture index for color
  1058. */
  1059. static readonly PREPASS_COLOR_INDEX: number;
  1060. /**
  1061. * Prepass texture index for irradiance
  1062. */
  1063. static readonly PREPASS_IRRADIANCE_INDEX: number;
  1064. /**
  1065. * Prepass texture index for depth + normal
  1066. */
  1067. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  1068. /**
  1069. * Prepass texture index for albedo
  1070. */
  1071. static readonly PREPASS_ALBEDO_INDEX: number;
  1072. }
  1073. }
  1074. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1075. import { Nullable } from "babylonjs/types";
  1076. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1077. /**
  1078. * This represents the required contract to create a new type of texture loader.
  1079. */
  1080. export interface IInternalTextureLoader {
  1081. /**
  1082. * Defines wether the loader supports cascade loading the different faces.
  1083. */
  1084. supportCascades: boolean;
  1085. /**
  1086. * This returns if the loader support the current file information.
  1087. * @param extension defines the file extension of the file being loaded
  1088. * @param mimeType defines the optional mime type of the file being loaded
  1089. * @returns true if the loader can load the specified file
  1090. */
  1091. canLoad(extension: string, mimeType?: string): boolean;
  1092. /**
  1093. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1094. * @param data contains the texture data
  1095. * @param texture defines the BabylonJS internal texture
  1096. * @param createPolynomials will be true if polynomials have been requested
  1097. * @param onLoad defines the callback to trigger once the texture is ready
  1098. * @param onError defines the callback to trigger in case of error
  1099. */
  1100. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1101. /**
  1102. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1103. * @param data contains the texture data
  1104. * @param texture defines the BabylonJS internal texture
  1105. * @param callback defines the method to call once ready to upload
  1106. */
  1107. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1108. }
  1109. }
  1110. declare module "babylonjs/Engines/IPipelineContext" {
  1111. /**
  1112. * Class used to store and describe the pipeline context associated with an effect
  1113. */
  1114. export interface IPipelineContext {
  1115. /**
  1116. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1117. */
  1118. isAsync: boolean;
  1119. /**
  1120. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1121. */
  1122. isReady: boolean;
  1123. /** @hidden */
  1124. _getVertexShaderCode(): string | null;
  1125. /** @hidden */
  1126. _getFragmentShaderCode(): string | null;
  1127. /** @hidden */
  1128. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1129. }
  1130. }
  1131. declare module "babylonjs/Meshes/dataBuffer" {
  1132. /**
  1133. * Class used to store gfx data (like WebGLBuffer)
  1134. */
  1135. export class DataBuffer {
  1136. /**
  1137. * Gets or sets the number of objects referencing this buffer
  1138. */
  1139. references: number;
  1140. /** Gets or sets the size of the underlying buffer */
  1141. capacity: number;
  1142. /**
  1143. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1144. */
  1145. is32Bits: boolean;
  1146. /**
  1147. * Gets the underlying buffer
  1148. */
  1149. get underlyingResource(): any;
  1150. }
  1151. }
  1152. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1153. /** @hidden */
  1154. export interface IShaderProcessor {
  1155. attributeProcessor?: (attribute: string) => string;
  1156. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1157. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1158. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1159. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1160. lineProcessor?: (line: string, isFragment: boolean) => string;
  1161. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1162. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1163. }
  1164. }
  1165. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1166. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1167. /** @hidden */
  1168. export interface ProcessingOptions {
  1169. defines: string[];
  1170. indexParameters: any;
  1171. isFragment: boolean;
  1172. shouldUseHighPrecisionShader: boolean;
  1173. supportsUniformBuffers: boolean;
  1174. shadersRepository: string;
  1175. includesShadersStore: {
  1176. [key: string]: string;
  1177. };
  1178. processor?: IShaderProcessor;
  1179. version: string;
  1180. platformName: string;
  1181. lookForClosingBracketForUniformBuffer?: boolean;
  1182. }
  1183. }
  1184. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1185. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1186. /** @hidden */
  1187. export class ShaderCodeNode {
  1188. line: string;
  1189. children: ShaderCodeNode[];
  1190. additionalDefineKey?: string;
  1191. additionalDefineValue?: string;
  1192. isValid(preprocessors: {
  1193. [key: string]: string;
  1194. }): boolean;
  1195. process(preprocessors: {
  1196. [key: string]: string;
  1197. }, options: ProcessingOptions): string;
  1198. }
  1199. }
  1200. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1201. /** @hidden */
  1202. export class ShaderCodeCursor {
  1203. private _lines;
  1204. lineIndex: number;
  1205. get currentLine(): string;
  1206. get canRead(): boolean;
  1207. set lines(value: string[]);
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1213. /** @hidden */
  1214. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1215. process(preprocessors: {
  1216. [key: string]: string;
  1217. }, options: ProcessingOptions): string;
  1218. }
  1219. }
  1220. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1221. /** @hidden */
  1222. export class ShaderDefineExpression {
  1223. isTrue(preprocessors: {
  1224. [key: string]: string;
  1225. }): boolean;
  1226. private static _OperatorPriority;
  1227. private static _Stack;
  1228. static postfixToInfix(postfix: string[]): string;
  1229. static infixToPostfix(infix: string): string[];
  1230. }
  1231. }
  1232. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1233. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderCodeTestNode extends ShaderCodeNode {
  1237. testExpression: ShaderDefineExpression;
  1238. isValid(preprocessors: {
  1239. [key: string]: string;
  1240. }): boolean;
  1241. }
  1242. }
  1243. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1244. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1245. /** @hidden */
  1246. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1247. define: string;
  1248. not: boolean;
  1249. constructor(define: string, not?: boolean);
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1259. leftOperand: ShaderDefineExpression;
  1260. rightOperand: ShaderDefineExpression;
  1261. isTrue(preprocessors: {
  1262. [key: string]: string;
  1263. }): boolean;
  1264. }
  1265. }
  1266. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1267. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1268. /** @hidden */
  1269. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1270. leftOperand: ShaderDefineExpression;
  1271. rightOperand: ShaderDefineExpression;
  1272. isTrue(preprocessors: {
  1273. [key: string]: string;
  1274. }): boolean;
  1275. }
  1276. }
  1277. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1278. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1279. /** @hidden */
  1280. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1281. define: string;
  1282. operand: string;
  1283. testValue: string;
  1284. constructor(define: string, operand: string, testValue: string);
  1285. isTrue(preprocessors: {
  1286. [key: string]: string;
  1287. }): boolean;
  1288. }
  1289. }
  1290. declare module "babylonjs/Offline/IOfflineProvider" {
  1291. /**
  1292. * Class used to enable access to offline support
  1293. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1294. */
  1295. export interface IOfflineProvider {
  1296. /**
  1297. * Gets a boolean indicating if scene must be saved in the database
  1298. */
  1299. enableSceneOffline: boolean;
  1300. /**
  1301. * Gets a boolean indicating if textures must be saved in the database
  1302. */
  1303. enableTexturesOffline: boolean;
  1304. /**
  1305. * Open the offline support and make it available
  1306. * @param successCallback defines the callback to call on success
  1307. * @param errorCallback defines the callback to call on error
  1308. */
  1309. open(successCallback: () => void, errorCallback: () => void): void;
  1310. /**
  1311. * Loads an image from the offline support
  1312. * @param url defines the url to load from
  1313. * @param image defines the target DOM image
  1314. */
  1315. loadImage(url: string, image: HTMLImageElement): void;
  1316. /**
  1317. * Loads a file from offline support
  1318. * @param url defines the URL to load from
  1319. * @param sceneLoaded defines a callback to call on success
  1320. * @param progressCallBack defines a callback to call when progress changed
  1321. * @param errorCallback defines a callback to call on error
  1322. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1323. */
  1324. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1325. }
  1326. }
  1327. declare module "babylonjs/Misc/filesInputStore" {
  1328. /**
  1329. * Class used to help managing file picking and drag'n'drop
  1330. * File Storage
  1331. */
  1332. export class FilesInputStore {
  1333. /**
  1334. * List of files ready to be loaded
  1335. */
  1336. static FilesToLoad: {
  1337. [key: string]: File;
  1338. };
  1339. }
  1340. }
  1341. declare module "babylonjs/Misc/retryStrategy" {
  1342. import { WebRequest } from "babylonjs/Misc/webRequest";
  1343. /**
  1344. * Class used to define a retry strategy when error happens while loading assets
  1345. */
  1346. export class RetryStrategy {
  1347. /**
  1348. * Function used to defines an exponential back off strategy
  1349. * @param maxRetries defines the maximum number of retries (3 by default)
  1350. * @param baseInterval defines the interval between retries
  1351. * @returns the strategy function to use
  1352. */
  1353. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1354. }
  1355. }
  1356. declare module "babylonjs/Misc/baseError" {
  1357. /**
  1358. * @ignore
  1359. * Application error to support additional information when loading a file
  1360. */
  1361. export abstract class BaseError extends Error {
  1362. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1363. }
  1364. }
  1365. declare module "babylonjs/Misc/fileTools" {
  1366. import { WebRequest } from "babylonjs/Misc/webRequest";
  1367. import { Nullable } from "babylonjs/types";
  1368. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1369. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1370. import { BaseError } from "babylonjs/Misc/baseError";
  1371. /** @ignore */
  1372. export class LoadFileError extends BaseError {
  1373. request?: WebRequest;
  1374. file?: File;
  1375. /**
  1376. * Creates a new LoadFileError
  1377. * @param message defines the message of the error
  1378. * @param request defines the optional web request
  1379. * @param file defines the optional file
  1380. */
  1381. constructor(message: string, object?: WebRequest | File);
  1382. }
  1383. /** @ignore */
  1384. export class RequestFileError extends BaseError {
  1385. request: WebRequest;
  1386. /**
  1387. * Creates a new LoadFileError
  1388. * @param message defines the message of the error
  1389. * @param request defines the optional web request
  1390. */
  1391. constructor(message: string, request: WebRequest);
  1392. }
  1393. /** @ignore */
  1394. export class ReadFileError extends BaseError {
  1395. file: File;
  1396. /**
  1397. * Creates a new ReadFileError
  1398. * @param message defines the message of the error
  1399. * @param file defines the optional file
  1400. */
  1401. constructor(message: string, file: File);
  1402. }
  1403. /**
  1404. * @hidden
  1405. */
  1406. export class FileTools {
  1407. /**
  1408. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1409. */
  1410. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1411. /**
  1412. * Gets or sets the base URL to use to load assets
  1413. */
  1414. static BaseUrl: string;
  1415. /**
  1416. * Default behaviour for cors in the application.
  1417. * It can be a string if the expected behavior is identical in the entire app.
  1418. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1419. */
  1420. static CorsBehavior: string | ((url: string | string[]) => string);
  1421. /**
  1422. * Gets or sets a function used to pre-process url before using them to load assets
  1423. */
  1424. static PreprocessUrl: (url: string) => string;
  1425. /**
  1426. * Removes unwanted characters from an url
  1427. * @param url defines the url to clean
  1428. * @returns the cleaned url
  1429. */
  1430. private static _CleanUrl;
  1431. /**
  1432. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1433. * @param url define the url we are trying
  1434. * @param element define the dom element where to configure the cors policy
  1435. */
  1436. static SetCorsBehavior(url: string | string[], element: {
  1437. crossOrigin: string | null;
  1438. }): void;
  1439. /**
  1440. * Loads an image as an HTMLImageElement.
  1441. * @param input url string, ArrayBuffer, or Blob to load
  1442. * @param onLoad callback called when the image successfully loads
  1443. * @param onError callback called when the image fails to load
  1444. * @param offlineProvider offline provider for caching
  1445. * @param mimeType optional mime type
  1446. * @returns the HTMLImageElement of the loaded image
  1447. */
  1448. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1449. /**
  1450. * Reads a file from a File object
  1451. * @param file defines the file to load
  1452. * @param onSuccess defines the callback to call when data is loaded
  1453. * @param onProgress defines the callback to call during loading process
  1454. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1455. * @param onError defines the callback to call when an error occurs
  1456. * @returns a file request object
  1457. */
  1458. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1459. /**
  1460. * Loads a file from a url
  1461. * @param url url to load
  1462. * @param onSuccess callback called when the file successfully loads
  1463. * @param onProgress callback called while file is loading (if the server supports this mode)
  1464. * @param offlineProvider defines the offline provider for caching
  1465. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1466. * @param onError callback called when the file fails to load
  1467. * @returns a file request object
  1468. */
  1469. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1470. /**
  1471. * Loads a file
  1472. * @param url url to load
  1473. * @param onSuccess callback called when the file successfully loads
  1474. * @param onProgress callback called while file is loading (if the server supports this mode)
  1475. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1476. * @param onError callback called when the file fails to load
  1477. * @param onOpened callback called when the web request is opened
  1478. * @returns a file request object
  1479. */
  1480. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1481. /**
  1482. * Checks if the loaded document was accessed via `file:`-Protocol.
  1483. * @returns boolean
  1484. */
  1485. static IsFileURL(): boolean;
  1486. }
  1487. }
  1488. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1489. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1490. import { WebRequest } from "babylonjs/Misc/webRequest";
  1491. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1492. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1493. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1494. /** @hidden */
  1495. export class ShaderProcessor {
  1496. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1497. private static _ProcessPrecision;
  1498. private static _ExtractOperation;
  1499. private static _BuildSubExpression;
  1500. private static _BuildExpression;
  1501. private static _MoveCursorWithinIf;
  1502. private static _MoveCursor;
  1503. private static _EvaluatePreProcessors;
  1504. private static _PreparePreProcessors;
  1505. private static _ProcessShaderConversion;
  1506. private static _ProcessIncludes;
  1507. /**
  1508. * Loads a file from a url
  1509. * @param url url to load
  1510. * @param onSuccess callback called when the file successfully loads
  1511. * @param onProgress callback called while file is loading (if the server supports this mode)
  1512. * @param offlineProvider defines the offline provider for caching
  1513. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1514. * @param onError callback called when the file fails to load
  1515. * @returns a file request object
  1516. * @hidden
  1517. */
  1518. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1519. }
  1520. }
  1521. declare module "babylonjs/Maths/math.like" {
  1522. import { float, int, DeepImmutable } from "babylonjs/types";
  1523. /**
  1524. * @hidden
  1525. */
  1526. export interface IColor4Like {
  1527. r: float;
  1528. g: float;
  1529. b: float;
  1530. a: float;
  1531. }
  1532. /**
  1533. * @hidden
  1534. */
  1535. export interface IColor3Like {
  1536. r: float;
  1537. g: float;
  1538. b: float;
  1539. }
  1540. /**
  1541. * @hidden
  1542. */
  1543. export interface IVector4Like {
  1544. x: float;
  1545. y: float;
  1546. z: float;
  1547. w: float;
  1548. }
  1549. /**
  1550. * @hidden
  1551. */
  1552. export interface IVector3Like {
  1553. x: float;
  1554. y: float;
  1555. z: float;
  1556. }
  1557. /**
  1558. * @hidden
  1559. */
  1560. export interface IVector2Like {
  1561. x: float;
  1562. y: float;
  1563. }
  1564. /**
  1565. * @hidden
  1566. */
  1567. export interface IMatrixLike {
  1568. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1569. updateFlag: int;
  1570. }
  1571. /**
  1572. * @hidden
  1573. */
  1574. export interface IViewportLike {
  1575. x: float;
  1576. y: float;
  1577. width: float;
  1578. height: float;
  1579. }
  1580. /**
  1581. * @hidden
  1582. */
  1583. export interface IPlaneLike {
  1584. normal: IVector3Like;
  1585. d: float;
  1586. normalize(): void;
  1587. }
  1588. }
  1589. declare module "babylonjs/Materials/iEffectFallbacks" {
  1590. import { Effect } from "babylonjs/Materials/effect";
  1591. /**
  1592. * Interface used to define common properties for effect fallbacks
  1593. */
  1594. export interface IEffectFallbacks {
  1595. /**
  1596. * Removes the defines that should be removed when falling back.
  1597. * @param currentDefines defines the current define statements for the shader.
  1598. * @param effect defines the current effect we try to compile
  1599. * @returns The resulting defines with defines of the current rank removed.
  1600. */
  1601. reduce(currentDefines: string, effect: Effect): string;
  1602. /**
  1603. * Removes the fallback from the bound mesh.
  1604. */
  1605. unBindMesh(): void;
  1606. /**
  1607. * Checks to see if more fallbacks are still availible.
  1608. */
  1609. hasMoreFallbacks: boolean;
  1610. }
  1611. }
  1612. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1613. /**
  1614. * Class used to evalaute queries containing `and` and `or` operators
  1615. */
  1616. export class AndOrNotEvaluator {
  1617. /**
  1618. * Evaluate a query
  1619. * @param query defines the query to evaluate
  1620. * @param evaluateCallback defines the callback used to filter result
  1621. * @returns true if the query matches
  1622. */
  1623. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1624. private static _HandleParenthesisContent;
  1625. private static _SimplifyNegation;
  1626. }
  1627. }
  1628. declare module "babylonjs/Misc/tags" {
  1629. /**
  1630. * Class used to store custom tags
  1631. */
  1632. export class Tags {
  1633. /**
  1634. * Adds support for tags on the given object
  1635. * @param obj defines the object to use
  1636. */
  1637. static EnableFor(obj: any): void;
  1638. /**
  1639. * Removes tags support
  1640. * @param obj defines the object to use
  1641. */
  1642. static DisableFor(obj: any): void;
  1643. /**
  1644. * Gets a boolean indicating if the given object has tags
  1645. * @param obj defines the object to use
  1646. * @returns a boolean
  1647. */
  1648. static HasTags(obj: any): boolean;
  1649. /**
  1650. * Gets the tags available on a given object
  1651. * @param obj defines the object to use
  1652. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1653. * @returns the tags
  1654. */
  1655. static GetTags(obj: any, asString?: boolean): any;
  1656. /**
  1657. * Adds tags to an object
  1658. * @param obj defines the object to use
  1659. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1660. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1661. */
  1662. static AddTagsTo(obj: any, tagsString: string): void;
  1663. /**
  1664. * @hidden
  1665. */
  1666. static _AddTagTo(obj: any, tag: string): void;
  1667. /**
  1668. * Removes specific tags from a specific object
  1669. * @param obj defines the object to use
  1670. * @param tagsString defines the tags to remove
  1671. */
  1672. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1673. /**
  1674. * @hidden
  1675. */
  1676. static _RemoveTagFrom(obj: any, tag: string): void;
  1677. /**
  1678. * Defines if tags hosted on an object match a given query
  1679. * @param obj defines the object to use
  1680. * @param tagsQuery defines the tag query
  1681. * @returns a boolean
  1682. */
  1683. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1684. }
  1685. }
  1686. declare module "babylonjs/Maths/math.scalar" {
  1687. /**
  1688. * Scalar computation library
  1689. */
  1690. export class Scalar {
  1691. /**
  1692. * Two pi constants convenient for computation.
  1693. */
  1694. static TwoPi: number;
  1695. /**
  1696. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1697. * @param a number
  1698. * @param b number
  1699. * @param epsilon (default = 1.401298E-45)
  1700. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1701. */
  1702. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1703. /**
  1704. * Returns a string : the upper case translation of the number i to hexadecimal.
  1705. * @param i number
  1706. * @returns the upper case translation of the number i to hexadecimal.
  1707. */
  1708. static ToHex(i: number): string;
  1709. /**
  1710. * Returns -1 if value is negative and +1 is value is positive.
  1711. * @param value the value
  1712. * @returns the value itself if it's equal to zero.
  1713. */
  1714. static Sign(value: number): number;
  1715. /**
  1716. * Returns the value itself if it's between min and max.
  1717. * Returns min if the value is lower than min.
  1718. * Returns max if the value is greater than max.
  1719. * @param value the value to clmap
  1720. * @param min the min value to clamp to (default: 0)
  1721. * @param max the max value to clamp to (default: 1)
  1722. * @returns the clamped value
  1723. */
  1724. static Clamp(value: number, min?: number, max?: number): number;
  1725. /**
  1726. * the log2 of value.
  1727. * @param value the value to compute log2 of
  1728. * @returns the log2 of value.
  1729. */
  1730. static Log2(value: number): number;
  1731. /**
  1732. * Loops the value, so that it is never larger than length and never smaller than 0.
  1733. *
  1734. * This is similar to the modulo operator but it works with floating point numbers.
  1735. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1736. * With t = 5 and length = 2.5, the result would be 0.0.
  1737. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1738. * @param value the value
  1739. * @param length the length
  1740. * @returns the looped value
  1741. */
  1742. static Repeat(value: number, length: number): number;
  1743. /**
  1744. * Normalize the value between 0.0 and 1.0 using min and max values
  1745. * @param value value to normalize
  1746. * @param min max to normalize between
  1747. * @param max min to normalize between
  1748. * @returns the normalized value
  1749. */
  1750. static Normalize(value: number, min: number, max: number): number;
  1751. /**
  1752. * Denormalize the value from 0.0 and 1.0 using min and max values
  1753. * @param normalized value to denormalize
  1754. * @param min max to denormalize between
  1755. * @param max min to denormalize between
  1756. * @returns the denormalized value
  1757. */
  1758. static Denormalize(normalized: number, min: number, max: number): number;
  1759. /**
  1760. * Calculates the shortest difference between two given angles given in degrees.
  1761. * @param current current angle in degrees
  1762. * @param target target angle in degrees
  1763. * @returns the delta
  1764. */
  1765. static DeltaAngle(current: number, target: number): number;
  1766. /**
  1767. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1768. * @param tx value
  1769. * @param length length
  1770. * @returns The returned value will move back and forth between 0 and length
  1771. */
  1772. static PingPong(tx: number, length: number): number;
  1773. /**
  1774. * Interpolates between min and max with smoothing at the limits.
  1775. *
  1776. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1777. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1778. * @param from from
  1779. * @param to to
  1780. * @param tx value
  1781. * @returns the smooth stepped value
  1782. */
  1783. static SmoothStep(from: number, to: number, tx: number): number;
  1784. /**
  1785. * Moves a value current towards target.
  1786. *
  1787. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1788. * Negative values of maxDelta pushes the value away from target.
  1789. * @param current current value
  1790. * @param target target value
  1791. * @param maxDelta max distance to move
  1792. * @returns resulting value
  1793. */
  1794. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1795. /**
  1796. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1797. *
  1798. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1799. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1800. * @param current current value
  1801. * @param target target value
  1802. * @param maxDelta max distance to move
  1803. * @returns resulting angle
  1804. */
  1805. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1806. /**
  1807. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1808. * @param start start value
  1809. * @param end target value
  1810. * @param amount amount to lerp between
  1811. * @returns the lerped value
  1812. */
  1813. static Lerp(start: number, end: number, amount: number): number;
  1814. /**
  1815. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1816. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1817. * @param start start value
  1818. * @param end target value
  1819. * @param amount amount to lerp between
  1820. * @returns the lerped value
  1821. */
  1822. static LerpAngle(start: number, end: number, amount: number): number;
  1823. /**
  1824. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1825. * @param a start value
  1826. * @param b target value
  1827. * @param value value between a and b
  1828. * @returns the inverseLerp value
  1829. */
  1830. static InverseLerp(a: number, b: number, value: number): number;
  1831. /**
  1832. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1833. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1834. * @param value1 spline value
  1835. * @param tangent1 spline value
  1836. * @param value2 spline value
  1837. * @param tangent2 spline value
  1838. * @param amount input value
  1839. * @returns hermite result
  1840. */
  1841. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1842. /**
  1843. * Returns a random float number between and min and max values
  1844. * @param min min value of random
  1845. * @param max max value of random
  1846. * @returns random value
  1847. */
  1848. static RandomRange(min: number, max: number): number;
  1849. /**
  1850. * This function returns percentage of a number in a given range.
  1851. *
  1852. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1853. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1854. * @param number to convert to percentage
  1855. * @param min min range
  1856. * @param max max range
  1857. * @returns the percentage
  1858. */
  1859. static RangeToPercent(number: number, min: number, max: number): number;
  1860. /**
  1861. * This function returns number that corresponds to the percentage in a given range.
  1862. *
  1863. * PercentToRange(0.34,0,100) will return 34.
  1864. * @param percent to convert to number
  1865. * @param min min range
  1866. * @param max max range
  1867. * @returns the number
  1868. */
  1869. static PercentToRange(percent: number, min: number, max: number): number;
  1870. /**
  1871. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1872. * @param angle The angle to normalize in radian.
  1873. * @return The converted angle.
  1874. */
  1875. static NormalizeRadians(angle: number): number;
  1876. }
  1877. }
  1878. declare module "babylonjs/Maths/math.constants" {
  1879. /**
  1880. * Constant used to convert a value to gamma space
  1881. * @ignorenaming
  1882. */
  1883. export const ToGammaSpace: number;
  1884. /**
  1885. * Constant used to convert a value to linear space
  1886. * @ignorenaming
  1887. */
  1888. export const ToLinearSpace = 2.2;
  1889. /**
  1890. * Constant used to define the minimal number value in Babylon.js
  1891. * @ignorenaming
  1892. */
  1893. let Epsilon: number;
  1894. export { Epsilon };
  1895. }
  1896. declare module "babylonjs/Maths/math.viewport" {
  1897. /**
  1898. * Class used to represent a viewport on screen
  1899. */
  1900. export class Viewport {
  1901. /** viewport left coordinate */
  1902. x: number;
  1903. /** viewport top coordinate */
  1904. y: number;
  1905. /**viewport width */
  1906. width: number;
  1907. /** viewport height */
  1908. height: number;
  1909. /**
  1910. * Creates a Viewport object located at (x, y) and sized (width, height)
  1911. * @param x defines viewport left coordinate
  1912. * @param y defines viewport top coordinate
  1913. * @param width defines the viewport width
  1914. * @param height defines the viewport height
  1915. */
  1916. constructor(
  1917. /** viewport left coordinate */
  1918. x: number,
  1919. /** viewport top coordinate */
  1920. y: number,
  1921. /**viewport width */
  1922. width: number,
  1923. /** viewport height */
  1924. height: number);
  1925. /**
  1926. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1927. * @param renderWidth defines the rendering width
  1928. * @param renderHeight defines the rendering height
  1929. * @returns a new Viewport
  1930. */
  1931. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1932. /**
  1933. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1934. * @param renderWidth defines the rendering width
  1935. * @param renderHeight defines the rendering height
  1936. * @param ref defines the target viewport
  1937. * @returns the current viewport
  1938. */
  1939. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1940. /**
  1941. * Returns a new Viewport copied from the current one
  1942. * @returns a new Viewport
  1943. */
  1944. clone(): Viewport;
  1945. }
  1946. }
  1947. declare module "babylonjs/Misc/arrayTools" {
  1948. /**
  1949. * Class containing a set of static utilities functions for arrays.
  1950. */
  1951. export class ArrayTools {
  1952. /**
  1953. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1954. * @param size the number of element to construct and put in the array
  1955. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1956. * @returns a new array filled with new objects
  1957. */
  1958. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1959. }
  1960. }
  1961. declare module "babylonjs/Maths/math.plane" {
  1962. import { DeepImmutable } from "babylonjs/types";
  1963. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1964. /**
  1965. * Represents a plane by the equation ax + by + cz + d = 0
  1966. */
  1967. export class Plane {
  1968. private static _TmpMatrix;
  1969. /**
  1970. * Normal of the plane (a,b,c)
  1971. */
  1972. normal: Vector3;
  1973. /**
  1974. * d component of the plane
  1975. */
  1976. d: number;
  1977. /**
  1978. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  1979. * @param a a component of the plane
  1980. * @param b b component of the plane
  1981. * @param c c component of the plane
  1982. * @param d d component of the plane
  1983. */
  1984. constructor(a: number, b: number, c: number, d: number);
  1985. /**
  1986. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  1987. */
  1988. asArray(): number[];
  1989. /**
  1990. * @returns a new plane copied from the current Plane.
  1991. */
  1992. clone(): Plane;
  1993. /**
  1994. * @returns the string "Plane".
  1995. */
  1996. getClassName(): string;
  1997. /**
  1998. * @returns the Plane hash code.
  1999. */
  2000. getHashCode(): number;
  2001. /**
  2002. * Normalize the current Plane in place.
  2003. * @returns the updated Plane.
  2004. */
  2005. normalize(): Plane;
  2006. /**
  2007. * Applies a transformation the plane and returns the result
  2008. * @param transformation the transformation matrix to be applied to the plane
  2009. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2010. */
  2011. transform(transformation: DeepImmutable<Matrix>): Plane;
  2012. /**
  2013. * Compute the dot product between the point and the plane normal
  2014. * @param point point to calculate the dot product with
  2015. * @returns the dot product (float) of the point coordinates and the plane normal.
  2016. */
  2017. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2018. /**
  2019. * Updates the current Plane from the plane defined by the three given points.
  2020. * @param point1 one of the points used to contruct the plane
  2021. * @param point2 one of the points used to contruct the plane
  2022. * @param point3 one of the points used to contruct the plane
  2023. * @returns the updated Plane.
  2024. */
  2025. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2026. /**
  2027. * Checks if the plane is facing a given direction
  2028. * @param direction the direction to check if the plane is facing
  2029. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2030. * @returns True is the vector "direction" is the same side than the plane normal.
  2031. */
  2032. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2033. /**
  2034. * Calculates the distance to a point
  2035. * @param point point to calculate distance to
  2036. * @returns the signed distance (float) from the given point to the Plane.
  2037. */
  2038. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2039. /**
  2040. * Creates a plane from an array
  2041. * @param array the array to create a plane from
  2042. * @returns a new Plane from the given array.
  2043. */
  2044. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2045. /**
  2046. * Creates a plane from three points
  2047. * @param point1 point used to create the plane
  2048. * @param point2 point used to create the plane
  2049. * @param point3 point used to create the plane
  2050. * @returns a new Plane defined by the three given points.
  2051. */
  2052. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2053. /**
  2054. * Creates a plane from an origin point and a normal
  2055. * @param origin origin of the plane to be constructed
  2056. * @param normal normal of the plane to be constructed
  2057. * @returns a new Plane the normal vector to this plane at the given origin point.
  2058. * Note : the vector "normal" is updated because normalized.
  2059. */
  2060. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2061. /**
  2062. * Calculates the distance from a plane and a point
  2063. * @param origin origin of the plane to be constructed
  2064. * @param normal normal of the plane to be constructed
  2065. * @param point point to calculate distance to
  2066. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2067. */
  2068. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2069. }
  2070. }
  2071. declare module "babylonjs/Engines/performanceConfigurator" {
  2072. /** @hidden */
  2073. export class PerformanceConfigurator {
  2074. /** @hidden */
  2075. static MatrixUse64Bits: boolean;
  2076. /** @hidden */
  2077. static MatrixTrackPrecisionChange: boolean;
  2078. /** @hidden */
  2079. static MatrixCurrentType: any;
  2080. /** @hidden */
  2081. static MatrixTrackedMatrices: Array<any> | null;
  2082. /** @hidden */
  2083. static SetMatrixPrecision(use64bits: boolean): void;
  2084. }
  2085. }
  2086. declare module "babylonjs/Maths/math.vector" {
  2087. import { Viewport } from "babylonjs/Maths/math.viewport";
  2088. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2089. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2090. import { Plane } from "babylonjs/Maths/math.plane";
  2091. /**
  2092. * Class representing a vector containing 2 coordinates
  2093. */
  2094. export class Vector2 {
  2095. /** defines the first coordinate */
  2096. x: number;
  2097. /** defines the second coordinate */
  2098. y: number;
  2099. /**
  2100. * Creates a new Vector2 from the given x and y coordinates
  2101. * @param x defines the first coordinate
  2102. * @param y defines the second coordinate
  2103. */
  2104. constructor(
  2105. /** defines the first coordinate */
  2106. x?: number,
  2107. /** defines the second coordinate */
  2108. y?: number);
  2109. /**
  2110. * Gets a string with the Vector2 coordinates
  2111. * @returns a string with the Vector2 coordinates
  2112. */
  2113. toString(): string;
  2114. /**
  2115. * Gets class name
  2116. * @returns the string "Vector2"
  2117. */
  2118. getClassName(): string;
  2119. /**
  2120. * Gets current vector hash code
  2121. * @returns the Vector2 hash code as a number
  2122. */
  2123. getHashCode(): number;
  2124. /**
  2125. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2126. * @param array defines the source array
  2127. * @param index defines the offset in source array
  2128. * @returns the current Vector2
  2129. */
  2130. toArray(array: FloatArray, index?: number): Vector2;
  2131. /**
  2132. * Update the current vector from an array
  2133. * @param array defines the destination array
  2134. * @param index defines the offset in the destination array
  2135. * @returns the current Vector3
  2136. */
  2137. fromArray(array: FloatArray, index?: number): Vector2;
  2138. /**
  2139. * Copy the current vector to an array
  2140. * @returns a new array with 2 elements: the Vector2 coordinates.
  2141. */
  2142. asArray(): number[];
  2143. /**
  2144. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2145. * @param source defines the source Vector2
  2146. * @returns the current updated Vector2
  2147. */
  2148. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2149. /**
  2150. * Sets the Vector2 coordinates with the given floats
  2151. * @param x defines the first coordinate
  2152. * @param y defines the second coordinate
  2153. * @returns the current updated Vector2
  2154. */
  2155. copyFromFloats(x: number, y: number): Vector2;
  2156. /**
  2157. * Sets the Vector2 coordinates with the given floats
  2158. * @param x defines the first coordinate
  2159. * @param y defines the second coordinate
  2160. * @returns the current updated Vector2
  2161. */
  2162. set(x: number, y: number): Vector2;
  2163. /**
  2164. * Add another vector with the current one
  2165. * @param otherVector defines the other vector
  2166. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2167. */
  2168. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2169. /**
  2170. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2171. * @param otherVector defines the other vector
  2172. * @param result defines the target vector
  2173. * @returns the unmodified current Vector2
  2174. */
  2175. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2176. /**
  2177. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2178. * @param otherVector defines the other vector
  2179. * @returns the current updated Vector2
  2180. */
  2181. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2182. /**
  2183. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2184. * @param otherVector defines the other vector
  2185. * @returns a new Vector2
  2186. */
  2187. addVector3(otherVector: Vector3): Vector2;
  2188. /**
  2189. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2190. * @param otherVector defines the other vector
  2191. * @returns a new Vector2
  2192. */
  2193. subtract(otherVector: Vector2): Vector2;
  2194. /**
  2195. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2196. * @param otherVector defines the other vector
  2197. * @param result defines the target vector
  2198. * @returns the unmodified current Vector2
  2199. */
  2200. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2201. /**
  2202. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2203. * @param otherVector defines the other vector
  2204. * @returns the current updated Vector2
  2205. */
  2206. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2207. /**
  2208. * Multiplies in place the current Vector2 coordinates by the given ones
  2209. * @param otherVector defines the other vector
  2210. * @returns the current updated Vector2
  2211. */
  2212. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2213. /**
  2214. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2215. * @param otherVector defines the other vector
  2216. * @returns a new Vector2
  2217. */
  2218. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2219. /**
  2220. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2221. * @param otherVector defines the other vector
  2222. * @param result defines the target vector
  2223. * @returns the unmodified current Vector2
  2224. */
  2225. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2226. /**
  2227. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2228. * @param x defines the first coordinate
  2229. * @param y defines the second coordinate
  2230. * @returns a new Vector2
  2231. */
  2232. multiplyByFloats(x: number, y: number): Vector2;
  2233. /**
  2234. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2235. * @param otherVector defines the other vector
  2236. * @returns a new Vector2
  2237. */
  2238. divide(otherVector: Vector2): Vector2;
  2239. /**
  2240. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2241. * @param otherVector defines the other vector
  2242. * @param result defines the target vector
  2243. * @returns the unmodified current Vector2
  2244. */
  2245. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2246. /**
  2247. * Divides the current Vector2 coordinates by the given ones
  2248. * @param otherVector defines the other vector
  2249. * @returns the current updated Vector2
  2250. */
  2251. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2252. /**
  2253. * Gets a new Vector2 with current Vector2 negated coordinates
  2254. * @returns a new Vector2
  2255. */
  2256. negate(): Vector2;
  2257. /**
  2258. * Negate this vector in place
  2259. * @returns this
  2260. */
  2261. negateInPlace(): Vector2;
  2262. /**
  2263. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2264. * @param result defines the Vector3 object where to store the result
  2265. * @returns the current Vector2
  2266. */
  2267. negateToRef(result: Vector2): Vector2;
  2268. /**
  2269. * Multiply the Vector2 coordinates by scale
  2270. * @param scale defines the scaling factor
  2271. * @returns the current updated Vector2
  2272. */
  2273. scaleInPlace(scale: number): Vector2;
  2274. /**
  2275. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2276. * @param scale defines the scaling factor
  2277. * @returns a new Vector2
  2278. */
  2279. scale(scale: number): Vector2;
  2280. /**
  2281. * Scale the current Vector2 values by a factor to a given Vector2
  2282. * @param scale defines the scale factor
  2283. * @param result defines the Vector2 object where to store the result
  2284. * @returns the unmodified current Vector2
  2285. */
  2286. scaleToRef(scale: number, result: Vector2): Vector2;
  2287. /**
  2288. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2289. * @param scale defines the scale factor
  2290. * @param result defines the Vector2 object where to store the result
  2291. * @returns the unmodified current Vector2
  2292. */
  2293. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2294. /**
  2295. * Gets a boolean if two vectors are equals
  2296. * @param otherVector defines the other vector
  2297. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2298. */
  2299. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2300. /**
  2301. * Gets a boolean if two vectors are equals (using an epsilon value)
  2302. * @param otherVector defines the other vector
  2303. * @param epsilon defines the minimal distance to consider equality
  2304. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2305. */
  2306. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2307. /**
  2308. * Gets a new Vector2 from current Vector2 floored values
  2309. * @returns a new Vector2
  2310. */
  2311. floor(): Vector2;
  2312. /**
  2313. * Gets a new Vector2 from current Vector2 floored values
  2314. * @returns a new Vector2
  2315. */
  2316. fract(): Vector2;
  2317. /**
  2318. * Gets the length of the vector
  2319. * @returns the vector length (float)
  2320. */
  2321. length(): number;
  2322. /**
  2323. * Gets the vector squared length
  2324. * @returns the vector squared length (float)
  2325. */
  2326. lengthSquared(): number;
  2327. /**
  2328. * Normalize the vector
  2329. * @returns the current updated Vector2
  2330. */
  2331. normalize(): Vector2;
  2332. /**
  2333. * Gets a new Vector2 copied from the Vector2
  2334. * @returns a new Vector2
  2335. */
  2336. clone(): Vector2;
  2337. /**
  2338. * Gets a new Vector2(0, 0)
  2339. * @returns a new Vector2
  2340. */
  2341. static Zero(): Vector2;
  2342. /**
  2343. * Gets a new Vector2(1, 1)
  2344. * @returns a new Vector2
  2345. */
  2346. static One(): Vector2;
  2347. /**
  2348. * Gets a new Vector2 set from the given index element of the given array
  2349. * @param array defines the data source
  2350. * @param offset defines the offset in the data source
  2351. * @returns a new Vector2
  2352. */
  2353. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2354. /**
  2355. * Sets "result" from the given index element of the given array
  2356. * @param array defines the data source
  2357. * @param offset defines the offset in the data source
  2358. * @param result defines the target vector
  2359. */
  2360. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2361. /**
  2362. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2363. * @param value1 defines 1st point of control
  2364. * @param value2 defines 2nd point of control
  2365. * @param value3 defines 3rd point of control
  2366. * @param value4 defines 4th point of control
  2367. * @param amount defines the interpolation factor
  2368. * @returns a new Vector2
  2369. */
  2370. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2371. /**
  2372. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  2373. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2374. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2375. * @param value defines the value to clamp
  2376. * @param min defines the lower limit
  2377. * @param max defines the upper limit
  2378. * @returns a new Vector2
  2379. */
  2380. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2381. /**
  2382. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2383. * @param value1 defines the 1st control point
  2384. * @param tangent1 defines the outgoing tangent
  2385. * @param value2 defines the 2nd control point
  2386. * @param tangent2 defines the incoming tangent
  2387. * @param amount defines the interpolation factor
  2388. * @returns a new Vector2
  2389. */
  2390. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2391. /**
  2392. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2393. * @param start defines the start vector
  2394. * @param end defines the end vector
  2395. * @param amount defines the interpolation factor
  2396. * @returns a new Vector2
  2397. */
  2398. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2399. /**
  2400. * Gets the dot product of the vector "left" and the vector "right"
  2401. * @param left defines first vector
  2402. * @param right defines second vector
  2403. * @returns the dot product (float)
  2404. */
  2405. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2406. /**
  2407. * Returns a new Vector2 equal to the normalized given vector
  2408. * @param vector defines the vector to normalize
  2409. * @returns a new Vector2
  2410. */
  2411. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2412. /**
  2413. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2414. * @param left defines 1st vector
  2415. * @param right defines 2nd vector
  2416. * @returns a new Vector2
  2417. */
  2418. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2419. /**
  2420. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2421. * @param left defines 1st vector
  2422. * @param right defines 2nd vector
  2423. * @returns a new Vector2
  2424. */
  2425. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2426. /**
  2427. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2428. * @param vector defines the vector to transform
  2429. * @param transformation defines the matrix to apply
  2430. * @returns a new Vector2
  2431. */
  2432. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2433. /**
  2434. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2435. * @param vector defines the vector to transform
  2436. * @param transformation defines the matrix to apply
  2437. * @param result defines the target vector
  2438. */
  2439. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2440. /**
  2441. * Determines if a given vector is included in a triangle
  2442. * @param p defines the vector to test
  2443. * @param p0 defines 1st triangle point
  2444. * @param p1 defines 2nd triangle point
  2445. * @param p2 defines 3rd triangle point
  2446. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2447. */
  2448. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2449. /**
  2450. * Gets the distance between the vectors "value1" and "value2"
  2451. * @param value1 defines first vector
  2452. * @param value2 defines second vector
  2453. * @returns the distance between vectors
  2454. */
  2455. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2456. /**
  2457. * Returns the squared distance between the vectors "value1" and "value2"
  2458. * @param value1 defines first vector
  2459. * @param value2 defines second vector
  2460. * @returns the squared distance between vectors
  2461. */
  2462. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2463. /**
  2464. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2465. * @param value1 defines first vector
  2466. * @param value2 defines second vector
  2467. * @returns a new Vector2
  2468. */
  2469. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2470. /**
  2471. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2472. * @param p defines the middle point
  2473. * @param segA defines one point of the segment
  2474. * @param segB defines the other point of the segment
  2475. * @returns the shortest distance
  2476. */
  2477. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2478. }
  2479. /**
  2480. * Class used to store (x,y,z) vector representation
  2481. * A Vector3 is the main object used in 3D geometry
  2482. * It can represent etiher the coordinates of a point the space, either a direction
  2483. * Reminder: js uses a left handed forward facing system
  2484. */
  2485. export class Vector3 {
  2486. private static _UpReadOnly;
  2487. private static _ZeroReadOnly;
  2488. /** @hidden */
  2489. _x: number;
  2490. /** @hidden */
  2491. _y: number;
  2492. /** @hidden */
  2493. _z: number;
  2494. /** @hidden */
  2495. _isDirty: boolean;
  2496. /** Gets or sets the x coordinate */
  2497. get x(): number;
  2498. set x(value: number);
  2499. /** Gets or sets the y coordinate */
  2500. get y(): number;
  2501. set y(value: number);
  2502. /** Gets or sets the z coordinate */
  2503. get z(): number;
  2504. set z(value: number);
  2505. /**
  2506. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2507. * @param x defines the first coordinates (on X axis)
  2508. * @param y defines the second coordinates (on Y axis)
  2509. * @param z defines the third coordinates (on Z axis)
  2510. */
  2511. constructor(x?: number, y?: number, z?: number);
  2512. /**
  2513. * Creates a string representation of the Vector3
  2514. * @returns a string with the Vector3 coordinates.
  2515. */
  2516. toString(): string;
  2517. /**
  2518. * Gets the class name
  2519. * @returns the string "Vector3"
  2520. */
  2521. getClassName(): string;
  2522. /**
  2523. * Creates the Vector3 hash code
  2524. * @returns a number which tends to be unique between Vector3 instances
  2525. */
  2526. getHashCode(): number;
  2527. /**
  2528. * Creates an array containing three elements : the coordinates of the Vector3
  2529. * @returns a new array of numbers
  2530. */
  2531. asArray(): number[];
  2532. /**
  2533. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2534. * @param array defines the destination array
  2535. * @param index defines the offset in the destination array
  2536. * @returns the current Vector3
  2537. */
  2538. toArray(array: FloatArray, index?: number): Vector3;
  2539. /**
  2540. * Update the current vector from an array
  2541. * @param array defines the destination array
  2542. * @param index defines the offset in the destination array
  2543. * @returns the current Vector3
  2544. */
  2545. fromArray(array: FloatArray, index?: number): Vector3;
  2546. /**
  2547. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2548. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2549. */
  2550. toQuaternion(): Quaternion;
  2551. /**
  2552. * Adds the given vector to the current Vector3
  2553. * @param otherVector defines the second operand
  2554. * @returns the current updated Vector3
  2555. */
  2556. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2557. /**
  2558. * Adds the given coordinates to the current Vector3
  2559. * @param x defines the x coordinate of the operand
  2560. * @param y defines the y coordinate of the operand
  2561. * @param z defines the z coordinate of the operand
  2562. * @returns the current updated Vector3
  2563. */
  2564. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2565. /**
  2566. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2567. * @param otherVector defines the second operand
  2568. * @returns the resulting Vector3
  2569. */
  2570. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2571. /**
  2572. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2573. * @param otherVector defines the second operand
  2574. * @param result defines the Vector3 object where to store the result
  2575. * @returns the current Vector3
  2576. */
  2577. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2578. /**
  2579. * Subtract the given vector from the current Vector3
  2580. * @param otherVector defines the second operand
  2581. * @returns the current updated Vector3
  2582. */
  2583. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2584. /**
  2585. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2586. * @param otherVector defines the second operand
  2587. * @returns the resulting Vector3
  2588. */
  2589. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2590. /**
  2591. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2592. * @param otherVector defines the second operand
  2593. * @param result defines the Vector3 object where to store the result
  2594. * @returns the current Vector3
  2595. */
  2596. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2597. /**
  2598. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2599. * @param x defines the x coordinate of the operand
  2600. * @param y defines the y coordinate of the operand
  2601. * @param z defines the z coordinate of the operand
  2602. * @returns the resulting Vector3
  2603. */
  2604. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2605. /**
  2606. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2607. * @param x defines the x coordinate of the operand
  2608. * @param y defines the y coordinate of the operand
  2609. * @param z defines the z coordinate of the operand
  2610. * @param result defines the Vector3 object where to store the result
  2611. * @returns the current Vector3
  2612. */
  2613. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2614. /**
  2615. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2616. * @returns a new Vector3
  2617. */
  2618. negate(): Vector3;
  2619. /**
  2620. * Negate this vector in place
  2621. * @returns this
  2622. */
  2623. negateInPlace(): Vector3;
  2624. /**
  2625. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2626. * @param result defines the Vector3 object where to store the result
  2627. * @returns the current Vector3
  2628. */
  2629. negateToRef(result: Vector3): Vector3;
  2630. /**
  2631. * Multiplies the Vector3 coordinates by the float "scale"
  2632. * @param scale defines the multiplier factor
  2633. * @returns the current updated Vector3
  2634. */
  2635. scaleInPlace(scale: number): Vector3;
  2636. /**
  2637. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2638. * @param scale defines the multiplier factor
  2639. * @returns a new Vector3
  2640. */
  2641. scale(scale: number): Vector3;
  2642. /**
  2643. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2644. * @param scale defines the multiplier factor
  2645. * @param result defines the Vector3 object where to store the result
  2646. * @returns the current Vector3
  2647. */
  2648. scaleToRef(scale: number, result: Vector3): Vector3;
  2649. /**
  2650. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2651. * @param scale defines the scale factor
  2652. * @param result defines the Vector3 object where to store the result
  2653. * @returns the unmodified current Vector3
  2654. */
  2655. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2656. /**
  2657. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2658. * @param origin defines the origin of the projection ray
  2659. * @param plane defines the plane to project to
  2660. * @returns the projected vector3
  2661. */
  2662. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2663. /**
  2664. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2665. * @param origin defines the origin of the projection ray
  2666. * @param plane defines the plane to project to
  2667. * @param result defines the Vector3 where to store the result
  2668. */
  2669. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2670. /**
  2671. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2672. * @param otherVector defines the second operand
  2673. * @returns true if both vectors are equals
  2674. */
  2675. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2676. /**
  2677. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2678. * @param otherVector defines the second operand
  2679. * @param epsilon defines the minimal distance to define values as equals
  2680. * @returns true if both vectors are distant less than epsilon
  2681. */
  2682. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2683. /**
  2684. * Returns true if the current Vector3 coordinates equals the given floats
  2685. * @param x defines the x coordinate of the operand
  2686. * @param y defines the y coordinate of the operand
  2687. * @param z defines the z coordinate of the operand
  2688. * @returns true if both vectors are equals
  2689. */
  2690. equalsToFloats(x: number, y: number, z: number): boolean;
  2691. /**
  2692. * Multiplies the current Vector3 coordinates by the given ones
  2693. * @param otherVector defines the second operand
  2694. * @returns the current updated Vector3
  2695. */
  2696. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2697. /**
  2698. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2699. * @param otherVector defines the second operand
  2700. * @returns the new Vector3
  2701. */
  2702. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2703. /**
  2704. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2705. * @param otherVector defines the second operand
  2706. * @param result defines the Vector3 object where to store the result
  2707. * @returns the current Vector3
  2708. */
  2709. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2710. /**
  2711. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2712. * @param x defines the x coordinate of the operand
  2713. * @param y defines the y coordinate of the operand
  2714. * @param z defines the z coordinate of the operand
  2715. * @returns the new Vector3
  2716. */
  2717. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2718. /**
  2719. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2720. * @param otherVector defines the second operand
  2721. * @returns the new Vector3
  2722. */
  2723. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2724. /**
  2725. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2726. * @param otherVector defines the second operand
  2727. * @param result defines the Vector3 object where to store the result
  2728. * @returns the current Vector3
  2729. */
  2730. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2731. /**
  2732. * Divides the current Vector3 coordinates by the given ones.
  2733. * @param otherVector defines the second operand
  2734. * @returns the current updated Vector3
  2735. */
  2736. divideInPlace(otherVector: Vector3): Vector3;
  2737. /**
  2738. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2739. * @param other defines the second operand
  2740. * @returns the current updated Vector3
  2741. */
  2742. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2743. /**
  2744. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2745. * @param other defines the second operand
  2746. * @returns the current updated Vector3
  2747. */
  2748. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2749. /**
  2750. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2751. * @param x defines the x coordinate of the operand
  2752. * @param y defines the y coordinate of the operand
  2753. * @param z defines the z coordinate of the operand
  2754. * @returns the current updated Vector3
  2755. */
  2756. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2757. /**
  2758. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2759. * @param x defines the x coordinate of the operand
  2760. * @param y defines the y coordinate of the operand
  2761. * @param z defines the z coordinate of the operand
  2762. * @returns the current updated Vector3
  2763. */
  2764. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2765. /**
  2766. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2767. * Check if is non uniform within a certain amount of decimal places to account for this
  2768. * @param epsilon the amount the values can differ
  2769. * @returns if the the vector is non uniform to a certain number of decimal places
  2770. */
  2771. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2772. /**
  2773. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2774. */
  2775. get isNonUniform(): boolean;
  2776. /**
  2777. * Gets a new Vector3 from current Vector3 floored values
  2778. * @returns a new Vector3
  2779. */
  2780. floor(): Vector3;
  2781. /**
  2782. * Gets a new Vector3 from current Vector3 floored values
  2783. * @returns a new Vector3
  2784. */
  2785. fract(): Vector3;
  2786. /**
  2787. * Gets the length of the Vector3
  2788. * @returns the length of the Vector3
  2789. */
  2790. length(): number;
  2791. /**
  2792. * Gets the squared length of the Vector3
  2793. * @returns squared length of the Vector3
  2794. */
  2795. lengthSquared(): number;
  2796. /**
  2797. * Normalize the current Vector3.
  2798. * Please note that this is an in place operation.
  2799. * @returns the current updated Vector3
  2800. */
  2801. normalize(): Vector3;
  2802. /**
  2803. * Reorders the x y z properties of the vector in place
  2804. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2805. * @returns the current updated vector
  2806. */
  2807. reorderInPlace(order: string): this;
  2808. /**
  2809. * Rotates the vector around 0,0,0 by a quaternion
  2810. * @param quaternion the rotation quaternion
  2811. * @param result vector to store the result
  2812. * @returns the resulting vector
  2813. */
  2814. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2815. /**
  2816. * Rotates a vector around a given point
  2817. * @param quaternion the rotation quaternion
  2818. * @param point the point to rotate around
  2819. * @param result vector to store the result
  2820. * @returns the resulting vector
  2821. */
  2822. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2823. /**
  2824. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2825. * The cross product is then orthogonal to both current and "other"
  2826. * @param other defines the right operand
  2827. * @returns the cross product
  2828. */
  2829. cross(other: Vector3): Vector3;
  2830. /**
  2831. * Normalize the current Vector3 with the given input length.
  2832. * Please note that this is an in place operation.
  2833. * @param len the length of the vector
  2834. * @returns the current updated Vector3
  2835. */
  2836. normalizeFromLength(len: number): Vector3;
  2837. /**
  2838. * Normalize the current Vector3 to a new vector
  2839. * @returns the new Vector3
  2840. */
  2841. normalizeToNew(): Vector3;
  2842. /**
  2843. * Normalize the current Vector3 to the reference
  2844. * @param reference define the Vector3 to update
  2845. * @returns the updated Vector3
  2846. */
  2847. normalizeToRef(reference: Vector3): Vector3;
  2848. /**
  2849. * Creates a new Vector3 copied from the current Vector3
  2850. * @returns the new Vector3
  2851. */
  2852. clone(): Vector3;
  2853. /**
  2854. * Copies the given vector coordinates to the current Vector3 ones
  2855. * @param source defines the source Vector3
  2856. * @returns the current updated Vector3
  2857. */
  2858. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2859. /**
  2860. * Copies the given floats to the current Vector3 coordinates
  2861. * @param x defines the x coordinate of the operand
  2862. * @param y defines the y coordinate of the operand
  2863. * @param z defines the z coordinate of the operand
  2864. * @returns the current updated Vector3
  2865. */
  2866. copyFromFloats(x: number, y: number, z: number): Vector3;
  2867. /**
  2868. * Copies the given floats to the current Vector3 coordinates
  2869. * @param x defines the x coordinate of the operand
  2870. * @param y defines the y coordinate of the operand
  2871. * @param z defines the z coordinate of the operand
  2872. * @returns the current updated Vector3
  2873. */
  2874. set(x: number, y: number, z: number): Vector3;
  2875. /**
  2876. * Copies the given float to the current Vector3 coordinates
  2877. * @param v defines the x, y and z coordinates of the operand
  2878. * @returns the current updated Vector3
  2879. */
  2880. setAll(v: number): Vector3;
  2881. /**
  2882. * Get the clip factor between two vectors
  2883. * @param vector0 defines the first operand
  2884. * @param vector1 defines the second operand
  2885. * @param axis defines the axis to use
  2886. * @param size defines the size along the axis
  2887. * @returns the clip factor
  2888. */
  2889. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2890. /**
  2891. * Get angle between two vectors
  2892. * @param vector0 angle between vector0 and vector1
  2893. * @param vector1 angle between vector0 and vector1
  2894. * @param normal direction of the normal
  2895. * @return the angle between vector0 and vector1
  2896. */
  2897. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2898. /**
  2899. * Returns a new Vector3 set from the index "offset" of the given array
  2900. * @param array defines the source array
  2901. * @param offset defines the offset in the source array
  2902. * @returns the new Vector3
  2903. */
  2904. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2905. /**
  2906. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2907. * @param array defines the source array
  2908. * @param offset defines the offset in the source array
  2909. * @returns the new Vector3
  2910. * @deprecated Please use FromArray instead.
  2911. */
  2912. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2913. /**
  2914. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2915. * @param array defines the source array
  2916. * @param offset defines the offset in the source array
  2917. * @param result defines the Vector3 where to store the result
  2918. */
  2919. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2920. /**
  2921. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2922. * @param array defines the source array
  2923. * @param offset defines the offset in the source array
  2924. * @param result defines the Vector3 where to store the result
  2925. * @deprecated Please use FromArrayToRef instead.
  2926. */
  2927. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2928. /**
  2929. * Sets the given vector "result" with the given floats.
  2930. * @param x defines the x coordinate of the source
  2931. * @param y defines the y coordinate of the source
  2932. * @param z defines the z coordinate of the source
  2933. * @param result defines the Vector3 where to store the result
  2934. */
  2935. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2936. /**
  2937. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2938. * @returns a new empty Vector3
  2939. */
  2940. static Zero(): Vector3;
  2941. /**
  2942. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2943. * @returns a new unit Vector3
  2944. */
  2945. static One(): Vector3;
  2946. /**
  2947. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2948. * @returns a new up Vector3
  2949. */
  2950. static Up(): Vector3;
  2951. /**
  2952. * Gets a up Vector3 that must not be updated
  2953. */
  2954. static get UpReadOnly(): DeepImmutable<Vector3>;
  2955. /**
  2956. * Gets a zero Vector3 that must not be updated
  2957. */
  2958. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2959. /**
  2960. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2961. * @returns a new down Vector3
  2962. */
  2963. static Down(): Vector3;
  2964. /**
  2965. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2966. * @param rightHandedSystem is the scene right-handed (negative z)
  2967. * @returns a new forward Vector3
  2968. */
  2969. static Forward(rightHandedSystem?: boolean): Vector3;
  2970. /**
  2971. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2972. * @param rightHandedSystem is the scene right-handed (negative-z)
  2973. * @returns a new forward Vector3
  2974. */
  2975. static Backward(rightHandedSystem?: boolean): Vector3;
  2976. /**
  2977. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2978. * @returns a new right Vector3
  2979. */
  2980. static Right(): Vector3;
  2981. /**
  2982. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2983. * @returns a new left Vector3
  2984. */
  2985. static Left(): Vector3;
  2986. /**
  2987. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2988. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2989. * @param vector defines the Vector3 to transform
  2990. * @param transformation defines the transformation matrix
  2991. * @returns the transformed Vector3
  2992. */
  2993. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2994. /**
  2995. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2996. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2997. * @param vector defines the Vector3 to transform
  2998. * @param transformation defines the transformation matrix
  2999. * @param result defines the Vector3 where to store the result
  3000. */
  3001. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3002. /**
  3003. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3004. * This method computes tranformed coordinates only, not transformed direction vectors
  3005. * @param x define the x coordinate of the source vector
  3006. * @param y define the y coordinate of the source vector
  3007. * @param z define the z coordinate of the source vector
  3008. * @param transformation defines the transformation matrix
  3009. * @param result defines the Vector3 where to store the result
  3010. */
  3011. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3012. /**
  3013. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3014. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3015. * @param vector defines the Vector3 to transform
  3016. * @param transformation defines the transformation matrix
  3017. * @returns the new Vector3
  3018. */
  3019. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3020. /**
  3021. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3022. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3023. * @param vector defines the Vector3 to transform
  3024. * @param transformation defines the transformation matrix
  3025. * @param result defines the Vector3 where to store the result
  3026. */
  3027. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3028. /**
  3029. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3030. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3031. * @param x define the x coordinate of the source vector
  3032. * @param y define the y coordinate of the source vector
  3033. * @param z define the z coordinate of the source vector
  3034. * @param transformation defines the transformation matrix
  3035. * @param result defines the Vector3 where to store the result
  3036. */
  3037. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3038. /**
  3039. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3040. * @param value1 defines the first control point
  3041. * @param value2 defines the second control point
  3042. * @param value3 defines the third control point
  3043. * @param value4 defines the fourth control point
  3044. * @param amount defines the amount on the spline to use
  3045. * @returns the new Vector3
  3046. */
  3047. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3048. /**
  3049. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3050. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3051. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3052. * @param value defines the current value
  3053. * @param min defines the lower range value
  3054. * @param max defines the upper range value
  3055. * @returns the new Vector3
  3056. */
  3057. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3058. /**
  3059. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3060. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3061. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3062. * @param value defines the current value
  3063. * @param min defines the lower range value
  3064. * @param max defines the upper range value
  3065. * @param result defines the Vector3 where to store the result
  3066. */
  3067. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3068. /**
  3069. * Checks if a given vector is inside a specific range
  3070. * @param v defines the vector to test
  3071. * @param min defines the minimum range
  3072. * @param max defines the maximum range
  3073. */
  3074. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3075. /**
  3076. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3077. * @param value1 defines the first control point
  3078. * @param tangent1 defines the first tangent vector
  3079. * @param value2 defines the second control point
  3080. * @param tangent2 defines the second tangent vector
  3081. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3082. * @returns the new Vector3
  3083. */
  3084. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3085. /**
  3086. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3087. * @param start defines the start value
  3088. * @param end defines the end value
  3089. * @param amount max defines amount between both (between 0 and 1)
  3090. * @returns the new Vector3
  3091. */
  3092. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3093. /**
  3094. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3095. * @param start defines the start value
  3096. * @param end defines the end value
  3097. * @param amount max defines amount between both (between 0 and 1)
  3098. * @param result defines the Vector3 where to store the result
  3099. */
  3100. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3101. /**
  3102. * Returns the dot product (float) between the vectors "left" and "right"
  3103. * @param left defines the left operand
  3104. * @param right defines the right operand
  3105. * @returns the dot product
  3106. */
  3107. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3108. /**
  3109. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3110. * The cross product is then orthogonal to both "left" and "right"
  3111. * @param left defines the left operand
  3112. * @param right defines the right operand
  3113. * @returns the cross product
  3114. */
  3115. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3116. /**
  3117. * Sets the given vector "result" with the cross product of "left" and "right"
  3118. * The cross product is then orthogonal to both "left" and "right"
  3119. * @param left defines the left operand
  3120. * @param right defines the right operand
  3121. * @param result defines the Vector3 where to store the result
  3122. */
  3123. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3124. /**
  3125. * Returns a new Vector3 as the normalization of the given vector
  3126. * @param vector defines the Vector3 to normalize
  3127. * @returns the new Vector3
  3128. */
  3129. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3130. /**
  3131. * Sets the given vector "result" with the normalization of the given first vector
  3132. * @param vector defines the Vector3 to normalize
  3133. * @param result defines the Vector3 where to store the result
  3134. */
  3135. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3136. /**
  3137. * Project a Vector3 onto screen space
  3138. * @param vector defines the Vector3 to project
  3139. * @param world defines the world matrix to use
  3140. * @param transform defines the transform (view x projection) matrix to use
  3141. * @param viewport defines the screen viewport to use
  3142. * @returns the new Vector3
  3143. */
  3144. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3145. /** @hidden */
  3146. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3147. /**
  3148. * Unproject from screen space to object space
  3149. * @param source defines the screen space Vector3 to use
  3150. * @param viewportWidth defines the current width of the viewport
  3151. * @param viewportHeight defines the current height of the viewport
  3152. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3153. * @param transform defines the transform (view x projection) matrix to use
  3154. * @returns the new Vector3
  3155. */
  3156. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3157. /**
  3158. * Unproject from screen space to object space
  3159. * @param source defines the screen space Vector3 to use
  3160. * @param viewportWidth defines the current width of the viewport
  3161. * @param viewportHeight defines the current height of the viewport
  3162. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3163. * @param view defines the view matrix to use
  3164. * @param projection defines the projection matrix to use
  3165. * @returns the new Vector3
  3166. */
  3167. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3168. /**
  3169. * Unproject from screen space to object space
  3170. * @param source defines the screen space Vector3 to use
  3171. * @param viewportWidth defines the current width of the viewport
  3172. * @param viewportHeight defines the current height of the viewport
  3173. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3174. * @param view defines the view matrix to use
  3175. * @param projection defines the projection matrix to use
  3176. * @param result defines the Vector3 where to store the result
  3177. */
  3178. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3179. /**
  3180. * Unproject from screen space to object space
  3181. * @param sourceX defines the screen space x coordinate to use
  3182. * @param sourceY defines the screen space y coordinate to use
  3183. * @param sourceZ defines the screen space z coordinate to use
  3184. * @param viewportWidth defines the current width of the viewport
  3185. * @param viewportHeight defines the current height of the viewport
  3186. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3187. * @param view defines the view matrix to use
  3188. * @param projection defines the projection matrix to use
  3189. * @param result defines the Vector3 where to store the result
  3190. */
  3191. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3192. /**
  3193. * Gets the minimal coordinate values between two Vector3
  3194. * @param left defines the first operand
  3195. * @param right defines the second operand
  3196. * @returns the new Vector3
  3197. */
  3198. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3199. /**
  3200. * Gets the maximal coordinate values between two Vector3
  3201. * @param left defines the first operand
  3202. * @param right defines the second operand
  3203. * @returns the new Vector3
  3204. */
  3205. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3206. /**
  3207. * Returns the distance between the vectors "value1" and "value2"
  3208. * @param value1 defines the first operand
  3209. * @param value2 defines the second operand
  3210. * @returns the distance
  3211. */
  3212. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3213. /**
  3214. * Returns the squared distance between the vectors "value1" and "value2"
  3215. * @param value1 defines the first operand
  3216. * @param value2 defines the second operand
  3217. * @returns the squared distance
  3218. */
  3219. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3220. /**
  3221. * Returns a new Vector3 located at the center between "value1" and "value2"
  3222. * @param value1 defines the first operand
  3223. * @param value2 defines the second operand
  3224. * @returns the new Vector3
  3225. */
  3226. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3227. /**
  3228. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3229. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3230. * to something in order to rotate it from its local system to the given target system
  3231. * Note: axis1, axis2 and axis3 are normalized during this operation
  3232. * @param axis1 defines the first axis
  3233. * @param axis2 defines the second axis
  3234. * @param axis3 defines the third axis
  3235. * @returns a new Vector3
  3236. */
  3237. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3238. /**
  3239. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3240. * @param axis1 defines the first axis
  3241. * @param axis2 defines the second axis
  3242. * @param axis3 defines the third axis
  3243. * @param ref defines the Vector3 where to store the result
  3244. */
  3245. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3246. }
  3247. /**
  3248. * Vector4 class created for EulerAngle class conversion to Quaternion
  3249. */
  3250. export class Vector4 {
  3251. /** x value of the vector */
  3252. x: number;
  3253. /** y value of the vector */
  3254. y: number;
  3255. /** z value of the vector */
  3256. z: number;
  3257. /** w value of the vector */
  3258. w: number;
  3259. /**
  3260. * Creates a Vector4 object from the given floats.
  3261. * @param x x value of the vector
  3262. * @param y y value of the vector
  3263. * @param z z value of the vector
  3264. * @param w w value of the vector
  3265. */
  3266. constructor(
  3267. /** x value of the vector */
  3268. x: number,
  3269. /** y value of the vector */
  3270. y: number,
  3271. /** z value of the vector */
  3272. z: number,
  3273. /** w value of the vector */
  3274. w: number);
  3275. /**
  3276. * Returns the string with the Vector4 coordinates.
  3277. * @returns a string containing all the vector values
  3278. */
  3279. toString(): string;
  3280. /**
  3281. * Returns the string "Vector4".
  3282. * @returns "Vector4"
  3283. */
  3284. getClassName(): string;
  3285. /**
  3286. * Returns the Vector4 hash code.
  3287. * @returns a unique hash code
  3288. */
  3289. getHashCode(): number;
  3290. /**
  3291. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3292. * @returns the resulting array
  3293. */
  3294. asArray(): number[];
  3295. /**
  3296. * Populates the given array from the given index with the Vector4 coordinates.
  3297. * @param array array to populate
  3298. * @param index index of the array to start at (default: 0)
  3299. * @returns the Vector4.
  3300. */
  3301. toArray(array: FloatArray, index?: number): Vector4;
  3302. /**
  3303. * Update the current vector from an array
  3304. * @param array defines the destination array
  3305. * @param index defines the offset in the destination array
  3306. * @returns the current Vector3
  3307. */
  3308. fromArray(array: FloatArray, index?: number): Vector4;
  3309. /**
  3310. * Adds the given vector to the current Vector4.
  3311. * @param otherVector the vector to add
  3312. * @returns the updated Vector4.
  3313. */
  3314. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3315. /**
  3316. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3317. * @param otherVector the vector to add
  3318. * @returns the resulting vector
  3319. */
  3320. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3321. /**
  3322. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3323. * @param otherVector the vector to add
  3324. * @param result the vector to store the result
  3325. * @returns the current Vector4.
  3326. */
  3327. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3328. /**
  3329. * Subtract in place the given vector from the current Vector4.
  3330. * @param otherVector the vector to subtract
  3331. * @returns the updated Vector4.
  3332. */
  3333. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3334. /**
  3335. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3336. * @param otherVector the vector to add
  3337. * @returns the new vector with the result
  3338. */
  3339. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3340. /**
  3341. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3342. * @param otherVector the vector to subtract
  3343. * @param result the vector to store the result
  3344. * @returns the current Vector4.
  3345. */
  3346. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3347. /**
  3348. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3349. */
  3350. /**
  3351. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3352. * @param x value to subtract
  3353. * @param y value to subtract
  3354. * @param z value to subtract
  3355. * @param w value to subtract
  3356. * @returns new vector containing the result
  3357. */
  3358. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3359. /**
  3360. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3361. * @param x value to subtract
  3362. * @param y value to subtract
  3363. * @param z value to subtract
  3364. * @param w value to subtract
  3365. * @param result the vector to store the result in
  3366. * @returns the current Vector4.
  3367. */
  3368. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3369. /**
  3370. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3371. * @returns a new vector with the negated values
  3372. */
  3373. negate(): Vector4;
  3374. /**
  3375. * Negate this vector in place
  3376. * @returns this
  3377. */
  3378. negateInPlace(): Vector4;
  3379. /**
  3380. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3381. * @param result defines the Vector3 object where to store the result
  3382. * @returns the current Vector4
  3383. */
  3384. negateToRef(result: Vector4): Vector4;
  3385. /**
  3386. * Multiplies the current Vector4 coordinates by scale (float).
  3387. * @param scale the number to scale with
  3388. * @returns the updated Vector4.
  3389. */
  3390. scaleInPlace(scale: number): Vector4;
  3391. /**
  3392. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3393. * @param scale the number to scale with
  3394. * @returns a new vector with the result
  3395. */
  3396. scale(scale: number): Vector4;
  3397. /**
  3398. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3399. * @param scale the number to scale with
  3400. * @param result a vector to store the result in
  3401. * @returns the current Vector4.
  3402. */
  3403. scaleToRef(scale: number, result: Vector4): Vector4;
  3404. /**
  3405. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3406. * @param scale defines the scale factor
  3407. * @param result defines the Vector4 object where to store the result
  3408. * @returns the unmodified current Vector4
  3409. */
  3410. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3411. /**
  3412. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3413. * @param otherVector the vector to compare against
  3414. * @returns true if they are equal
  3415. */
  3416. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3417. /**
  3418. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3419. * @param otherVector vector to compare against
  3420. * @param epsilon (Default: very small number)
  3421. * @returns true if they are equal
  3422. */
  3423. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3424. /**
  3425. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3426. * @param x x value to compare against
  3427. * @param y y value to compare against
  3428. * @param z z value to compare against
  3429. * @param w w value to compare against
  3430. * @returns true if equal
  3431. */
  3432. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3433. /**
  3434. * Multiplies in place the current Vector4 by the given one.
  3435. * @param otherVector vector to multiple with
  3436. * @returns the updated Vector4.
  3437. */
  3438. multiplyInPlace(otherVector: Vector4): Vector4;
  3439. /**
  3440. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3441. * @param otherVector vector to multiple with
  3442. * @returns resulting new vector
  3443. */
  3444. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3445. /**
  3446. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3447. * @param otherVector vector to multiple with
  3448. * @param result vector to store the result
  3449. * @returns the current Vector4.
  3450. */
  3451. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3452. /**
  3453. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3454. * @param x x value multiply with
  3455. * @param y y value multiply with
  3456. * @param z z value multiply with
  3457. * @param w w value multiply with
  3458. * @returns resulting new vector
  3459. */
  3460. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3461. /**
  3462. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3463. * @param otherVector vector to devide with
  3464. * @returns resulting new vector
  3465. */
  3466. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3467. /**
  3468. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3469. * @param otherVector vector to devide with
  3470. * @param result vector to store the result
  3471. * @returns the current Vector4.
  3472. */
  3473. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3474. /**
  3475. * Divides the current Vector3 coordinates by the given ones.
  3476. * @param otherVector vector to devide with
  3477. * @returns the updated Vector3.
  3478. */
  3479. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3480. /**
  3481. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3482. * @param other defines the second operand
  3483. * @returns the current updated Vector4
  3484. */
  3485. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3486. /**
  3487. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3488. * @param other defines the second operand
  3489. * @returns the current updated Vector4
  3490. */
  3491. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3492. /**
  3493. * Gets a new Vector4 from current Vector4 floored values
  3494. * @returns a new Vector4
  3495. */
  3496. floor(): Vector4;
  3497. /**
  3498. * Gets a new Vector4 from current Vector3 floored values
  3499. * @returns a new Vector4
  3500. */
  3501. fract(): Vector4;
  3502. /**
  3503. * Returns the Vector4 length (float).
  3504. * @returns the length
  3505. */
  3506. length(): number;
  3507. /**
  3508. * Returns the Vector4 squared length (float).
  3509. * @returns the length squared
  3510. */
  3511. lengthSquared(): number;
  3512. /**
  3513. * Normalizes in place the Vector4.
  3514. * @returns the updated Vector4.
  3515. */
  3516. normalize(): Vector4;
  3517. /**
  3518. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3519. * @returns this converted to a new vector3
  3520. */
  3521. toVector3(): Vector3;
  3522. /**
  3523. * Returns a new Vector4 copied from the current one.
  3524. * @returns the new cloned vector
  3525. */
  3526. clone(): Vector4;
  3527. /**
  3528. * Updates the current Vector4 with the given one coordinates.
  3529. * @param source the source vector to copy from
  3530. * @returns the updated Vector4.
  3531. */
  3532. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3533. /**
  3534. * Updates the current Vector4 coordinates with the given floats.
  3535. * @param x float to copy from
  3536. * @param y float to copy from
  3537. * @param z float to copy from
  3538. * @param w float to copy from
  3539. * @returns the updated Vector4.
  3540. */
  3541. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3542. /**
  3543. * Updates the current Vector4 coordinates with the given floats.
  3544. * @param x float to set from
  3545. * @param y float to set from
  3546. * @param z float to set from
  3547. * @param w float to set from
  3548. * @returns the updated Vector4.
  3549. */
  3550. set(x: number, y: number, z: number, w: number): Vector4;
  3551. /**
  3552. * Copies the given float to the current Vector3 coordinates
  3553. * @param v defines the x, y, z and w coordinates of the operand
  3554. * @returns the current updated Vector3
  3555. */
  3556. setAll(v: number): Vector4;
  3557. /**
  3558. * Returns a new Vector4 set from the starting index of the given array.
  3559. * @param array the array to pull values from
  3560. * @param offset the offset into the array to start at
  3561. * @returns the new vector
  3562. */
  3563. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3564. /**
  3565. * Updates the given vector "result" from the starting index of the given array.
  3566. * @param array the array to pull values from
  3567. * @param offset the offset into the array to start at
  3568. * @param result the vector to store the result in
  3569. */
  3570. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3571. /**
  3572. * Updates the given vector "result" from the starting index of the given Float32Array.
  3573. * @param array the array to pull values from
  3574. * @param offset the offset into the array to start at
  3575. * @param result the vector to store the result in
  3576. */
  3577. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3578. /**
  3579. * Updates the given vector "result" coordinates from the given floats.
  3580. * @param x float to set from
  3581. * @param y float to set from
  3582. * @param z float to set from
  3583. * @param w float to set from
  3584. * @param result the vector to the floats in
  3585. */
  3586. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3587. /**
  3588. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3589. * @returns the new vector
  3590. */
  3591. static Zero(): Vector4;
  3592. /**
  3593. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3594. * @returns the new vector
  3595. */
  3596. static One(): Vector4;
  3597. /**
  3598. * Returns a new normalized Vector4 from the given one.
  3599. * @param vector the vector to normalize
  3600. * @returns the vector
  3601. */
  3602. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3603. /**
  3604. * Updates the given vector "result" from the normalization of the given one.
  3605. * @param vector the vector to normalize
  3606. * @param result the vector to store the result in
  3607. */
  3608. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3609. /**
  3610. * Returns a vector with the minimum values from the left and right vectors
  3611. * @param left left vector to minimize
  3612. * @param right right vector to minimize
  3613. * @returns a new vector with the minimum of the left and right vector values
  3614. */
  3615. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3616. /**
  3617. * Returns a vector with the maximum values from the left and right vectors
  3618. * @param left left vector to maximize
  3619. * @param right right vector to maximize
  3620. * @returns a new vector with the maximum of the left and right vector values
  3621. */
  3622. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3623. /**
  3624. * Returns the distance (float) between the vectors "value1" and "value2".
  3625. * @param value1 value to calulate the distance between
  3626. * @param value2 value to calulate the distance between
  3627. * @return the distance between the two vectors
  3628. */
  3629. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3630. /**
  3631. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3632. * @param value1 value to calulate the distance between
  3633. * @param value2 value to calulate the distance between
  3634. * @return the distance between the two vectors squared
  3635. */
  3636. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3637. /**
  3638. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3639. * @param value1 value to calulate the center between
  3640. * @param value2 value to calulate the center between
  3641. * @return the center between the two vectors
  3642. */
  3643. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3644. /**
  3645. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3646. * This methods computes transformed normalized direction vectors only.
  3647. * @param vector the vector to transform
  3648. * @param transformation the transformation matrix to apply
  3649. * @returns the new vector
  3650. */
  3651. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3652. /**
  3653. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3654. * This methods computes transformed normalized direction vectors only.
  3655. * @param vector the vector to transform
  3656. * @param transformation the transformation matrix to apply
  3657. * @param result the vector to store the result in
  3658. */
  3659. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3660. /**
  3661. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3662. * This methods computes transformed normalized direction vectors only.
  3663. * @param x value to transform
  3664. * @param y value to transform
  3665. * @param z value to transform
  3666. * @param w value to transform
  3667. * @param transformation the transformation matrix to apply
  3668. * @param result the vector to store the results in
  3669. */
  3670. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3671. /**
  3672. * Creates a new Vector4 from a Vector3
  3673. * @param source defines the source data
  3674. * @param w defines the 4th component (default is 0)
  3675. * @returns a new Vector4
  3676. */
  3677. static FromVector3(source: Vector3, w?: number): Vector4;
  3678. }
  3679. /**
  3680. * Class used to store quaternion data
  3681. * @see https://en.wikipedia.org/wiki/Quaternion
  3682. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3683. */
  3684. export class Quaternion {
  3685. /** @hidden */
  3686. _x: number;
  3687. /** @hidden */
  3688. _y: number;
  3689. /** @hidden */
  3690. _z: number;
  3691. /** @hidden */
  3692. _w: number;
  3693. /** @hidden */
  3694. _isDirty: boolean;
  3695. /** Gets or sets the x coordinate */
  3696. get x(): number;
  3697. set x(value: number);
  3698. /** Gets or sets the y coordinate */
  3699. get y(): number;
  3700. set y(value: number);
  3701. /** Gets or sets the z coordinate */
  3702. get z(): number;
  3703. set z(value: number);
  3704. /** Gets or sets the w coordinate */
  3705. get w(): number;
  3706. set w(value: number);
  3707. /**
  3708. * Creates a new Quaternion from the given floats
  3709. * @param x defines the first component (0 by default)
  3710. * @param y defines the second component (0 by default)
  3711. * @param z defines the third component (0 by default)
  3712. * @param w defines the fourth component (1.0 by default)
  3713. */
  3714. constructor(x?: number, y?: number, z?: number, w?: number);
  3715. /**
  3716. * Gets a string representation for the current quaternion
  3717. * @returns a string with the Quaternion coordinates
  3718. */
  3719. toString(): string;
  3720. /**
  3721. * Gets the class name of the quaternion
  3722. * @returns the string "Quaternion"
  3723. */
  3724. getClassName(): string;
  3725. /**
  3726. * Gets a hash code for this quaternion
  3727. * @returns the quaternion hash code
  3728. */
  3729. getHashCode(): number;
  3730. /**
  3731. * Copy the quaternion to an array
  3732. * @returns a new array populated with 4 elements from the quaternion coordinates
  3733. */
  3734. asArray(): number[];
  3735. /**
  3736. * Check if two quaternions are equals
  3737. * @param otherQuaternion defines the second operand
  3738. * @return true if the current quaternion and the given one coordinates are strictly equals
  3739. */
  3740. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3741. /**
  3742. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3743. * @param otherQuaternion defines the other quaternion
  3744. * @param epsilon defines the minimal distance to consider equality
  3745. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3746. */
  3747. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3748. /**
  3749. * Clone the current quaternion
  3750. * @returns a new quaternion copied from the current one
  3751. */
  3752. clone(): Quaternion;
  3753. /**
  3754. * Copy a quaternion to the current one
  3755. * @param other defines the other quaternion
  3756. * @returns the updated current quaternion
  3757. */
  3758. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3759. /**
  3760. * Updates the current quaternion with the given float coordinates
  3761. * @param x defines the x coordinate
  3762. * @param y defines the y coordinate
  3763. * @param z defines the z coordinate
  3764. * @param w defines the w coordinate
  3765. * @returns the updated current quaternion
  3766. */
  3767. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3768. /**
  3769. * Updates the current quaternion from the given float coordinates
  3770. * @param x defines the x coordinate
  3771. * @param y defines the y coordinate
  3772. * @param z defines the z coordinate
  3773. * @param w defines the w coordinate
  3774. * @returns the updated current quaternion
  3775. */
  3776. set(x: number, y: number, z: number, w: number): Quaternion;
  3777. /**
  3778. * Adds two quaternions
  3779. * @param other defines the second operand
  3780. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3781. */
  3782. add(other: DeepImmutable<Quaternion>): Quaternion;
  3783. /**
  3784. * Add a quaternion to the current one
  3785. * @param other defines the quaternion to add
  3786. * @returns the current quaternion
  3787. */
  3788. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3789. /**
  3790. * Subtract two quaternions
  3791. * @param other defines the second operand
  3792. * @returns a new quaternion as the subtraction result of the given one from the current one
  3793. */
  3794. subtract(other: Quaternion): Quaternion;
  3795. /**
  3796. * Multiplies the current quaternion by a scale factor
  3797. * @param value defines the scale factor
  3798. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3799. */
  3800. scale(value: number): Quaternion;
  3801. /**
  3802. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3803. * @param scale defines the scale factor
  3804. * @param result defines the Quaternion object where to store the result
  3805. * @returns the unmodified current quaternion
  3806. */
  3807. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3808. /**
  3809. * Multiplies in place the current quaternion by a scale factor
  3810. * @param value defines the scale factor
  3811. * @returns the current modified quaternion
  3812. */
  3813. scaleInPlace(value: number): Quaternion;
  3814. /**
  3815. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3816. * @param scale defines the scale factor
  3817. * @param result defines the Quaternion object where to store the result
  3818. * @returns the unmodified current quaternion
  3819. */
  3820. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3821. /**
  3822. * Multiplies two quaternions
  3823. * @param q1 defines the second operand
  3824. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3825. */
  3826. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3827. /**
  3828. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3829. * @param q1 defines the second operand
  3830. * @param result defines the target quaternion
  3831. * @returns the current quaternion
  3832. */
  3833. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3834. /**
  3835. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3836. * @param q1 defines the second operand
  3837. * @returns the currentupdated quaternion
  3838. */
  3839. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3840. /**
  3841. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3842. * @param ref defines the target quaternion
  3843. * @returns the current quaternion
  3844. */
  3845. conjugateToRef(ref: Quaternion): Quaternion;
  3846. /**
  3847. * Conjugates in place (1-q) the current quaternion
  3848. * @returns the current updated quaternion
  3849. */
  3850. conjugateInPlace(): Quaternion;
  3851. /**
  3852. * Conjugates in place (1-q) the current quaternion
  3853. * @returns a new quaternion
  3854. */
  3855. conjugate(): Quaternion;
  3856. /**
  3857. * Gets length of current quaternion
  3858. * @returns the quaternion length (float)
  3859. */
  3860. length(): number;
  3861. /**
  3862. * Normalize in place the current quaternion
  3863. * @returns the current updated quaternion
  3864. */
  3865. normalize(): Quaternion;
  3866. /**
  3867. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3868. * @param order is a reserved parameter and is ignore for now
  3869. * @returns a new Vector3 containing the Euler angles
  3870. */
  3871. toEulerAngles(order?: string): Vector3;
  3872. /**
  3873. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3874. * @param result defines the vector which will be filled with the Euler angles
  3875. * @param order is a reserved parameter and is ignore for now
  3876. * @returns the current unchanged quaternion
  3877. */
  3878. toEulerAnglesToRef(result: Vector3): Quaternion;
  3879. /**
  3880. * Updates the given rotation matrix with the current quaternion values
  3881. * @param result defines the target matrix
  3882. * @returns the current unchanged quaternion
  3883. */
  3884. toRotationMatrix(result: Matrix): Quaternion;
  3885. /**
  3886. * Updates the current quaternion from the given rotation matrix values
  3887. * @param matrix defines the source matrix
  3888. * @returns the current updated quaternion
  3889. */
  3890. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3891. /**
  3892. * Creates a new quaternion from a rotation matrix
  3893. * @param matrix defines the source matrix
  3894. * @returns a new quaternion created from the given rotation matrix values
  3895. */
  3896. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3897. /**
  3898. * Updates the given quaternion with the given rotation matrix values
  3899. * @param matrix defines the source matrix
  3900. * @param result defines the target quaternion
  3901. */
  3902. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3903. /**
  3904. * Returns the dot product (float) between the quaternions "left" and "right"
  3905. * @param left defines the left operand
  3906. * @param right defines the right operand
  3907. * @returns the dot product
  3908. */
  3909. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3910. /**
  3911. * Checks if the two quaternions are close to each other
  3912. * @param quat0 defines the first quaternion to check
  3913. * @param quat1 defines the second quaternion to check
  3914. * @returns true if the two quaternions are close to each other
  3915. */
  3916. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3917. /**
  3918. * Creates an empty quaternion
  3919. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3920. */
  3921. static Zero(): Quaternion;
  3922. /**
  3923. * Inverse a given quaternion
  3924. * @param q defines the source quaternion
  3925. * @returns a new quaternion as the inverted current quaternion
  3926. */
  3927. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3928. /**
  3929. * Inverse a given quaternion
  3930. * @param q defines the source quaternion
  3931. * @param result the quaternion the result will be stored in
  3932. * @returns the result quaternion
  3933. */
  3934. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3935. /**
  3936. * Creates an identity quaternion
  3937. * @returns the identity quaternion
  3938. */
  3939. static Identity(): Quaternion;
  3940. /**
  3941. * Gets a boolean indicating if the given quaternion is identity
  3942. * @param quaternion defines the quaternion to check
  3943. * @returns true if the quaternion is identity
  3944. */
  3945. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3946. /**
  3947. * Creates a quaternion from a rotation around an axis
  3948. * @param axis defines the axis to use
  3949. * @param angle defines the angle to use
  3950. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3951. */
  3952. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3953. /**
  3954. * Creates a rotation around an axis and stores it into the given quaternion
  3955. * @param axis defines the axis to use
  3956. * @param angle defines the angle to use
  3957. * @param result defines the target quaternion
  3958. * @returns the target quaternion
  3959. */
  3960. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3961. /**
  3962. * Creates a new quaternion from data stored into an array
  3963. * @param array defines the data source
  3964. * @param offset defines the offset in the source array where the data starts
  3965. * @returns a new quaternion
  3966. */
  3967. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3968. /**
  3969. * Updates the given quaternion "result" from the starting index of the given array.
  3970. * @param array the array to pull values from
  3971. * @param offset the offset into the array to start at
  3972. * @param result the quaternion to store the result in
  3973. */
  3974. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3975. /**
  3976. * Create a quaternion from Euler rotation angles
  3977. * @param x Pitch
  3978. * @param y Yaw
  3979. * @param z Roll
  3980. * @returns the new Quaternion
  3981. */
  3982. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3983. /**
  3984. * Updates a quaternion from Euler rotation angles
  3985. * @param x Pitch
  3986. * @param y Yaw
  3987. * @param z Roll
  3988. * @param result the quaternion to store the result
  3989. * @returns the updated quaternion
  3990. */
  3991. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3992. /**
  3993. * Create a quaternion from Euler rotation vector
  3994. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3995. * @returns the new Quaternion
  3996. */
  3997. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3998. /**
  3999. * Updates a quaternion from Euler rotation vector
  4000. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4001. * @param result the quaternion to store the result
  4002. * @returns the updated quaternion
  4003. */
  4004. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4005. /**
  4006. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4007. * @param yaw defines the rotation around Y axis
  4008. * @param pitch defines the rotation around X axis
  4009. * @param roll defines the rotation around Z axis
  4010. * @returns the new quaternion
  4011. */
  4012. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4013. /**
  4014. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4015. * @param yaw defines the rotation around Y axis
  4016. * @param pitch defines the rotation around X axis
  4017. * @param roll defines the rotation around Z axis
  4018. * @param result defines the target quaternion
  4019. */
  4020. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4021. /**
  4022. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4023. * @param alpha defines the rotation around first axis
  4024. * @param beta defines the rotation around second axis
  4025. * @param gamma defines the rotation around third axis
  4026. * @returns the new quaternion
  4027. */
  4028. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4029. /**
  4030. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4031. * @param alpha defines the rotation around first axis
  4032. * @param beta defines the rotation around second axis
  4033. * @param gamma defines the rotation around third axis
  4034. * @param result defines the target quaternion
  4035. */
  4036. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4037. /**
  4038. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  4039. * @param axis1 defines the first axis
  4040. * @param axis2 defines the second axis
  4041. * @param axis3 defines the third axis
  4042. * @returns the new quaternion
  4043. */
  4044. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4045. /**
  4046. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  4047. * @param axis1 defines the first axis
  4048. * @param axis2 defines the second axis
  4049. * @param axis3 defines the third axis
  4050. * @param ref defines the target quaternion
  4051. */
  4052. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4053. /**
  4054. * Interpolates between two quaternions
  4055. * @param left defines first quaternion
  4056. * @param right defines second quaternion
  4057. * @param amount defines the gradient to use
  4058. * @returns the new interpolated quaternion
  4059. */
  4060. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4061. /**
  4062. * Interpolates between two quaternions and stores it into a target quaternion
  4063. * @param left defines first quaternion
  4064. * @param right defines second quaternion
  4065. * @param amount defines the gradient to use
  4066. * @param result defines the target quaternion
  4067. */
  4068. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4069. /**
  4070. * Interpolate between two quaternions using Hermite interpolation
  4071. * @param value1 defines first quaternion
  4072. * @param tangent1 defines the incoming tangent
  4073. * @param value2 defines second quaternion
  4074. * @param tangent2 defines the outgoing tangent
  4075. * @param amount defines the target quaternion
  4076. * @returns the new interpolated quaternion
  4077. */
  4078. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4079. }
  4080. /**
  4081. * Class used to store matrix data (4x4)
  4082. */
  4083. export class Matrix {
  4084. /**
  4085. * Gets the precision of matrix computations
  4086. */
  4087. static get Use64Bits(): boolean;
  4088. private static _updateFlagSeed;
  4089. private static _identityReadOnly;
  4090. private _isIdentity;
  4091. private _isIdentityDirty;
  4092. private _isIdentity3x2;
  4093. private _isIdentity3x2Dirty;
  4094. /**
  4095. * Gets the update flag of the matrix which is an unique number for the matrix.
  4096. * It will be incremented every time the matrix data change.
  4097. * You can use it to speed the comparison between two versions of the same matrix.
  4098. */
  4099. updateFlag: number;
  4100. private readonly _m;
  4101. /**
  4102. * Gets the internal data of the matrix
  4103. */
  4104. get m(): DeepImmutable<Float32Array | Array<number>>;
  4105. /** @hidden */
  4106. _markAsUpdated(): void;
  4107. /** @hidden */
  4108. private _updateIdentityStatus;
  4109. /**
  4110. * Creates an empty matrix (filled with zeros)
  4111. */
  4112. constructor();
  4113. /**
  4114. * Check if the current matrix is identity
  4115. * @returns true is the matrix is the identity matrix
  4116. */
  4117. isIdentity(): boolean;
  4118. /**
  4119. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4120. * @returns true is the matrix is the identity matrix
  4121. */
  4122. isIdentityAs3x2(): boolean;
  4123. /**
  4124. * Gets the determinant of the matrix
  4125. * @returns the matrix determinant
  4126. */
  4127. determinant(): number;
  4128. /**
  4129. * Returns the matrix as a Float32Array or Array<number>
  4130. * @returns the matrix underlying array
  4131. */
  4132. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4133. /**
  4134. * Returns the matrix as a Float32Array or Array<number>
  4135. * @returns the matrix underlying array.
  4136. */
  4137. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4138. /**
  4139. * Inverts the current matrix in place
  4140. * @returns the current inverted matrix
  4141. */
  4142. invert(): Matrix;
  4143. /**
  4144. * Sets all the matrix elements to zero
  4145. * @returns the current matrix
  4146. */
  4147. reset(): Matrix;
  4148. /**
  4149. * Adds the current matrix with a second one
  4150. * @param other defines the matrix to add
  4151. * @returns a new matrix as the addition of the current matrix and the given one
  4152. */
  4153. add(other: DeepImmutable<Matrix>): Matrix;
  4154. /**
  4155. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4156. * @param other defines the matrix to add
  4157. * @param result defines the target matrix
  4158. * @returns the current matrix
  4159. */
  4160. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4161. /**
  4162. * Adds in place the given matrix to the current matrix
  4163. * @param other defines the second operand
  4164. * @returns the current updated matrix
  4165. */
  4166. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4167. /**
  4168. * Sets the given matrix to the current inverted Matrix
  4169. * @param other defines the target matrix
  4170. * @returns the unmodified current matrix
  4171. */
  4172. invertToRef(other: Matrix): Matrix;
  4173. /**
  4174. * add a value at the specified position in the current Matrix
  4175. * @param index the index of the value within the matrix. between 0 and 15.
  4176. * @param value the value to be added
  4177. * @returns the current updated matrix
  4178. */
  4179. addAtIndex(index: number, value: number): Matrix;
  4180. /**
  4181. * mutiply the specified position in the current Matrix by a value
  4182. * @param index the index of the value within the matrix. between 0 and 15.
  4183. * @param value the value to be added
  4184. * @returns the current updated matrix
  4185. */
  4186. multiplyAtIndex(index: number, value: number): Matrix;
  4187. /**
  4188. * Inserts the translation vector (using 3 floats) in the current matrix
  4189. * @param x defines the 1st component of the translation
  4190. * @param y defines the 2nd component of the translation
  4191. * @param z defines the 3rd component of the translation
  4192. * @returns the current updated matrix
  4193. */
  4194. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4195. /**
  4196. * Adds the translation vector (using 3 floats) in the current matrix
  4197. * @param x defines the 1st component of the translation
  4198. * @param y defines the 2nd component of the translation
  4199. * @param z defines the 3rd component of the translation
  4200. * @returns the current updated matrix
  4201. */
  4202. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4203. /**
  4204. * Inserts the translation vector in the current matrix
  4205. * @param vector3 defines the translation to insert
  4206. * @returns the current updated matrix
  4207. */
  4208. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4209. /**
  4210. * Gets the translation value of the current matrix
  4211. * @returns a new Vector3 as the extracted translation from the matrix
  4212. */
  4213. getTranslation(): Vector3;
  4214. /**
  4215. * Fill a Vector3 with the extracted translation from the matrix
  4216. * @param result defines the Vector3 where to store the translation
  4217. * @returns the current matrix
  4218. */
  4219. getTranslationToRef(result: Vector3): Matrix;
  4220. /**
  4221. * Remove rotation and scaling part from the matrix
  4222. * @returns the updated matrix
  4223. */
  4224. removeRotationAndScaling(): Matrix;
  4225. /**
  4226. * Multiply two matrices
  4227. * @param other defines the second operand
  4228. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4229. */
  4230. multiply(other: DeepImmutable<Matrix>): Matrix;
  4231. /**
  4232. * Copy the current matrix from the given one
  4233. * @param other defines the source matrix
  4234. * @returns the current updated matrix
  4235. */
  4236. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4237. /**
  4238. * Populates the given array from the starting index with the current matrix values
  4239. * @param array defines the target array
  4240. * @param offset defines the offset in the target array where to start storing values
  4241. * @returns the current matrix
  4242. */
  4243. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4244. /**
  4245. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4246. * @param other defines the second operand
  4247. * @param result defines the matrix where to store the multiplication
  4248. * @returns the current matrix
  4249. */
  4250. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4251. /**
  4252. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4253. * @param other defines the second operand
  4254. * @param result defines the array where to store the multiplication
  4255. * @param offset defines the offset in the target array where to start storing values
  4256. * @returns the current matrix
  4257. */
  4258. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4259. /**
  4260. * Check equality between this matrix and a second one
  4261. * @param value defines the second matrix to compare
  4262. * @returns true is the current matrix and the given one values are strictly equal
  4263. */
  4264. equals(value: DeepImmutable<Matrix>): boolean;
  4265. /**
  4266. * Clone the current matrix
  4267. * @returns a new matrix from the current matrix
  4268. */
  4269. clone(): Matrix;
  4270. /**
  4271. * Returns the name of the current matrix class
  4272. * @returns the string "Matrix"
  4273. */
  4274. getClassName(): string;
  4275. /**
  4276. * Gets the hash code of the current matrix
  4277. * @returns the hash code
  4278. */
  4279. getHashCode(): number;
  4280. /**
  4281. * Decomposes the current Matrix into a translation, rotation and scaling components
  4282. * @param scale defines the scale vector3 given as a reference to update
  4283. * @param rotation defines the rotation quaternion given as a reference to update
  4284. * @param translation defines the translation vector3 given as a reference to update
  4285. * @returns true if operation was successful
  4286. */
  4287. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4288. /**
  4289. * Gets specific row of the matrix
  4290. * @param index defines the number of the row to get
  4291. * @returns the index-th row of the current matrix as a new Vector4
  4292. */
  4293. getRow(index: number): Nullable<Vector4>;
  4294. /**
  4295. * Sets the index-th row of the current matrix to the vector4 values
  4296. * @param index defines the number of the row to set
  4297. * @param row defines the target vector4
  4298. * @returns the updated current matrix
  4299. */
  4300. setRow(index: number, row: Vector4): Matrix;
  4301. /**
  4302. * Compute the transpose of the matrix
  4303. * @returns the new transposed matrix
  4304. */
  4305. transpose(): Matrix;
  4306. /**
  4307. * Compute the transpose of the matrix and store it in a given matrix
  4308. * @param result defines the target matrix
  4309. * @returns the current matrix
  4310. */
  4311. transposeToRef(result: Matrix): Matrix;
  4312. /**
  4313. * Sets the index-th row of the current matrix with the given 4 x float values
  4314. * @param index defines the row index
  4315. * @param x defines the x component to set
  4316. * @param y defines the y component to set
  4317. * @param z defines the z component to set
  4318. * @param w defines the w component to set
  4319. * @returns the updated current matrix
  4320. */
  4321. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4322. /**
  4323. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4324. * @param scale defines the scale factor
  4325. * @returns a new matrix
  4326. */
  4327. scale(scale: number): Matrix;
  4328. /**
  4329. * Scale the current matrix values by a factor to a given result matrix
  4330. * @param scale defines the scale factor
  4331. * @param result defines the matrix to store the result
  4332. * @returns the current matrix
  4333. */
  4334. scaleToRef(scale: number, result: Matrix): Matrix;
  4335. /**
  4336. * Scale the current matrix values by a factor and add the result to a given matrix
  4337. * @param scale defines the scale factor
  4338. * @param result defines the Matrix to store the result
  4339. * @returns the current matrix
  4340. */
  4341. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4342. /**
  4343. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4344. * @param ref matrix to store the result
  4345. */
  4346. toNormalMatrix(ref: Matrix): void;
  4347. /**
  4348. * Gets only rotation part of the current matrix
  4349. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4350. */
  4351. getRotationMatrix(): Matrix;
  4352. /**
  4353. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4354. * @param result defines the target matrix to store data to
  4355. * @returns the current matrix
  4356. */
  4357. getRotationMatrixToRef(result: Matrix): Matrix;
  4358. /**
  4359. * Toggles model matrix from being right handed to left handed in place and vice versa
  4360. */
  4361. toggleModelMatrixHandInPlace(): void;
  4362. /**
  4363. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4364. */
  4365. toggleProjectionMatrixHandInPlace(): void;
  4366. /**
  4367. * Creates a matrix from an array
  4368. * @param array defines the source array
  4369. * @param offset defines an offset in the source array
  4370. * @returns a new Matrix set from the starting index of the given array
  4371. */
  4372. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4373. /**
  4374. * Copy the content of an array into a given matrix
  4375. * @param array defines the source array
  4376. * @param offset defines an offset in the source array
  4377. * @param result defines the target matrix
  4378. */
  4379. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4380. /**
  4381. * Stores an array into a matrix after having multiplied each component by a given factor
  4382. * @param array defines the source array
  4383. * @param offset defines the offset in the source array
  4384. * @param scale defines the scaling factor
  4385. * @param result defines the target matrix
  4386. */
  4387. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4388. /**
  4389. * Gets an identity matrix that must not be updated
  4390. */
  4391. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4392. /**
  4393. * Stores a list of values (16) inside a given matrix
  4394. * @param initialM11 defines 1st value of 1st row
  4395. * @param initialM12 defines 2nd value of 1st row
  4396. * @param initialM13 defines 3rd value of 1st row
  4397. * @param initialM14 defines 4th value of 1st row
  4398. * @param initialM21 defines 1st value of 2nd row
  4399. * @param initialM22 defines 2nd value of 2nd row
  4400. * @param initialM23 defines 3rd value of 2nd row
  4401. * @param initialM24 defines 4th value of 2nd row
  4402. * @param initialM31 defines 1st value of 3rd row
  4403. * @param initialM32 defines 2nd value of 3rd row
  4404. * @param initialM33 defines 3rd value of 3rd row
  4405. * @param initialM34 defines 4th value of 3rd row
  4406. * @param initialM41 defines 1st value of 4th row
  4407. * @param initialM42 defines 2nd value of 4th row
  4408. * @param initialM43 defines 3rd value of 4th row
  4409. * @param initialM44 defines 4th value of 4th row
  4410. * @param result defines the target matrix
  4411. */
  4412. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  4413. /**
  4414. * Creates new matrix from a list of values (16)
  4415. * @param initialM11 defines 1st value of 1st row
  4416. * @param initialM12 defines 2nd value of 1st row
  4417. * @param initialM13 defines 3rd value of 1st row
  4418. * @param initialM14 defines 4th value of 1st row
  4419. * @param initialM21 defines 1st value of 2nd row
  4420. * @param initialM22 defines 2nd value of 2nd row
  4421. * @param initialM23 defines 3rd value of 2nd row
  4422. * @param initialM24 defines 4th value of 2nd row
  4423. * @param initialM31 defines 1st value of 3rd row
  4424. * @param initialM32 defines 2nd value of 3rd row
  4425. * @param initialM33 defines 3rd value of 3rd row
  4426. * @param initialM34 defines 4th value of 3rd row
  4427. * @param initialM41 defines 1st value of 4th row
  4428. * @param initialM42 defines 2nd value of 4th row
  4429. * @param initialM43 defines 3rd value of 4th row
  4430. * @param initialM44 defines 4th value of 4th row
  4431. * @returns the new matrix
  4432. */
  4433. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  4434. /**
  4435. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4436. * @param scale defines the scale vector3
  4437. * @param rotation defines the rotation quaternion
  4438. * @param translation defines the translation vector3
  4439. * @returns a new matrix
  4440. */
  4441. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4442. /**
  4443. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4444. * @param scale defines the scale vector3
  4445. * @param rotation defines the rotation quaternion
  4446. * @param translation defines the translation vector3
  4447. * @param result defines the target matrix
  4448. */
  4449. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4450. /**
  4451. * Creates a new identity matrix
  4452. * @returns a new identity matrix
  4453. */
  4454. static Identity(): Matrix;
  4455. /**
  4456. * Creates a new identity matrix and stores the result in a given matrix
  4457. * @param result defines the target matrix
  4458. */
  4459. static IdentityToRef(result: Matrix): void;
  4460. /**
  4461. * Creates a new zero matrix
  4462. * @returns a new zero matrix
  4463. */
  4464. static Zero(): Matrix;
  4465. /**
  4466. * Creates a new rotation matrix for "angle" radians around the X axis
  4467. * @param angle defines the angle (in radians) to use
  4468. * @return the new matrix
  4469. */
  4470. static RotationX(angle: number): Matrix;
  4471. /**
  4472. * Creates a new matrix as the invert of a given matrix
  4473. * @param source defines the source matrix
  4474. * @returns the new matrix
  4475. */
  4476. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4477. /**
  4478. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4479. * @param angle defines the angle (in radians) to use
  4480. * @param result defines the target matrix
  4481. */
  4482. static RotationXToRef(angle: number, result: Matrix): void;
  4483. /**
  4484. * Creates a new rotation matrix for "angle" radians around the Y axis
  4485. * @param angle defines the angle (in radians) to use
  4486. * @return the new matrix
  4487. */
  4488. static RotationY(angle: number): Matrix;
  4489. /**
  4490. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4491. * @param angle defines the angle (in radians) to use
  4492. * @param result defines the target matrix
  4493. */
  4494. static RotationYToRef(angle: number, result: Matrix): void;
  4495. /**
  4496. * Creates a new rotation matrix for "angle" radians around the Z axis
  4497. * @param angle defines the angle (in radians) to use
  4498. * @return the new matrix
  4499. */
  4500. static RotationZ(angle: number): Matrix;
  4501. /**
  4502. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4503. * @param angle defines the angle (in radians) to use
  4504. * @param result defines the target matrix
  4505. */
  4506. static RotationZToRef(angle: number, result: Matrix): void;
  4507. /**
  4508. * Creates a new rotation matrix for "angle" radians around the given axis
  4509. * @param axis defines the axis to use
  4510. * @param angle defines the angle (in radians) to use
  4511. * @return the new matrix
  4512. */
  4513. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4514. /**
  4515. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4516. * @param axis defines the axis to use
  4517. * @param angle defines the angle (in radians) to use
  4518. * @param result defines the target matrix
  4519. */
  4520. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4521. /**
  4522. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4523. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4524. * @param from defines the vector to align
  4525. * @param to defines the vector to align to
  4526. * @param result defines the target matrix
  4527. */
  4528. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4529. /**
  4530. * Creates a rotation matrix
  4531. * @param yaw defines the yaw angle in radians (Y axis)
  4532. * @param pitch defines the pitch angle in radians (X axis)
  4533. * @param roll defines the roll angle in radians (Z axis)
  4534. * @returns the new rotation matrix
  4535. */
  4536. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4537. /**
  4538. * Creates a rotation matrix and stores it in a given matrix
  4539. * @param yaw defines the yaw angle in radians (Y axis)
  4540. * @param pitch defines the pitch angle in radians (X axis)
  4541. * @param roll defines the roll angle in radians (Z axis)
  4542. * @param result defines the target matrix
  4543. */
  4544. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4545. /**
  4546. * Creates a scaling matrix
  4547. * @param x defines the scale factor on X axis
  4548. * @param y defines the scale factor on Y axis
  4549. * @param z defines the scale factor on Z axis
  4550. * @returns the new matrix
  4551. */
  4552. static Scaling(x: number, y: number, z: number): Matrix;
  4553. /**
  4554. * Creates a scaling matrix and stores it in a given matrix
  4555. * @param x defines the scale factor on X axis
  4556. * @param y defines the scale factor on Y axis
  4557. * @param z defines the scale factor on Z axis
  4558. * @param result defines the target matrix
  4559. */
  4560. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4561. /**
  4562. * Creates a translation matrix
  4563. * @param x defines the translation on X axis
  4564. * @param y defines the translation on Y axis
  4565. * @param z defines the translationon Z axis
  4566. * @returns the new matrix
  4567. */
  4568. static Translation(x: number, y: number, z: number): Matrix;
  4569. /**
  4570. * Creates a translation matrix and stores it in a given matrix
  4571. * @param x defines the translation on X axis
  4572. * @param y defines the translation on Y axis
  4573. * @param z defines the translationon Z axis
  4574. * @param result defines the target matrix
  4575. */
  4576. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4577. /**
  4578. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4579. * @param startValue defines the start value
  4580. * @param endValue defines the end value
  4581. * @param gradient defines the gradient factor
  4582. * @returns the new matrix
  4583. */
  4584. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4585. /**
  4586. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4587. * @param startValue defines the start value
  4588. * @param endValue defines the end value
  4589. * @param gradient defines the gradient factor
  4590. * @param result defines the Matrix object where to store data
  4591. */
  4592. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4593. /**
  4594. * Builds a new matrix whose values are computed by:
  4595. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4596. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4597. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4598. * @param startValue defines the first matrix
  4599. * @param endValue defines the second matrix
  4600. * @param gradient defines the gradient between the two matrices
  4601. * @returns the new matrix
  4602. */
  4603. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4604. /**
  4605. * Update a matrix to values which are computed by:
  4606. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4607. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4608. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4609. * @param startValue defines the first matrix
  4610. * @param endValue defines the second matrix
  4611. * @param gradient defines the gradient between the two matrices
  4612. * @param result defines the target matrix
  4613. */
  4614. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4615. /**
  4616. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4617. * This function works in left handed mode
  4618. * @param eye defines the final position of the entity
  4619. * @param target defines where the entity should look at
  4620. * @param up defines the up vector for the entity
  4621. * @returns the new matrix
  4622. */
  4623. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4624. /**
  4625. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4626. * This function works in left handed mode
  4627. * @param eye defines the final position of the entity
  4628. * @param target defines where the entity should look at
  4629. * @param up defines the up vector for the entity
  4630. * @param result defines the target matrix
  4631. */
  4632. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4633. /**
  4634. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4635. * This function works in right handed mode
  4636. * @param eye defines the final position of the entity
  4637. * @param target defines where the entity should look at
  4638. * @param up defines the up vector for the entity
  4639. * @returns the new matrix
  4640. */
  4641. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4642. /**
  4643. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4644. * This function works in right handed mode
  4645. * @param eye defines the final position of the entity
  4646. * @param target defines where the entity should look at
  4647. * @param up defines the up vector for the entity
  4648. * @param result defines the target matrix
  4649. */
  4650. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4651. /**
  4652. * Create a left-handed orthographic projection matrix
  4653. * @param width defines the viewport width
  4654. * @param height defines the viewport height
  4655. * @param znear defines the near clip plane
  4656. * @param zfar defines the far clip plane
  4657. * @returns a new matrix as a left-handed orthographic projection matrix
  4658. */
  4659. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4660. /**
  4661. * Store a left-handed orthographic projection to a given matrix
  4662. * @param width defines the viewport width
  4663. * @param height defines the viewport height
  4664. * @param znear defines the near clip plane
  4665. * @param zfar defines the far clip plane
  4666. * @param result defines the target matrix
  4667. */
  4668. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4669. /**
  4670. * Create a left-handed orthographic projection matrix
  4671. * @param left defines the viewport left coordinate
  4672. * @param right defines the viewport right coordinate
  4673. * @param bottom defines the viewport bottom coordinate
  4674. * @param top defines the viewport top coordinate
  4675. * @param znear defines the near clip plane
  4676. * @param zfar defines the far clip plane
  4677. * @returns a new matrix as a left-handed orthographic projection matrix
  4678. */
  4679. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4680. /**
  4681. * Stores a left-handed orthographic projection into a given matrix
  4682. * @param left defines the viewport left coordinate
  4683. * @param right defines the viewport right coordinate
  4684. * @param bottom defines the viewport bottom coordinate
  4685. * @param top defines the viewport top coordinate
  4686. * @param znear defines the near clip plane
  4687. * @param zfar defines the far clip plane
  4688. * @param result defines the target matrix
  4689. */
  4690. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4691. /**
  4692. * Creates a right-handed orthographic projection matrix
  4693. * @param left defines the viewport left coordinate
  4694. * @param right defines the viewport right coordinate
  4695. * @param bottom defines the viewport bottom coordinate
  4696. * @param top defines the viewport top coordinate
  4697. * @param znear defines the near clip plane
  4698. * @param zfar defines the far clip plane
  4699. * @returns a new matrix as a right-handed orthographic projection matrix
  4700. */
  4701. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4702. /**
  4703. * Stores a right-handed orthographic projection into a given matrix
  4704. * @param left defines the viewport left coordinate
  4705. * @param right defines the viewport right coordinate
  4706. * @param bottom defines the viewport bottom coordinate
  4707. * @param top defines the viewport top coordinate
  4708. * @param znear defines the near clip plane
  4709. * @param zfar defines the far clip plane
  4710. * @param result defines the target matrix
  4711. */
  4712. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4713. /**
  4714. * Creates a left-handed perspective projection matrix
  4715. * @param width defines the viewport width
  4716. * @param height defines the viewport height
  4717. * @param znear defines the near clip plane
  4718. * @param zfar defines the far clip plane
  4719. * @returns a new matrix as a left-handed perspective projection matrix
  4720. */
  4721. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4722. /**
  4723. * Creates a left-handed perspective projection matrix
  4724. * @param fov defines the horizontal field of view
  4725. * @param aspect defines the aspect ratio
  4726. * @param znear defines the near clip plane
  4727. * @param zfar defines the far clip plane
  4728. * @returns a new matrix as a left-handed perspective projection matrix
  4729. */
  4730. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4731. /**
  4732. * Stores a left-handed perspective projection into a given matrix
  4733. * @param fov defines the horizontal field of view
  4734. * @param aspect defines the aspect ratio
  4735. * @param znear defines the near clip plane
  4736. * @param zfar defines the far clip plane
  4737. * @param result defines the target matrix
  4738. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4739. */
  4740. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4741. /**
  4742. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4743. * @param fov defines the horizontal field of view
  4744. * @param aspect defines the aspect ratio
  4745. * @param znear defines the near clip plane
  4746. * @param zfar not used as infinity is used as far clip
  4747. * @param result defines the target matrix
  4748. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4749. */
  4750. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4751. /**
  4752. * Creates a right-handed perspective projection matrix
  4753. * @param fov defines the horizontal field of view
  4754. * @param aspect defines the aspect ratio
  4755. * @param znear defines the near clip plane
  4756. * @param zfar defines the far clip plane
  4757. * @returns a new matrix as a right-handed perspective projection matrix
  4758. */
  4759. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4760. /**
  4761. * Stores a right-handed perspective projection into a given matrix
  4762. * @param fov defines the horizontal field of view
  4763. * @param aspect defines the aspect ratio
  4764. * @param znear defines the near clip plane
  4765. * @param zfar defines the far clip plane
  4766. * @param result defines the target matrix
  4767. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4768. */
  4769. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4770. /**
  4771. * Stores a right-handed perspective projection into a given matrix
  4772. * @param fov defines the horizontal field of view
  4773. * @param aspect defines the aspect ratio
  4774. * @param znear defines the near clip plane
  4775. * @param zfar not used as infinity is used as far clip
  4776. * @param result defines the target matrix
  4777. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4778. */
  4779. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4780. /**
  4781. * Stores a perspective projection for WebVR info a given matrix
  4782. * @param fov defines the field of view
  4783. * @param znear defines the near clip plane
  4784. * @param zfar defines the far clip plane
  4785. * @param result defines the target matrix
  4786. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4787. */
  4788. static PerspectiveFovWebVRToRef(fov: {
  4789. upDegrees: number;
  4790. downDegrees: number;
  4791. leftDegrees: number;
  4792. rightDegrees: number;
  4793. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4794. /**
  4795. * Computes a complete transformation matrix
  4796. * @param viewport defines the viewport to use
  4797. * @param world defines the world matrix
  4798. * @param view defines the view matrix
  4799. * @param projection defines the projection matrix
  4800. * @param zmin defines the near clip plane
  4801. * @param zmax defines the far clip plane
  4802. * @returns the transformation matrix
  4803. */
  4804. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4805. /**
  4806. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4807. * @param matrix defines the matrix to use
  4808. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4809. */
  4810. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4811. /**
  4812. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4813. * @param matrix defines the matrix to use
  4814. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4815. */
  4816. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4817. /**
  4818. * Compute the transpose of a given matrix
  4819. * @param matrix defines the matrix to transpose
  4820. * @returns the new matrix
  4821. */
  4822. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4823. /**
  4824. * Compute the transpose of a matrix and store it in a target matrix
  4825. * @param matrix defines the matrix to transpose
  4826. * @param result defines the target matrix
  4827. */
  4828. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4829. /**
  4830. * Computes a reflection matrix from a plane
  4831. * @param plane defines the reflection plane
  4832. * @returns a new matrix
  4833. */
  4834. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4835. /**
  4836. * Computes a reflection matrix from a plane
  4837. * @param plane defines the reflection plane
  4838. * @param result defines the target matrix
  4839. */
  4840. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4841. /**
  4842. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4843. * @param xaxis defines the value of the 1st axis
  4844. * @param yaxis defines the value of the 2nd axis
  4845. * @param zaxis defines the value of the 3rd axis
  4846. * @param result defines the target matrix
  4847. */
  4848. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4849. /**
  4850. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4851. * @param quat defines the quaternion to use
  4852. * @param result defines the target matrix
  4853. */
  4854. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4855. }
  4856. /**
  4857. * @hidden
  4858. */
  4859. export class TmpVectors {
  4860. static Vector2: Vector2[];
  4861. static Vector3: Vector3[];
  4862. static Vector4: Vector4[];
  4863. static Quaternion: Quaternion[];
  4864. static Matrix: Matrix[];
  4865. }
  4866. }
  4867. declare module "babylonjs/Maths/math.path" {
  4868. import { DeepImmutable, Nullable } from "babylonjs/types";
  4869. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4870. /**
  4871. * Defines potential orientation for back face culling
  4872. */
  4873. export enum Orientation {
  4874. /**
  4875. * Clockwise
  4876. */
  4877. CW = 0,
  4878. /** Counter clockwise */
  4879. CCW = 1
  4880. }
  4881. /** Class used to represent a Bezier curve */
  4882. export class BezierCurve {
  4883. /**
  4884. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4885. * @param t defines the time
  4886. * @param x1 defines the left coordinate on X axis
  4887. * @param y1 defines the left coordinate on Y axis
  4888. * @param x2 defines the right coordinate on X axis
  4889. * @param y2 defines the right coordinate on Y axis
  4890. * @returns the interpolated value
  4891. */
  4892. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4893. }
  4894. /**
  4895. * Defines angle representation
  4896. */
  4897. export class Angle {
  4898. private _radians;
  4899. /**
  4900. * Creates an Angle object of "radians" radians (float).
  4901. * @param radians the angle in radians
  4902. */
  4903. constructor(radians: number);
  4904. /**
  4905. * Get value in degrees
  4906. * @returns the Angle value in degrees (float)
  4907. */
  4908. degrees(): number;
  4909. /**
  4910. * Get value in radians
  4911. * @returns the Angle value in radians (float)
  4912. */
  4913. radians(): number;
  4914. /**
  4915. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4916. * @param a defines first point as the origin
  4917. * @param b defines point
  4918. * @returns a new Angle
  4919. */
  4920. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4921. /**
  4922. * Gets a new Angle object from the given float in radians
  4923. * @param radians defines the angle value in radians
  4924. * @returns a new Angle
  4925. */
  4926. static FromRadians(radians: number): Angle;
  4927. /**
  4928. * Gets a new Angle object from the given float in degrees
  4929. * @param degrees defines the angle value in degrees
  4930. * @returns a new Angle
  4931. */
  4932. static FromDegrees(degrees: number): Angle;
  4933. }
  4934. /**
  4935. * This represents an arc in a 2d space.
  4936. */
  4937. export class Arc2 {
  4938. /** Defines the start point of the arc */
  4939. startPoint: Vector2;
  4940. /** Defines the mid point of the arc */
  4941. midPoint: Vector2;
  4942. /** Defines the end point of the arc */
  4943. endPoint: Vector2;
  4944. /**
  4945. * Defines the center point of the arc.
  4946. */
  4947. centerPoint: Vector2;
  4948. /**
  4949. * Defines the radius of the arc.
  4950. */
  4951. radius: number;
  4952. /**
  4953. * Defines the angle of the arc (from mid point to end point).
  4954. */
  4955. angle: Angle;
  4956. /**
  4957. * Defines the start angle of the arc (from start point to middle point).
  4958. */
  4959. startAngle: Angle;
  4960. /**
  4961. * Defines the orientation of the arc (clock wise/counter clock wise).
  4962. */
  4963. orientation: Orientation;
  4964. /**
  4965. * Creates an Arc object from the three given points : start, middle and end.
  4966. * @param startPoint Defines the start point of the arc
  4967. * @param midPoint Defines the midlle point of the arc
  4968. * @param endPoint Defines the end point of the arc
  4969. */
  4970. constructor(
  4971. /** Defines the start point of the arc */
  4972. startPoint: Vector2,
  4973. /** Defines the mid point of the arc */
  4974. midPoint: Vector2,
  4975. /** Defines the end point of the arc */
  4976. endPoint: Vector2);
  4977. }
  4978. /**
  4979. * Represents a 2D path made up of multiple 2D points
  4980. */
  4981. export class Path2 {
  4982. private _points;
  4983. private _length;
  4984. /**
  4985. * If the path start and end point are the same
  4986. */
  4987. closed: boolean;
  4988. /**
  4989. * Creates a Path2 object from the starting 2D coordinates x and y.
  4990. * @param x the starting points x value
  4991. * @param y the starting points y value
  4992. */
  4993. constructor(x: number, y: number);
  4994. /**
  4995. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4996. * @param x the added points x value
  4997. * @param y the added points y value
  4998. * @returns the updated Path2.
  4999. */
  5000. addLineTo(x: number, y: number): Path2;
  5001. /**
  5002. * Adds _numberOfSegments_ segments according to the arc definition (middle point coordinates, end point coordinates, the arc start point being the current Path2 last point) to the current Path2.
  5003. * @param midX middle point x value
  5004. * @param midY middle point y value
  5005. * @param endX end point x value
  5006. * @param endY end point y value
  5007. * @param numberOfSegments (default: 36)
  5008. * @returns the updated Path2.
  5009. */
  5010. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5011. /**
  5012. * Closes the Path2.
  5013. * @returns the Path2.
  5014. */
  5015. close(): Path2;
  5016. /**
  5017. * Gets the sum of the distance between each sequential point in the path
  5018. * @returns the Path2 total length (float).
  5019. */
  5020. length(): number;
  5021. /**
  5022. * Gets the points which construct the path
  5023. * @returns the Path2 internal array of points.
  5024. */
  5025. getPoints(): Vector2[];
  5026. /**
  5027. * Retreives the point at the distance aways from the starting point
  5028. * @param normalizedLengthPosition the length along the path to retreive the point from
  5029. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5030. */
  5031. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5032. /**
  5033. * Creates a new path starting from an x and y position
  5034. * @param x starting x value
  5035. * @param y starting y value
  5036. * @returns a new Path2 starting at the coordinates (x, y).
  5037. */
  5038. static StartingAt(x: number, y: number): Path2;
  5039. }
  5040. /**
  5041. * Represents a 3D path made up of multiple 3D points
  5042. */
  5043. export class Path3D {
  5044. /**
  5045. * an array of Vector3, the curve axis of the Path3D
  5046. */
  5047. path: Vector3[];
  5048. private _curve;
  5049. private _distances;
  5050. private _tangents;
  5051. private _normals;
  5052. private _binormals;
  5053. private _raw;
  5054. private _alignTangentsWithPath;
  5055. private readonly _pointAtData;
  5056. /**
  5057. * new Path3D(path, normal, raw)
  5058. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5059. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5060. * @param path an array of Vector3, the curve axis of the Path3D
  5061. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5062. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5063. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5064. */
  5065. constructor(
  5066. /**
  5067. * an array of Vector3, the curve axis of the Path3D
  5068. */
  5069. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5070. /**
  5071. * Returns the Path3D array of successive Vector3 designing its curve.
  5072. * @returns the Path3D array of successive Vector3 designing its curve.
  5073. */
  5074. getCurve(): Vector3[];
  5075. /**
  5076. * Returns the Path3D array of successive Vector3 designing its curve.
  5077. * @returns the Path3D array of successive Vector3 designing its curve.
  5078. */
  5079. getPoints(): Vector3[];
  5080. /**
  5081. * @returns the computed length (float) of the path.
  5082. */
  5083. length(): number;
  5084. /**
  5085. * Returns an array populated with tangent vectors on each Path3D curve point.
  5086. * @returns an array populated with tangent vectors on each Path3D curve point.
  5087. */
  5088. getTangents(): Vector3[];
  5089. /**
  5090. * Returns an array populated with normal vectors on each Path3D curve point.
  5091. * @returns an array populated with normal vectors on each Path3D curve point.
  5092. */
  5093. getNormals(): Vector3[];
  5094. /**
  5095. * Returns an array populated with binormal vectors on each Path3D curve point.
  5096. * @returns an array populated with binormal vectors on each Path3D curve point.
  5097. */
  5098. getBinormals(): Vector3[];
  5099. /**
  5100. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5101. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5102. */
  5103. getDistances(): number[];
  5104. /**
  5105. * Returns an interpolated point along this path
  5106. * @param position the position of the point along this path, from 0.0 to 1.0
  5107. * @returns a new Vector3 as the point
  5108. */
  5109. getPointAt(position: number): Vector3;
  5110. /**
  5111. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5112. * @param position the position of the point along this path, from 0.0 to 1.0
  5113. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5114. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5115. */
  5116. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5117. /**
  5118. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5119. * @param position the position of the point along this path, from 0.0 to 1.0
  5120. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5121. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5122. */
  5123. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5124. /**
  5125. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5126. * @param position the position of the point along this path, from 0.0 to 1.0
  5127. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5128. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5129. */
  5130. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5131. /**
  5132. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5133. * @param position the position of the point along this path, from 0.0 to 1.0
  5134. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5135. */
  5136. getDistanceAt(position: number): number;
  5137. /**
  5138. * Returns the array index of the previous point of an interpolated point along this path
  5139. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5140. * @returns the array index
  5141. */
  5142. getPreviousPointIndexAt(position: number): number;
  5143. /**
  5144. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  5145. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5146. * @returns the sub position
  5147. */
  5148. getSubPositionAt(position: number): number;
  5149. /**
  5150. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5151. * @param target the vector of which to get the closest position to
  5152. * @returns the position of the closest virtual point on this path to the target vector
  5153. */
  5154. getClosestPositionTo(target: Vector3): number;
  5155. /**
  5156. * Returns a sub path (slice) of this path
  5157. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5158. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5159. * @returns a sub path (slice) of this path
  5160. */
  5161. slice(start?: number, end?: number): Path3D;
  5162. /**
  5163. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5164. * @param path path which all values are copied into the curves points
  5165. * @param firstNormal which should be projected onto the curve
  5166. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5167. * @returns the same object updated.
  5168. */
  5169. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5170. private _compute;
  5171. private _getFirstNonNullVector;
  5172. private _getLastNonNullVector;
  5173. private _normalVector;
  5174. /**
  5175. * Updates the point at data for an interpolated point along this curve
  5176. * @param position the position of the point along this curve, from 0.0 to 1.0
  5177. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5178. * @returns the (updated) point at data
  5179. */
  5180. private _updatePointAtData;
  5181. /**
  5182. * Updates the point at data from the specified parameters
  5183. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5184. * @param point the interpolated point
  5185. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5186. */
  5187. private _setPointAtData;
  5188. /**
  5189. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5190. */
  5191. private _updateInterpolationMatrix;
  5192. }
  5193. /**
  5194. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5195. * A Curve3 is designed from a series of successive Vector3.
  5196. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5197. */
  5198. export class Curve3 {
  5199. private _points;
  5200. private _length;
  5201. /**
  5202. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5203. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5204. * @param v1 (Vector3) the control point
  5205. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5206. * @param nbPoints (integer) the wanted number of points in the curve
  5207. * @returns the created Curve3
  5208. */
  5209. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5210. /**
  5211. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5212. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5213. * @param v1 (Vector3) the first control point
  5214. * @param v2 (Vector3) the second control point
  5215. * @param v3 (Vector3) the end point of the Cubic Bezier
  5216. * @param nbPoints (integer) the wanted number of points in the curve
  5217. * @returns the created Curve3
  5218. */
  5219. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5220. /**
  5221. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5222. * @param p1 (Vector3) the origin point of the Hermite Spline
  5223. * @param t1 (Vector3) the tangent vector at the origin point
  5224. * @param p2 (Vector3) the end point of the Hermite Spline
  5225. * @param t2 (Vector3) the tangent vector at the end point
  5226. * @param nbPoints (integer) the wanted number of points in the curve
  5227. * @returns the created Curve3
  5228. */
  5229. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5230. /**
  5231. * Returns a Curve3 object along a CatmullRom Spline curve :
  5232. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5233. * @param nbPoints (integer) the wanted number of points between each curve control points
  5234. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5235. * @returns the created Curve3
  5236. */
  5237. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5238. /**
  5239. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5240. * A Curve3 is designed from a series of successive Vector3.
  5241. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5242. * @param points points which make up the curve
  5243. */
  5244. constructor(points: Vector3[]);
  5245. /**
  5246. * @returns the Curve3 stored array of successive Vector3
  5247. */
  5248. getPoints(): Vector3[];
  5249. /**
  5250. * @returns the computed length (float) of the curve.
  5251. */
  5252. length(): number;
  5253. /**
  5254. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5255. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5256. * curveA and curveB keep unchanged.
  5257. * @param curve the curve to continue from this curve
  5258. * @returns the newly constructed curve
  5259. */
  5260. continue(curve: DeepImmutable<Curve3>): Curve3;
  5261. private _computeLength;
  5262. }
  5263. }
  5264. declare module "babylonjs/Animations/easing" {
  5265. /**
  5266. * This represents the main contract an easing function should follow.
  5267. * Easing functions are used throughout the animation system.
  5268. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5269. */
  5270. export interface IEasingFunction {
  5271. /**
  5272. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5273. * of the easing function.
  5274. * The link below provides some of the most common examples of easing functions.
  5275. * @see https://easings.net/
  5276. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5277. * @returns the corresponding value on the curve defined by the easing function
  5278. */
  5279. ease(gradient: number): number;
  5280. }
  5281. /**
  5282. * Base class used for every default easing function.
  5283. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5284. */
  5285. export class EasingFunction implements IEasingFunction {
  5286. /**
  5287. * Interpolation follows the mathematical formula associated with the easing function.
  5288. */
  5289. static readonly EASINGMODE_EASEIN: number;
  5290. /**
  5291. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5292. */
  5293. static readonly EASINGMODE_EASEOUT: number;
  5294. /**
  5295. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5296. */
  5297. static readonly EASINGMODE_EASEINOUT: number;
  5298. private _easingMode;
  5299. /**
  5300. * Sets the easing mode of the current function.
  5301. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5302. */
  5303. setEasingMode(easingMode: number): void;
  5304. /**
  5305. * Gets the current easing mode.
  5306. * @returns the easing mode
  5307. */
  5308. getEasingMode(): number;
  5309. /**
  5310. * @hidden
  5311. */
  5312. easeInCore(gradient: number): number;
  5313. /**
  5314. * Given an input gradient between 0 and 1, this returns the corresponding value
  5315. * of the easing function.
  5316. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5317. * @returns the corresponding value on the curve defined by the easing function
  5318. */
  5319. ease(gradient: number): number;
  5320. }
  5321. /**
  5322. * Easing function with a circle shape (see link below).
  5323. * @see https://easings.net/#easeInCirc
  5324. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5325. */
  5326. export class CircleEase extends EasingFunction implements IEasingFunction {
  5327. /** @hidden */
  5328. easeInCore(gradient: number): number;
  5329. }
  5330. /**
  5331. * Easing function with a ease back shape (see link below).
  5332. * @see https://easings.net/#easeInBack
  5333. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5334. */
  5335. export class BackEase extends EasingFunction implements IEasingFunction {
  5336. /** Defines the amplitude of the function */
  5337. amplitude: number;
  5338. /**
  5339. * Instantiates a back ease easing
  5340. * @see https://easings.net/#easeInBack
  5341. * @param amplitude Defines the amplitude of the function
  5342. */
  5343. constructor(
  5344. /** Defines the amplitude of the function */
  5345. amplitude?: number);
  5346. /** @hidden */
  5347. easeInCore(gradient: number): number;
  5348. }
  5349. /**
  5350. * Easing function with a bouncing shape (see link below).
  5351. * @see https://easings.net/#easeInBounce
  5352. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5353. */
  5354. export class BounceEase extends EasingFunction implements IEasingFunction {
  5355. /** Defines the number of bounces */
  5356. bounces: number;
  5357. /** Defines the amplitude of the bounce */
  5358. bounciness: number;
  5359. /**
  5360. * Instantiates a bounce easing
  5361. * @see https://easings.net/#easeInBounce
  5362. * @param bounces Defines the number of bounces
  5363. * @param bounciness Defines the amplitude of the bounce
  5364. */
  5365. constructor(
  5366. /** Defines the number of bounces */
  5367. bounces?: number,
  5368. /** Defines the amplitude of the bounce */
  5369. bounciness?: number);
  5370. /** @hidden */
  5371. easeInCore(gradient: number): number;
  5372. }
  5373. /**
  5374. * Easing function with a power of 3 shape (see link below).
  5375. * @see https://easings.net/#easeInCubic
  5376. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5377. */
  5378. export class CubicEase extends EasingFunction implements IEasingFunction {
  5379. /** @hidden */
  5380. easeInCore(gradient: number): number;
  5381. }
  5382. /**
  5383. * Easing function with an elastic shape (see link below).
  5384. * @see https://easings.net/#easeInElastic
  5385. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5386. */
  5387. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5388. /** Defines the number of oscillations*/
  5389. oscillations: number;
  5390. /** Defines the amplitude of the oscillations*/
  5391. springiness: number;
  5392. /**
  5393. * Instantiates an elastic easing function
  5394. * @see https://easings.net/#easeInElastic
  5395. * @param oscillations Defines the number of oscillations
  5396. * @param springiness Defines the amplitude of the oscillations
  5397. */
  5398. constructor(
  5399. /** Defines the number of oscillations*/
  5400. oscillations?: number,
  5401. /** Defines the amplitude of the oscillations*/
  5402. springiness?: number);
  5403. /** @hidden */
  5404. easeInCore(gradient: number): number;
  5405. }
  5406. /**
  5407. * Easing function with an exponential shape (see link below).
  5408. * @see https://easings.net/#easeInExpo
  5409. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5410. */
  5411. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5412. /** Defines the exponent of the function */
  5413. exponent: number;
  5414. /**
  5415. * Instantiates an exponential easing function
  5416. * @see https://easings.net/#easeInExpo
  5417. * @param exponent Defines the exponent of the function
  5418. */
  5419. constructor(
  5420. /** Defines the exponent of the function */
  5421. exponent?: number);
  5422. /** @hidden */
  5423. easeInCore(gradient: number): number;
  5424. }
  5425. /**
  5426. * Easing function with a power shape (see link below).
  5427. * @see https://easings.net/#easeInQuad
  5428. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5429. */
  5430. export class PowerEase extends EasingFunction implements IEasingFunction {
  5431. /** Defines the power of the function */
  5432. power: number;
  5433. /**
  5434. * Instantiates an power base easing function
  5435. * @see https://easings.net/#easeInQuad
  5436. * @param power Defines the power of the function
  5437. */
  5438. constructor(
  5439. /** Defines the power of the function */
  5440. power?: number);
  5441. /** @hidden */
  5442. easeInCore(gradient: number): number;
  5443. }
  5444. /**
  5445. * Easing function with a power of 2 shape (see link below).
  5446. * @see https://easings.net/#easeInQuad
  5447. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5448. */
  5449. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5450. /** @hidden */
  5451. easeInCore(gradient: number): number;
  5452. }
  5453. /**
  5454. * Easing function with a power of 4 shape (see link below).
  5455. * @see https://easings.net/#easeInQuart
  5456. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5457. */
  5458. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5459. /** @hidden */
  5460. easeInCore(gradient: number): number;
  5461. }
  5462. /**
  5463. * Easing function with a power of 5 shape (see link below).
  5464. * @see https://easings.net/#easeInQuint
  5465. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5466. */
  5467. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5468. /** @hidden */
  5469. easeInCore(gradient: number): number;
  5470. }
  5471. /**
  5472. * Easing function with a sin shape (see link below).
  5473. * @see https://easings.net/#easeInSine
  5474. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5475. */
  5476. export class SineEase extends EasingFunction implements IEasingFunction {
  5477. /** @hidden */
  5478. easeInCore(gradient: number): number;
  5479. }
  5480. /**
  5481. * Easing function with a bezier shape (see link below).
  5482. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5483. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5484. */
  5485. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5486. /** Defines the x component of the start tangent in the bezier curve */
  5487. x1: number;
  5488. /** Defines the y component of the start tangent in the bezier curve */
  5489. y1: number;
  5490. /** Defines the x component of the end tangent in the bezier curve */
  5491. x2: number;
  5492. /** Defines the y component of the end tangent in the bezier curve */
  5493. y2: number;
  5494. /**
  5495. * Instantiates a bezier function
  5496. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5497. * @param x1 Defines the x component of the start tangent in the bezier curve
  5498. * @param y1 Defines the y component of the start tangent in the bezier curve
  5499. * @param x2 Defines the x component of the end tangent in the bezier curve
  5500. * @param y2 Defines the y component of the end tangent in the bezier curve
  5501. */
  5502. constructor(
  5503. /** Defines the x component of the start tangent in the bezier curve */
  5504. x1?: number,
  5505. /** Defines the y component of the start tangent in the bezier curve */
  5506. y1?: number,
  5507. /** Defines the x component of the end tangent in the bezier curve */
  5508. x2?: number,
  5509. /** Defines the y component of the end tangent in the bezier curve */
  5510. y2?: number);
  5511. /** @hidden */
  5512. easeInCore(gradient: number): number;
  5513. }
  5514. }
  5515. declare module "babylonjs/Maths/math.color" {
  5516. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5517. /**
  5518. * Class used to hold a RBG color
  5519. */
  5520. export class Color3 {
  5521. /**
  5522. * Defines the red component (between 0 and 1, default is 0)
  5523. */
  5524. r: number;
  5525. /**
  5526. * Defines the green component (between 0 and 1, default is 0)
  5527. */
  5528. g: number;
  5529. /**
  5530. * Defines the blue component (between 0 and 1, default is 0)
  5531. */
  5532. b: number;
  5533. /**
  5534. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5535. * @param r defines the red component (between 0 and 1, default is 0)
  5536. * @param g defines the green component (between 0 and 1, default is 0)
  5537. * @param b defines the blue component (between 0 and 1, default is 0)
  5538. */
  5539. constructor(
  5540. /**
  5541. * Defines the red component (between 0 and 1, default is 0)
  5542. */
  5543. r?: number,
  5544. /**
  5545. * Defines the green component (between 0 and 1, default is 0)
  5546. */
  5547. g?: number,
  5548. /**
  5549. * Defines the blue component (between 0 and 1, default is 0)
  5550. */
  5551. b?: number);
  5552. /**
  5553. * Creates a string with the Color3 current values
  5554. * @returns the string representation of the Color3 object
  5555. */
  5556. toString(): string;
  5557. /**
  5558. * Returns the string "Color3"
  5559. * @returns "Color3"
  5560. */
  5561. getClassName(): string;
  5562. /**
  5563. * Compute the Color3 hash code
  5564. * @returns an unique number that can be used to hash Color3 objects
  5565. */
  5566. getHashCode(): number;
  5567. /**
  5568. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5569. * @param array defines the array where to store the r,g,b components
  5570. * @param index defines an optional index in the target array to define where to start storing values
  5571. * @returns the current Color3 object
  5572. */
  5573. toArray(array: FloatArray, index?: number): Color3;
  5574. /**
  5575. * Update the current color with values stored in an array from the starting index of the given array
  5576. * @param array defines the source array
  5577. * @param offset defines an offset in the source array
  5578. * @returns the current Color3 object
  5579. */
  5580. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5581. /**
  5582. * Returns a new Color4 object from the current Color3 and the given alpha
  5583. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5584. * @returns a new Color4 object
  5585. */
  5586. toColor4(alpha?: number): Color4;
  5587. /**
  5588. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5589. * @returns the new array
  5590. */
  5591. asArray(): number[];
  5592. /**
  5593. * Returns the luminance value
  5594. * @returns a float value
  5595. */
  5596. toLuminance(): number;
  5597. /**
  5598. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5599. * @param otherColor defines the second operand
  5600. * @returns the new Color3 object
  5601. */
  5602. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5603. /**
  5604. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5605. * @param otherColor defines the second operand
  5606. * @param result defines the Color3 object where to store the result
  5607. * @returns the current Color3
  5608. */
  5609. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5610. /**
  5611. * Determines equality between Color3 objects
  5612. * @param otherColor defines the second operand
  5613. * @returns true if the rgb values are equal to the given ones
  5614. */
  5615. equals(otherColor: DeepImmutable<Color3>): boolean;
  5616. /**
  5617. * Determines equality between the current Color3 object and a set of r,b,g values
  5618. * @param r defines the red component to check
  5619. * @param g defines the green component to check
  5620. * @param b defines the blue component to check
  5621. * @returns true if the rgb values are equal to the given ones
  5622. */
  5623. equalsFloats(r: number, g: number, b: number): boolean;
  5624. /**
  5625. * Multiplies in place each rgb value by scale
  5626. * @param scale defines the scaling factor
  5627. * @returns the updated Color3
  5628. */
  5629. scale(scale: number): Color3;
  5630. /**
  5631. * Multiplies the rgb values by scale and stores the result into "result"
  5632. * @param scale defines the scaling factor
  5633. * @param result defines the Color3 object where to store the result
  5634. * @returns the unmodified current Color3
  5635. */
  5636. scaleToRef(scale: number, result: Color3): Color3;
  5637. /**
  5638. * Scale the current Color3 values by a factor and add the result to a given Color3
  5639. * @param scale defines the scale factor
  5640. * @param result defines color to store the result into
  5641. * @returns the unmodified current Color3
  5642. */
  5643. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5644. /**
  5645. * Clamps the rgb values by the min and max values and stores the result into "result"
  5646. * @param min defines minimum clamping value (default is 0)
  5647. * @param max defines maximum clamping value (default is 1)
  5648. * @param result defines color to store the result into
  5649. * @returns the original Color3
  5650. */
  5651. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5652. /**
  5653. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5654. * @param otherColor defines the second operand
  5655. * @returns the new Color3
  5656. */
  5657. add(otherColor: DeepImmutable<Color3>): Color3;
  5658. /**
  5659. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5660. * @param otherColor defines the second operand
  5661. * @param result defines Color3 object to store the result into
  5662. * @returns the unmodified current Color3
  5663. */
  5664. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5665. /**
  5666. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5667. * @param otherColor defines the second operand
  5668. * @returns the new Color3
  5669. */
  5670. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5671. /**
  5672. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5673. * @param otherColor defines the second operand
  5674. * @param result defines Color3 object to store the result into
  5675. * @returns the unmodified current Color3
  5676. */
  5677. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5678. /**
  5679. * Copy the current object
  5680. * @returns a new Color3 copied the current one
  5681. */
  5682. clone(): Color3;
  5683. /**
  5684. * Copies the rgb values from the source in the current Color3
  5685. * @param source defines the source Color3 object
  5686. * @returns the updated Color3 object
  5687. */
  5688. copyFrom(source: DeepImmutable<Color3>): Color3;
  5689. /**
  5690. * Updates the Color3 rgb values from the given floats
  5691. * @param r defines the red component to read from
  5692. * @param g defines the green component to read from
  5693. * @param b defines the blue component to read from
  5694. * @returns the current Color3 object
  5695. */
  5696. copyFromFloats(r: number, g: number, b: number): Color3;
  5697. /**
  5698. * Updates the Color3 rgb values from the given floats
  5699. * @param r defines the red component to read from
  5700. * @param g defines the green component to read from
  5701. * @param b defines the blue component to read from
  5702. * @returns the current Color3 object
  5703. */
  5704. set(r: number, g: number, b: number): Color3;
  5705. /**
  5706. * Compute the Color3 hexadecimal code as a string
  5707. * @returns a string containing the hexadecimal representation of the Color3 object
  5708. */
  5709. toHexString(): string;
  5710. /**
  5711. * Computes a new Color3 converted from the current one to linear space
  5712. * @returns a new Color3 object
  5713. */
  5714. toLinearSpace(): Color3;
  5715. /**
  5716. * Converts current color in rgb space to HSV values
  5717. * @returns a new color3 representing the HSV values
  5718. */
  5719. toHSV(): Color3;
  5720. /**
  5721. * Converts current color in rgb space to HSV values
  5722. * @param result defines the Color3 where to store the HSV values
  5723. */
  5724. toHSVToRef(result: Color3): void;
  5725. /**
  5726. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5727. * @param convertedColor defines the Color3 object where to store the linear space version
  5728. * @returns the unmodified Color3
  5729. */
  5730. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5731. /**
  5732. * Computes a new Color3 converted from the current one to gamma space
  5733. * @returns a new Color3 object
  5734. */
  5735. toGammaSpace(): Color3;
  5736. /**
  5737. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5738. * @param convertedColor defines the Color3 object where to store the gamma space version
  5739. * @returns the unmodified Color3
  5740. */
  5741. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5742. private static _BlackReadOnly;
  5743. /**
  5744. * Convert Hue, saturation and value to a Color3 (RGB)
  5745. * @param hue defines the hue
  5746. * @param saturation defines the saturation
  5747. * @param value defines the value
  5748. * @param result defines the Color3 where to store the RGB values
  5749. */
  5750. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5751. /**
  5752. * Creates a new Color3 from the string containing valid hexadecimal values
  5753. * @param hex defines a string containing valid hexadecimal values
  5754. * @returns a new Color3 object
  5755. */
  5756. static FromHexString(hex: string): Color3;
  5757. /**
  5758. * Creates a new Color3 from the starting index of the given array
  5759. * @param array defines the source array
  5760. * @param offset defines an offset in the source array
  5761. * @returns a new Color3 object
  5762. */
  5763. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5764. /**
  5765. * Creates a new Color3 from the starting index element of the given array
  5766. * @param array defines the source array to read from
  5767. * @param offset defines the offset in the source array
  5768. * @param result defines the target Color3 object
  5769. */
  5770. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  5771. /**
  5772. * Creates a new Color3 from integer values (< 256)
  5773. * @param r defines the red component to read from (value between 0 and 255)
  5774. * @param g defines the green component to read from (value between 0 and 255)
  5775. * @param b defines the blue component to read from (value between 0 and 255)
  5776. * @returns a new Color3 object
  5777. */
  5778. static FromInts(r: number, g: number, b: number): Color3;
  5779. /**
  5780. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5781. * @param start defines the start Color3 value
  5782. * @param end defines the end Color3 value
  5783. * @param amount defines the gradient value between start and end
  5784. * @returns a new Color3 object
  5785. */
  5786. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5787. /**
  5788. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5789. * @param left defines the start value
  5790. * @param right defines the end value
  5791. * @param amount defines the gradient factor
  5792. * @param result defines the Color3 object where to store the result
  5793. */
  5794. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5795. /**
  5796. * Returns a Color3 value containing a red color
  5797. * @returns a new Color3 object
  5798. */
  5799. static Red(): Color3;
  5800. /**
  5801. * Returns a Color3 value containing a green color
  5802. * @returns a new Color3 object
  5803. */
  5804. static Green(): Color3;
  5805. /**
  5806. * Returns a Color3 value containing a blue color
  5807. * @returns a new Color3 object
  5808. */
  5809. static Blue(): Color3;
  5810. /**
  5811. * Returns a Color3 value containing a black color
  5812. * @returns a new Color3 object
  5813. */
  5814. static Black(): Color3;
  5815. /**
  5816. * Gets a Color3 value containing a black color that must not be updated
  5817. */
  5818. static get BlackReadOnly(): DeepImmutable<Color3>;
  5819. /**
  5820. * Returns a Color3 value containing a white color
  5821. * @returns a new Color3 object
  5822. */
  5823. static White(): Color3;
  5824. /**
  5825. * Returns a Color3 value containing a purple color
  5826. * @returns a new Color3 object
  5827. */
  5828. static Purple(): Color3;
  5829. /**
  5830. * Returns a Color3 value containing a magenta color
  5831. * @returns a new Color3 object
  5832. */
  5833. static Magenta(): Color3;
  5834. /**
  5835. * Returns a Color3 value containing a yellow color
  5836. * @returns a new Color3 object
  5837. */
  5838. static Yellow(): Color3;
  5839. /**
  5840. * Returns a Color3 value containing a gray color
  5841. * @returns a new Color3 object
  5842. */
  5843. static Gray(): Color3;
  5844. /**
  5845. * Returns a Color3 value containing a teal color
  5846. * @returns a new Color3 object
  5847. */
  5848. static Teal(): Color3;
  5849. /**
  5850. * Returns a Color3 value containing a random color
  5851. * @returns a new Color3 object
  5852. */
  5853. static Random(): Color3;
  5854. }
  5855. /**
  5856. * Class used to hold a RBGA color
  5857. */
  5858. export class Color4 {
  5859. /**
  5860. * Defines the red component (between 0 and 1, default is 0)
  5861. */
  5862. r: number;
  5863. /**
  5864. * Defines the green component (between 0 and 1, default is 0)
  5865. */
  5866. g: number;
  5867. /**
  5868. * Defines the blue component (between 0 and 1, default is 0)
  5869. */
  5870. b: number;
  5871. /**
  5872. * Defines the alpha component (between 0 and 1, default is 1)
  5873. */
  5874. a: number;
  5875. /**
  5876. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5877. * @param r defines the red component (between 0 and 1, default is 0)
  5878. * @param g defines the green component (between 0 and 1, default is 0)
  5879. * @param b defines the blue component (between 0 and 1, default is 0)
  5880. * @param a defines the alpha component (between 0 and 1, default is 1)
  5881. */
  5882. constructor(
  5883. /**
  5884. * Defines the red component (between 0 and 1, default is 0)
  5885. */
  5886. r?: number,
  5887. /**
  5888. * Defines the green component (between 0 and 1, default is 0)
  5889. */
  5890. g?: number,
  5891. /**
  5892. * Defines the blue component (between 0 and 1, default is 0)
  5893. */
  5894. b?: number,
  5895. /**
  5896. * Defines the alpha component (between 0 and 1, default is 1)
  5897. */
  5898. a?: number);
  5899. /**
  5900. * Adds in place the given Color4 values to the current Color4 object
  5901. * @param right defines the second operand
  5902. * @returns the current updated Color4 object
  5903. */
  5904. addInPlace(right: DeepImmutable<Color4>): Color4;
  5905. /**
  5906. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5907. * @returns the new array
  5908. */
  5909. asArray(): number[];
  5910. /**
  5911. * Stores from the starting index in the given array the Color4 successive values
  5912. * @param array defines the array where to store the r,g,b components
  5913. * @param index defines an optional index in the target array to define where to start storing values
  5914. * @returns the current Color4 object
  5915. */
  5916. toArray(array: number[], index?: number): Color4;
  5917. /**
  5918. * Update the current color with values stored in an array from the starting index of the given array
  5919. * @param array defines the source array
  5920. * @param offset defines an offset in the source array
  5921. * @returns the current Color4 object
  5922. */
  5923. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5924. /**
  5925. * Determines equality between Color4 objects
  5926. * @param otherColor defines the second operand
  5927. * @returns true if the rgba values are equal to the given ones
  5928. */
  5929. equals(otherColor: DeepImmutable<Color4>): boolean;
  5930. /**
  5931. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5932. * @param right defines the second operand
  5933. * @returns a new Color4 object
  5934. */
  5935. add(right: DeepImmutable<Color4>): Color4;
  5936. /**
  5937. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5938. * @param right defines the second operand
  5939. * @returns a new Color4 object
  5940. */
  5941. subtract(right: DeepImmutable<Color4>): Color4;
  5942. /**
  5943. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5944. * @param right defines the second operand
  5945. * @param result defines the Color4 object where to store the result
  5946. * @returns the current Color4 object
  5947. */
  5948. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5949. /**
  5950. * Creates a new Color4 with the current Color4 values multiplied by scale
  5951. * @param scale defines the scaling factor to apply
  5952. * @returns a new Color4 object
  5953. */
  5954. scale(scale: number): Color4;
  5955. /**
  5956. * Multiplies the current Color4 values by scale and stores the result in "result"
  5957. * @param scale defines the scaling factor to apply
  5958. * @param result defines the Color4 object where to store the result
  5959. * @returns the current unmodified Color4
  5960. */
  5961. scaleToRef(scale: number, result: Color4): Color4;
  5962. /**
  5963. * Scale the current Color4 values by a factor and add the result to a given Color4
  5964. * @param scale defines the scale factor
  5965. * @param result defines the Color4 object where to store the result
  5966. * @returns the unmodified current Color4
  5967. */
  5968. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5969. /**
  5970. * Clamps the rgb values by the min and max values and stores the result into "result"
  5971. * @param min defines minimum clamping value (default is 0)
  5972. * @param max defines maximum clamping value (default is 1)
  5973. * @param result defines color to store the result into.
  5974. * @returns the cuurent Color4
  5975. */
  5976. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5977. /**
  5978. * Multipy an Color4 value by another and return a new Color4 object
  5979. * @param color defines the Color4 value to multiply by
  5980. * @returns a new Color4 object
  5981. */
  5982. multiply(color: Color4): Color4;
  5983. /**
  5984. * Multipy a Color4 value by another and push the result in a reference value
  5985. * @param color defines the Color4 value to multiply by
  5986. * @param result defines the Color4 to fill the result in
  5987. * @returns the result Color4
  5988. */
  5989. multiplyToRef(color: Color4, result: Color4): Color4;
  5990. /**
  5991. * Creates a string with the Color4 current values
  5992. * @returns the string representation of the Color4 object
  5993. */
  5994. toString(): string;
  5995. /**
  5996. * Returns the string "Color4"
  5997. * @returns "Color4"
  5998. */
  5999. getClassName(): string;
  6000. /**
  6001. * Compute the Color4 hash code
  6002. * @returns an unique number that can be used to hash Color4 objects
  6003. */
  6004. getHashCode(): number;
  6005. /**
  6006. * Creates a new Color4 copied from the current one
  6007. * @returns a new Color4 object
  6008. */
  6009. clone(): Color4;
  6010. /**
  6011. * Copies the given Color4 values into the current one
  6012. * @param source defines the source Color4 object
  6013. * @returns the current updated Color4 object
  6014. */
  6015. copyFrom(source: Color4): Color4;
  6016. /**
  6017. * Copies the given float values into the current one
  6018. * @param r defines the red component to read from
  6019. * @param g defines the green component to read from
  6020. * @param b defines the blue component to read from
  6021. * @param a defines the alpha component to read from
  6022. * @returns the current updated Color4 object
  6023. */
  6024. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6025. /**
  6026. * Copies the given float values into the current one
  6027. * @param r defines the red component to read from
  6028. * @param g defines the green component to read from
  6029. * @param b defines the blue component to read from
  6030. * @param a defines the alpha component to read from
  6031. * @returns the current updated Color4 object
  6032. */
  6033. set(r: number, g: number, b: number, a: number): Color4;
  6034. /**
  6035. * Compute the Color4 hexadecimal code as a string
  6036. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6037. * @returns a string containing the hexadecimal representation of the Color4 object
  6038. */
  6039. toHexString(returnAsColor3?: boolean): string;
  6040. /**
  6041. * Computes a new Color4 converted from the current one to linear space
  6042. * @returns a new Color4 object
  6043. */
  6044. toLinearSpace(): Color4;
  6045. /**
  6046. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6047. * @param convertedColor defines the Color4 object where to store the linear space version
  6048. * @returns the unmodified Color4
  6049. */
  6050. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6051. /**
  6052. * Computes a new Color4 converted from the current one to gamma space
  6053. * @returns a new Color4 object
  6054. */
  6055. toGammaSpace(): Color4;
  6056. /**
  6057. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6058. * @param convertedColor defines the Color4 object where to store the gamma space version
  6059. * @returns the unmodified Color4
  6060. */
  6061. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6062. /**
  6063. * Creates a new Color4 from the string containing valid hexadecimal values
  6064. * @param hex defines a string containing valid hexadecimal values
  6065. * @returns a new Color4 object
  6066. */
  6067. static FromHexString(hex: string): Color4;
  6068. /**
  6069. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6070. * @param left defines the start value
  6071. * @param right defines the end value
  6072. * @param amount defines the gradient factor
  6073. * @returns a new Color4 object
  6074. */
  6075. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6076. /**
  6077. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6078. * @param left defines the start value
  6079. * @param right defines the end value
  6080. * @param amount defines the gradient factor
  6081. * @param result defines the Color4 object where to store data
  6082. */
  6083. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6084. /**
  6085. * Creates a new Color4 from a Color3 and an alpha value
  6086. * @param color3 defines the source Color3 to read from
  6087. * @param alpha defines the alpha component (1.0 by default)
  6088. * @returns a new Color4 object
  6089. */
  6090. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6091. /**
  6092. * Creates a new Color4 from the starting index element of the given array
  6093. * @param array defines the source array to read from
  6094. * @param offset defines the offset in the source array
  6095. * @returns a new Color4 object
  6096. */
  6097. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6098. /**
  6099. * Creates a new Color4 from the starting index element of the given array
  6100. * @param array defines the source array to read from
  6101. * @param offset defines the offset in the source array
  6102. * @param result defines the target Color4 object
  6103. */
  6104. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6105. /**
  6106. * Creates a new Color3 from integer values (< 256)
  6107. * @param r defines the red component to read from (value between 0 and 255)
  6108. * @param g defines the green component to read from (value between 0 and 255)
  6109. * @param b defines the blue component to read from (value between 0 and 255)
  6110. * @param a defines the alpha component to read from (value between 0 and 255)
  6111. * @returns a new Color3 object
  6112. */
  6113. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6114. /**
  6115. * Check the content of a given array and convert it to an array containing RGBA data
  6116. * If the original array was already containing count * 4 values then it is returned directly
  6117. * @param colors defines the array to check
  6118. * @param count defines the number of RGBA data to expect
  6119. * @returns an array containing count * 4 values (RGBA)
  6120. */
  6121. static CheckColors4(colors: number[], count: number): number[];
  6122. }
  6123. /**
  6124. * @hidden
  6125. */
  6126. export class TmpColors {
  6127. static Color3: Color3[];
  6128. static Color4: Color4[];
  6129. }
  6130. }
  6131. declare module "babylonjs/Animations/animationKey" {
  6132. /**
  6133. * Defines an interface which represents an animation key frame
  6134. */
  6135. export interface IAnimationKey {
  6136. /**
  6137. * Frame of the key frame
  6138. */
  6139. frame: number;
  6140. /**
  6141. * Value at the specifies key frame
  6142. */
  6143. value: any;
  6144. /**
  6145. * The input tangent for the cubic hermite spline
  6146. */
  6147. inTangent?: any;
  6148. /**
  6149. * The output tangent for the cubic hermite spline
  6150. */
  6151. outTangent?: any;
  6152. /**
  6153. * The animation interpolation type
  6154. */
  6155. interpolation?: AnimationKeyInterpolation;
  6156. }
  6157. /**
  6158. * Enum for the animation key frame interpolation type
  6159. */
  6160. export enum AnimationKeyInterpolation {
  6161. /**
  6162. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6163. */
  6164. STEP = 1
  6165. }
  6166. }
  6167. declare module "babylonjs/Animations/animationRange" {
  6168. /**
  6169. * Represents the range of an animation
  6170. */
  6171. export class AnimationRange {
  6172. /**The name of the animation range**/
  6173. name: string;
  6174. /**The starting frame of the animation */
  6175. from: number;
  6176. /**The ending frame of the animation*/
  6177. to: number;
  6178. /**
  6179. * Initializes the range of an animation
  6180. * @param name The name of the animation range
  6181. * @param from The starting frame of the animation
  6182. * @param to The ending frame of the animation
  6183. */
  6184. constructor(
  6185. /**The name of the animation range**/
  6186. name: string,
  6187. /**The starting frame of the animation */
  6188. from: number,
  6189. /**The ending frame of the animation*/
  6190. to: number);
  6191. /**
  6192. * Makes a copy of the animation range
  6193. * @returns A copy of the animation range
  6194. */
  6195. clone(): AnimationRange;
  6196. }
  6197. }
  6198. declare module "babylonjs/Animations/animationEvent" {
  6199. /**
  6200. * Composed of a frame, and an action function
  6201. */
  6202. export class AnimationEvent {
  6203. /** The frame for which the event is triggered **/
  6204. frame: number;
  6205. /** The event to perform when triggered **/
  6206. action: (currentFrame: number) => void;
  6207. /** Specifies if the event should be triggered only once**/
  6208. onlyOnce?: boolean | undefined;
  6209. /**
  6210. * Specifies if the animation event is done
  6211. */
  6212. isDone: boolean;
  6213. /**
  6214. * Initializes the animation event
  6215. * @param frame The frame for which the event is triggered
  6216. * @param action The event to perform when triggered
  6217. * @param onlyOnce Specifies if the event should be triggered only once
  6218. */
  6219. constructor(
  6220. /** The frame for which the event is triggered **/
  6221. frame: number,
  6222. /** The event to perform when triggered **/
  6223. action: (currentFrame: number) => void,
  6224. /** Specifies if the event should be triggered only once**/
  6225. onlyOnce?: boolean | undefined);
  6226. /** @hidden */
  6227. _clone(): AnimationEvent;
  6228. }
  6229. }
  6230. declare module "babylonjs/Behaviors/behavior" {
  6231. import { Nullable } from "babylonjs/types";
  6232. /**
  6233. * Interface used to define a behavior
  6234. */
  6235. export interface Behavior<T> {
  6236. /** gets or sets behavior's name */
  6237. name: string;
  6238. /**
  6239. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6240. */
  6241. init(): void;
  6242. /**
  6243. * Called when the behavior is attached to a target
  6244. * @param target defines the target where the behavior is attached to
  6245. */
  6246. attach(target: T): void;
  6247. /**
  6248. * Called when the behavior is detached from its target
  6249. */
  6250. detach(): void;
  6251. }
  6252. /**
  6253. * Interface implemented by classes supporting behaviors
  6254. */
  6255. export interface IBehaviorAware<T> {
  6256. /**
  6257. * Attach a behavior
  6258. * @param behavior defines the behavior to attach
  6259. * @returns the current host
  6260. */
  6261. addBehavior(behavior: Behavior<T>): T;
  6262. /**
  6263. * Remove a behavior from the current object
  6264. * @param behavior defines the behavior to detach
  6265. * @returns the current host
  6266. */
  6267. removeBehavior(behavior: Behavior<T>): T;
  6268. /**
  6269. * Gets a behavior using its name to search
  6270. * @param name defines the name to search
  6271. * @returns the behavior or null if not found
  6272. */
  6273. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6274. }
  6275. }
  6276. declare module "babylonjs/Misc/smartArray" {
  6277. /**
  6278. * Defines an array and its length.
  6279. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6280. */
  6281. export interface ISmartArrayLike<T> {
  6282. /**
  6283. * The data of the array.
  6284. */
  6285. data: Array<T>;
  6286. /**
  6287. * The active length of the array.
  6288. */
  6289. length: number;
  6290. }
  6291. /**
  6292. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6293. */
  6294. export class SmartArray<T> implements ISmartArrayLike<T> {
  6295. /**
  6296. * The full set of data from the array.
  6297. */
  6298. data: Array<T>;
  6299. /**
  6300. * The active length of the array.
  6301. */
  6302. length: number;
  6303. protected _id: number;
  6304. /**
  6305. * Instantiates a Smart Array.
  6306. * @param capacity defines the default capacity of the array.
  6307. */
  6308. constructor(capacity: number);
  6309. /**
  6310. * Pushes a value at the end of the active data.
  6311. * @param value defines the object to push in the array.
  6312. */
  6313. push(value: T): void;
  6314. /**
  6315. * Iterates over the active data and apply the lambda to them.
  6316. * @param func defines the action to apply on each value.
  6317. */
  6318. forEach(func: (content: T) => void): void;
  6319. /**
  6320. * Sorts the full sets of data.
  6321. * @param compareFn defines the comparison function to apply.
  6322. */
  6323. sort(compareFn: (a: T, b: T) => number): void;
  6324. /**
  6325. * Resets the active data to an empty array.
  6326. */
  6327. reset(): void;
  6328. /**
  6329. * Releases all the data from the array as well as the array.
  6330. */
  6331. dispose(): void;
  6332. /**
  6333. * Concats the active data with a given array.
  6334. * @param array defines the data to concatenate with.
  6335. */
  6336. concat(array: any): void;
  6337. /**
  6338. * Returns the position of a value in the active data.
  6339. * @param value defines the value to find the index for
  6340. * @returns the index if found in the active data otherwise -1
  6341. */
  6342. indexOf(value: T): number;
  6343. /**
  6344. * Returns whether an element is part of the active data.
  6345. * @param value defines the value to look for
  6346. * @returns true if found in the active data otherwise false
  6347. */
  6348. contains(value: T): boolean;
  6349. private static _GlobalId;
  6350. }
  6351. /**
  6352. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6353. * The data in this array can only be present once
  6354. */
  6355. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6356. private _duplicateId;
  6357. /**
  6358. * Pushes a value at the end of the active data.
  6359. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6360. * @param value defines the object to push in the array.
  6361. */
  6362. push(value: T): void;
  6363. /**
  6364. * Pushes a value at the end of the active data.
  6365. * If the data is already present, it won t be added again
  6366. * @param value defines the object to push in the array.
  6367. * @returns true if added false if it was already present
  6368. */
  6369. pushNoDuplicate(value: T): boolean;
  6370. /**
  6371. * Resets the active data to an empty array.
  6372. */
  6373. reset(): void;
  6374. /**
  6375. * Concats the active data with a given array.
  6376. * This ensures no dupplicate will be present in the result.
  6377. * @param array defines the data to concatenate with.
  6378. */
  6379. concatWithNoDuplicate(array: any): void;
  6380. }
  6381. }
  6382. declare module "babylonjs/Cameras/cameraInputsManager" {
  6383. import { Nullable } from "babylonjs/types";
  6384. import { Camera } from "babylonjs/Cameras/camera";
  6385. /**
  6386. * @ignore
  6387. * This is a list of all the different input types that are available in the application.
  6388. * Fo instance: ArcRotateCameraGamepadInput...
  6389. */
  6390. export var CameraInputTypes: {};
  6391. /**
  6392. * This is the contract to implement in order to create a new input class.
  6393. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6394. */
  6395. export interface ICameraInput<TCamera extends Camera> {
  6396. /**
  6397. * Defines the camera the input is attached to.
  6398. */
  6399. camera: Nullable<TCamera>;
  6400. /**
  6401. * Gets the class name of the current intput.
  6402. * @returns the class name
  6403. */
  6404. getClassName(): string;
  6405. /**
  6406. * Get the friendly name associated with the input class.
  6407. * @returns the input friendly name
  6408. */
  6409. getSimpleName(): string;
  6410. /**
  6411. * Attach the input controls to a specific dom element to get the input from.
  6412. * @param element Defines the element the controls should be listened from
  6413. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6414. */
  6415. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6416. /**
  6417. * Detach the current controls from the specified dom element.
  6418. * @param element Defines the element to stop listening the inputs from
  6419. */
  6420. detachControl(element: Nullable<HTMLElement>): void;
  6421. /**
  6422. * Update the current camera state depending on the inputs that have been used this frame.
  6423. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6424. */
  6425. checkInputs?: () => void;
  6426. }
  6427. /**
  6428. * Represents a map of input types to input instance or input index to input instance.
  6429. */
  6430. export interface CameraInputsMap<TCamera extends Camera> {
  6431. /**
  6432. * Accessor to the input by input type.
  6433. */
  6434. [name: string]: ICameraInput<TCamera>;
  6435. /**
  6436. * Accessor to the input by input index.
  6437. */
  6438. [idx: number]: ICameraInput<TCamera>;
  6439. }
  6440. /**
  6441. * This represents the input manager used within a camera.
  6442. * It helps dealing with all the different kind of input attached to a camera.
  6443. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6444. */
  6445. export class CameraInputsManager<TCamera extends Camera> {
  6446. /**
  6447. * Defines the list of inputs attahed to the camera.
  6448. */
  6449. attached: CameraInputsMap<TCamera>;
  6450. /**
  6451. * Defines the dom element the camera is collecting inputs from.
  6452. * This is null if the controls have not been attached.
  6453. */
  6454. attachedElement: Nullable<HTMLElement>;
  6455. /**
  6456. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6457. */
  6458. noPreventDefault: boolean;
  6459. /**
  6460. * Defined the camera the input manager belongs to.
  6461. */
  6462. camera: TCamera;
  6463. /**
  6464. * Update the current camera state depending on the inputs that have been used this frame.
  6465. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6466. */
  6467. checkInputs: () => void;
  6468. /**
  6469. * Instantiate a new Camera Input Manager.
  6470. * @param camera Defines the camera the input manager blongs to
  6471. */
  6472. constructor(camera: TCamera);
  6473. /**
  6474. * Add an input method to a camera
  6475. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6476. * @param input camera input method
  6477. */
  6478. add(input: ICameraInput<TCamera>): void;
  6479. /**
  6480. * Remove a specific input method from a camera
  6481. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6482. * @param inputToRemove camera input method
  6483. */
  6484. remove(inputToRemove: ICameraInput<TCamera>): void;
  6485. /**
  6486. * Remove a specific input type from a camera
  6487. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6488. * @param inputType the type of the input to remove
  6489. */
  6490. removeByType(inputType: string): void;
  6491. private _addCheckInputs;
  6492. /**
  6493. * Attach the input controls to the currently attached dom element to listen the events from.
  6494. * @param input Defines the input to attach
  6495. */
  6496. attachInput(input: ICameraInput<TCamera>): void;
  6497. /**
  6498. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6499. * @param element Defines the dom element to collect the events from
  6500. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6501. */
  6502. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6503. /**
  6504. * Detach the current manager inputs controls from a specific dom element.
  6505. * @param element Defines the dom element to collect the events from
  6506. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6507. */
  6508. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6509. /**
  6510. * Rebuild the dynamic inputCheck function from the current list of
  6511. * defined inputs in the manager.
  6512. */
  6513. rebuildInputCheck(): void;
  6514. /**
  6515. * Remove all attached input methods from a camera
  6516. */
  6517. clear(): void;
  6518. /**
  6519. * Serialize the current input manager attached to a camera.
  6520. * This ensures than once parsed,
  6521. * the input associated to the camera will be identical to the current ones
  6522. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6523. */
  6524. serialize(serializedCamera: any): void;
  6525. /**
  6526. * Parses an input manager serialized JSON to restore the previous list of inputs
  6527. * and states associated to a camera.
  6528. * @param parsedCamera Defines the JSON to parse
  6529. */
  6530. parse(parsedCamera: any): void;
  6531. }
  6532. }
  6533. declare module "babylonjs/Meshes/buffer" {
  6534. import { Nullable, DataArray } from "babylonjs/types";
  6535. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6536. /**
  6537. * Class used to store data that will be store in GPU memory
  6538. */
  6539. export class Buffer {
  6540. private _engine;
  6541. private _buffer;
  6542. /** @hidden */
  6543. _data: Nullable<DataArray>;
  6544. private _updatable;
  6545. private _instanced;
  6546. private _divisor;
  6547. /**
  6548. * Gets the byte stride.
  6549. */
  6550. readonly byteStride: number;
  6551. /**
  6552. * Constructor
  6553. * @param engine the engine
  6554. * @param data the data to use for this buffer
  6555. * @param updatable whether the data is updatable
  6556. * @param stride the stride (optional)
  6557. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6558. * @param instanced whether the buffer is instanced (optional)
  6559. * @param useBytes set to true if the stride in in bytes (optional)
  6560. * @param divisor sets an optional divisor for instances (1 by default)
  6561. */
  6562. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6563. /**
  6564. * Create a new VertexBuffer based on the current buffer
  6565. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6566. * @param offset defines offset in the buffer (0 by default)
  6567. * @param size defines the size in floats of attributes (position is 3 for instance)
  6568. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6569. * @param instanced defines if the vertex buffer contains indexed data
  6570. * @param useBytes defines if the offset and stride are in bytes *
  6571. * @param divisor sets an optional divisor for instances (1 by default)
  6572. * @returns the new vertex buffer
  6573. */
  6574. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6575. /**
  6576. * Gets a boolean indicating if the Buffer is updatable?
  6577. * @returns true if the buffer is updatable
  6578. */
  6579. isUpdatable(): boolean;
  6580. /**
  6581. * Gets current buffer's data
  6582. * @returns a DataArray or null
  6583. */
  6584. getData(): Nullable<DataArray>;
  6585. /**
  6586. * Gets underlying native buffer
  6587. * @returns underlying native buffer
  6588. */
  6589. getBuffer(): Nullable<DataBuffer>;
  6590. /**
  6591. * Gets the stride in float32 units (i.e. byte stride / 4).
  6592. * May not be an integer if the byte stride is not divisible by 4.
  6593. * @returns the stride in float32 units
  6594. * @deprecated Please use byteStride instead.
  6595. */
  6596. getStrideSize(): number;
  6597. /**
  6598. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6599. * @param data defines the data to store
  6600. */
  6601. create(data?: Nullable<DataArray>): void;
  6602. /** @hidden */
  6603. _rebuild(): void;
  6604. /**
  6605. * Update current buffer data
  6606. * @param data defines the data to store
  6607. */
  6608. update(data: DataArray): void;
  6609. /**
  6610. * Updates the data directly.
  6611. * @param data the new data
  6612. * @param offset the new offset
  6613. * @param vertexCount the vertex count (optional)
  6614. * @param useBytes set to true if the offset is in bytes
  6615. */
  6616. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6617. /**
  6618. * Release all resources
  6619. */
  6620. dispose(): void;
  6621. }
  6622. /**
  6623. * Specialized buffer used to store vertex data
  6624. */
  6625. export class VertexBuffer {
  6626. /** @hidden */
  6627. _buffer: Buffer;
  6628. private _kind;
  6629. private _size;
  6630. private _ownsBuffer;
  6631. private _instanced;
  6632. private _instanceDivisor;
  6633. /**
  6634. * The byte type.
  6635. */
  6636. static readonly BYTE: number;
  6637. /**
  6638. * The unsigned byte type.
  6639. */
  6640. static readonly UNSIGNED_BYTE: number;
  6641. /**
  6642. * The short type.
  6643. */
  6644. static readonly SHORT: number;
  6645. /**
  6646. * The unsigned short type.
  6647. */
  6648. static readonly UNSIGNED_SHORT: number;
  6649. /**
  6650. * The integer type.
  6651. */
  6652. static readonly INT: number;
  6653. /**
  6654. * The unsigned integer type.
  6655. */
  6656. static readonly UNSIGNED_INT: number;
  6657. /**
  6658. * The float type.
  6659. */
  6660. static readonly FLOAT: number;
  6661. /**
  6662. * Gets or sets the instance divisor when in instanced mode
  6663. */
  6664. get instanceDivisor(): number;
  6665. set instanceDivisor(value: number);
  6666. /**
  6667. * Gets the byte stride.
  6668. */
  6669. readonly byteStride: number;
  6670. /**
  6671. * Gets the byte offset.
  6672. */
  6673. readonly byteOffset: number;
  6674. /**
  6675. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6676. */
  6677. readonly normalized: boolean;
  6678. /**
  6679. * Gets the data type of each component in the array.
  6680. */
  6681. readonly type: number;
  6682. /**
  6683. * Constructor
  6684. * @param engine the engine
  6685. * @param data the data to use for this vertex buffer
  6686. * @param kind the vertex buffer kind
  6687. * @param updatable whether the data is updatable
  6688. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6689. * @param stride the stride (optional)
  6690. * @param instanced whether the buffer is instanced (optional)
  6691. * @param offset the offset of the data (optional)
  6692. * @param size the number of components (optional)
  6693. * @param type the type of the component (optional)
  6694. * @param normalized whether the data contains normalized data (optional)
  6695. * @param useBytes set to true if stride and offset are in bytes (optional)
  6696. * @param divisor defines the instance divisor to use (1 by default)
  6697. */
  6698. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  6699. /** @hidden */
  6700. _rebuild(): void;
  6701. /**
  6702. * Returns the kind of the VertexBuffer (string)
  6703. * @returns a string
  6704. */
  6705. getKind(): string;
  6706. /**
  6707. * Gets a boolean indicating if the VertexBuffer is updatable?
  6708. * @returns true if the buffer is updatable
  6709. */
  6710. isUpdatable(): boolean;
  6711. /**
  6712. * Gets current buffer's data
  6713. * @returns a DataArray or null
  6714. */
  6715. getData(): Nullable<DataArray>;
  6716. /**
  6717. * Gets underlying native buffer
  6718. * @returns underlying native buffer
  6719. */
  6720. getBuffer(): Nullable<DataBuffer>;
  6721. /**
  6722. * Gets the stride in float32 units (i.e. byte stride / 4).
  6723. * May not be an integer if the byte stride is not divisible by 4.
  6724. * @returns the stride in float32 units
  6725. * @deprecated Please use byteStride instead.
  6726. */
  6727. getStrideSize(): number;
  6728. /**
  6729. * Returns the offset as a multiple of the type byte length.
  6730. * @returns the offset in bytes
  6731. * @deprecated Please use byteOffset instead.
  6732. */
  6733. getOffset(): number;
  6734. /**
  6735. * Returns the number of components per vertex attribute (integer)
  6736. * @returns the size in float
  6737. */
  6738. getSize(): number;
  6739. /**
  6740. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6741. * @returns true if this buffer is instanced
  6742. */
  6743. getIsInstanced(): boolean;
  6744. /**
  6745. * Returns the instancing divisor, zero for non-instanced (integer).
  6746. * @returns a number
  6747. */
  6748. getInstanceDivisor(): number;
  6749. /**
  6750. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6751. * @param data defines the data to store
  6752. */
  6753. create(data?: DataArray): void;
  6754. /**
  6755. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6756. * This function will create a new buffer if the current one is not updatable
  6757. * @param data defines the data to store
  6758. */
  6759. update(data: DataArray): void;
  6760. /**
  6761. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6762. * Returns the directly updated WebGLBuffer.
  6763. * @param data the new data
  6764. * @param offset the new offset
  6765. * @param useBytes set to true if the offset is in bytes
  6766. */
  6767. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6768. /**
  6769. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6770. */
  6771. dispose(): void;
  6772. /**
  6773. * Enumerates each value of this vertex buffer as numbers.
  6774. * @param count the number of values to enumerate
  6775. * @param callback the callback function called for each value
  6776. */
  6777. forEach(count: number, callback: (value: number, index: number) => void): void;
  6778. /**
  6779. * Positions
  6780. */
  6781. static readonly PositionKind: string;
  6782. /**
  6783. * Normals
  6784. */
  6785. static readonly NormalKind: string;
  6786. /**
  6787. * Tangents
  6788. */
  6789. static readonly TangentKind: string;
  6790. /**
  6791. * Texture coordinates
  6792. */
  6793. static readonly UVKind: string;
  6794. /**
  6795. * Texture coordinates 2
  6796. */
  6797. static readonly UV2Kind: string;
  6798. /**
  6799. * Texture coordinates 3
  6800. */
  6801. static readonly UV3Kind: string;
  6802. /**
  6803. * Texture coordinates 4
  6804. */
  6805. static readonly UV4Kind: string;
  6806. /**
  6807. * Texture coordinates 5
  6808. */
  6809. static readonly UV5Kind: string;
  6810. /**
  6811. * Texture coordinates 6
  6812. */
  6813. static readonly UV6Kind: string;
  6814. /**
  6815. * Colors
  6816. */
  6817. static readonly ColorKind: string;
  6818. /**
  6819. * Matrix indices (for bones)
  6820. */
  6821. static readonly MatricesIndicesKind: string;
  6822. /**
  6823. * Matrix weights (for bones)
  6824. */
  6825. static readonly MatricesWeightsKind: string;
  6826. /**
  6827. * Additional matrix indices (for bones)
  6828. */
  6829. static readonly MatricesIndicesExtraKind: string;
  6830. /**
  6831. * Additional matrix weights (for bones)
  6832. */
  6833. static readonly MatricesWeightsExtraKind: string;
  6834. /**
  6835. * Deduces the stride given a kind.
  6836. * @param kind The kind string to deduce
  6837. * @returns The deduced stride
  6838. */
  6839. static DeduceStride(kind: string): number;
  6840. /**
  6841. * Gets the byte length of the given type.
  6842. * @param type the type
  6843. * @returns the number of bytes
  6844. */
  6845. static GetTypeByteLength(type: number): number;
  6846. /**
  6847. * Enumerates each value of the given parameters as numbers.
  6848. * @param data the data to enumerate
  6849. * @param byteOffset the byte offset of the data
  6850. * @param byteStride the byte stride of the data
  6851. * @param componentCount the number of components per element
  6852. * @param componentType the type of the component
  6853. * @param count the number of values to enumerate
  6854. * @param normalized whether the data is normalized
  6855. * @param callback the callback function called for each value
  6856. */
  6857. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6858. private static _GetFloatValue;
  6859. }
  6860. }
  6861. declare module "babylonjs/Collisions/intersectionInfo" {
  6862. import { Nullable } from "babylonjs/types";
  6863. /**
  6864. * @hidden
  6865. */
  6866. export class IntersectionInfo {
  6867. bu: Nullable<number>;
  6868. bv: Nullable<number>;
  6869. distance: number;
  6870. faceId: number;
  6871. subMeshId: number;
  6872. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6873. }
  6874. }
  6875. declare module "babylonjs/Culling/boundingSphere" {
  6876. import { DeepImmutable } from "babylonjs/types";
  6877. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6878. import { Plane } from "babylonjs/Maths/math.plane";
  6879. /**
  6880. * Class used to store bounding sphere information
  6881. */
  6882. export class BoundingSphere {
  6883. /**
  6884. * Gets the center of the bounding sphere in local space
  6885. */
  6886. readonly center: Vector3;
  6887. /**
  6888. * Radius of the bounding sphere in local space
  6889. */
  6890. radius: number;
  6891. /**
  6892. * Gets the center of the bounding sphere in world space
  6893. */
  6894. readonly centerWorld: Vector3;
  6895. /**
  6896. * Radius of the bounding sphere in world space
  6897. */
  6898. radiusWorld: number;
  6899. /**
  6900. * Gets the minimum vector in local space
  6901. */
  6902. readonly minimum: Vector3;
  6903. /**
  6904. * Gets the maximum vector in local space
  6905. */
  6906. readonly maximum: Vector3;
  6907. private _worldMatrix;
  6908. private static readonly TmpVector3;
  6909. /**
  6910. * Creates a new bounding sphere
  6911. * @param min defines the minimum vector (in local space)
  6912. * @param max defines the maximum vector (in local space)
  6913. * @param worldMatrix defines the new world matrix
  6914. */
  6915. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6916. /**
  6917. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6918. * @param min defines the new minimum vector (in local space)
  6919. * @param max defines the new maximum vector (in local space)
  6920. * @param worldMatrix defines the new world matrix
  6921. */
  6922. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6923. /**
  6924. * Scale the current bounding sphere by applying a scale factor
  6925. * @param factor defines the scale factor to apply
  6926. * @returns the current bounding box
  6927. */
  6928. scale(factor: number): BoundingSphere;
  6929. /**
  6930. * Gets the world matrix of the bounding box
  6931. * @returns a matrix
  6932. */
  6933. getWorldMatrix(): DeepImmutable<Matrix>;
  6934. /** @hidden */
  6935. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6936. /**
  6937. * Tests if the bounding sphere is intersecting the frustum planes
  6938. * @param frustumPlanes defines the frustum planes to test
  6939. * @returns true if there is an intersection
  6940. */
  6941. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6942. /**
  6943. * Tests if the bounding sphere center is in between the frustum planes.
  6944. * Used for optimistic fast inclusion.
  6945. * @param frustumPlanes defines the frustum planes to test
  6946. * @returns true if the sphere center is in between the frustum planes
  6947. */
  6948. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6949. /**
  6950. * Tests if a point is inside the bounding sphere
  6951. * @param point defines the point to test
  6952. * @returns true if the point is inside the bounding sphere
  6953. */
  6954. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6955. /**
  6956. * Checks if two sphere intersct
  6957. * @param sphere0 sphere 0
  6958. * @param sphere1 sphere 1
  6959. * @returns true if the speres intersect
  6960. */
  6961. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6962. }
  6963. }
  6964. declare module "babylonjs/Culling/boundingBox" {
  6965. import { DeepImmutable } from "babylonjs/types";
  6966. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6967. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6968. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6969. import { Plane } from "babylonjs/Maths/math.plane";
  6970. /**
  6971. * Class used to store bounding box information
  6972. */
  6973. export class BoundingBox implements ICullable {
  6974. /**
  6975. * Gets the 8 vectors representing the bounding box in local space
  6976. */
  6977. readonly vectors: Vector3[];
  6978. /**
  6979. * Gets the center of the bounding box in local space
  6980. */
  6981. readonly center: Vector3;
  6982. /**
  6983. * Gets the center of the bounding box in world space
  6984. */
  6985. readonly centerWorld: Vector3;
  6986. /**
  6987. * Gets the extend size in local space
  6988. */
  6989. readonly extendSize: Vector3;
  6990. /**
  6991. * Gets the extend size in world space
  6992. */
  6993. readonly extendSizeWorld: Vector3;
  6994. /**
  6995. * Gets the OBB (object bounding box) directions
  6996. */
  6997. readonly directions: Vector3[];
  6998. /**
  6999. * Gets the 8 vectors representing the bounding box in world space
  7000. */
  7001. readonly vectorsWorld: Vector3[];
  7002. /**
  7003. * Gets the minimum vector in world space
  7004. */
  7005. readonly minimumWorld: Vector3;
  7006. /**
  7007. * Gets the maximum vector in world space
  7008. */
  7009. readonly maximumWorld: Vector3;
  7010. /**
  7011. * Gets the minimum vector in local space
  7012. */
  7013. readonly minimum: Vector3;
  7014. /**
  7015. * Gets the maximum vector in local space
  7016. */
  7017. readonly maximum: Vector3;
  7018. private _worldMatrix;
  7019. private static readonly TmpVector3;
  7020. /**
  7021. * @hidden
  7022. */
  7023. _tag: number;
  7024. /**
  7025. * Creates a new bounding box
  7026. * @param min defines the minimum vector (in local space)
  7027. * @param max defines the maximum vector (in local space)
  7028. * @param worldMatrix defines the new world matrix
  7029. */
  7030. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7031. /**
  7032. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7033. * @param min defines the new minimum vector (in local space)
  7034. * @param max defines the new maximum vector (in local space)
  7035. * @param worldMatrix defines the new world matrix
  7036. */
  7037. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7038. /**
  7039. * Scale the current bounding box by applying a scale factor
  7040. * @param factor defines the scale factor to apply
  7041. * @returns the current bounding box
  7042. */
  7043. scale(factor: number): BoundingBox;
  7044. /**
  7045. * Gets the world matrix of the bounding box
  7046. * @returns a matrix
  7047. */
  7048. getWorldMatrix(): DeepImmutable<Matrix>;
  7049. /** @hidden */
  7050. _update(world: DeepImmutable<Matrix>): void;
  7051. /**
  7052. * Tests if the bounding box is intersecting the frustum planes
  7053. * @param frustumPlanes defines the frustum planes to test
  7054. * @returns true if there is an intersection
  7055. */
  7056. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7057. /**
  7058. * Tests if the bounding box is entirely inside the frustum planes
  7059. * @param frustumPlanes defines the frustum planes to test
  7060. * @returns true if there is an inclusion
  7061. */
  7062. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7063. /**
  7064. * Tests if a point is inside the bounding box
  7065. * @param point defines the point to test
  7066. * @returns true if the point is inside the bounding box
  7067. */
  7068. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7069. /**
  7070. * Tests if the bounding box intersects with a bounding sphere
  7071. * @param sphere defines the sphere to test
  7072. * @returns true if there is an intersection
  7073. */
  7074. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7075. /**
  7076. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7077. * @param min defines the min vector to use
  7078. * @param max defines the max vector to use
  7079. * @returns true if there is an intersection
  7080. */
  7081. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7082. /**
  7083. * Tests if two bounding boxes are intersections
  7084. * @param box0 defines the first box to test
  7085. * @param box1 defines the second box to test
  7086. * @returns true if there is an intersection
  7087. */
  7088. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7089. /**
  7090. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7091. * @param minPoint defines the minimum vector of the bounding box
  7092. * @param maxPoint defines the maximum vector of the bounding box
  7093. * @param sphereCenter defines the sphere center
  7094. * @param sphereRadius defines the sphere radius
  7095. * @returns true if there is an intersection
  7096. */
  7097. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7098. /**
  7099. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7100. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7101. * @param frustumPlanes defines the frustum planes to test
  7102. * @return true if there is an inclusion
  7103. */
  7104. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7105. /**
  7106. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7107. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7108. * @param frustumPlanes defines the frustum planes to test
  7109. * @return true if there is an intersection
  7110. */
  7111. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7112. }
  7113. }
  7114. declare module "babylonjs/Collisions/collider" {
  7115. import { Nullable, IndicesArray } from "babylonjs/types";
  7116. import { Vector3 } from "babylonjs/Maths/math.vector";
  7117. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7118. import { Plane } from "babylonjs/Maths/math.plane";
  7119. /** @hidden */
  7120. export class Collider {
  7121. /** Define if a collision was found */
  7122. collisionFound: boolean;
  7123. /**
  7124. * Define last intersection point in local space
  7125. */
  7126. intersectionPoint: Vector3;
  7127. /**
  7128. * Define last collided mesh
  7129. */
  7130. collidedMesh: Nullable<AbstractMesh>;
  7131. private _collisionPoint;
  7132. private _planeIntersectionPoint;
  7133. private _tempVector;
  7134. private _tempVector2;
  7135. private _tempVector3;
  7136. private _tempVector4;
  7137. private _edge;
  7138. private _baseToVertex;
  7139. private _destinationPoint;
  7140. private _slidePlaneNormal;
  7141. private _displacementVector;
  7142. /** @hidden */
  7143. _radius: Vector3;
  7144. /** @hidden */
  7145. _retry: number;
  7146. private _velocity;
  7147. private _basePoint;
  7148. private _epsilon;
  7149. /** @hidden */
  7150. _velocityWorldLength: number;
  7151. /** @hidden */
  7152. _basePointWorld: Vector3;
  7153. private _velocityWorld;
  7154. private _normalizedVelocity;
  7155. /** @hidden */
  7156. _initialVelocity: Vector3;
  7157. /** @hidden */
  7158. _initialPosition: Vector3;
  7159. private _nearestDistance;
  7160. private _collisionMask;
  7161. get collisionMask(): number;
  7162. set collisionMask(mask: number);
  7163. /**
  7164. * Gets the plane normal used to compute the sliding response (in local space)
  7165. */
  7166. get slidePlaneNormal(): Vector3;
  7167. /** @hidden */
  7168. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7169. /** @hidden */
  7170. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7171. /** @hidden */
  7172. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7173. /** @hidden */
  7174. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7175. /** @hidden */
  7176. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7177. /** @hidden */
  7178. _getResponse(pos: Vector3, vel: Vector3): void;
  7179. }
  7180. }
  7181. declare module "babylonjs/Culling/boundingInfo" {
  7182. import { DeepImmutable } from "babylonjs/types";
  7183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7184. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7185. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7186. import { Plane } from "babylonjs/Maths/math.plane";
  7187. import { Collider } from "babylonjs/Collisions/collider";
  7188. /**
  7189. * Interface for cullable objects
  7190. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7191. */
  7192. export interface ICullable {
  7193. /**
  7194. * Checks if the object or part of the object is in the frustum
  7195. * @param frustumPlanes Camera near/planes
  7196. * @returns true if the object is in frustum otherwise false
  7197. */
  7198. isInFrustum(frustumPlanes: Plane[]): boolean;
  7199. /**
  7200. * Checks if a cullable object (mesh...) is in the camera frustum
  7201. * Unlike isInFrustum this cheks the full bounding box
  7202. * @param frustumPlanes Camera near/planes
  7203. * @returns true if the object is in frustum otherwise false
  7204. */
  7205. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7206. }
  7207. /**
  7208. * Info for a bounding data of a mesh
  7209. */
  7210. export class BoundingInfo implements ICullable {
  7211. /**
  7212. * Bounding box for the mesh
  7213. */
  7214. readonly boundingBox: BoundingBox;
  7215. /**
  7216. * Bounding sphere for the mesh
  7217. */
  7218. readonly boundingSphere: BoundingSphere;
  7219. private _isLocked;
  7220. private static readonly TmpVector3;
  7221. /**
  7222. * Constructs bounding info
  7223. * @param minimum min vector of the bounding box/sphere
  7224. * @param maximum max vector of the bounding box/sphere
  7225. * @param worldMatrix defines the new world matrix
  7226. */
  7227. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7228. /**
  7229. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7230. * @param min defines the new minimum vector (in local space)
  7231. * @param max defines the new maximum vector (in local space)
  7232. * @param worldMatrix defines the new world matrix
  7233. */
  7234. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7235. /**
  7236. * min vector of the bounding box/sphere
  7237. */
  7238. get minimum(): Vector3;
  7239. /**
  7240. * max vector of the bounding box/sphere
  7241. */
  7242. get maximum(): Vector3;
  7243. /**
  7244. * If the info is locked and won't be updated to avoid perf overhead
  7245. */
  7246. get isLocked(): boolean;
  7247. set isLocked(value: boolean);
  7248. /**
  7249. * Updates the bounding sphere and box
  7250. * @param world world matrix to be used to update
  7251. */
  7252. update(world: DeepImmutable<Matrix>): void;
  7253. /**
  7254. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7255. * @param center New center of the bounding info
  7256. * @param extend New extend of the bounding info
  7257. * @returns the current bounding info
  7258. */
  7259. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7260. /**
  7261. * Scale the current bounding info by applying a scale factor
  7262. * @param factor defines the scale factor to apply
  7263. * @returns the current bounding info
  7264. */
  7265. scale(factor: number): BoundingInfo;
  7266. /**
  7267. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7268. * @param frustumPlanes defines the frustum to test
  7269. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7270. * @returns true if the bounding info is in the frustum planes
  7271. */
  7272. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7273. /**
  7274. * Gets the world distance between the min and max points of the bounding box
  7275. */
  7276. get diagonalLength(): number;
  7277. /**
  7278. * Checks if a cullable object (mesh...) is in the camera frustum
  7279. * Unlike isInFrustum this cheks the full bounding box
  7280. * @param frustumPlanes Camera near/planes
  7281. * @returns true if the object is in frustum otherwise false
  7282. */
  7283. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7284. /** @hidden */
  7285. _checkCollision(collider: Collider): boolean;
  7286. /**
  7287. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7288. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7289. * @param point the point to check intersection with
  7290. * @returns if the point intersects
  7291. */
  7292. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7293. /**
  7294. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7295. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7296. * @param boundingInfo the bounding info to check intersection with
  7297. * @param precise if the intersection should be done using OBB
  7298. * @returns if the bounding info intersects
  7299. */
  7300. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7301. }
  7302. }
  7303. declare module "babylonjs/Maths/math.functions" {
  7304. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7305. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7306. /**
  7307. * Extracts minimum and maximum values from a list of indexed positions
  7308. * @param positions defines the positions to use
  7309. * @param indices defines the indices to the positions
  7310. * @param indexStart defines the start index
  7311. * @param indexCount defines the end index
  7312. * @param bias defines bias value to add to the result
  7313. * @return minimum and maximum values
  7314. */
  7315. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7316. minimum: Vector3;
  7317. maximum: Vector3;
  7318. };
  7319. /**
  7320. * Extracts minimum and maximum values from a list of positions
  7321. * @param positions defines the positions to use
  7322. * @param start defines the start index in the positions array
  7323. * @param count defines the number of positions to handle
  7324. * @param bias defines bias value to add to the result
  7325. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7326. * @return minimum and maximum values
  7327. */
  7328. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7329. minimum: Vector3;
  7330. maximum: Vector3;
  7331. };
  7332. }
  7333. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7334. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7335. /** @hidden */
  7336. export class WebGLDataBuffer extends DataBuffer {
  7337. private _buffer;
  7338. constructor(resource: WebGLBuffer);
  7339. get underlyingResource(): any;
  7340. }
  7341. }
  7342. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7343. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7344. import { Nullable } from "babylonjs/types";
  7345. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7346. /** @hidden */
  7347. export class WebGLPipelineContext implements IPipelineContext {
  7348. engine: ThinEngine;
  7349. program: Nullable<WebGLProgram>;
  7350. context?: WebGLRenderingContext;
  7351. vertexShader?: WebGLShader;
  7352. fragmentShader?: WebGLShader;
  7353. isParallelCompiled: boolean;
  7354. onCompiled?: () => void;
  7355. transformFeedback?: WebGLTransformFeedback | null;
  7356. vertexCompilationError: Nullable<string>;
  7357. fragmentCompilationError: Nullable<string>;
  7358. programLinkError: Nullable<string>;
  7359. programValidationError: Nullable<string>;
  7360. get isAsync(): boolean;
  7361. get isReady(): boolean;
  7362. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7363. _getVertexShaderCode(): string | null;
  7364. _getFragmentShaderCode(): string | null;
  7365. }
  7366. }
  7367. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7368. import { FloatArray, Nullable } from "babylonjs/types";
  7369. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7370. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7371. module "babylonjs/Engines/thinEngine" {
  7372. interface ThinEngine {
  7373. /**
  7374. * Create an uniform buffer
  7375. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7376. * @param elements defines the content of the uniform buffer
  7377. * @returns the webGL uniform buffer
  7378. */
  7379. createUniformBuffer(elements: FloatArray): DataBuffer;
  7380. /**
  7381. * Create a dynamic uniform buffer
  7382. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7383. * @param elements defines the content of the uniform buffer
  7384. * @returns the webGL uniform buffer
  7385. */
  7386. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7387. /**
  7388. * Update an existing uniform buffer
  7389. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7390. * @param uniformBuffer defines the target uniform buffer
  7391. * @param elements defines the content to update
  7392. * @param offset defines the offset in the uniform buffer where update should start
  7393. * @param count defines the size of the data to update
  7394. */
  7395. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7396. /**
  7397. * Bind an uniform buffer to the current webGL context
  7398. * @param buffer defines the buffer to bind
  7399. */
  7400. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7401. /**
  7402. * Bind a buffer to the current webGL context at a given location
  7403. * @param buffer defines the buffer to bind
  7404. * @param location defines the index where to bind the buffer
  7405. */
  7406. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7407. /**
  7408. * Bind a specific block at a given index in a specific shader program
  7409. * @param pipelineContext defines the pipeline context to use
  7410. * @param blockName defines the block name
  7411. * @param index defines the index where to bind the block
  7412. */
  7413. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7414. }
  7415. }
  7416. }
  7417. declare module "babylonjs/Materials/uniformBuffer" {
  7418. import { Nullable, FloatArray } from "babylonjs/types";
  7419. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7420. import { Engine } from "babylonjs/Engines/engine";
  7421. import { Effect } from "babylonjs/Materials/effect";
  7422. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7423. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7424. import { Color3 } from "babylonjs/Maths/math.color";
  7425. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7426. /**
  7427. * Uniform buffer objects.
  7428. *
  7429. * Handles blocks of uniform on the GPU.
  7430. *
  7431. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7432. *
  7433. * For more information, please refer to :
  7434. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7435. */
  7436. export class UniformBuffer {
  7437. private _engine;
  7438. private _buffer;
  7439. private _data;
  7440. private _bufferData;
  7441. private _dynamic?;
  7442. private _uniformLocations;
  7443. private _uniformSizes;
  7444. private _uniformLocationPointer;
  7445. private _needSync;
  7446. private _noUBO;
  7447. private _currentEffect;
  7448. /** @hidden */
  7449. _alreadyBound: boolean;
  7450. private static _MAX_UNIFORM_SIZE;
  7451. private static _tempBuffer;
  7452. /**
  7453. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7454. * This is dynamic to allow compat with webgl 1 and 2.
  7455. * You will need to pass the name of the uniform as well as the value.
  7456. */
  7457. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7458. /**
  7459. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7460. * This is dynamic to allow compat with webgl 1 and 2.
  7461. * You will need to pass the name of the uniform as well as the value.
  7462. */
  7463. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7464. /**
  7465. * Lambda to Update a single float in a uniform buffer.
  7466. * This is dynamic to allow compat with webgl 1 and 2.
  7467. * You will need to pass the name of the uniform as well as the value.
  7468. */
  7469. updateFloat: (name: string, x: number) => void;
  7470. /**
  7471. * Lambda to Update a vec2 of float in a uniform buffer.
  7472. * This is dynamic to allow compat with webgl 1 and 2.
  7473. * You will need to pass the name of the uniform as well as the value.
  7474. */
  7475. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7476. /**
  7477. * Lambda to Update a vec3 of float in a uniform buffer.
  7478. * This is dynamic to allow compat with webgl 1 and 2.
  7479. * You will need to pass the name of the uniform as well as the value.
  7480. */
  7481. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7482. /**
  7483. * Lambda to Update a vec4 of float in a uniform buffer.
  7484. * This is dynamic to allow compat with webgl 1 and 2.
  7485. * You will need to pass the name of the uniform as well as the value.
  7486. */
  7487. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7488. /**
  7489. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7490. * This is dynamic to allow compat with webgl 1 and 2.
  7491. * You will need to pass the name of the uniform as well as the value.
  7492. */
  7493. updateMatrix: (name: string, mat: Matrix) => void;
  7494. /**
  7495. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7496. * This is dynamic to allow compat with webgl 1 and 2.
  7497. * You will need to pass the name of the uniform as well as the value.
  7498. */
  7499. updateVector3: (name: string, vector: Vector3) => void;
  7500. /**
  7501. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7502. * This is dynamic to allow compat with webgl 1 and 2.
  7503. * You will need to pass the name of the uniform as well as the value.
  7504. */
  7505. updateVector4: (name: string, vector: Vector4) => void;
  7506. /**
  7507. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7508. * This is dynamic to allow compat with webgl 1 and 2.
  7509. * You will need to pass the name of the uniform as well as the value.
  7510. */
  7511. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7512. /**
  7513. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7514. * This is dynamic to allow compat with webgl 1 and 2.
  7515. * You will need to pass the name of the uniform as well as the value.
  7516. */
  7517. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7518. /**
  7519. * Instantiates a new Uniform buffer objects.
  7520. *
  7521. * Handles blocks of uniform on the GPU.
  7522. *
  7523. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7524. *
  7525. * For more information, please refer to :
  7526. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7527. * @param engine Define the engine the buffer is associated with
  7528. * @param data Define the data contained in the buffer
  7529. * @param dynamic Define if the buffer is updatable
  7530. */
  7531. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7532. /**
  7533. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7534. * or just falling back on setUniformXXX calls.
  7535. */
  7536. get useUbo(): boolean;
  7537. /**
  7538. * Indicates if the WebGL underlying uniform buffer is in sync
  7539. * with the javascript cache data.
  7540. */
  7541. get isSync(): boolean;
  7542. /**
  7543. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7544. * Also, a dynamic UniformBuffer will disable cache verification and always
  7545. * update the underlying WebGL uniform buffer to the GPU.
  7546. * @returns if Dynamic, otherwise false
  7547. */
  7548. isDynamic(): boolean;
  7549. /**
  7550. * The data cache on JS side.
  7551. * @returns the underlying data as a float array
  7552. */
  7553. getData(): Float32Array;
  7554. /**
  7555. * The underlying WebGL Uniform buffer.
  7556. * @returns the webgl buffer
  7557. */
  7558. getBuffer(): Nullable<DataBuffer>;
  7559. /**
  7560. * std140 layout specifies how to align data within an UBO structure.
  7561. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7562. * for specs.
  7563. */
  7564. private _fillAlignment;
  7565. /**
  7566. * Adds an uniform in the buffer.
  7567. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7568. * for the layout to be correct !
  7569. * @param name Name of the uniform, as used in the uniform block in the shader.
  7570. * @param size Data size, or data directly.
  7571. */
  7572. addUniform(name: string, size: number | number[]): void;
  7573. /**
  7574. * Adds a Matrix 4x4 to the uniform buffer.
  7575. * @param name Name of the uniform, as used in the uniform block in the shader.
  7576. * @param mat A 4x4 matrix.
  7577. */
  7578. addMatrix(name: string, mat: Matrix): void;
  7579. /**
  7580. * Adds a vec2 to the uniform buffer.
  7581. * @param name Name of the uniform, as used in the uniform block in the shader.
  7582. * @param x Define the x component value of the vec2
  7583. * @param y Define the y component value of the vec2
  7584. */
  7585. addFloat2(name: string, x: number, y: number): void;
  7586. /**
  7587. * Adds a vec3 to the uniform buffer.
  7588. * @param name Name of the uniform, as used in the uniform block in the shader.
  7589. * @param x Define the x component value of the vec3
  7590. * @param y Define the y component value of the vec3
  7591. * @param z Define the z component value of the vec3
  7592. */
  7593. addFloat3(name: string, x: number, y: number, z: number): void;
  7594. /**
  7595. * Adds a vec3 to the uniform buffer.
  7596. * @param name Name of the uniform, as used in the uniform block in the shader.
  7597. * @param color Define the vec3 from a Color
  7598. */
  7599. addColor3(name: string, color: Color3): void;
  7600. /**
  7601. * Adds a vec4 to the uniform buffer.
  7602. * @param name Name of the uniform, as used in the uniform block in the shader.
  7603. * @param color Define the rgb components from a Color
  7604. * @param alpha Define the a component of the vec4
  7605. */
  7606. addColor4(name: string, color: Color3, alpha: number): void;
  7607. /**
  7608. * Adds a vec3 to the uniform buffer.
  7609. * @param name Name of the uniform, as used in the uniform block in the shader.
  7610. * @param vector Define the vec3 components from a Vector
  7611. */
  7612. addVector3(name: string, vector: Vector3): void;
  7613. /**
  7614. * Adds a Matrix 3x3 to the uniform buffer.
  7615. * @param name Name of the uniform, as used in the uniform block in the shader.
  7616. */
  7617. addMatrix3x3(name: string): void;
  7618. /**
  7619. * Adds a Matrix 2x2 to the uniform buffer.
  7620. * @param name Name of the uniform, as used in the uniform block in the shader.
  7621. */
  7622. addMatrix2x2(name: string): void;
  7623. /**
  7624. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7625. */
  7626. create(): void;
  7627. /** @hidden */
  7628. _rebuild(): void;
  7629. /**
  7630. * Updates the WebGL Uniform Buffer on the GPU.
  7631. * If the `dynamic` flag is set to true, no cache comparison is done.
  7632. * Otherwise, the buffer will be updated only if the cache differs.
  7633. */
  7634. update(): void;
  7635. /**
  7636. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7637. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7638. * @param data Define the flattened data
  7639. * @param size Define the size of the data.
  7640. */
  7641. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7642. private _valueCache;
  7643. private _cacheMatrix;
  7644. private _updateMatrix3x3ForUniform;
  7645. private _updateMatrix3x3ForEffect;
  7646. private _updateMatrix2x2ForEffect;
  7647. private _updateMatrix2x2ForUniform;
  7648. private _updateFloatForEffect;
  7649. private _updateFloatForUniform;
  7650. private _updateFloat2ForEffect;
  7651. private _updateFloat2ForUniform;
  7652. private _updateFloat3ForEffect;
  7653. private _updateFloat3ForUniform;
  7654. private _updateFloat4ForEffect;
  7655. private _updateFloat4ForUniform;
  7656. private _updateMatrixForEffect;
  7657. private _updateMatrixForUniform;
  7658. private _updateVector3ForEffect;
  7659. private _updateVector3ForUniform;
  7660. private _updateVector4ForEffect;
  7661. private _updateVector4ForUniform;
  7662. private _updateColor3ForEffect;
  7663. private _updateColor3ForUniform;
  7664. private _updateColor4ForEffect;
  7665. private _updateColor4ForUniform;
  7666. /**
  7667. * Sets a sampler uniform on the effect.
  7668. * @param name Define the name of the sampler.
  7669. * @param texture Define the texture to set in the sampler
  7670. */
  7671. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7672. /**
  7673. * Directly updates the value of the uniform in the cache AND on the GPU.
  7674. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7675. * @param data Define the flattened data
  7676. */
  7677. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7678. /**
  7679. * Binds this uniform buffer to an effect.
  7680. * @param effect Define the effect to bind the buffer to
  7681. * @param name Name of the uniform block in the shader.
  7682. */
  7683. bindToEffect(effect: Effect, name: string): void;
  7684. /**
  7685. * Disposes the uniform buffer.
  7686. */
  7687. dispose(): void;
  7688. }
  7689. }
  7690. declare module "babylonjs/Misc/iInspectable" {
  7691. /**
  7692. * Enum that determines the text-wrapping mode to use.
  7693. */
  7694. export enum InspectableType {
  7695. /**
  7696. * Checkbox for booleans
  7697. */
  7698. Checkbox = 0,
  7699. /**
  7700. * Sliders for numbers
  7701. */
  7702. Slider = 1,
  7703. /**
  7704. * Vector3
  7705. */
  7706. Vector3 = 2,
  7707. /**
  7708. * Quaternions
  7709. */
  7710. Quaternion = 3,
  7711. /**
  7712. * Color3
  7713. */
  7714. Color3 = 4,
  7715. /**
  7716. * String
  7717. */
  7718. String = 5
  7719. }
  7720. /**
  7721. * Interface used to define custom inspectable properties.
  7722. * This interface is used by the inspector to display custom property grids
  7723. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7724. */
  7725. export interface IInspectable {
  7726. /**
  7727. * Gets the label to display
  7728. */
  7729. label: string;
  7730. /**
  7731. * Gets the name of the property to edit
  7732. */
  7733. propertyName: string;
  7734. /**
  7735. * Gets the type of the editor to use
  7736. */
  7737. type: InspectableType;
  7738. /**
  7739. * Gets the minimum value of the property when using in "slider" mode
  7740. */
  7741. min?: number;
  7742. /**
  7743. * Gets the maximum value of the property when using in "slider" mode
  7744. */
  7745. max?: number;
  7746. /**
  7747. * Gets the setp to use when using in "slider" mode
  7748. */
  7749. step?: number;
  7750. }
  7751. }
  7752. declare module "babylonjs/Misc/timingTools" {
  7753. /**
  7754. * Class used to provide helper for timing
  7755. */
  7756. export class TimingTools {
  7757. /**
  7758. * Polyfill for setImmediate
  7759. * @param action defines the action to execute after the current execution block
  7760. */
  7761. static SetImmediate(action: () => void): void;
  7762. }
  7763. }
  7764. declare module "babylonjs/Misc/instantiationTools" {
  7765. /**
  7766. * Class used to enable instatition of objects by class name
  7767. */
  7768. export class InstantiationTools {
  7769. /**
  7770. * Use this object to register external classes like custom textures or material
  7771. * to allow the laoders to instantiate them
  7772. */
  7773. static RegisteredExternalClasses: {
  7774. [key: string]: Object;
  7775. };
  7776. /**
  7777. * Tries to instantiate a new object from a given class name
  7778. * @param className defines the class name to instantiate
  7779. * @returns the new object or null if the system was not able to do the instantiation
  7780. */
  7781. static Instantiate(className: string): any;
  7782. }
  7783. }
  7784. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7785. /**
  7786. * Define options used to create a depth texture
  7787. */
  7788. export class DepthTextureCreationOptions {
  7789. /** Specifies whether or not a stencil should be allocated in the texture */
  7790. generateStencil?: boolean;
  7791. /** Specifies whether or not bilinear filtering is enable on the texture */
  7792. bilinearFiltering?: boolean;
  7793. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7794. comparisonFunction?: number;
  7795. /** Specifies if the created texture is a cube texture */
  7796. isCube?: boolean;
  7797. }
  7798. }
  7799. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7800. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7801. import { Nullable } from "babylonjs/types";
  7802. import { Scene } from "babylonjs/scene";
  7803. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7804. module "babylonjs/Engines/thinEngine" {
  7805. interface ThinEngine {
  7806. /**
  7807. * Creates a depth stencil cube texture.
  7808. * This is only available in WebGL 2.
  7809. * @param size The size of face edge in the cube texture.
  7810. * @param options The options defining the cube texture.
  7811. * @returns The cube texture
  7812. */
  7813. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7814. /**
  7815. * Creates a cube texture
  7816. * @param rootUrl defines the url where the files to load is located
  7817. * @param scene defines the current scene
  7818. * @param files defines the list of files to load (1 per face)
  7819. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7820. * @param onLoad defines an optional callback raised when the texture is loaded
  7821. * @param onError defines an optional callback raised if there is an issue to load the texture
  7822. * @param format defines the format of the data
  7823. * @param forcedExtension defines the extension to use to pick the right loader
  7824. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7825. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7826. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7827. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7828. * @returns the cube texture as an InternalTexture
  7829. */
  7830. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>): InternalTexture;
  7831. /**
  7832. * Creates a cube texture
  7833. * @param rootUrl defines the url where the files to load is located
  7834. * @param scene defines the current scene
  7835. * @param files defines the list of files to load (1 per face)
  7836. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7837. * @param onLoad defines an optional callback raised when the texture is loaded
  7838. * @param onError defines an optional callback raised if there is an issue to load the texture
  7839. * @param format defines the format of the data
  7840. * @param forcedExtension defines the extension to use to pick the right loader
  7841. * @returns the cube texture as an InternalTexture
  7842. */
  7843. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any): InternalTexture;
  7844. /**
  7845. * Creates a cube texture
  7846. * @param rootUrl defines the url where the files to load is located
  7847. * @param scene defines the current scene
  7848. * @param files defines the list of files to load (1 per face)
  7849. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7850. * @param onLoad defines an optional callback raised when the texture is loaded
  7851. * @param onError defines an optional callback raised if there is an issue to load the texture
  7852. * @param format defines the format of the data
  7853. * @param forcedExtension defines the extension to use to pick the right loader
  7854. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7855. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7856. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7857. * @returns the cube texture as an InternalTexture
  7858. */
  7859. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number): InternalTexture;
  7860. /** @hidden */
  7861. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7862. /** @hidden */
  7863. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7864. /** @hidden */
  7865. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7866. /** @hidden */
  7867. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7868. /**
  7869. * @hidden
  7870. */
  7871. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7872. }
  7873. }
  7874. }
  7875. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7876. import { Nullable } from "babylonjs/types";
  7877. import { Scene } from "babylonjs/scene";
  7878. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7879. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7880. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7881. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7882. import { Observable } from "babylonjs/Misc/observable";
  7883. /**
  7884. * Class for creating a cube texture
  7885. */
  7886. export class CubeTexture extends BaseTexture {
  7887. private _delayedOnLoad;
  7888. /**
  7889. * Observable triggered once the texture has been loaded.
  7890. */
  7891. onLoadObservable: Observable<CubeTexture>;
  7892. /**
  7893. * The url of the texture
  7894. */
  7895. url: string;
  7896. /**
  7897. * Gets or sets the center of the bounding box associated with the cube texture.
  7898. * It must define where the camera used to render the texture was set
  7899. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7900. */
  7901. boundingBoxPosition: Vector3;
  7902. private _boundingBoxSize;
  7903. /**
  7904. * Gets or sets the size of the bounding box associated with the cube texture
  7905. * When defined, the cubemap will switch to local mode
  7906. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7907. * @example https://www.babylonjs-playground.com/#RNASML
  7908. */
  7909. set boundingBoxSize(value: Vector3);
  7910. /**
  7911. * Returns the bounding box size
  7912. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7913. */
  7914. get boundingBoxSize(): Vector3;
  7915. protected _rotationY: number;
  7916. /**
  7917. * Sets texture matrix rotation angle around Y axis in radians.
  7918. */
  7919. set rotationY(value: number);
  7920. /**
  7921. * Gets texture matrix rotation angle around Y axis radians.
  7922. */
  7923. get rotationY(): number;
  7924. /**
  7925. * Are mip maps generated for this texture or not.
  7926. */
  7927. get noMipmap(): boolean;
  7928. private _noMipmap;
  7929. private _files;
  7930. protected _forcedExtension: Nullable<string>;
  7931. private _extensions;
  7932. private _textureMatrix;
  7933. private _format;
  7934. private _createPolynomials;
  7935. /**
  7936. * Creates a cube texture from an array of image urls
  7937. * @param files defines an array of image urls
  7938. * @param scene defines the hosting scene
  7939. * @param noMipmap specifies if mip maps are not used
  7940. * @returns a cube texture
  7941. */
  7942. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7943. /**
  7944. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7945. * @param url defines the url of the prefiltered texture
  7946. * @param scene defines the scene the texture is attached to
  7947. * @param forcedExtension defines the extension of the file if different from the url
  7948. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7949. * @return the prefiltered texture
  7950. */
  7951. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7952. /**
  7953. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7954. * as prefiltered data.
  7955. * @param rootUrl defines the url of the texture or the root name of the six images
  7956. * @param null defines the scene or engine the texture is attached to
  7957. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7958. * @param noMipmap defines if mipmaps should be created or not
  7959. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7960. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7961. * @param onError defines a callback triggered in case of error during load
  7962. * @param format defines the internal format to use for the texture once loaded
  7963. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7964. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7965. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7966. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7967. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7968. * @return the cube texture
  7969. */
  7970. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  7971. /**
  7972. * Get the current class name of the texture useful for serialization or dynamic coding.
  7973. * @returns "CubeTexture"
  7974. */
  7975. getClassName(): string;
  7976. /**
  7977. * Update the url (and optional buffer) of this texture if url was null during construction.
  7978. * @param url the url of the texture
  7979. * @param forcedExtension defines the extension to use
  7980. * @param onLoad callback called when the texture is loaded (defaults to null)
  7981. * @param prefiltered Defines whether the updated texture is prefiltered or not
  7982. */
  7983. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  7984. /**
  7985. * Delays loading of the cube texture
  7986. * @param forcedExtension defines the extension to use
  7987. */
  7988. delayLoad(forcedExtension?: string): void;
  7989. /**
  7990. * Returns the reflection texture matrix
  7991. * @returns the reflection texture matrix
  7992. */
  7993. getReflectionTextureMatrix(): Matrix;
  7994. /**
  7995. * Sets the reflection texture matrix
  7996. * @param value Reflection texture matrix
  7997. */
  7998. setReflectionTextureMatrix(value: Matrix): void;
  7999. /**
  8000. * Parses text to create a cube texture
  8001. * @param parsedTexture define the serialized text to read from
  8002. * @param scene defines the hosting scene
  8003. * @param rootUrl defines the root url of the cube texture
  8004. * @returns a cube texture
  8005. */
  8006. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  8007. /**
  8008. * Makes a clone, or deep copy, of the cube texture
  8009. * @returns a new cube texture
  8010. */
  8011. clone(): CubeTexture;
  8012. }
  8013. }
  8014. declare module "babylonjs/Materials/materialDefines" {
  8015. /**
  8016. * Manages the defines for the Material
  8017. */
  8018. export class MaterialDefines {
  8019. /** @hidden */
  8020. protected _keys: string[];
  8021. private _isDirty;
  8022. /** @hidden */
  8023. _renderId: number;
  8024. /** @hidden */
  8025. _areLightsDirty: boolean;
  8026. /** @hidden */
  8027. _areLightsDisposed: boolean;
  8028. /** @hidden */
  8029. _areAttributesDirty: boolean;
  8030. /** @hidden */
  8031. _areTexturesDirty: boolean;
  8032. /** @hidden */
  8033. _areFresnelDirty: boolean;
  8034. /** @hidden */
  8035. _areMiscDirty: boolean;
  8036. /** @hidden */
  8037. _areImageProcessingDirty: boolean;
  8038. /** @hidden */
  8039. _normals: boolean;
  8040. /** @hidden */
  8041. _uvs: boolean;
  8042. /** @hidden */
  8043. _needNormals: boolean;
  8044. /** @hidden */
  8045. _needUVs: boolean;
  8046. [id: string]: any;
  8047. /**
  8048. * Specifies if the material needs to be re-calculated
  8049. */
  8050. get isDirty(): boolean;
  8051. /**
  8052. * Marks the material to indicate that it has been re-calculated
  8053. */
  8054. markAsProcessed(): void;
  8055. /**
  8056. * Marks the material to indicate that it needs to be re-calculated
  8057. */
  8058. markAsUnprocessed(): void;
  8059. /**
  8060. * Marks the material to indicate all of its defines need to be re-calculated
  8061. */
  8062. markAllAsDirty(): void;
  8063. /**
  8064. * Marks the material to indicate that image processing needs to be re-calculated
  8065. */
  8066. markAsImageProcessingDirty(): void;
  8067. /**
  8068. * Marks the material to indicate the lights need to be re-calculated
  8069. * @param disposed Defines whether the light is dirty due to dispose or not
  8070. */
  8071. markAsLightDirty(disposed?: boolean): void;
  8072. /**
  8073. * Marks the attribute state as changed
  8074. */
  8075. markAsAttributesDirty(): void;
  8076. /**
  8077. * Marks the texture state as changed
  8078. */
  8079. markAsTexturesDirty(): void;
  8080. /**
  8081. * Marks the fresnel state as changed
  8082. */
  8083. markAsFresnelDirty(): void;
  8084. /**
  8085. * Marks the misc state as changed
  8086. */
  8087. markAsMiscDirty(): void;
  8088. /**
  8089. * Rebuilds the material defines
  8090. */
  8091. rebuild(): void;
  8092. /**
  8093. * Specifies if two material defines are equal
  8094. * @param other - A material define instance to compare to
  8095. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8096. */
  8097. isEqual(other: MaterialDefines): boolean;
  8098. /**
  8099. * Clones this instance's defines to another instance
  8100. * @param other - material defines to clone values to
  8101. */
  8102. cloneTo(other: MaterialDefines): void;
  8103. /**
  8104. * Resets the material define values
  8105. */
  8106. reset(): void;
  8107. /**
  8108. * Converts the material define values to a string
  8109. * @returns - String of material define information
  8110. */
  8111. toString(): string;
  8112. }
  8113. }
  8114. declare module "babylonjs/Materials/colorCurves" {
  8115. import { Effect } from "babylonjs/Materials/effect";
  8116. /**
  8117. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8118. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8119. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  8120. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8121. */
  8122. export class ColorCurves {
  8123. private _dirty;
  8124. private _tempColor;
  8125. private _globalCurve;
  8126. private _highlightsCurve;
  8127. private _midtonesCurve;
  8128. private _shadowsCurve;
  8129. private _positiveCurve;
  8130. private _negativeCurve;
  8131. private _globalHue;
  8132. private _globalDensity;
  8133. private _globalSaturation;
  8134. private _globalExposure;
  8135. /**
  8136. * Gets the global Hue value.
  8137. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8138. */
  8139. get globalHue(): number;
  8140. /**
  8141. * Sets the global Hue value.
  8142. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8143. */
  8144. set globalHue(value: number);
  8145. /**
  8146. * Gets the global Density value.
  8147. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8148. * Values less than zero provide a filter of opposite hue.
  8149. */
  8150. get globalDensity(): number;
  8151. /**
  8152. * Sets the global Density value.
  8153. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8154. * Values less than zero provide a filter of opposite hue.
  8155. */
  8156. set globalDensity(value: number);
  8157. /**
  8158. * Gets the global Saturation value.
  8159. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8160. */
  8161. get globalSaturation(): number;
  8162. /**
  8163. * Sets the global Saturation value.
  8164. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8165. */
  8166. set globalSaturation(value: number);
  8167. /**
  8168. * Gets the global Exposure value.
  8169. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8170. */
  8171. get globalExposure(): number;
  8172. /**
  8173. * Sets the global Exposure value.
  8174. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8175. */
  8176. set globalExposure(value: number);
  8177. private _highlightsHue;
  8178. private _highlightsDensity;
  8179. private _highlightsSaturation;
  8180. private _highlightsExposure;
  8181. /**
  8182. * Gets the highlights Hue value.
  8183. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8184. */
  8185. get highlightsHue(): number;
  8186. /**
  8187. * Sets the highlights Hue value.
  8188. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8189. */
  8190. set highlightsHue(value: number);
  8191. /**
  8192. * Gets the highlights Density value.
  8193. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8194. * Values less than zero provide a filter of opposite hue.
  8195. */
  8196. get highlightsDensity(): number;
  8197. /**
  8198. * Sets the highlights Density value.
  8199. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8200. * Values less than zero provide a filter of opposite hue.
  8201. */
  8202. set highlightsDensity(value: number);
  8203. /**
  8204. * Gets the highlights Saturation value.
  8205. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8206. */
  8207. get highlightsSaturation(): number;
  8208. /**
  8209. * Sets the highlights Saturation value.
  8210. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8211. */
  8212. set highlightsSaturation(value: number);
  8213. /**
  8214. * Gets the highlights Exposure value.
  8215. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8216. */
  8217. get highlightsExposure(): number;
  8218. /**
  8219. * Sets the highlights Exposure value.
  8220. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8221. */
  8222. set highlightsExposure(value: number);
  8223. private _midtonesHue;
  8224. private _midtonesDensity;
  8225. private _midtonesSaturation;
  8226. private _midtonesExposure;
  8227. /**
  8228. * Gets the midtones Hue value.
  8229. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8230. */
  8231. get midtonesHue(): number;
  8232. /**
  8233. * Sets the midtones Hue value.
  8234. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8235. */
  8236. set midtonesHue(value: number);
  8237. /**
  8238. * Gets the midtones Density value.
  8239. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8240. * Values less than zero provide a filter of opposite hue.
  8241. */
  8242. get midtonesDensity(): number;
  8243. /**
  8244. * Sets the midtones Density value.
  8245. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8246. * Values less than zero provide a filter of opposite hue.
  8247. */
  8248. set midtonesDensity(value: number);
  8249. /**
  8250. * Gets the midtones Saturation value.
  8251. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8252. */
  8253. get midtonesSaturation(): number;
  8254. /**
  8255. * Sets the midtones Saturation value.
  8256. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8257. */
  8258. set midtonesSaturation(value: number);
  8259. /**
  8260. * Gets the midtones Exposure value.
  8261. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8262. */
  8263. get midtonesExposure(): number;
  8264. /**
  8265. * Sets the midtones Exposure value.
  8266. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8267. */
  8268. set midtonesExposure(value: number);
  8269. private _shadowsHue;
  8270. private _shadowsDensity;
  8271. private _shadowsSaturation;
  8272. private _shadowsExposure;
  8273. /**
  8274. * Gets the shadows Hue value.
  8275. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8276. */
  8277. get shadowsHue(): number;
  8278. /**
  8279. * Sets the shadows Hue value.
  8280. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8281. */
  8282. set shadowsHue(value: number);
  8283. /**
  8284. * Gets the shadows Density value.
  8285. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8286. * Values less than zero provide a filter of opposite hue.
  8287. */
  8288. get shadowsDensity(): number;
  8289. /**
  8290. * Sets the shadows Density value.
  8291. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8292. * Values less than zero provide a filter of opposite hue.
  8293. */
  8294. set shadowsDensity(value: number);
  8295. /**
  8296. * Gets the shadows Saturation value.
  8297. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8298. */
  8299. get shadowsSaturation(): number;
  8300. /**
  8301. * Sets the shadows Saturation value.
  8302. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8303. */
  8304. set shadowsSaturation(value: number);
  8305. /**
  8306. * Gets the shadows Exposure value.
  8307. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8308. */
  8309. get shadowsExposure(): number;
  8310. /**
  8311. * Sets the shadows Exposure value.
  8312. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8313. */
  8314. set shadowsExposure(value: number);
  8315. /**
  8316. * Returns the class name
  8317. * @returns The class name
  8318. */
  8319. getClassName(): string;
  8320. /**
  8321. * Binds the color curves to the shader.
  8322. * @param colorCurves The color curve to bind
  8323. * @param effect The effect to bind to
  8324. * @param positiveUniform The positive uniform shader parameter
  8325. * @param neutralUniform The neutral uniform shader parameter
  8326. * @param negativeUniform The negative uniform shader parameter
  8327. */
  8328. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8329. /**
  8330. * Prepare the list of uniforms associated with the ColorCurves effects.
  8331. * @param uniformsList The list of uniforms used in the effect
  8332. */
  8333. static PrepareUniforms(uniformsList: string[]): void;
  8334. /**
  8335. * Returns color grading data based on a hue, density, saturation and exposure value.
  8336. * @param filterHue The hue of the color filter.
  8337. * @param filterDensity The density of the color filter.
  8338. * @param saturation The saturation.
  8339. * @param exposure The exposure.
  8340. * @param result The result data container.
  8341. */
  8342. private getColorGradingDataToRef;
  8343. /**
  8344. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8345. * @param value The input slider value in range [-100,100].
  8346. * @returns Adjusted value.
  8347. */
  8348. private static applyColorGradingSliderNonlinear;
  8349. /**
  8350. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8351. * @param hue The hue (H) input.
  8352. * @param saturation The saturation (S) input.
  8353. * @param brightness The brightness (B) input.
  8354. * @result An RGBA color represented as Vector4.
  8355. */
  8356. private static fromHSBToRef;
  8357. /**
  8358. * Returns a value clamped between min and max
  8359. * @param value The value to clamp
  8360. * @param min The minimum of value
  8361. * @param max The maximum of value
  8362. * @returns The clamped value.
  8363. */
  8364. private static clamp;
  8365. /**
  8366. * Clones the current color curve instance.
  8367. * @return The cloned curves
  8368. */
  8369. clone(): ColorCurves;
  8370. /**
  8371. * Serializes the current color curve instance to a json representation.
  8372. * @return a JSON representation
  8373. */
  8374. serialize(): any;
  8375. /**
  8376. * Parses the color curve from a json representation.
  8377. * @param source the JSON source to parse
  8378. * @return The parsed curves
  8379. */
  8380. static Parse(source: any): ColorCurves;
  8381. }
  8382. }
  8383. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8384. import { Observable } from "babylonjs/Misc/observable";
  8385. import { Nullable } from "babylonjs/types";
  8386. import { Color4 } from "babylonjs/Maths/math.color";
  8387. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8388. import { Effect } from "babylonjs/Materials/effect";
  8389. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8390. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8391. /**
  8392. * Interface to follow in your material defines to integrate easily the
  8393. * Image proccessing functions.
  8394. * @hidden
  8395. */
  8396. export interface IImageProcessingConfigurationDefines {
  8397. IMAGEPROCESSING: boolean;
  8398. VIGNETTE: boolean;
  8399. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8400. VIGNETTEBLENDMODEOPAQUE: boolean;
  8401. TONEMAPPING: boolean;
  8402. TONEMAPPING_ACES: boolean;
  8403. CONTRAST: boolean;
  8404. EXPOSURE: boolean;
  8405. COLORCURVES: boolean;
  8406. COLORGRADING: boolean;
  8407. COLORGRADING3D: boolean;
  8408. SAMPLER3DGREENDEPTH: boolean;
  8409. SAMPLER3DBGRMAP: boolean;
  8410. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8411. }
  8412. /**
  8413. * @hidden
  8414. */
  8415. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8416. IMAGEPROCESSING: boolean;
  8417. VIGNETTE: boolean;
  8418. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8419. VIGNETTEBLENDMODEOPAQUE: boolean;
  8420. TONEMAPPING: boolean;
  8421. TONEMAPPING_ACES: boolean;
  8422. CONTRAST: boolean;
  8423. COLORCURVES: boolean;
  8424. COLORGRADING: boolean;
  8425. COLORGRADING3D: boolean;
  8426. SAMPLER3DGREENDEPTH: boolean;
  8427. SAMPLER3DBGRMAP: boolean;
  8428. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8429. EXPOSURE: boolean;
  8430. constructor();
  8431. }
  8432. /**
  8433. * This groups together the common properties used for image processing either in direct forward pass
  8434. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8435. * or not.
  8436. */
  8437. export class ImageProcessingConfiguration {
  8438. /**
  8439. * Default tone mapping applied in BabylonJS.
  8440. */
  8441. static readonly TONEMAPPING_STANDARD: number;
  8442. /**
  8443. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8444. * to other engines rendering to increase portability.
  8445. */
  8446. static readonly TONEMAPPING_ACES: number;
  8447. /**
  8448. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8449. */
  8450. colorCurves: Nullable<ColorCurves>;
  8451. private _colorCurvesEnabled;
  8452. /**
  8453. * Gets wether the color curves effect is enabled.
  8454. */
  8455. get colorCurvesEnabled(): boolean;
  8456. /**
  8457. * Sets wether the color curves effect is enabled.
  8458. */
  8459. set colorCurvesEnabled(value: boolean);
  8460. private _colorGradingTexture;
  8461. /**
  8462. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8463. */
  8464. get colorGradingTexture(): Nullable<BaseTexture>;
  8465. /**
  8466. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8467. */
  8468. set colorGradingTexture(value: Nullable<BaseTexture>);
  8469. private _colorGradingEnabled;
  8470. /**
  8471. * Gets wether the color grading effect is enabled.
  8472. */
  8473. get colorGradingEnabled(): boolean;
  8474. /**
  8475. * Sets wether the color grading effect is enabled.
  8476. */
  8477. set colorGradingEnabled(value: boolean);
  8478. private _colorGradingWithGreenDepth;
  8479. /**
  8480. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8481. */
  8482. get colorGradingWithGreenDepth(): boolean;
  8483. /**
  8484. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8485. */
  8486. set colorGradingWithGreenDepth(value: boolean);
  8487. private _colorGradingBGR;
  8488. /**
  8489. * Gets wether the color grading texture contains BGR values.
  8490. */
  8491. get colorGradingBGR(): boolean;
  8492. /**
  8493. * Sets wether the color grading texture contains BGR values.
  8494. */
  8495. set colorGradingBGR(value: boolean);
  8496. /** @hidden */
  8497. _exposure: number;
  8498. /**
  8499. * Gets the Exposure used in the effect.
  8500. */
  8501. get exposure(): number;
  8502. /**
  8503. * Sets the Exposure used in the effect.
  8504. */
  8505. set exposure(value: number);
  8506. private _toneMappingEnabled;
  8507. /**
  8508. * Gets wether the tone mapping effect is enabled.
  8509. */
  8510. get toneMappingEnabled(): boolean;
  8511. /**
  8512. * Sets wether the tone mapping effect is enabled.
  8513. */
  8514. set toneMappingEnabled(value: boolean);
  8515. private _toneMappingType;
  8516. /**
  8517. * Gets the type of tone mapping effect.
  8518. */
  8519. get toneMappingType(): number;
  8520. /**
  8521. * Sets the type of tone mapping effect used in BabylonJS.
  8522. */
  8523. set toneMappingType(value: number);
  8524. protected _contrast: number;
  8525. /**
  8526. * Gets the contrast used in the effect.
  8527. */
  8528. get contrast(): number;
  8529. /**
  8530. * Sets the contrast used in the effect.
  8531. */
  8532. set contrast(value: number);
  8533. /**
  8534. * Vignette stretch size.
  8535. */
  8536. vignetteStretch: number;
  8537. /**
  8538. * Vignette centre X Offset.
  8539. */
  8540. vignetteCentreX: number;
  8541. /**
  8542. * Vignette centre Y Offset.
  8543. */
  8544. vignetteCentreY: number;
  8545. /**
  8546. * Vignette weight or intensity of the vignette effect.
  8547. */
  8548. vignetteWeight: number;
  8549. /**
  8550. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8551. * if vignetteEnabled is set to true.
  8552. */
  8553. vignetteColor: Color4;
  8554. /**
  8555. * Camera field of view used by the Vignette effect.
  8556. */
  8557. vignetteCameraFov: number;
  8558. private _vignetteBlendMode;
  8559. /**
  8560. * Gets the vignette blend mode allowing different kind of effect.
  8561. */
  8562. get vignetteBlendMode(): number;
  8563. /**
  8564. * Sets the vignette blend mode allowing different kind of effect.
  8565. */
  8566. set vignetteBlendMode(value: number);
  8567. private _vignetteEnabled;
  8568. /**
  8569. * Gets wether the vignette effect is enabled.
  8570. */
  8571. get vignetteEnabled(): boolean;
  8572. /**
  8573. * Sets wether the vignette effect is enabled.
  8574. */
  8575. set vignetteEnabled(value: boolean);
  8576. private _applyByPostProcess;
  8577. /**
  8578. * Gets wether the image processing is applied through a post process or not.
  8579. */
  8580. get applyByPostProcess(): boolean;
  8581. /**
  8582. * Sets wether the image processing is applied through a post process or not.
  8583. */
  8584. set applyByPostProcess(value: boolean);
  8585. private _isEnabled;
  8586. /**
  8587. * Gets wether the image processing is enabled or not.
  8588. */
  8589. get isEnabled(): boolean;
  8590. /**
  8591. * Sets wether the image processing is enabled or not.
  8592. */
  8593. set isEnabled(value: boolean);
  8594. /**
  8595. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8596. */
  8597. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8598. /**
  8599. * Method called each time the image processing information changes requires to recompile the effect.
  8600. */
  8601. protected _updateParameters(): void;
  8602. /**
  8603. * Gets the current class name.
  8604. * @return "ImageProcessingConfiguration"
  8605. */
  8606. getClassName(): string;
  8607. /**
  8608. * Prepare the list of uniforms associated with the Image Processing effects.
  8609. * @param uniforms The list of uniforms used in the effect
  8610. * @param defines the list of defines currently in use
  8611. */
  8612. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8613. /**
  8614. * Prepare the list of samplers associated with the Image Processing effects.
  8615. * @param samplersList The list of uniforms used in the effect
  8616. * @param defines the list of defines currently in use
  8617. */
  8618. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8619. /**
  8620. * Prepare the list of defines associated to the shader.
  8621. * @param defines the list of defines to complete
  8622. * @param forPostProcess Define if we are currently in post process mode or not
  8623. */
  8624. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8625. /**
  8626. * Returns true if all the image processing information are ready.
  8627. * @returns True if ready, otherwise, false
  8628. */
  8629. isReady(): boolean;
  8630. /**
  8631. * Binds the image processing to the shader.
  8632. * @param effect The effect to bind to
  8633. * @param overrideAspectRatio Override the aspect ratio of the effect
  8634. */
  8635. bind(effect: Effect, overrideAspectRatio?: number): void;
  8636. /**
  8637. * Clones the current image processing instance.
  8638. * @return The cloned image processing
  8639. */
  8640. clone(): ImageProcessingConfiguration;
  8641. /**
  8642. * Serializes the current image processing instance to a json representation.
  8643. * @return a JSON representation
  8644. */
  8645. serialize(): any;
  8646. /**
  8647. * Parses the image processing from a json representation.
  8648. * @param source the JSON source to parse
  8649. * @return The parsed image processing
  8650. */
  8651. static Parse(source: any): ImageProcessingConfiguration;
  8652. private static _VIGNETTEMODE_MULTIPLY;
  8653. private static _VIGNETTEMODE_OPAQUE;
  8654. /**
  8655. * Used to apply the vignette as a mix with the pixel color.
  8656. */
  8657. static get VIGNETTEMODE_MULTIPLY(): number;
  8658. /**
  8659. * Used to apply the vignette as a replacement of the pixel color.
  8660. */
  8661. static get VIGNETTEMODE_OPAQUE(): number;
  8662. }
  8663. }
  8664. declare module "babylonjs/Shaders/postprocess.vertex" {
  8665. /** @hidden */
  8666. export var postprocessVertexShader: {
  8667. name: string;
  8668. shader: string;
  8669. };
  8670. }
  8671. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8672. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8673. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8674. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8675. module "babylonjs/Engines/thinEngine" {
  8676. interface ThinEngine {
  8677. /**
  8678. * Creates a new render target texture
  8679. * @param size defines the size of the texture
  8680. * @param options defines the options used to create the texture
  8681. * @returns a new render target texture stored in an InternalTexture
  8682. */
  8683. createRenderTargetTexture(size: number | {
  8684. width: number;
  8685. height: number;
  8686. layers?: number;
  8687. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8688. /**
  8689. * Creates a depth stencil texture.
  8690. * This is only available in WebGL 2 or with the depth texture extension available.
  8691. * @param size The size of face edge in the texture.
  8692. * @param options The options defining the texture.
  8693. * @returns The texture
  8694. */
  8695. createDepthStencilTexture(size: number | {
  8696. width: number;
  8697. height: number;
  8698. layers?: number;
  8699. }, options: DepthTextureCreationOptions): InternalTexture;
  8700. /** @hidden */
  8701. _createDepthStencilTexture(size: number | {
  8702. width: number;
  8703. height: number;
  8704. layers?: number;
  8705. }, options: DepthTextureCreationOptions): InternalTexture;
  8706. }
  8707. }
  8708. }
  8709. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8710. /**
  8711. * Defines the kind of connection point for node based material
  8712. */
  8713. export enum NodeMaterialBlockConnectionPointTypes {
  8714. /** Float */
  8715. Float = 1,
  8716. /** Int */
  8717. Int = 2,
  8718. /** Vector2 */
  8719. Vector2 = 4,
  8720. /** Vector3 */
  8721. Vector3 = 8,
  8722. /** Vector4 */
  8723. Vector4 = 16,
  8724. /** Color3 */
  8725. Color3 = 32,
  8726. /** Color4 */
  8727. Color4 = 64,
  8728. /** Matrix */
  8729. Matrix = 128,
  8730. /** Custom object */
  8731. Object = 256,
  8732. /** Detect type based on connection */
  8733. AutoDetect = 1024,
  8734. /** Output type that will be defined by input type */
  8735. BasedOnInput = 2048
  8736. }
  8737. }
  8738. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8739. /**
  8740. * Enum used to define the target of a block
  8741. */
  8742. export enum NodeMaterialBlockTargets {
  8743. /** Vertex shader */
  8744. Vertex = 1,
  8745. /** Fragment shader */
  8746. Fragment = 2,
  8747. /** Neutral */
  8748. Neutral = 4,
  8749. /** Vertex and Fragment */
  8750. VertexAndFragment = 3
  8751. }
  8752. }
  8753. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8754. /**
  8755. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8756. */
  8757. export enum NodeMaterialBlockConnectionPointMode {
  8758. /** Value is an uniform */
  8759. Uniform = 0,
  8760. /** Value is a mesh attribute */
  8761. Attribute = 1,
  8762. /** Value is a varying between vertex and fragment shaders */
  8763. Varying = 2,
  8764. /** Mode is undefined */
  8765. Undefined = 3
  8766. }
  8767. }
  8768. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8769. /**
  8770. * Enum used to define system values e.g. values automatically provided by the system
  8771. */
  8772. export enum NodeMaterialSystemValues {
  8773. /** World */
  8774. World = 1,
  8775. /** View */
  8776. View = 2,
  8777. /** Projection */
  8778. Projection = 3,
  8779. /** ViewProjection */
  8780. ViewProjection = 4,
  8781. /** WorldView */
  8782. WorldView = 5,
  8783. /** WorldViewProjection */
  8784. WorldViewProjection = 6,
  8785. /** CameraPosition */
  8786. CameraPosition = 7,
  8787. /** Fog Color */
  8788. FogColor = 8,
  8789. /** Delta time */
  8790. DeltaTime = 9
  8791. }
  8792. }
  8793. declare module "babylonjs/Maths/math.axis" {
  8794. import { Vector3 } from "babylonjs/Maths/math.vector";
  8795. /** Defines supported spaces */
  8796. export enum Space {
  8797. /** Local (object) space */
  8798. LOCAL = 0,
  8799. /** World space */
  8800. WORLD = 1,
  8801. /** Bone space */
  8802. BONE = 2
  8803. }
  8804. /** Defines the 3 main axes */
  8805. export class Axis {
  8806. /** X axis */
  8807. static X: Vector3;
  8808. /** Y axis */
  8809. static Y: Vector3;
  8810. /** Z axis */
  8811. static Z: Vector3;
  8812. }
  8813. }
  8814. declare module "babylonjs/Maths/math.frustum" {
  8815. import { Matrix } from "babylonjs/Maths/math.vector";
  8816. import { DeepImmutable } from "babylonjs/types";
  8817. import { Plane } from "babylonjs/Maths/math.plane";
  8818. /**
  8819. * Represents a camera frustum
  8820. */
  8821. export class Frustum {
  8822. /**
  8823. * Gets the planes representing the frustum
  8824. * @param transform matrix to be applied to the returned planes
  8825. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8826. */
  8827. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8828. /**
  8829. * Gets the near frustum plane transformed by the transform matrix
  8830. * @param transform transformation matrix to be applied to the resulting frustum plane
  8831. * @param frustumPlane the resuling frustum plane
  8832. */
  8833. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8834. /**
  8835. * Gets the far frustum plane transformed by the transform matrix
  8836. * @param transform transformation matrix to be applied to the resulting frustum plane
  8837. * @param frustumPlane the resuling frustum plane
  8838. */
  8839. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8840. /**
  8841. * Gets the left frustum plane transformed by the transform matrix
  8842. * @param transform transformation matrix to be applied to the resulting frustum plane
  8843. * @param frustumPlane the resuling frustum plane
  8844. */
  8845. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8846. /**
  8847. * Gets the right frustum plane transformed by the transform matrix
  8848. * @param transform transformation matrix to be applied to the resulting frustum plane
  8849. * @param frustumPlane the resuling frustum plane
  8850. */
  8851. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8852. /**
  8853. * Gets the top frustum plane transformed by the transform matrix
  8854. * @param transform transformation matrix to be applied to the resulting frustum plane
  8855. * @param frustumPlane the resuling frustum plane
  8856. */
  8857. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8858. /**
  8859. * Gets the bottom frustum plane transformed by the transform matrix
  8860. * @param transform transformation matrix to be applied to the resulting frustum plane
  8861. * @param frustumPlane the resuling frustum plane
  8862. */
  8863. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8864. /**
  8865. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8866. * @param transform transformation matrix to be applied to the resulting frustum planes
  8867. * @param frustumPlanes the resuling frustum planes
  8868. */
  8869. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8870. }
  8871. }
  8872. declare module "babylonjs/Maths/math.size" {
  8873. /**
  8874. * Interface for the size containing width and height
  8875. */
  8876. export interface ISize {
  8877. /**
  8878. * Width
  8879. */
  8880. width: number;
  8881. /**
  8882. * Heighht
  8883. */
  8884. height: number;
  8885. }
  8886. /**
  8887. * Size containing widht and height
  8888. */
  8889. export class Size implements ISize {
  8890. /**
  8891. * Width
  8892. */
  8893. width: number;
  8894. /**
  8895. * Height
  8896. */
  8897. height: number;
  8898. /**
  8899. * Creates a Size object from the given width and height (floats).
  8900. * @param width width of the new size
  8901. * @param height height of the new size
  8902. */
  8903. constructor(width: number, height: number);
  8904. /**
  8905. * Returns a string with the Size width and height
  8906. * @returns a string with the Size width and height
  8907. */
  8908. toString(): string;
  8909. /**
  8910. * "Size"
  8911. * @returns the string "Size"
  8912. */
  8913. getClassName(): string;
  8914. /**
  8915. * Returns the Size hash code.
  8916. * @returns a hash code for a unique width and height
  8917. */
  8918. getHashCode(): number;
  8919. /**
  8920. * Updates the current size from the given one.
  8921. * @param src the given size
  8922. */
  8923. copyFrom(src: Size): void;
  8924. /**
  8925. * Updates in place the current Size from the given floats.
  8926. * @param width width of the new size
  8927. * @param height height of the new size
  8928. * @returns the updated Size.
  8929. */
  8930. copyFromFloats(width: number, height: number): Size;
  8931. /**
  8932. * Updates in place the current Size from the given floats.
  8933. * @param width width to set
  8934. * @param height height to set
  8935. * @returns the updated Size.
  8936. */
  8937. set(width: number, height: number): Size;
  8938. /**
  8939. * Multiplies the width and height by numbers
  8940. * @param w factor to multiple the width by
  8941. * @param h factor to multiple the height by
  8942. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8943. */
  8944. multiplyByFloats(w: number, h: number): Size;
  8945. /**
  8946. * Clones the size
  8947. * @returns a new Size copied from the given one.
  8948. */
  8949. clone(): Size;
  8950. /**
  8951. * True if the current Size and the given one width and height are strictly equal.
  8952. * @param other the other size to compare against
  8953. * @returns True if the current Size and the given one width and height are strictly equal.
  8954. */
  8955. equals(other: Size): boolean;
  8956. /**
  8957. * The surface of the Size : width * height (float).
  8958. */
  8959. get surface(): number;
  8960. /**
  8961. * Create a new size of zero
  8962. * @returns a new Size set to (0.0, 0.0)
  8963. */
  8964. static Zero(): Size;
  8965. /**
  8966. * Sums the width and height of two sizes
  8967. * @param otherSize size to add to this size
  8968. * @returns a new Size set as the addition result of the current Size and the given one.
  8969. */
  8970. add(otherSize: Size): Size;
  8971. /**
  8972. * Subtracts the width and height of two
  8973. * @param otherSize size to subtract to this size
  8974. * @returns a new Size set as the subtraction result of the given one from the current Size.
  8975. */
  8976. subtract(otherSize: Size): Size;
  8977. /**
  8978. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  8979. * @param start starting size to lerp between
  8980. * @param end end size to lerp between
  8981. * @param amount amount to lerp between the start and end values
  8982. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  8983. */
  8984. static Lerp(start: Size, end: Size, amount: number): Size;
  8985. }
  8986. }
  8987. declare module "babylonjs/Maths/math.vertexFormat" {
  8988. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8989. /**
  8990. * Contains position and normal vectors for a vertex
  8991. */
  8992. export class PositionNormalVertex {
  8993. /** the position of the vertex (defaut: 0,0,0) */
  8994. position: Vector3;
  8995. /** the normal of the vertex (defaut: 0,1,0) */
  8996. normal: Vector3;
  8997. /**
  8998. * Creates a PositionNormalVertex
  8999. * @param position the position of the vertex (defaut: 0,0,0)
  9000. * @param normal the normal of the vertex (defaut: 0,1,0)
  9001. */
  9002. constructor(
  9003. /** the position of the vertex (defaut: 0,0,0) */
  9004. position?: Vector3,
  9005. /** the normal of the vertex (defaut: 0,1,0) */
  9006. normal?: Vector3);
  9007. /**
  9008. * Clones the PositionNormalVertex
  9009. * @returns the cloned PositionNormalVertex
  9010. */
  9011. clone(): PositionNormalVertex;
  9012. }
  9013. /**
  9014. * Contains position, normal and uv vectors for a vertex
  9015. */
  9016. export class PositionNormalTextureVertex {
  9017. /** the position of the vertex (defaut: 0,0,0) */
  9018. position: Vector3;
  9019. /** the normal of the vertex (defaut: 0,1,0) */
  9020. normal: Vector3;
  9021. /** the uv of the vertex (default: 0,0) */
  9022. uv: Vector2;
  9023. /**
  9024. * Creates a PositionNormalTextureVertex
  9025. * @param position the position of the vertex (defaut: 0,0,0)
  9026. * @param normal the normal of the vertex (defaut: 0,1,0)
  9027. * @param uv the uv of the vertex (default: 0,0)
  9028. */
  9029. constructor(
  9030. /** the position of the vertex (defaut: 0,0,0) */
  9031. position?: Vector3,
  9032. /** the normal of the vertex (defaut: 0,1,0) */
  9033. normal?: Vector3,
  9034. /** the uv of the vertex (default: 0,0) */
  9035. uv?: Vector2);
  9036. /**
  9037. * Clones the PositionNormalTextureVertex
  9038. * @returns the cloned PositionNormalTextureVertex
  9039. */
  9040. clone(): PositionNormalTextureVertex;
  9041. }
  9042. }
  9043. declare module "babylonjs/Maths/math" {
  9044. export * from "babylonjs/Maths/math.axis";
  9045. export * from "babylonjs/Maths/math.color";
  9046. export * from "babylonjs/Maths/math.constants";
  9047. export * from "babylonjs/Maths/math.frustum";
  9048. export * from "babylonjs/Maths/math.path";
  9049. export * from "babylonjs/Maths/math.plane";
  9050. export * from "babylonjs/Maths/math.size";
  9051. export * from "babylonjs/Maths/math.vector";
  9052. export * from "babylonjs/Maths/math.vertexFormat";
  9053. export * from "babylonjs/Maths/math.viewport";
  9054. }
  9055. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9056. /**
  9057. * Enum defining the type of animations supported by InputBlock
  9058. */
  9059. export enum AnimatedInputBlockTypes {
  9060. /** No animation */
  9061. None = 0,
  9062. /** Time based animation. Will only work for floats */
  9063. Time = 1
  9064. }
  9065. }
  9066. declare module "babylonjs/Lights/shadowLight" {
  9067. import { Camera } from "babylonjs/Cameras/camera";
  9068. import { Scene } from "babylonjs/scene";
  9069. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9070. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9071. import { Light } from "babylonjs/Lights/light";
  9072. /**
  9073. * Interface describing all the common properties and methods a shadow light needs to implement.
  9074. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9075. * as well as binding the different shadow properties to the effects.
  9076. */
  9077. export interface IShadowLight extends Light {
  9078. /**
  9079. * The light id in the scene (used in scene.findLighById for instance)
  9080. */
  9081. id: string;
  9082. /**
  9083. * The position the shdow will be casted from.
  9084. */
  9085. position: Vector3;
  9086. /**
  9087. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9088. */
  9089. direction: Vector3;
  9090. /**
  9091. * The transformed position. Position of the light in world space taking parenting in account.
  9092. */
  9093. transformedPosition: Vector3;
  9094. /**
  9095. * The transformed direction. Direction of the light in world space taking parenting in account.
  9096. */
  9097. transformedDirection: Vector3;
  9098. /**
  9099. * The friendly name of the light in the scene.
  9100. */
  9101. name: string;
  9102. /**
  9103. * Defines the shadow projection clipping minimum z value.
  9104. */
  9105. shadowMinZ: number;
  9106. /**
  9107. * Defines the shadow projection clipping maximum z value.
  9108. */
  9109. shadowMaxZ: number;
  9110. /**
  9111. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9112. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9113. */
  9114. computeTransformedInformation(): boolean;
  9115. /**
  9116. * Gets the scene the light belongs to.
  9117. * @returns The scene
  9118. */
  9119. getScene(): Scene;
  9120. /**
  9121. * Callback defining a custom Projection Matrix Builder.
  9122. * This can be used to override the default projection matrix computation.
  9123. */
  9124. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9125. /**
  9126. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9127. * @param matrix The materix to updated with the projection information
  9128. * @param viewMatrix The transform matrix of the light
  9129. * @param renderList The list of mesh to render in the map
  9130. * @returns The current light
  9131. */
  9132. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9133. /**
  9134. * Gets the current depth scale used in ESM.
  9135. * @returns The scale
  9136. */
  9137. getDepthScale(): number;
  9138. /**
  9139. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9140. * @returns true if a cube texture needs to be use
  9141. */
  9142. needCube(): boolean;
  9143. /**
  9144. * Detects if the projection matrix requires to be recomputed this frame.
  9145. * @returns true if it requires to be recomputed otherwise, false.
  9146. */
  9147. needProjectionMatrixCompute(): boolean;
  9148. /**
  9149. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9150. */
  9151. forceProjectionMatrixCompute(): void;
  9152. /**
  9153. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9154. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9155. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9156. */
  9157. getShadowDirection(faceIndex?: number): Vector3;
  9158. /**
  9159. * Gets the minZ used for shadow according to both the scene and the light.
  9160. * @param activeCamera The camera we are returning the min for
  9161. * @returns the depth min z
  9162. */
  9163. getDepthMinZ(activeCamera: Camera): number;
  9164. /**
  9165. * Gets the maxZ used for shadow according to both the scene and the light.
  9166. * @param activeCamera The camera we are returning the max for
  9167. * @returns the depth max z
  9168. */
  9169. getDepthMaxZ(activeCamera: Camera): number;
  9170. }
  9171. /**
  9172. * Base implementation IShadowLight
  9173. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9174. */
  9175. export abstract class ShadowLight extends Light implements IShadowLight {
  9176. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9177. protected _position: Vector3;
  9178. protected _setPosition(value: Vector3): void;
  9179. /**
  9180. * Sets the position the shadow will be casted from. Also use as the light position for both
  9181. * point and spot lights.
  9182. */
  9183. get position(): Vector3;
  9184. /**
  9185. * Sets the position the shadow will be casted from. Also use as the light position for both
  9186. * point and spot lights.
  9187. */
  9188. set position(value: Vector3);
  9189. protected _direction: Vector3;
  9190. protected _setDirection(value: Vector3): void;
  9191. /**
  9192. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9193. * Also use as the light direction on spot and directional lights.
  9194. */
  9195. get direction(): Vector3;
  9196. /**
  9197. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9198. * Also use as the light direction on spot and directional lights.
  9199. */
  9200. set direction(value: Vector3);
  9201. protected _shadowMinZ: number;
  9202. /**
  9203. * Gets the shadow projection clipping minimum z value.
  9204. */
  9205. get shadowMinZ(): number;
  9206. /**
  9207. * Sets the shadow projection clipping minimum z value.
  9208. */
  9209. set shadowMinZ(value: number);
  9210. protected _shadowMaxZ: number;
  9211. /**
  9212. * Sets the shadow projection clipping maximum z value.
  9213. */
  9214. get shadowMaxZ(): number;
  9215. /**
  9216. * Gets the shadow projection clipping maximum z value.
  9217. */
  9218. set shadowMaxZ(value: number);
  9219. /**
  9220. * Callback defining a custom Projection Matrix Builder.
  9221. * This can be used to override the default projection matrix computation.
  9222. */
  9223. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9224. /**
  9225. * The transformed position. Position of the light in world space taking parenting in account.
  9226. */
  9227. transformedPosition: Vector3;
  9228. /**
  9229. * The transformed direction. Direction of the light in world space taking parenting in account.
  9230. */
  9231. transformedDirection: Vector3;
  9232. private _needProjectionMatrixCompute;
  9233. /**
  9234. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9235. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9236. */
  9237. computeTransformedInformation(): boolean;
  9238. /**
  9239. * Return the depth scale used for the shadow map.
  9240. * @returns the depth scale.
  9241. */
  9242. getDepthScale(): number;
  9243. /**
  9244. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9245. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9246. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9247. */
  9248. getShadowDirection(faceIndex?: number): Vector3;
  9249. /**
  9250. * Returns the ShadowLight absolute position in the World.
  9251. * @returns the position vector in world space
  9252. */
  9253. getAbsolutePosition(): Vector3;
  9254. /**
  9255. * Sets the ShadowLight direction toward the passed target.
  9256. * @param target The point to target in local space
  9257. * @returns the updated ShadowLight direction
  9258. */
  9259. setDirectionToTarget(target: Vector3): Vector3;
  9260. /**
  9261. * Returns the light rotation in euler definition.
  9262. * @returns the x y z rotation in local space.
  9263. */
  9264. getRotation(): Vector3;
  9265. /**
  9266. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9267. * @returns true if a cube texture needs to be use
  9268. */
  9269. needCube(): boolean;
  9270. /**
  9271. * Detects if the projection matrix requires to be recomputed this frame.
  9272. * @returns true if it requires to be recomputed otherwise, false.
  9273. */
  9274. needProjectionMatrixCompute(): boolean;
  9275. /**
  9276. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9277. */
  9278. forceProjectionMatrixCompute(): void;
  9279. /** @hidden */
  9280. _initCache(): void;
  9281. /** @hidden */
  9282. _isSynchronized(): boolean;
  9283. /**
  9284. * Computes the world matrix of the node
  9285. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9286. * @returns the world matrix
  9287. */
  9288. computeWorldMatrix(force?: boolean): Matrix;
  9289. /**
  9290. * Gets the minZ used for shadow according to both the scene and the light.
  9291. * @param activeCamera The camera we are returning the min for
  9292. * @returns the depth min z
  9293. */
  9294. getDepthMinZ(activeCamera: Camera): number;
  9295. /**
  9296. * Gets the maxZ used for shadow according to both the scene and the light.
  9297. * @param activeCamera The camera we are returning the max for
  9298. * @returns the depth max z
  9299. */
  9300. getDepthMaxZ(activeCamera: Camera): number;
  9301. /**
  9302. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9303. * @param matrix The materix to updated with the projection information
  9304. * @param viewMatrix The transform matrix of the light
  9305. * @param renderList The list of mesh to render in the map
  9306. * @returns The current light
  9307. */
  9308. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9309. }
  9310. }
  9311. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9312. /** @hidden */
  9313. export var packingFunctions: {
  9314. name: string;
  9315. shader: string;
  9316. };
  9317. }
  9318. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9319. /** @hidden */
  9320. export var bayerDitherFunctions: {
  9321. name: string;
  9322. shader: string;
  9323. };
  9324. }
  9325. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9326. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9327. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9328. /** @hidden */
  9329. export var shadowMapFragmentDeclaration: {
  9330. name: string;
  9331. shader: string;
  9332. };
  9333. }
  9334. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9335. /** @hidden */
  9336. export var clipPlaneFragmentDeclaration: {
  9337. name: string;
  9338. shader: string;
  9339. };
  9340. }
  9341. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9342. /** @hidden */
  9343. export var clipPlaneFragment: {
  9344. name: string;
  9345. shader: string;
  9346. };
  9347. }
  9348. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9349. /** @hidden */
  9350. export var shadowMapFragment: {
  9351. name: string;
  9352. shader: string;
  9353. };
  9354. }
  9355. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9356. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9357. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9358. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9359. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9360. /** @hidden */
  9361. export var shadowMapPixelShader: {
  9362. name: string;
  9363. shader: string;
  9364. };
  9365. }
  9366. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9367. /** @hidden */
  9368. export var bonesDeclaration: {
  9369. name: string;
  9370. shader: string;
  9371. };
  9372. }
  9373. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9374. /** @hidden */
  9375. export var morphTargetsVertexGlobalDeclaration: {
  9376. name: string;
  9377. shader: string;
  9378. };
  9379. }
  9380. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9381. /** @hidden */
  9382. export var morphTargetsVertexDeclaration: {
  9383. name: string;
  9384. shader: string;
  9385. };
  9386. }
  9387. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9388. /** @hidden */
  9389. export var instancesDeclaration: {
  9390. name: string;
  9391. shader: string;
  9392. };
  9393. }
  9394. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9395. /** @hidden */
  9396. export var helperFunctions: {
  9397. name: string;
  9398. shader: string;
  9399. };
  9400. }
  9401. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9402. /** @hidden */
  9403. export var shadowMapVertexDeclaration: {
  9404. name: string;
  9405. shader: string;
  9406. };
  9407. }
  9408. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9409. /** @hidden */
  9410. export var clipPlaneVertexDeclaration: {
  9411. name: string;
  9412. shader: string;
  9413. };
  9414. }
  9415. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9416. /** @hidden */
  9417. export var morphTargetsVertex: {
  9418. name: string;
  9419. shader: string;
  9420. };
  9421. }
  9422. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9423. /** @hidden */
  9424. export var instancesVertex: {
  9425. name: string;
  9426. shader: string;
  9427. };
  9428. }
  9429. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9430. /** @hidden */
  9431. export var bonesVertex: {
  9432. name: string;
  9433. shader: string;
  9434. };
  9435. }
  9436. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9437. /** @hidden */
  9438. export var shadowMapVertexNormalBias: {
  9439. name: string;
  9440. shader: string;
  9441. };
  9442. }
  9443. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9444. /** @hidden */
  9445. export var shadowMapVertexMetric: {
  9446. name: string;
  9447. shader: string;
  9448. };
  9449. }
  9450. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9451. /** @hidden */
  9452. export var clipPlaneVertex: {
  9453. name: string;
  9454. shader: string;
  9455. };
  9456. }
  9457. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9458. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9459. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9460. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9461. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9462. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9463. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9464. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9465. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9466. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9467. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9468. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9469. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9470. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9471. /** @hidden */
  9472. export var shadowMapVertexShader: {
  9473. name: string;
  9474. shader: string;
  9475. };
  9476. }
  9477. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9478. /** @hidden */
  9479. export var depthBoxBlurPixelShader: {
  9480. name: string;
  9481. shader: string;
  9482. };
  9483. }
  9484. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9485. /** @hidden */
  9486. export var shadowMapFragmentSoftTransparentShadow: {
  9487. name: string;
  9488. shader: string;
  9489. };
  9490. }
  9491. declare module "babylonjs/Materials/effectFallbacks" {
  9492. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9493. import { Effect } from "babylonjs/Materials/effect";
  9494. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9495. /**
  9496. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9497. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9498. */
  9499. export class EffectFallbacks implements IEffectFallbacks {
  9500. private _defines;
  9501. private _currentRank;
  9502. private _maxRank;
  9503. private _mesh;
  9504. /**
  9505. * Removes the fallback from the bound mesh.
  9506. */
  9507. unBindMesh(): void;
  9508. /**
  9509. * Adds a fallback on the specified property.
  9510. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9511. * @param define The name of the define in the shader
  9512. */
  9513. addFallback(rank: number, define: string): void;
  9514. /**
  9515. * Sets the mesh to use CPU skinning when needing to fallback.
  9516. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9517. * @param mesh The mesh to use the fallbacks.
  9518. */
  9519. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9520. /**
  9521. * Checks to see if more fallbacks are still availible.
  9522. */
  9523. get hasMoreFallbacks(): boolean;
  9524. /**
  9525. * Removes the defines that should be removed when falling back.
  9526. * @param currentDefines defines the current define statements for the shader.
  9527. * @param effect defines the current effect we try to compile
  9528. * @returns The resulting defines with defines of the current rank removed.
  9529. */
  9530. reduce(currentDefines: string, effect: Effect): string;
  9531. }
  9532. }
  9533. declare module "babylonjs/Actions/action" {
  9534. import { Observable } from "babylonjs/Misc/observable";
  9535. import { Condition } from "babylonjs/Actions/condition";
  9536. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9537. import { Nullable } from "babylonjs/types";
  9538. import { Scene } from "babylonjs/scene";
  9539. import { ActionManager } from "babylonjs/Actions/actionManager";
  9540. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9541. import { Node } from "babylonjs/node";
  9542. /**
  9543. * Interface used to define Action
  9544. */
  9545. export interface IAction {
  9546. /**
  9547. * Trigger for the action
  9548. */
  9549. trigger: number;
  9550. /** Options of the trigger */
  9551. triggerOptions: any;
  9552. /**
  9553. * Gets the trigger parameters
  9554. * @returns the trigger parameters
  9555. */
  9556. getTriggerParameter(): any;
  9557. /**
  9558. * Internal only - executes current action event
  9559. * @hidden
  9560. */
  9561. _executeCurrent(evt?: ActionEvent): void;
  9562. /**
  9563. * Serialize placeholder for child classes
  9564. * @param parent of child
  9565. * @returns the serialized object
  9566. */
  9567. serialize(parent: any): any;
  9568. /**
  9569. * Internal only
  9570. * @hidden
  9571. */
  9572. _prepare(): void;
  9573. /**
  9574. * Internal only - manager for action
  9575. * @hidden
  9576. */
  9577. _actionManager: Nullable<AbstractActionManager>;
  9578. /**
  9579. * Adds action to chain of actions, may be a DoNothingAction
  9580. * @param action defines the next action to execute
  9581. * @returns The action passed in
  9582. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9583. */
  9584. then(action: IAction): IAction;
  9585. }
  9586. /**
  9587. * The action to be carried out following a trigger
  9588. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9589. */
  9590. export class Action implements IAction {
  9591. /** the trigger, with or without parameters, for the action */
  9592. triggerOptions: any;
  9593. /**
  9594. * Trigger for the action
  9595. */
  9596. trigger: number;
  9597. /**
  9598. * Internal only - manager for action
  9599. * @hidden
  9600. */
  9601. _actionManager: ActionManager;
  9602. private _nextActiveAction;
  9603. private _child;
  9604. private _condition?;
  9605. private _triggerParameter;
  9606. /**
  9607. * An event triggered prior to action being executed.
  9608. */
  9609. onBeforeExecuteObservable: Observable<Action>;
  9610. /**
  9611. * Creates a new Action
  9612. * @param triggerOptions the trigger, with or without parameters, for the action
  9613. * @param condition an optional determinant of action
  9614. */
  9615. constructor(
  9616. /** the trigger, with or without parameters, for the action */
  9617. triggerOptions: any, condition?: Condition);
  9618. /**
  9619. * Internal only
  9620. * @hidden
  9621. */
  9622. _prepare(): void;
  9623. /**
  9624. * Gets the trigger parameters
  9625. * @returns the trigger parameters
  9626. */
  9627. getTriggerParameter(): any;
  9628. /**
  9629. * Internal only - executes current action event
  9630. * @hidden
  9631. */
  9632. _executeCurrent(evt?: ActionEvent): void;
  9633. /**
  9634. * Execute placeholder for child classes
  9635. * @param evt optional action event
  9636. */
  9637. execute(evt?: ActionEvent): void;
  9638. /**
  9639. * Skips to next active action
  9640. */
  9641. skipToNextActiveAction(): void;
  9642. /**
  9643. * Adds action to chain of actions, may be a DoNothingAction
  9644. * @param action defines the next action to execute
  9645. * @returns The action passed in
  9646. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9647. */
  9648. then(action: Action): Action;
  9649. /**
  9650. * Internal only
  9651. * @hidden
  9652. */
  9653. _getProperty(propertyPath: string): string;
  9654. /**
  9655. * Internal only
  9656. * @hidden
  9657. */
  9658. _getEffectiveTarget(target: any, propertyPath: string): any;
  9659. /**
  9660. * Serialize placeholder for child classes
  9661. * @param parent of child
  9662. * @returns the serialized object
  9663. */
  9664. serialize(parent: any): any;
  9665. /**
  9666. * Internal only called by serialize
  9667. * @hidden
  9668. */
  9669. protected _serialize(serializedAction: any, parent?: any): any;
  9670. /**
  9671. * Internal only
  9672. * @hidden
  9673. */
  9674. static _SerializeValueAsString: (value: any) => string;
  9675. /**
  9676. * Internal only
  9677. * @hidden
  9678. */
  9679. static _GetTargetProperty: (target: Scene | Node) => {
  9680. name: string;
  9681. targetType: string;
  9682. value: string;
  9683. };
  9684. }
  9685. }
  9686. declare module "babylonjs/Actions/condition" {
  9687. import { ActionManager } from "babylonjs/Actions/actionManager";
  9688. /**
  9689. * A Condition applied to an Action
  9690. */
  9691. export class Condition {
  9692. /**
  9693. * Internal only - manager for action
  9694. * @hidden
  9695. */
  9696. _actionManager: ActionManager;
  9697. /**
  9698. * Internal only
  9699. * @hidden
  9700. */
  9701. _evaluationId: number;
  9702. /**
  9703. * Internal only
  9704. * @hidden
  9705. */
  9706. _currentResult: boolean;
  9707. /**
  9708. * Creates a new Condition
  9709. * @param actionManager the manager of the action the condition is applied to
  9710. */
  9711. constructor(actionManager: ActionManager);
  9712. /**
  9713. * Check if the current condition is valid
  9714. * @returns a boolean
  9715. */
  9716. isValid(): boolean;
  9717. /**
  9718. * Internal only
  9719. * @hidden
  9720. */
  9721. _getProperty(propertyPath: string): string;
  9722. /**
  9723. * Internal only
  9724. * @hidden
  9725. */
  9726. _getEffectiveTarget(target: any, propertyPath: string): any;
  9727. /**
  9728. * Serialize placeholder for child classes
  9729. * @returns the serialized object
  9730. */
  9731. serialize(): any;
  9732. /**
  9733. * Internal only
  9734. * @hidden
  9735. */
  9736. protected _serialize(serializedCondition: any): any;
  9737. }
  9738. /**
  9739. * Defines specific conditional operators as extensions of Condition
  9740. */
  9741. export class ValueCondition extends Condition {
  9742. /** path to specify the property of the target the conditional operator uses */
  9743. propertyPath: string;
  9744. /** the value compared by the conditional operator against the current value of the property */
  9745. value: any;
  9746. /** the conditional operator, default ValueCondition.IsEqual */
  9747. operator: number;
  9748. /**
  9749. * Internal only
  9750. * @hidden
  9751. */
  9752. private static _IsEqual;
  9753. /**
  9754. * Internal only
  9755. * @hidden
  9756. */
  9757. private static _IsDifferent;
  9758. /**
  9759. * Internal only
  9760. * @hidden
  9761. */
  9762. private static _IsGreater;
  9763. /**
  9764. * Internal only
  9765. * @hidden
  9766. */
  9767. private static _IsLesser;
  9768. /**
  9769. * returns the number for IsEqual
  9770. */
  9771. static get IsEqual(): number;
  9772. /**
  9773. * Returns the number for IsDifferent
  9774. */
  9775. static get IsDifferent(): number;
  9776. /**
  9777. * Returns the number for IsGreater
  9778. */
  9779. static get IsGreater(): number;
  9780. /**
  9781. * Returns the number for IsLesser
  9782. */
  9783. static get IsLesser(): number;
  9784. /**
  9785. * Internal only The action manager for the condition
  9786. * @hidden
  9787. */
  9788. _actionManager: ActionManager;
  9789. /**
  9790. * Internal only
  9791. * @hidden
  9792. */
  9793. private _target;
  9794. /**
  9795. * Internal only
  9796. * @hidden
  9797. */
  9798. private _effectiveTarget;
  9799. /**
  9800. * Internal only
  9801. * @hidden
  9802. */
  9803. private _property;
  9804. /**
  9805. * Creates a new ValueCondition
  9806. * @param actionManager manager for the action the condition applies to
  9807. * @param target for the action
  9808. * @param propertyPath path to specify the property of the target the conditional operator uses
  9809. * @param value the value compared by the conditional operator against the current value of the property
  9810. * @param operator the conditional operator, default ValueCondition.IsEqual
  9811. */
  9812. constructor(actionManager: ActionManager, target: any,
  9813. /** path to specify the property of the target the conditional operator uses */
  9814. propertyPath: string,
  9815. /** the value compared by the conditional operator against the current value of the property */
  9816. value: any,
  9817. /** the conditional operator, default ValueCondition.IsEqual */
  9818. operator?: number);
  9819. /**
  9820. * Compares the given value with the property value for the specified conditional operator
  9821. * @returns the result of the comparison
  9822. */
  9823. isValid(): boolean;
  9824. /**
  9825. * Serialize the ValueCondition into a JSON compatible object
  9826. * @returns serialization object
  9827. */
  9828. serialize(): any;
  9829. /**
  9830. * Gets the name of the conditional operator for the ValueCondition
  9831. * @param operator the conditional operator
  9832. * @returns the name
  9833. */
  9834. static GetOperatorName(operator: number): string;
  9835. }
  9836. /**
  9837. * Defines a predicate condition as an extension of Condition
  9838. */
  9839. export class PredicateCondition extends Condition {
  9840. /** defines the predicate function used to validate the condition */
  9841. predicate: () => boolean;
  9842. /**
  9843. * Internal only - manager for action
  9844. * @hidden
  9845. */
  9846. _actionManager: ActionManager;
  9847. /**
  9848. * Creates a new PredicateCondition
  9849. * @param actionManager manager for the action the condition applies to
  9850. * @param predicate defines the predicate function used to validate the condition
  9851. */
  9852. constructor(actionManager: ActionManager,
  9853. /** defines the predicate function used to validate the condition */
  9854. predicate: () => boolean);
  9855. /**
  9856. * @returns the validity of the predicate condition
  9857. */
  9858. isValid(): boolean;
  9859. }
  9860. /**
  9861. * Defines a state condition as an extension of Condition
  9862. */
  9863. export class StateCondition extends Condition {
  9864. /** Value to compare with target state */
  9865. value: string;
  9866. /**
  9867. * Internal only - manager for action
  9868. * @hidden
  9869. */
  9870. _actionManager: ActionManager;
  9871. /**
  9872. * Internal only
  9873. * @hidden
  9874. */
  9875. private _target;
  9876. /**
  9877. * Creates a new StateCondition
  9878. * @param actionManager manager for the action the condition applies to
  9879. * @param target of the condition
  9880. * @param value to compare with target state
  9881. */
  9882. constructor(actionManager: ActionManager, target: any,
  9883. /** Value to compare with target state */
  9884. value: string);
  9885. /**
  9886. * Gets a boolean indicating if the current condition is met
  9887. * @returns the validity of the state
  9888. */
  9889. isValid(): boolean;
  9890. /**
  9891. * Serialize the StateCondition into a JSON compatible object
  9892. * @returns serialization object
  9893. */
  9894. serialize(): any;
  9895. }
  9896. }
  9897. declare module "babylonjs/Actions/directActions" {
  9898. import { Action } from "babylonjs/Actions/action";
  9899. import { Condition } from "babylonjs/Actions/condition";
  9900. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9901. /**
  9902. * This defines an action responsible to toggle a boolean once triggered.
  9903. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9904. */
  9905. export class SwitchBooleanAction extends Action {
  9906. /**
  9907. * The path to the boolean property in the target object
  9908. */
  9909. propertyPath: string;
  9910. private _target;
  9911. private _effectiveTarget;
  9912. private _property;
  9913. /**
  9914. * Instantiate the action
  9915. * @param triggerOptions defines the trigger options
  9916. * @param target defines the object containing the boolean
  9917. * @param propertyPath defines the path to the boolean property in the target object
  9918. * @param condition defines the trigger related conditions
  9919. */
  9920. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9921. /** @hidden */
  9922. _prepare(): void;
  9923. /**
  9924. * Execute the action toggle the boolean value.
  9925. */
  9926. execute(): void;
  9927. /**
  9928. * Serializes the actions and its related information.
  9929. * @param parent defines the object to serialize in
  9930. * @returns the serialized object
  9931. */
  9932. serialize(parent: any): any;
  9933. }
  9934. /**
  9935. * This defines an action responsible to set a the state field of the target
  9936. * to a desired value once triggered.
  9937. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9938. */
  9939. export class SetStateAction extends Action {
  9940. /**
  9941. * The value to store in the state field.
  9942. */
  9943. value: string;
  9944. private _target;
  9945. /**
  9946. * Instantiate the action
  9947. * @param triggerOptions defines the trigger options
  9948. * @param target defines the object containing the state property
  9949. * @param value defines the value to store in the state field
  9950. * @param condition defines the trigger related conditions
  9951. */
  9952. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9953. /**
  9954. * Execute the action and store the value on the target state property.
  9955. */
  9956. execute(): void;
  9957. /**
  9958. * Serializes the actions and its related information.
  9959. * @param parent defines the object to serialize in
  9960. * @returns the serialized object
  9961. */
  9962. serialize(parent: any): any;
  9963. }
  9964. /**
  9965. * This defines an action responsible to set a property of the target
  9966. * to a desired value once triggered.
  9967. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9968. */
  9969. export class SetValueAction extends Action {
  9970. /**
  9971. * The path of the property to set in the target.
  9972. */
  9973. propertyPath: string;
  9974. /**
  9975. * The value to set in the property
  9976. */
  9977. value: any;
  9978. private _target;
  9979. private _effectiveTarget;
  9980. private _property;
  9981. /**
  9982. * Instantiate the action
  9983. * @param triggerOptions defines the trigger options
  9984. * @param target defines the object containing the property
  9985. * @param propertyPath defines the path of the property to set in the target
  9986. * @param value defines the value to set in the property
  9987. * @param condition defines the trigger related conditions
  9988. */
  9989. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9990. /** @hidden */
  9991. _prepare(): void;
  9992. /**
  9993. * Execute the action and set the targetted property to the desired value.
  9994. */
  9995. execute(): void;
  9996. /**
  9997. * Serializes the actions and its related information.
  9998. * @param parent defines the object to serialize in
  9999. * @returns the serialized object
  10000. */
  10001. serialize(parent: any): any;
  10002. }
  10003. /**
  10004. * This defines an action responsible to increment the target value
  10005. * to a desired value once triggered.
  10006. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10007. */
  10008. export class IncrementValueAction extends Action {
  10009. /**
  10010. * The path of the property to increment in the target.
  10011. */
  10012. propertyPath: string;
  10013. /**
  10014. * The value we should increment the property by.
  10015. */
  10016. value: any;
  10017. private _target;
  10018. private _effectiveTarget;
  10019. private _property;
  10020. /**
  10021. * Instantiate the action
  10022. * @param triggerOptions defines the trigger options
  10023. * @param target defines the object containing the property
  10024. * @param propertyPath defines the path of the property to increment in the target
  10025. * @param value defines the value value we should increment the property by
  10026. * @param condition defines the trigger related conditions
  10027. */
  10028. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10029. /** @hidden */
  10030. _prepare(): void;
  10031. /**
  10032. * Execute the action and increment the target of the value amount.
  10033. */
  10034. execute(): void;
  10035. /**
  10036. * Serializes the actions and its related information.
  10037. * @param parent defines the object to serialize in
  10038. * @returns the serialized object
  10039. */
  10040. serialize(parent: any): any;
  10041. }
  10042. /**
  10043. * This defines an action responsible to start an animation once triggered.
  10044. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10045. */
  10046. export class PlayAnimationAction extends Action {
  10047. /**
  10048. * Where the animation should start (animation frame)
  10049. */
  10050. from: number;
  10051. /**
  10052. * Where the animation should stop (animation frame)
  10053. */
  10054. to: number;
  10055. /**
  10056. * Define if the animation should loop or stop after the first play.
  10057. */
  10058. loop?: boolean;
  10059. private _target;
  10060. /**
  10061. * Instantiate the action
  10062. * @param triggerOptions defines the trigger options
  10063. * @param target defines the target animation or animation name
  10064. * @param from defines from where the animation should start (animation frame)
  10065. * @param end defines where the animation should stop (animation frame)
  10066. * @param loop defines if the animation should loop or stop after the first play
  10067. * @param condition defines the trigger related conditions
  10068. */
  10069. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10070. /** @hidden */
  10071. _prepare(): void;
  10072. /**
  10073. * Execute the action and play the animation.
  10074. */
  10075. execute(): void;
  10076. /**
  10077. * Serializes the actions and its related information.
  10078. * @param parent defines the object to serialize in
  10079. * @returns the serialized object
  10080. */
  10081. serialize(parent: any): any;
  10082. }
  10083. /**
  10084. * This defines an action responsible to stop an animation once triggered.
  10085. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10086. */
  10087. export class StopAnimationAction extends Action {
  10088. private _target;
  10089. /**
  10090. * Instantiate the action
  10091. * @param triggerOptions defines the trigger options
  10092. * @param target defines the target animation or animation name
  10093. * @param condition defines the trigger related conditions
  10094. */
  10095. constructor(triggerOptions: any, target: any, condition?: Condition);
  10096. /** @hidden */
  10097. _prepare(): void;
  10098. /**
  10099. * Execute the action and stop the animation.
  10100. */
  10101. execute(): void;
  10102. /**
  10103. * Serializes the actions and its related information.
  10104. * @param parent defines the object to serialize in
  10105. * @returns the serialized object
  10106. */
  10107. serialize(parent: any): any;
  10108. }
  10109. /**
  10110. * This defines an action responsible that does nothing once triggered.
  10111. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10112. */
  10113. export class DoNothingAction extends Action {
  10114. /**
  10115. * Instantiate the action
  10116. * @param triggerOptions defines the trigger options
  10117. * @param condition defines the trigger related conditions
  10118. */
  10119. constructor(triggerOptions?: any, condition?: Condition);
  10120. /**
  10121. * Execute the action and do nothing.
  10122. */
  10123. execute(): void;
  10124. /**
  10125. * Serializes the actions and its related information.
  10126. * @param parent defines the object to serialize in
  10127. * @returns the serialized object
  10128. */
  10129. serialize(parent: any): any;
  10130. }
  10131. /**
  10132. * This defines an action responsible to trigger several actions once triggered.
  10133. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10134. */
  10135. export class CombineAction extends Action {
  10136. /**
  10137. * The list of aggregated animations to run.
  10138. */
  10139. children: Action[];
  10140. /**
  10141. * Instantiate the action
  10142. * @param triggerOptions defines the trigger options
  10143. * @param children defines the list of aggregated animations to run
  10144. * @param condition defines the trigger related conditions
  10145. */
  10146. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10147. /** @hidden */
  10148. _prepare(): void;
  10149. /**
  10150. * Execute the action and executes all the aggregated actions.
  10151. */
  10152. execute(evt: ActionEvent): void;
  10153. /**
  10154. * Serializes the actions and its related information.
  10155. * @param parent defines the object to serialize in
  10156. * @returns the serialized object
  10157. */
  10158. serialize(parent: any): any;
  10159. }
  10160. /**
  10161. * This defines an action responsible to run code (external event) once triggered.
  10162. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10163. */
  10164. export class ExecuteCodeAction extends Action {
  10165. /**
  10166. * The callback function to run.
  10167. */
  10168. func: (evt: ActionEvent) => void;
  10169. /**
  10170. * Instantiate the action
  10171. * @param triggerOptions defines the trigger options
  10172. * @param func defines the callback function to run
  10173. * @param condition defines the trigger related conditions
  10174. */
  10175. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10176. /**
  10177. * Execute the action and run the attached code.
  10178. */
  10179. execute(evt: ActionEvent): void;
  10180. }
  10181. /**
  10182. * This defines an action responsible to set the parent property of the target once triggered.
  10183. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10184. */
  10185. export class SetParentAction extends Action {
  10186. private _parent;
  10187. private _target;
  10188. /**
  10189. * Instantiate the action
  10190. * @param triggerOptions defines the trigger options
  10191. * @param target defines the target containing the parent property
  10192. * @param parent defines from where the animation should start (animation frame)
  10193. * @param condition defines the trigger related conditions
  10194. */
  10195. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10196. /** @hidden */
  10197. _prepare(): void;
  10198. /**
  10199. * Execute the action and set the parent property.
  10200. */
  10201. execute(): void;
  10202. /**
  10203. * Serializes the actions and its related information.
  10204. * @param parent defines the object to serialize in
  10205. * @returns the serialized object
  10206. */
  10207. serialize(parent: any): any;
  10208. }
  10209. }
  10210. declare module "babylonjs/Actions/actionManager" {
  10211. import { Nullable } from "babylonjs/types";
  10212. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10213. import { Scene } from "babylonjs/scene";
  10214. import { IAction } from "babylonjs/Actions/action";
  10215. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10216. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10217. /**
  10218. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10219. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10220. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10221. */
  10222. export class ActionManager extends AbstractActionManager {
  10223. /**
  10224. * Nothing
  10225. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10226. */
  10227. static readonly NothingTrigger: number;
  10228. /**
  10229. * On pick
  10230. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10231. */
  10232. static readonly OnPickTrigger: number;
  10233. /**
  10234. * On left pick
  10235. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10236. */
  10237. static readonly OnLeftPickTrigger: number;
  10238. /**
  10239. * On right pick
  10240. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10241. */
  10242. static readonly OnRightPickTrigger: number;
  10243. /**
  10244. * On center pick
  10245. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10246. */
  10247. static readonly OnCenterPickTrigger: number;
  10248. /**
  10249. * On pick down
  10250. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10251. */
  10252. static readonly OnPickDownTrigger: number;
  10253. /**
  10254. * On double pick
  10255. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10256. */
  10257. static readonly OnDoublePickTrigger: number;
  10258. /**
  10259. * On pick up
  10260. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10261. */
  10262. static readonly OnPickUpTrigger: number;
  10263. /**
  10264. * On pick out.
  10265. * This trigger will only be raised if you also declared a OnPickDown
  10266. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10267. */
  10268. static readonly OnPickOutTrigger: number;
  10269. /**
  10270. * On long press
  10271. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10272. */
  10273. static readonly OnLongPressTrigger: number;
  10274. /**
  10275. * On pointer over
  10276. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10277. */
  10278. static readonly OnPointerOverTrigger: number;
  10279. /**
  10280. * On pointer out
  10281. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10282. */
  10283. static readonly OnPointerOutTrigger: number;
  10284. /**
  10285. * On every frame
  10286. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10287. */
  10288. static readonly OnEveryFrameTrigger: number;
  10289. /**
  10290. * On intersection enter
  10291. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10292. */
  10293. static readonly OnIntersectionEnterTrigger: number;
  10294. /**
  10295. * On intersection exit
  10296. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10297. */
  10298. static readonly OnIntersectionExitTrigger: number;
  10299. /**
  10300. * On key down
  10301. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10302. */
  10303. static readonly OnKeyDownTrigger: number;
  10304. /**
  10305. * On key up
  10306. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10307. */
  10308. static readonly OnKeyUpTrigger: number;
  10309. private _scene;
  10310. /**
  10311. * Creates a new action manager
  10312. * @param scene defines the hosting scene
  10313. */
  10314. constructor(scene: Scene);
  10315. /**
  10316. * Releases all associated resources
  10317. */
  10318. dispose(): void;
  10319. /**
  10320. * Gets hosting scene
  10321. * @returns the hosting scene
  10322. */
  10323. getScene(): Scene;
  10324. /**
  10325. * Does this action manager handles actions of any of the given triggers
  10326. * @param triggers defines the triggers to be tested
  10327. * @return a boolean indicating whether one (or more) of the triggers is handled
  10328. */
  10329. hasSpecificTriggers(triggers: number[]): boolean;
  10330. /**
  10331. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10332. * speed.
  10333. * @param triggerA defines the trigger to be tested
  10334. * @param triggerB defines the trigger to be tested
  10335. * @return a boolean indicating whether one (or more) of the triggers is handled
  10336. */
  10337. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10338. /**
  10339. * Does this action manager handles actions of a given trigger
  10340. * @param trigger defines the trigger to be tested
  10341. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10342. * @return whether the trigger is handled
  10343. */
  10344. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10345. /**
  10346. * Does this action manager has pointer triggers
  10347. */
  10348. get hasPointerTriggers(): boolean;
  10349. /**
  10350. * Does this action manager has pick triggers
  10351. */
  10352. get hasPickTriggers(): boolean;
  10353. /**
  10354. * Registers an action to this action manager
  10355. * @param action defines the action to be registered
  10356. * @return the action amended (prepared) after registration
  10357. */
  10358. registerAction(action: IAction): Nullable<IAction>;
  10359. /**
  10360. * Unregisters an action to this action manager
  10361. * @param action defines the action to be unregistered
  10362. * @return a boolean indicating whether the action has been unregistered
  10363. */
  10364. unregisterAction(action: IAction): Boolean;
  10365. /**
  10366. * Process a specific trigger
  10367. * @param trigger defines the trigger to process
  10368. * @param evt defines the event details to be processed
  10369. */
  10370. processTrigger(trigger: number, evt?: IActionEvent): void;
  10371. /** @hidden */
  10372. _getEffectiveTarget(target: any, propertyPath: string): any;
  10373. /** @hidden */
  10374. _getProperty(propertyPath: string): string;
  10375. /**
  10376. * Serialize this manager to a JSON object
  10377. * @param name defines the property name to store this manager
  10378. * @returns a JSON representation of this manager
  10379. */
  10380. serialize(name: string): any;
  10381. /**
  10382. * Creates a new ActionManager from a JSON data
  10383. * @param parsedActions defines the JSON data to read from
  10384. * @param object defines the hosting mesh
  10385. * @param scene defines the hosting scene
  10386. */
  10387. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10388. /**
  10389. * Get a trigger name by index
  10390. * @param trigger defines the trigger index
  10391. * @returns a trigger name
  10392. */
  10393. static GetTriggerName(trigger: number): string;
  10394. }
  10395. }
  10396. declare module "babylonjs/Sprites/sprite" {
  10397. import { Vector3 } from "babylonjs/Maths/math.vector";
  10398. import { Nullable } from "babylonjs/types";
  10399. import { ActionManager } from "babylonjs/Actions/actionManager";
  10400. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10401. import { Color4 } from "babylonjs/Maths/math.color";
  10402. import { Observable } from "babylonjs/Misc/observable";
  10403. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10404. import { Animation } from "babylonjs/Animations/animation";
  10405. /**
  10406. * Class used to represent a sprite
  10407. * @see https://doc.babylonjs.com/babylon101/sprites
  10408. */
  10409. export class Sprite implements IAnimatable {
  10410. /** defines the name */
  10411. name: string;
  10412. /** Gets or sets the current world position */
  10413. position: Vector3;
  10414. /** Gets or sets the main color */
  10415. color: Color4;
  10416. /** Gets or sets the width */
  10417. width: number;
  10418. /** Gets or sets the height */
  10419. height: number;
  10420. /** Gets or sets rotation angle */
  10421. angle: number;
  10422. /** Gets or sets the cell index in the sprite sheet */
  10423. cellIndex: number;
  10424. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10425. cellRef: string;
  10426. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10427. invertU: boolean;
  10428. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10429. invertV: boolean;
  10430. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10431. disposeWhenFinishedAnimating: boolean;
  10432. /** Gets the list of attached animations */
  10433. animations: Nullable<Array<Animation>>;
  10434. /** Gets or sets a boolean indicating if the sprite can be picked */
  10435. isPickable: boolean;
  10436. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10437. useAlphaForPicking: boolean;
  10438. /** @hidden */
  10439. _xOffset: number;
  10440. /** @hidden */
  10441. _yOffset: number;
  10442. /** @hidden */
  10443. _xSize: number;
  10444. /** @hidden */
  10445. _ySize: number;
  10446. /**
  10447. * Gets or sets the associated action manager
  10448. */
  10449. actionManager: Nullable<ActionManager>;
  10450. /**
  10451. * An event triggered when the control has been disposed
  10452. */
  10453. onDisposeObservable: Observable<Sprite>;
  10454. private _animationStarted;
  10455. private _loopAnimation;
  10456. private _fromIndex;
  10457. private _toIndex;
  10458. private _delay;
  10459. private _direction;
  10460. private _manager;
  10461. private _time;
  10462. private _onAnimationEnd;
  10463. /**
  10464. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10465. */
  10466. isVisible: boolean;
  10467. /**
  10468. * Gets or sets the sprite size
  10469. */
  10470. get size(): number;
  10471. set size(value: number);
  10472. /**
  10473. * Returns a boolean indicating if the animation is started
  10474. */
  10475. get animationStarted(): boolean;
  10476. /**
  10477. * Gets or sets the unique id of the sprite
  10478. */
  10479. uniqueId: number;
  10480. /**
  10481. * Gets the manager of this sprite
  10482. */
  10483. get manager(): ISpriteManager;
  10484. /**
  10485. * Creates a new Sprite
  10486. * @param name defines the name
  10487. * @param manager defines the manager
  10488. */
  10489. constructor(
  10490. /** defines the name */
  10491. name: string, manager: ISpriteManager);
  10492. /**
  10493. * Returns the string "Sprite"
  10494. * @returns "Sprite"
  10495. */
  10496. getClassName(): string;
  10497. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10498. get fromIndex(): number;
  10499. set fromIndex(value: number);
  10500. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10501. get toIndex(): number;
  10502. set toIndex(value: number);
  10503. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10504. get loopAnimation(): boolean;
  10505. set loopAnimation(value: boolean);
  10506. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10507. get delay(): number;
  10508. set delay(value: number);
  10509. /**
  10510. * Starts an animation
  10511. * @param from defines the initial key
  10512. * @param to defines the end key
  10513. * @param loop defines if the animation must loop
  10514. * @param delay defines the start delay (in ms)
  10515. * @param onAnimationEnd defines a callback to call when animation ends
  10516. */
  10517. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10518. /** Stops current animation (if any) */
  10519. stopAnimation(): void;
  10520. /** @hidden */
  10521. _animate(deltaTime: number): void;
  10522. /** Release associated resources */
  10523. dispose(): void;
  10524. /**
  10525. * Serializes the sprite to a JSON object
  10526. * @returns the JSON object
  10527. */
  10528. serialize(): any;
  10529. /**
  10530. * Parses a JSON object to create a new sprite
  10531. * @param parsedSprite The JSON object to parse
  10532. * @param manager defines the hosting manager
  10533. * @returns the new sprite
  10534. */
  10535. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10536. }
  10537. }
  10538. declare module "babylonjs/Collisions/pickingInfo" {
  10539. import { Nullable } from "babylonjs/types";
  10540. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10541. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10542. import { Sprite } from "babylonjs/Sprites/sprite";
  10543. import { Ray } from "babylonjs/Culling/ray";
  10544. /**
  10545. * Information about the result of picking within a scene
  10546. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10547. */
  10548. export class PickingInfo {
  10549. /** @hidden */
  10550. _pickingUnavailable: boolean;
  10551. /**
  10552. * If the pick collided with an object
  10553. */
  10554. hit: boolean;
  10555. /**
  10556. * Distance away where the pick collided
  10557. */
  10558. distance: number;
  10559. /**
  10560. * The location of pick collision
  10561. */
  10562. pickedPoint: Nullable<Vector3>;
  10563. /**
  10564. * The mesh corresponding the the pick collision
  10565. */
  10566. pickedMesh: Nullable<AbstractMesh>;
  10567. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10568. bu: number;
  10569. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10570. bv: number;
  10571. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10572. faceId: number;
  10573. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10574. subMeshFaceId: number;
  10575. /** Id of the the submesh that was picked */
  10576. subMeshId: number;
  10577. /** If a sprite was picked, this will be the sprite the pick collided with */
  10578. pickedSprite: Nullable<Sprite>;
  10579. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  10580. thinInstanceIndex: number;
  10581. /**
  10582. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10583. */
  10584. originMesh: Nullable<AbstractMesh>;
  10585. /**
  10586. * The ray that was used to perform the picking.
  10587. */
  10588. ray: Nullable<Ray>;
  10589. /**
  10590. * Gets the normal correspodning to the face the pick collided with
  10591. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10592. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10593. * @returns The normal correspodning to the face the pick collided with
  10594. */
  10595. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10596. /**
  10597. * Gets the texture coordinates of where the pick occured
  10598. * @returns the vector containing the coordnates of the texture
  10599. */
  10600. getTextureCoordinates(): Nullable<Vector2>;
  10601. }
  10602. }
  10603. declare module "babylonjs/Culling/ray" {
  10604. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10605. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10606. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10607. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10608. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10609. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10610. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10611. import { Plane } from "babylonjs/Maths/math.plane";
  10612. /**
  10613. * Class representing a ray with position and direction
  10614. */
  10615. export class Ray {
  10616. /** origin point */
  10617. origin: Vector3;
  10618. /** direction */
  10619. direction: Vector3;
  10620. /** length of the ray */
  10621. length: number;
  10622. private static readonly _TmpVector3;
  10623. private _tmpRay;
  10624. /**
  10625. * Creates a new ray
  10626. * @param origin origin point
  10627. * @param direction direction
  10628. * @param length length of the ray
  10629. */
  10630. constructor(
  10631. /** origin point */
  10632. origin: Vector3,
  10633. /** direction */
  10634. direction: Vector3,
  10635. /** length of the ray */
  10636. length?: number);
  10637. /**
  10638. * Checks if the ray intersects a box
  10639. * This does not account for the ray lenght by design to improve perfs.
  10640. * @param minimum bound of the box
  10641. * @param maximum bound of the box
  10642. * @param intersectionTreshold extra extend to be added to the box in all direction
  10643. * @returns if the box was hit
  10644. */
  10645. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10646. /**
  10647. * Checks if the ray intersects a box
  10648. * This does not account for the ray lenght by design to improve perfs.
  10649. * @param box the bounding box to check
  10650. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10651. * @returns if the box was hit
  10652. */
  10653. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10654. /**
  10655. * If the ray hits a sphere
  10656. * @param sphere the bounding sphere to check
  10657. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10658. * @returns true if it hits the sphere
  10659. */
  10660. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10661. /**
  10662. * If the ray hits a triange
  10663. * @param vertex0 triangle vertex
  10664. * @param vertex1 triangle vertex
  10665. * @param vertex2 triangle vertex
  10666. * @returns intersection information if hit
  10667. */
  10668. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10669. /**
  10670. * Checks if ray intersects a plane
  10671. * @param plane the plane to check
  10672. * @returns the distance away it was hit
  10673. */
  10674. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10675. /**
  10676. * Calculate the intercept of a ray on a given axis
  10677. * @param axis to check 'x' | 'y' | 'z'
  10678. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10679. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10680. */
  10681. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10682. /**
  10683. * Checks if ray intersects a mesh
  10684. * @param mesh the mesh to check
  10685. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10686. * @returns picking info of the intersecton
  10687. */
  10688. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10689. /**
  10690. * Checks if ray intersects a mesh
  10691. * @param meshes the meshes to check
  10692. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10693. * @param results array to store result in
  10694. * @returns Array of picking infos
  10695. */
  10696. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10697. private _comparePickingInfo;
  10698. private static smallnum;
  10699. private static rayl;
  10700. /**
  10701. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10702. * @param sega the first point of the segment to test the intersection against
  10703. * @param segb the second point of the segment to test the intersection against
  10704. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10705. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10706. */
  10707. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10708. /**
  10709. * Update the ray from viewport position
  10710. * @param x position
  10711. * @param y y position
  10712. * @param viewportWidth viewport width
  10713. * @param viewportHeight viewport height
  10714. * @param world world matrix
  10715. * @param view view matrix
  10716. * @param projection projection matrix
  10717. * @returns this ray updated
  10718. */
  10719. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10720. /**
  10721. * Creates a ray with origin and direction of 0,0,0
  10722. * @returns the new ray
  10723. */
  10724. static Zero(): Ray;
  10725. /**
  10726. * Creates a new ray from screen space and viewport
  10727. * @param x position
  10728. * @param y y position
  10729. * @param viewportWidth viewport width
  10730. * @param viewportHeight viewport height
  10731. * @param world world matrix
  10732. * @param view view matrix
  10733. * @param projection projection matrix
  10734. * @returns new ray
  10735. */
  10736. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10737. /**
  10738. * Function will create a new transformed ray starting from origin and ending at the end point. Ray's length will be set, and ray will be
  10739. * transformed to the given world matrix.
  10740. * @param origin The origin point
  10741. * @param end The end point
  10742. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10743. * @returns the new ray
  10744. */
  10745. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10746. /**
  10747. * Transforms a ray by a matrix
  10748. * @param ray ray to transform
  10749. * @param matrix matrix to apply
  10750. * @returns the resulting new ray
  10751. */
  10752. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10753. /**
  10754. * Transforms a ray by a matrix
  10755. * @param ray ray to transform
  10756. * @param matrix matrix to apply
  10757. * @param result ray to store result in
  10758. */
  10759. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10760. /**
  10761. * Unproject a ray from screen space to object space
  10762. * @param sourceX defines the screen space x coordinate to use
  10763. * @param sourceY defines the screen space y coordinate to use
  10764. * @param viewportWidth defines the current width of the viewport
  10765. * @param viewportHeight defines the current height of the viewport
  10766. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10767. * @param view defines the view matrix to use
  10768. * @param projection defines the projection matrix to use
  10769. */
  10770. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10771. }
  10772. /**
  10773. * Type used to define predicate used to select faces when a mesh intersection is detected
  10774. */
  10775. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10776. module "babylonjs/scene" {
  10777. interface Scene {
  10778. /** @hidden */
  10779. _tempPickingRay: Nullable<Ray>;
  10780. /** @hidden */
  10781. _cachedRayForTransform: Ray;
  10782. /** @hidden */
  10783. _pickWithRayInverseMatrix: Matrix;
  10784. /** @hidden */
  10785. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10786. /** @hidden */
  10787. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10788. /** @hidden */
  10789. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10790. }
  10791. }
  10792. }
  10793. declare module "babylonjs/sceneComponent" {
  10794. import { Scene } from "babylonjs/scene";
  10795. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10796. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10797. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10798. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10799. import { Nullable } from "babylonjs/types";
  10800. import { Camera } from "babylonjs/Cameras/camera";
  10801. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10802. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10803. import { AbstractScene } from "babylonjs/abstractScene";
  10804. import { Mesh } from "babylonjs/Meshes/mesh";
  10805. /**
  10806. * Groups all the scene component constants in one place to ease maintenance.
  10807. * @hidden
  10808. */
  10809. export class SceneComponentConstants {
  10810. static readonly NAME_EFFECTLAYER: string;
  10811. static readonly NAME_LAYER: string;
  10812. static readonly NAME_LENSFLARESYSTEM: string;
  10813. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10814. static readonly NAME_PARTICLESYSTEM: string;
  10815. static readonly NAME_GAMEPAD: string;
  10816. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10817. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10818. static readonly NAME_PREPASSRENDERER: string;
  10819. static readonly NAME_DEPTHRENDERER: string;
  10820. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10821. static readonly NAME_SPRITE: string;
  10822. static readonly NAME_OUTLINERENDERER: string;
  10823. static readonly NAME_PROCEDURALTEXTURE: string;
  10824. static readonly NAME_SHADOWGENERATOR: string;
  10825. static readonly NAME_OCTREE: string;
  10826. static readonly NAME_PHYSICSENGINE: string;
  10827. static readonly NAME_AUDIO: string;
  10828. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10829. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10830. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10831. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10832. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10833. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10834. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10835. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10836. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10837. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10838. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10839. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10840. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10841. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10842. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10843. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10844. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10845. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10846. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10847. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10848. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10849. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10850. static readonly STEP_AFTERRENDER_AUDIO: number;
  10851. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10852. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10853. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10854. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10855. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10856. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10857. static readonly STEP_POINTERMOVE_SPRITE: number;
  10858. static readonly STEP_POINTERDOWN_SPRITE: number;
  10859. static readonly STEP_POINTERUP_SPRITE: number;
  10860. }
  10861. /**
  10862. * This represents a scene component.
  10863. *
  10864. * This is used to decouple the dependency the scene is having on the different workloads like
  10865. * layers, post processes...
  10866. */
  10867. export interface ISceneComponent {
  10868. /**
  10869. * The name of the component. Each component must have a unique name.
  10870. */
  10871. name: string;
  10872. /**
  10873. * The scene the component belongs to.
  10874. */
  10875. scene: Scene;
  10876. /**
  10877. * Register the component to one instance of a scene.
  10878. */
  10879. register(): void;
  10880. /**
  10881. * Rebuilds the elements related to this component in case of
  10882. * context lost for instance.
  10883. */
  10884. rebuild(): void;
  10885. /**
  10886. * Disposes the component and the associated ressources.
  10887. */
  10888. dispose(): void;
  10889. }
  10890. /**
  10891. * This represents a SERIALIZABLE scene component.
  10892. *
  10893. * This extends Scene Component to add Serialization methods on top.
  10894. */
  10895. export interface ISceneSerializableComponent extends ISceneComponent {
  10896. /**
  10897. * Adds all the elements from the container to the scene
  10898. * @param container the container holding the elements
  10899. */
  10900. addFromContainer(container: AbstractScene): void;
  10901. /**
  10902. * Removes all the elements in the container from the scene
  10903. * @param container contains the elements to remove
  10904. * @param dispose if the removed element should be disposed (default: false)
  10905. */
  10906. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10907. /**
  10908. * Serializes the component data to the specified json object
  10909. * @param serializationObject The object to serialize to
  10910. */
  10911. serialize(serializationObject: any): void;
  10912. }
  10913. /**
  10914. * Strong typing of a Mesh related stage step action
  10915. */
  10916. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10917. /**
  10918. * Strong typing of a Evaluate Sub Mesh related stage step action
  10919. */
  10920. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10921. /**
  10922. * Strong typing of a Active Mesh related stage step action
  10923. */
  10924. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10925. /**
  10926. * Strong typing of a Camera related stage step action
  10927. */
  10928. export type CameraStageAction = (camera: Camera) => void;
  10929. /**
  10930. * Strong typing of a Camera Frame buffer related stage step action
  10931. */
  10932. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10933. /**
  10934. * Strong typing of a Render Target related stage step action
  10935. */
  10936. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10937. /**
  10938. * Strong typing of a RenderingGroup related stage step action
  10939. */
  10940. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10941. /**
  10942. * Strong typing of a Mesh Render related stage step action
  10943. */
  10944. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10945. /**
  10946. * Strong typing of a simple stage step action
  10947. */
  10948. export type SimpleStageAction = () => void;
  10949. /**
  10950. * Strong typing of a render target action.
  10951. */
  10952. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10953. /**
  10954. * Strong typing of a pointer move action.
  10955. */
  10956. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10957. /**
  10958. * Strong typing of a pointer up/down action.
  10959. */
  10960. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10961. /**
  10962. * Representation of a stage in the scene (Basically a list of ordered steps)
  10963. * @hidden
  10964. */
  10965. export class Stage<T extends Function> extends Array<{
  10966. index: number;
  10967. component: ISceneComponent;
  10968. action: T;
  10969. }> {
  10970. /**
  10971. * Hide ctor from the rest of the world.
  10972. * @param items The items to add.
  10973. */
  10974. private constructor();
  10975. /**
  10976. * Creates a new Stage.
  10977. * @returns A new instance of a Stage
  10978. */
  10979. static Create<T extends Function>(): Stage<T>;
  10980. /**
  10981. * Registers a step in an ordered way in the targeted stage.
  10982. * @param index Defines the position to register the step in
  10983. * @param component Defines the component attached to the step
  10984. * @param action Defines the action to launch during the step
  10985. */
  10986. registerStep(index: number, component: ISceneComponent, action: T): void;
  10987. /**
  10988. * Clears all the steps from the stage.
  10989. */
  10990. clear(): void;
  10991. }
  10992. }
  10993. declare module "babylonjs/Sprites/spriteSceneComponent" {
  10994. import { Nullable } from "babylonjs/types";
  10995. import { Observable } from "babylonjs/Misc/observable";
  10996. import { Scene } from "babylonjs/scene";
  10997. import { Sprite } from "babylonjs/Sprites/sprite";
  10998. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  10999. import { Ray } from "babylonjs/Culling/ray";
  11000. import { Camera } from "babylonjs/Cameras/camera";
  11001. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11002. import { ISceneComponent } from "babylonjs/sceneComponent";
  11003. module "babylonjs/scene" {
  11004. interface Scene {
  11005. /** @hidden */
  11006. _pointerOverSprite: Nullable<Sprite>;
  11007. /** @hidden */
  11008. _pickedDownSprite: Nullable<Sprite>;
  11009. /** @hidden */
  11010. _tempSpritePickingRay: Nullable<Ray>;
  11011. /**
  11012. * All of the sprite managers added to this scene
  11013. * @see https://doc.babylonjs.com/babylon101/sprites
  11014. */
  11015. spriteManagers: Array<ISpriteManager>;
  11016. /**
  11017. * An event triggered when sprites rendering is about to start
  11018. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11019. */
  11020. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11021. /**
  11022. * An event triggered when sprites rendering is done
  11023. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11024. */
  11025. onAfterSpritesRenderingObservable: Observable<Scene>;
  11026. /** @hidden */
  11027. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11028. /** Launch a ray to try to pick a sprite in the scene
  11029. * @param x position on screen
  11030. * @param y position on screen
  11031. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11032. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11033. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11034. * @returns a PickingInfo
  11035. */
  11036. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11037. /** Use the given ray to pick a sprite in the scene
  11038. * @param ray The ray (in world space) to use to pick meshes
  11039. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11040. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11041. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11042. * @returns a PickingInfo
  11043. */
  11044. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11045. /** @hidden */
  11046. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11047. /** Launch a ray to try to pick sprites in the scene
  11048. * @param x position on screen
  11049. * @param y position on screen
  11050. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11051. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11052. * @returns a PickingInfo array
  11053. */
  11054. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11055. /** Use the given ray to pick sprites in the scene
  11056. * @param ray The ray (in world space) to use to pick meshes
  11057. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11058. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11059. * @returns a PickingInfo array
  11060. */
  11061. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11062. /**
  11063. * Force the sprite under the pointer
  11064. * @param sprite defines the sprite to use
  11065. */
  11066. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11067. /**
  11068. * Gets the sprite under the pointer
  11069. * @returns a Sprite or null if no sprite is under the pointer
  11070. */
  11071. getPointerOverSprite(): Nullable<Sprite>;
  11072. }
  11073. }
  11074. /**
  11075. * Defines the sprite scene component responsible to manage sprites
  11076. * in a given scene.
  11077. */
  11078. export class SpriteSceneComponent implements ISceneComponent {
  11079. /**
  11080. * The component name helpfull to identify the component in the list of scene components.
  11081. */
  11082. readonly name: string;
  11083. /**
  11084. * The scene the component belongs to.
  11085. */
  11086. scene: Scene;
  11087. /** @hidden */
  11088. private _spritePredicate;
  11089. /**
  11090. * Creates a new instance of the component for the given scene
  11091. * @param scene Defines the scene to register the component in
  11092. */
  11093. constructor(scene: Scene);
  11094. /**
  11095. * Registers the component in a given scene
  11096. */
  11097. register(): void;
  11098. /**
  11099. * Rebuilds the elements related to this component in case of
  11100. * context lost for instance.
  11101. */
  11102. rebuild(): void;
  11103. /**
  11104. * Disposes the component and the associated ressources.
  11105. */
  11106. dispose(): void;
  11107. private _pickSpriteButKeepRay;
  11108. private _pointerMove;
  11109. private _pointerDown;
  11110. private _pointerUp;
  11111. }
  11112. }
  11113. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11114. /** @hidden */
  11115. export var fogFragmentDeclaration: {
  11116. name: string;
  11117. shader: string;
  11118. };
  11119. }
  11120. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11121. /** @hidden */
  11122. export var fogFragment: {
  11123. name: string;
  11124. shader: string;
  11125. };
  11126. }
  11127. declare module "babylonjs/Shaders/sprites.fragment" {
  11128. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11129. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11130. /** @hidden */
  11131. export var spritesPixelShader: {
  11132. name: string;
  11133. shader: string;
  11134. };
  11135. }
  11136. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11137. /** @hidden */
  11138. export var fogVertexDeclaration: {
  11139. name: string;
  11140. shader: string;
  11141. };
  11142. }
  11143. declare module "babylonjs/Shaders/sprites.vertex" {
  11144. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11145. /** @hidden */
  11146. export var spritesVertexShader: {
  11147. name: string;
  11148. shader: string;
  11149. };
  11150. }
  11151. declare module "babylonjs/Sprites/spriteManager" {
  11152. import { IDisposable, Scene } from "babylonjs/scene";
  11153. import { Nullable } from "babylonjs/types";
  11154. import { Observable } from "babylonjs/Misc/observable";
  11155. import { Sprite } from "babylonjs/Sprites/sprite";
  11156. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11157. import { Camera } from "babylonjs/Cameras/camera";
  11158. import { Texture } from "babylonjs/Materials/Textures/texture";
  11159. import "babylonjs/Shaders/sprites.fragment";
  11160. import "babylonjs/Shaders/sprites.vertex";
  11161. import { Ray } from "babylonjs/Culling/ray";
  11162. /**
  11163. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11164. */
  11165. export interface ISpriteManager extends IDisposable {
  11166. /**
  11167. * Gets manager's name
  11168. */
  11169. name: string;
  11170. /**
  11171. * Restricts the camera to viewing objects with the same layerMask.
  11172. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11173. */
  11174. layerMask: number;
  11175. /**
  11176. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11177. */
  11178. isPickable: boolean;
  11179. /**
  11180. * Gets the hosting scene
  11181. */
  11182. scene: Scene;
  11183. /**
  11184. * Specifies the rendering group id for this mesh (0 by default)
  11185. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11186. */
  11187. renderingGroupId: number;
  11188. /**
  11189. * Defines the list of sprites managed by the manager.
  11190. */
  11191. sprites: Array<Sprite>;
  11192. /**
  11193. * Gets or sets the spritesheet texture
  11194. */
  11195. texture: Texture;
  11196. /** Defines the default width of a cell in the spritesheet */
  11197. cellWidth: number;
  11198. /** Defines the default height of a cell in the spritesheet */
  11199. cellHeight: number;
  11200. /**
  11201. * Tests the intersection of a sprite with a specific ray.
  11202. * @param ray The ray we are sending to test the collision
  11203. * @param camera The camera space we are sending rays in
  11204. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11205. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11206. * @returns picking info or null.
  11207. */
  11208. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11209. /**
  11210. * Intersects the sprites with a ray
  11211. * @param ray defines the ray to intersect with
  11212. * @param camera defines the current active camera
  11213. * @param predicate defines a predicate used to select candidate sprites
  11214. * @returns null if no hit or a PickingInfo array
  11215. */
  11216. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11217. /**
  11218. * Renders the list of sprites on screen.
  11219. */
  11220. render(): void;
  11221. }
  11222. /**
  11223. * Class used to manage multiple sprites on the same spritesheet
  11224. * @see https://doc.babylonjs.com/babylon101/sprites
  11225. */
  11226. export class SpriteManager implements ISpriteManager {
  11227. /** defines the manager's name */
  11228. name: string;
  11229. /** Define the Url to load snippets */
  11230. static SnippetUrl: string;
  11231. /** Snippet ID if the manager was created from the snippet server */
  11232. snippetId: string;
  11233. /** Gets the list of sprites */
  11234. sprites: Sprite[];
  11235. /** Gets or sets the rendering group id (0 by default) */
  11236. renderingGroupId: number;
  11237. /** Gets or sets camera layer mask */
  11238. layerMask: number;
  11239. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11240. fogEnabled: boolean;
  11241. /** Gets or sets a boolean indicating if the sprites are pickable */
  11242. isPickable: boolean;
  11243. /** Defines the default width of a cell in the spritesheet */
  11244. cellWidth: number;
  11245. /** Defines the default height of a cell in the spritesheet */
  11246. cellHeight: number;
  11247. /** Associative array from JSON sprite data file */
  11248. private _cellData;
  11249. /** Array of sprite names from JSON sprite data file */
  11250. private _spriteMap;
  11251. /** True when packed cell data from JSON file is ready*/
  11252. private _packedAndReady;
  11253. private _textureContent;
  11254. private _useInstancing;
  11255. /**
  11256. * An event triggered when the manager is disposed.
  11257. */
  11258. onDisposeObservable: Observable<SpriteManager>;
  11259. private _onDisposeObserver;
  11260. /**
  11261. * Callback called when the manager is disposed
  11262. */
  11263. set onDispose(callback: () => void);
  11264. private _capacity;
  11265. private _fromPacked;
  11266. private _spriteTexture;
  11267. private _epsilon;
  11268. private _scene;
  11269. private _vertexData;
  11270. private _buffer;
  11271. private _vertexBuffers;
  11272. private _spriteBuffer;
  11273. private _indexBuffer;
  11274. private _effectBase;
  11275. private _effectFog;
  11276. private _vertexBufferSize;
  11277. /**
  11278. * Gets or sets the unique id of the sprite
  11279. */
  11280. uniqueId: number;
  11281. /**
  11282. * Gets the array of sprites
  11283. */
  11284. get children(): Sprite[];
  11285. /**
  11286. * Gets the hosting scene
  11287. */
  11288. get scene(): Scene;
  11289. /**
  11290. * Gets the capacity of the manager
  11291. */
  11292. get capacity(): number;
  11293. /**
  11294. * Gets or sets the spritesheet texture
  11295. */
  11296. get texture(): Texture;
  11297. set texture(value: Texture);
  11298. private _blendMode;
  11299. /**
  11300. * Blend mode use to render the particle, it can be any of
  11301. * the static Constants.ALPHA_x properties provided in this class.
  11302. * Default value is Constants.ALPHA_COMBINE
  11303. */
  11304. get blendMode(): number;
  11305. set blendMode(blendMode: number);
  11306. /** Disables writing to the depth buffer when rendering the sprites.
  11307. * It can be handy to disable depth writing when using textures without alpha channel
  11308. * and setting some specific blend modes.
  11309. */
  11310. disableDepthWrite: boolean;
  11311. /**
  11312. * Creates a new sprite manager
  11313. * @param name defines the manager's name
  11314. * @param imgUrl defines the sprite sheet url
  11315. * @param capacity defines the maximum allowed number of sprites
  11316. * @param cellSize defines the size of a sprite cell
  11317. * @param scene defines the hosting scene
  11318. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11319. * @param samplingMode defines the smapling mode to use with spritesheet
  11320. * @param fromPacked set to false; do not alter
  11321. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11322. */
  11323. constructor(
  11324. /** defines the manager's name */
  11325. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11326. /**
  11327. * Returns the string "SpriteManager"
  11328. * @returns "SpriteManager"
  11329. */
  11330. getClassName(): string;
  11331. private _makePacked;
  11332. private _appendSpriteVertex;
  11333. private _checkTextureAlpha;
  11334. /**
  11335. * Intersects the sprites with a ray
  11336. * @param ray defines the ray to intersect with
  11337. * @param camera defines the current active camera
  11338. * @param predicate defines a predicate used to select candidate sprites
  11339. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11340. * @returns null if no hit or a PickingInfo
  11341. */
  11342. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11343. /**
  11344. * Intersects the sprites with a ray
  11345. * @param ray defines the ray to intersect with
  11346. * @param camera defines the current active camera
  11347. * @param predicate defines a predicate used to select candidate sprites
  11348. * @returns null if no hit or a PickingInfo array
  11349. */
  11350. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11351. /**
  11352. * Render all child sprites
  11353. */
  11354. render(): void;
  11355. /**
  11356. * Release associated resources
  11357. */
  11358. dispose(): void;
  11359. /**
  11360. * Serializes the sprite manager to a JSON object
  11361. * @param serializeTexture defines if the texture must be serialized as well
  11362. * @returns the JSON object
  11363. */
  11364. serialize(serializeTexture?: boolean): any;
  11365. /**
  11366. * Parses a JSON object to create a new sprite manager.
  11367. * @param parsedManager The JSON object to parse
  11368. * @param scene The scene to create the sprite managerin
  11369. * @param rootUrl The root url to use to load external dependencies like texture
  11370. * @returns the new sprite manager
  11371. */
  11372. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11373. /**
  11374. * Creates a sprite manager from a snippet saved in a remote file
  11375. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11376. * @param url defines the url to load from
  11377. * @param scene defines the hosting scene
  11378. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11379. * @returns a promise that will resolve to the new sprite manager
  11380. */
  11381. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11382. /**
  11383. * Creates a sprite manager from a snippet saved by the sprite editor
  11384. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11385. * @param scene defines the hosting scene
  11386. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11387. * @returns a promise that will resolve to the new sprite manager
  11388. */
  11389. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11390. }
  11391. }
  11392. declare module "babylonjs/Misc/gradients" {
  11393. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11394. /** Interface used by value gradients (color, factor, ...) */
  11395. export interface IValueGradient {
  11396. /**
  11397. * Gets or sets the gradient value (between 0 and 1)
  11398. */
  11399. gradient: number;
  11400. }
  11401. /** Class used to store color4 gradient */
  11402. export class ColorGradient implements IValueGradient {
  11403. /**
  11404. * Gets or sets the gradient value (between 0 and 1)
  11405. */
  11406. gradient: number;
  11407. /**
  11408. * Gets or sets first associated color
  11409. */
  11410. color1: Color4;
  11411. /**
  11412. * Gets or sets second associated color
  11413. */
  11414. color2?: Color4 | undefined;
  11415. /**
  11416. * Creates a new color4 gradient
  11417. * @param gradient gets or sets the gradient value (between 0 and 1)
  11418. * @param color1 gets or sets first associated color
  11419. * @param color2 gets or sets first second color
  11420. */
  11421. constructor(
  11422. /**
  11423. * Gets or sets the gradient value (between 0 and 1)
  11424. */
  11425. gradient: number,
  11426. /**
  11427. * Gets or sets first associated color
  11428. */
  11429. color1: Color4,
  11430. /**
  11431. * Gets or sets second associated color
  11432. */
  11433. color2?: Color4 | undefined);
  11434. /**
  11435. * Will get a color picked randomly between color1 and color2.
  11436. * If color2 is undefined then color1 will be used
  11437. * @param result defines the target Color4 to store the result in
  11438. */
  11439. getColorToRef(result: Color4): void;
  11440. }
  11441. /** Class used to store color 3 gradient */
  11442. export class Color3Gradient implements IValueGradient {
  11443. /**
  11444. * Gets or sets the gradient value (between 0 and 1)
  11445. */
  11446. gradient: number;
  11447. /**
  11448. * Gets or sets the associated color
  11449. */
  11450. color: Color3;
  11451. /**
  11452. * Creates a new color3 gradient
  11453. * @param gradient gets or sets the gradient value (between 0 and 1)
  11454. * @param color gets or sets associated color
  11455. */
  11456. constructor(
  11457. /**
  11458. * Gets or sets the gradient value (between 0 and 1)
  11459. */
  11460. gradient: number,
  11461. /**
  11462. * Gets or sets the associated color
  11463. */
  11464. color: Color3);
  11465. }
  11466. /** Class used to store factor gradient */
  11467. export class FactorGradient implements IValueGradient {
  11468. /**
  11469. * Gets or sets the gradient value (between 0 and 1)
  11470. */
  11471. gradient: number;
  11472. /**
  11473. * Gets or sets first associated factor
  11474. */
  11475. factor1: number;
  11476. /**
  11477. * Gets or sets second associated factor
  11478. */
  11479. factor2?: number | undefined;
  11480. /**
  11481. * Creates a new factor gradient
  11482. * @param gradient gets or sets the gradient value (between 0 and 1)
  11483. * @param factor1 gets or sets first associated factor
  11484. * @param factor2 gets or sets second associated factor
  11485. */
  11486. constructor(
  11487. /**
  11488. * Gets or sets the gradient value (between 0 and 1)
  11489. */
  11490. gradient: number,
  11491. /**
  11492. * Gets or sets first associated factor
  11493. */
  11494. factor1: number,
  11495. /**
  11496. * Gets or sets second associated factor
  11497. */
  11498. factor2?: number | undefined);
  11499. /**
  11500. * Will get a number picked randomly between factor1 and factor2.
  11501. * If factor2 is undefined then factor1 will be used
  11502. * @returns the picked number
  11503. */
  11504. getFactor(): number;
  11505. }
  11506. /**
  11507. * Helper used to simplify some generic gradient tasks
  11508. */
  11509. export class GradientHelper {
  11510. /**
  11511. * Gets the current gradient from an array of IValueGradient
  11512. * @param ratio defines the current ratio to get
  11513. * @param gradients defines the array of IValueGradient
  11514. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11515. */
  11516. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11517. }
  11518. }
  11519. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11520. import { Nullable } from "babylonjs/types";
  11521. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11522. import { Scene } from "babylonjs/scene";
  11523. module "babylonjs/Engines/thinEngine" {
  11524. interface ThinEngine {
  11525. /**
  11526. * Creates a raw texture
  11527. * @param data defines the data to store in the texture
  11528. * @param width defines the width of the texture
  11529. * @param height defines the height of the texture
  11530. * @param format defines the format of the data
  11531. * @param generateMipMaps defines if the engine should generate the mip levels
  11532. * @param invertY defines if data must be stored with Y axis inverted
  11533. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11534. * @param compression defines the compression used (null by default)
  11535. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11536. * @returns the raw texture inside an InternalTexture
  11537. */
  11538. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11539. /**
  11540. * Update a raw texture
  11541. * @param texture defines the texture to update
  11542. * @param data defines the data to store in the texture
  11543. * @param format defines the format of the data
  11544. * @param invertY defines if data must be stored with Y axis inverted
  11545. */
  11546. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11547. /**
  11548. * Update a raw texture
  11549. * @param texture defines the texture to update
  11550. * @param data defines the data to store in the texture
  11551. * @param format defines the format of the data
  11552. * @param invertY defines if data must be stored with Y axis inverted
  11553. * @param compression defines the compression used (null by default)
  11554. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11555. */
  11556. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11557. /**
  11558. * Creates a new raw cube texture
  11559. * @param data defines the array of data to use to create each face
  11560. * @param size defines the size of the textures
  11561. * @param format defines the format of the data
  11562. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11563. * @param generateMipMaps defines if the engine should generate the mip levels
  11564. * @param invertY defines if data must be stored with Y axis inverted
  11565. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11566. * @param compression defines the compression used (null by default)
  11567. * @returns the cube texture as an InternalTexture
  11568. */
  11569. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11570. /**
  11571. * Update a raw cube texture
  11572. * @param texture defines the texture to udpdate
  11573. * @param data defines the data to store
  11574. * @param format defines the data format
  11575. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11576. * @param invertY defines if data must be stored with Y axis inverted
  11577. */
  11578. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11579. /**
  11580. * Update a raw cube texture
  11581. * @param texture defines the texture to udpdate
  11582. * @param data defines the data to store
  11583. * @param format defines the data format
  11584. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11585. * @param invertY defines if data must be stored with Y axis inverted
  11586. * @param compression defines the compression used (null by default)
  11587. */
  11588. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11589. /**
  11590. * Update a raw cube texture
  11591. * @param texture defines the texture to udpdate
  11592. * @param data defines the data to store
  11593. * @param format defines the data format
  11594. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11595. * @param invertY defines if data must be stored with Y axis inverted
  11596. * @param compression defines the compression used (null by default)
  11597. * @param level defines which level of the texture to update
  11598. */
  11599. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11600. /**
  11601. * Creates a new raw cube texture from a specified url
  11602. * @param url defines the url where the data is located
  11603. * @param scene defines the current scene
  11604. * @param size defines the size of the textures
  11605. * @param format defines the format of the data
  11606. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11607. * @param noMipmap defines if the engine should avoid generating the mip levels
  11608. * @param callback defines a callback used to extract texture data from loaded data
  11609. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11610. * @param onLoad defines a callback called when texture is loaded
  11611. * @param onError defines a callback called if there is an error
  11612. * @returns the cube texture as an InternalTexture
  11613. */
  11614. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  11615. /**
  11616. * Creates a new raw cube texture from a specified url
  11617. * @param url defines the url where the data is located
  11618. * @param scene defines the current scene
  11619. * @param size defines the size of the textures
  11620. * @param format defines the format of the data
  11621. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11622. * @param noMipmap defines if the engine should avoid generating the mip levels
  11623. * @param callback defines a callback used to extract texture data from loaded data
  11624. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11625. * @param onLoad defines a callback called when texture is loaded
  11626. * @param onError defines a callback called if there is an error
  11627. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11628. * @param invertY defines if data must be stored with Y axis inverted
  11629. * @returns the cube texture as an InternalTexture
  11630. */
  11631. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  11632. /**
  11633. * Creates a new raw 3D texture
  11634. * @param data defines the data used to create the texture
  11635. * @param width defines the width of the texture
  11636. * @param height defines the height of the texture
  11637. * @param depth defines the depth of the texture
  11638. * @param format defines the format of the texture
  11639. * @param generateMipMaps defines if the engine must generate mip levels
  11640. * @param invertY defines if data must be stored with Y axis inverted
  11641. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11642. * @param compression defines the compressed used (can be null)
  11643. * @param textureType defines the compressed used (can be null)
  11644. * @returns a new raw 3D texture (stored in an InternalTexture)
  11645. */
  11646. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11647. /**
  11648. * Update a raw 3D texture
  11649. * @param texture defines the texture to update
  11650. * @param data defines the data to store
  11651. * @param format defines the data format
  11652. * @param invertY defines if data must be stored with Y axis inverted
  11653. */
  11654. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11655. /**
  11656. * Update a raw 3D texture
  11657. * @param texture defines the texture to update
  11658. * @param data defines the data to store
  11659. * @param format defines the data format
  11660. * @param invertY defines if data must be stored with Y axis inverted
  11661. * @param compression defines the used compression (can be null)
  11662. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11663. */
  11664. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11665. /**
  11666. * Creates a new raw 2D array texture
  11667. * @param data defines the data used to create the texture
  11668. * @param width defines the width of the texture
  11669. * @param height defines the height of the texture
  11670. * @param depth defines the number of layers of the texture
  11671. * @param format defines the format of the texture
  11672. * @param generateMipMaps defines if the engine must generate mip levels
  11673. * @param invertY defines if data must be stored with Y axis inverted
  11674. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11675. * @param compression defines the compressed used (can be null)
  11676. * @param textureType defines the compressed used (can be null)
  11677. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11678. */
  11679. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11680. /**
  11681. * Update a raw 2D array texture
  11682. * @param texture defines the texture to update
  11683. * @param data defines the data to store
  11684. * @param format defines the data format
  11685. * @param invertY defines if data must be stored with Y axis inverted
  11686. */
  11687. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11688. /**
  11689. * Update a raw 2D array texture
  11690. * @param texture defines the texture to update
  11691. * @param data defines the data to store
  11692. * @param format defines the data format
  11693. * @param invertY defines if data must be stored with Y axis inverted
  11694. * @param compression defines the used compression (can be null)
  11695. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11696. */
  11697. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11698. }
  11699. }
  11700. }
  11701. declare module "babylonjs/Materials/Textures/rawTexture" {
  11702. import { Texture } from "babylonjs/Materials/Textures/texture";
  11703. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11704. import { Nullable } from "babylonjs/types";
  11705. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  11706. import { Scene } from "babylonjs/scene";
  11707. /**
  11708. * Raw texture can help creating a texture directly from an array of data.
  11709. * This can be super useful if you either get the data from an uncompressed source or
  11710. * if you wish to create your texture pixel by pixel.
  11711. */
  11712. export class RawTexture extends Texture {
  11713. /**
  11714. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11715. */
  11716. format: number;
  11717. /**
  11718. * Instantiates a new RawTexture.
  11719. * Raw texture can help creating a texture directly from an array of data.
  11720. * This can be super useful if you either get the data from an uncompressed source or
  11721. * if you wish to create your texture pixel by pixel.
  11722. * @param data define the array of data to use to create the texture
  11723. * @param width define the width of the texture
  11724. * @param height define the height of the texture
  11725. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11726. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11727. * @param generateMipMaps define whether mip maps should be generated or not
  11728. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11729. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11730. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11731. */
  11732. constructor(data: ArrayBufferView, width: number, height: number,
  11733. /**
  11734. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11735. */
  11736. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11737. /**
  11738. * Updates the texture underlying data.
  11739. * @param data Define the new data of the texture
  11740. */
  11741. update(data: ArrayBufferView): void;
  11742. /**
  11743. * Creates a luminance texture from some data.
  11744. * @param data Define the texture data
  11745. * @param width Define the width of the texture
  11746. * @param height Define the height of the texture
  11747. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11748. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11749. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11750. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11751. * @returns the luminance texture
  11752. */
  11753. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11754. /**
  11755. * Creates a luminance alpha texture from some data.
  11756. * @param data Define the texture data
  11757. * @param width Define the width of the texture
  11758. * @param height Define the height of the texture
  11759. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11760. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11761. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11762. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11763. * @returns the luminance alpha texture
  11764. */
  11765. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11766. /**
  11767. * Creates an alpha texture from some data.
  11768. * @param data Define the texture data
  11769. * @param width Define the width of the texture
  11770. * @param height Define the height of the texture
  11771. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11772. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11773. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11774. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11775. * @returns the alpha texture
  11776. */
  11777. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11778. /**
  11779. * Creates a RGB texture from some data.
  11780. * @param data Define the texture data
  11781. * @param width Define the width of the texture
  11782. * @param height Define the height of the texture
  11783. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11784. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11785. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11786. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11787. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11788. * @returns the RGB alpha texture
  11789. */
  11790. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11791. /**
  11792. * Creates a RGBA texture from some data.
  11793. * @param data Define the texture data
  11794. * @param width Define the width of the texture
  11795. * @param height Define the height of the texture
  11796. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11797. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11798. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11799. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11800. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11801. * @returns the RGBA texture
  11802. */
  11803. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11804. /**
  11805. * Creates a R texture from some data.
  11806. * @param data Define the texture data
  11807. * @param width Define the width of the texture
  11808. * @param height Define the height of the texture
  11809. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11810. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11811. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11812. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11813. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11814. * @returns the R texture
  11815. */
  11816. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11817. }
  11818. }
  11819. declare module "babylonjs/Engines/Extensions/engine.dynamicBuffer" {
  11820. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  11821. import { IndicesArray, DataArray } from "babylonjs/types";
  11822. module "babylonjs/Engines/thinEngine" {
  11823. interface ThinEngine {
  11824. /**
  11825. * Update a dynamic index buffer
  11826. * @param indexBuffer defines the target index buffer
  11827. * @param indices defines the data to update
  11828. * @param offset defines the offset in the target index buffer where update should start
  11829. */
  11830. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  11831. /**
  11832. * Updates a dynamic vertex buffer.
  11833. * @param vertexBuffer the vertex buffer to update
  11834. * @param data the data used to update the vertex buffer
  11835. * @param byteOffset the byte offset of the data
  11836. * @param byteLength the byte length of the data
  11837. */
  11838. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  11839. }
  11840. }
  11841. }
  11842. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11843. import { Scene } from "babylonjs/scene";
  11844. import { ISceneComponent } from "babylonjs/sceneComponent";
  11845. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11846. module "babylonjs/abstractScene" {
  11847. interface AbstractScene {
  11848. /**
  11849. * The list of procedural textures added to the scene
  11850. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11851. */
  11852. proceduralTextures: Array<ProceduralTexture>;
  11853. }
  11854. }
  11855. /**
  11856. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11857. * in a given scene.
  11858. */
  11859. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11860. /**
  11861. * The component name helpfull to identify the component in the list of scene components.
  11862. */
  11863. readonly name: string;
  11864. /**
  11865. * The scene the component belongs to.
  11866. */
  11867. scene: Scene;
  11868. /**
  11869. * Creates a new instance of the component for the given scene
  11870. * @param scene Defines the scene to register the component in
  11871. */
  11872. constructor(scene: Scene);
  11873. /**
  11874. * Registers the component in a given scene
  11875. */
  11876. register(): void;
  11877. /**
  11878. * Rebuilds the elements related to this component in case of
  11879. * context lost for instance.
  11880. */
  11881. rebuild(): void;
  11882. /**
  11883. * Disposes the component and the associated ressources.
  11884. */
  11885. dispose(): void;
  11886. private _beforeClear;
  11887. }
  11888. }
  11889. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11890. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11891. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11892. module "babylonjs/Engines/thinEngine" {
  11893. interface ThinEngine {
  11894. /**
  11895. * Creates a new render target cube texture
  11896. * @param size defines the size of the texture
  11897. * @param options defines the options used to create the texture
  11898. * @returns a new render target cube texture stored in an InternalTexture
  11899. */
  11900. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11901. }
  11902. }
  11903. }
  11904. declare module "babylonjs/Shaders/procedural.vertex" {
  11905. /** @hidden */
  11906. export var proceduralVertexShader: {
  11907. name: string;
  11908. shader: string;
  11909. };
  11910. }
  11911. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11912. import { Observable } from "babylonjs/Misc/observable";
  11913. import { Nullable } from "babylonjs/types";
  11914. import { Scene } from "babylonjs/scene";
  11915. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11916. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11917. import { Effect } from "babylonjs/Materials/effect";
  11918. import { Texture } from "babylonjs/Materials/Textures/texture";
  11919. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11920. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11921. import "babylonjs/Shaders/procedural.vertex";
  11922. /**
  11923. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes calmpler' images.
  11924. * This is the base class of any Procedural texture and contains most of the shareable code.
  11925. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11926. */
  11927. export class ProceduralTexture extends Texture {
  11928. /**
  11929. * Define if the texture is enabled or not (disabled texture will not render)
  11930. */
  11931. isEnabled: boolean;
  11932. /**
  11933. * Define if the texture must be cleared before rendering (default is true)
  11934. */
  11935. autoClear: boolean;
  11936. /**
  11937. * Callback called when the texture is generated
  11938. */
  11939. onGenerated: () => void;
  11940. /**
  11941. * Event raised when the texture is generated
  11942. */
  11943. onGeneratedObservable: Observable<ProceduralTexture>;
  11944. /** @hidden */
  11945. _generateMipMaps: boolean;
  11946. /** @hidden **/
  11947. _effect: Effect;
  11948. /** @hidden */
  11949. _textures: {
  11950. [key: string]: Texture;
  11951. };
  11952. /** @hidden */
  11953. protected _fallbackTexture: Nullable<Texture>;
  11954. private _size;
  11955. private _currentRefreshId;
  11956. private _frameId;
  11957. private _refreshRate;
  11958. private _vertexBuffers;
  11959. private _indexBuffer;
  11960. private _uniforms;
  11961. private _samplers;
  11962. private _fragment;
  11963. private _floats;
  11964. private _ints;
  11965. private _floatsArrays;
  11966. private _colors3;
  11967. private _colors4;
  11968. private _vectors2;
  11969. private _vectors3;
  11970. private _matrices;
  11971. private _fallbackTextureUsed;
  11972. private _fullEngine;
  11973. private _cachedDefines;
  11974. private _contentUpdateId;
  11975. private _contentData;
  11976. /**
  11977. * Instantiates a new procedural texture.
  11978. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  11979. * This is the base class of any Procedural texture and contains most of the shareable code.
  11980. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11981. * @param name Define the name of the texture
  11982. * @param size Define the size of the texture to create
  11983. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  11984. * @param scene Define the scene the texture belongs to
  11985. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  11986. * @param generateMipMaps Define if the texture should creates mip maps or not
  11987. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  11988. */
  11989. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  11990. /**
  11991. * The effect that is created when initializing the post process.
  11992. * @returns The created effect corresponding the the postprocess.
  11993. */
  11994. getEffect(): Effect;
  11995. /**
  11996. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  11997. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  11998. */
  11999. getContent(): Nullable<ArrayBufferView>;
  12000. private _createIndexBuffer;
  12001. /** @hidden */
  12002. _rebuild(): void;
  12003. /**
  12004. * Resets the texture in order to recreate its associated resources.
  12005. * This can be called in case of context loss
  12006. */
  12007. reset(): void;
  12008. protected _getDefines(): string;
  12009. /**
  12010. * Is the texture ready to be used ? (rendered at least once)
  12011. * @returns true if ready, otherwise, false.
  12012. */
  12013. isReady(): boolean;
  12014. /**
  12015. * Resets the refresh counter of the texture and start bak from scratch.
  12016. * Could be useful to regenerate the texture if it is setup to render only once.
  12017. */
  12018. resetRefreshCounter(): void;
  12019. /**
  12020. * Set the fragment shader to use in order to render the texture.
  12021. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  12022. */
  12023. setFragment(fragment: any): void;
  12024. /**
  12025. * Define the refresh rate of the texture or the rendering frequency.
  12026. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  12027. */
  12028. get refreshRate(): number;
  12029. set refreshRate(value: number);
  12030. /** @hidden */
  12031. _shouldRender(): boolean;
  12032. /**
  12033. * Get the size the texture is rendering at.
  12034. * @returns the size (texture is always squared)
  12035. */
  12036. getRenderSize(): number;
  12037. /**
  12038. * Resize the texture to new value.
  12039. * @param size Define the new size the texture should have
  12040. * @param generateMipMaps Define whether the new texture should create mip maps
  12041. */
  12042. resize(size: number, generateMipMaps: boolean): void;
  12043. private _checkUniform;
  12044. /**
  12045. * Set a texture in the shader program used to render.
  12046. * @param name Define the name of the uniform samplers as defined in the shader
  12047. * @param texture Define the texture to bind to this sampler
  12048. * @return the texture itself allowing "fluent" like uniform updates
  12049. */
  12050. setTexture(name: string, texture: Texture): ProceduralTexture;
  12051. /**
  12052. * Set a float in the shader.
  12053. * @param name Define the name of the uniform as defined in the shader
  12054. * @param value Define the value to give to the uniform
  12055. * @return the texture itself allowing "fluent" like uniform updates
  12056. */
  12057. setFloat(name: string, value: number): ProceduralTexture;
  12058. /**
  12059. * Set a int in the shader.
  12060. * @param name Define the name of the uniform as defined in the shader
  12061. * @param value Define the value to give to the uniform
  12062. * @return the texture itself allowing "fluent" like uniform updates
  12063. */
  12064. setInt(name: string, value: number): ProceduralTexture;
  12065. /**
  12066. * Set an array of floats in the shader.
  12067. * @param name Define the name of the uniform as defined in the shader
  12068. * @param value Define the value to give to the uniform
  12069. * @return the texture itself allowing "fluent" like uniform updates
  12070. */
  12071. setFloats(name: string, value: number[]): ProceduralTexture;
  12072. /**
  12073. * Set a vec3 in the shader from a Color3.
  12074. * @param name Define the name of the uniform as defined in the shader
  12075. * @param value Define the value to give to the uniform
  12076. * @return the texture itself allowing "fluent" like uniform updates
  12077. */
  12078. setColor3(name: string, value: Color3): ProceduralTexture;
  12079. /**
  12080. * Set a vec4 in the shader from a Color4.
  12081. * @param name Define the name of the uniform as defined in the shader
  12082. * @param value Define the value to give to the uniform
  12083. * @return the texture itself allowing "fluent" like uniform updates
  12084. */
  12085. setColor4(name: string, value: Color4): ProceduralTexture;
  12086. /**
  12087. * Set a vec2 in the shader from a Vector2.
  12088. * @param name Define the name of the uniform as defined in the shader
  12089. * @param value Define the value to give to the uniform
  12090. * @return the texture itself allowing "fluent" like uniform updates
  12091. */
  12092. setVector2(name: string, value: Vector2): ProceduralTexture;
  12093. /**
  12094. * Set a vec3 in the shader from a Vector3.
  12095. * @param name Define the name of the uniform as defined in the shader
  12096. * @param value Define the value to give to the uniform
  12097. * @return the texture itself allowing "fluent" like uniform updates
  12098. */
  12099. setVector3(name: string, value: Vector3): ProceduralTexture;
  12100. /**
  12101. * Set a mat4 in the shader from a MAtrix.
  12102. * @param name Define the name of the uniform as defined in the shader
  12103. * @param value Define the value to give to the uniform
  12104. * @return the texture itself allowing "fluent" like uniform updates
  12105. */
  12106. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12107. /**
  12108. * Render the texture to its associated render target.
  12109. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12110. */
  12111. render(useCameraPostProcess?: boolean): void;
  12112. /**
  12113. * Clone the texture.
  12114. * @returns the cloned texture
  12115. */
  12116. clone(): ProceduralTexture;
  12117. /**
  12118. * Dispose the texture and release its asoociated resources.
  12119. */
  12120. dispose(): void;
  12121. }
  12122. }
  12123. declare module "babylonjs/Particles/baseParticleSystem" {
  12124. import { Nullable } from "babylonjs/types";
  12125. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12126. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12127. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12128. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12129. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12130. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  12131. import { Color4 } from "babylonjs/Maths/math.color";
  12132. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12133. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  12134. import { Animation } from "babylonjs/Animations/animation";
  12135. import { Scene } from "babylonjs/scene";
  12136. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12137. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12138. /**
  12139. * This represents the base class for particle system in Babylon.
  12140. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12141. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12142. * @example https://doc.babylonjs.com/babylon101/particles
  12143. */
  12144. export class BaseParticleSystem {
  12145. /**
  12146. * Source color is added to the destination color without alpha affecting the result
  12147. */
  12148. static BLENDMODE_ONEONE: number;
  12149. /**
  12150. * Blend current color and particle color using particle’s alpha
  12151. */
  12152. static BLENDMODE_STANDARD: number;
  12153. /**
  12154. * Add current color and particle color multiplied by particle’s alpha
  12155. */
  12156. static BLENDMODE_ADD: number;
  12157. /**
  12158. * Multiply current color with particle color
  12159. */
  12160. static BLENDMODE_MULTIPLY: number;
  12161. /**
  12162. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12163. */
  12164. static BLENDMODE_MULTIPLYADD: number;
  12165. /**
  12166. * List of animations used by the particle system.
  12167. */
  12168. animations: Animation[];
  12169. /**
  12170. * Gets or sets the unique id of the particle system
  12171. */
  12172. uniqueId: number;
  12173. /**
  12174. * The id of the Particle system.
  12175. */
  12176. id: string;
  12177. /**
  12178. * The friendly name of the Particle system.
  12179. */
  12180. name: string;
  12181. /**
  12182. * Snippet ID if the particle system was created from the snippet server
  12183. */
  12184. snippetId: string;
  12185. /**
  12186. * The rendering group used by the Particle system to chose when to render.
  12187. */
  12188. renderingGroupId: number;
  12189. /**
  12190. * The emitter represents the Mesh or position we are attaching the particle system to.
  12191. */
  12192. emitter: Nullable<AbstractMesh | Vector3>;
  12193. /**
  12194. * The maximum number of particles to emit per frame
  12195. */
  12196. emitRate: number;
  12197. /**
  12198. * If you want to launch only a few particles at once, that can be done, as well.
  12199. */
  12200. manualEmitCount: number;
  12201. /**
  12202. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12203. */
  12204. updateSpeed: number;
  12205. /**
  12206. * The amount of time the particle system is running (depends of the overall update speed).
  12207. */
  12208. targetStopDuration: number;
  12209. /**
  12210. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12211. */
  12212. disposeOnStop: boolean;
  12213. /**
  12214. * Minimum power of emitting particles.
  12215. */
  12216. minEmitPower: number;
  12217. /**
  12218. * Maximum power of emitting particles.
  12219. */
  12220. maxEmitPower: number;
  12221. /**
  12222. * Minimum life time of emitting particles.
  12223. */
  12224. minLifeTime: number;
  12225. /**
  12226. * Maximum life time of emitting particles.
  12227. */
  12228. maxLifeTime: number;
  12229. /**
  12230. * Minimum Size of emitting particles.
  12231. */
  12232. minSize: number;
  12233. /**
  12234. * Maximum Size of emitting particles.
  12235. */
  12236. maxSize: number;
  12237. /**
  12238. * Minimum scale of emitting particles on X axis.
  12239. */
  12240. minScaleX: number;
  12241. /**
  12242. * Maximum scale of emitting particles on X axis.
  12243. */
  12244. maxScaleX: number;
  12245. /**
  12246. * Minimum scale of emitting particles on Y axis.
  12247. */
  12248. minScaleY: number;
  12249. /**
  12250. * Maximum scale of emitting particles on Y axis.
  12251. */
  12252. maxScaleY: number;
  12253. /**
  12254. * Gets or sets the minimal initial rotation in radians.
  12255. */
  12256. minInitialRotation: number;
  12257. /**
  12258. * Gets or sets the maximal initial rotation in radians.
  12259. */
  12260. maxInitialRotation: number;
  12261. /**
  12262. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12263. */
  12264. minAngularSpeed: number;
  12265. /**
  12266. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12267. */
  12268. maxAngularSpeed: number;
  12269. /**
  12270. * The texture used to render each particle. (this can be a spritesheet)
  12271. */
  12272. particleTexture: Nullable<BaseTexture>;
  12273. /**
  12274. * The layer mask we are rendering the particles through.
  12275. */
  12276. layerMask: number;
  12277. /**
  12278. * This can help using your own shader to render the particle system.
  12279. * The according effect will be created
  12280. */
  12281. customShader: any;
  12282. /**
  12283. * By default particle system starts as soon as they are created. This prevents the
  12284. * automatic start to happen and let you decide when to start emitting particles.
  12285. */
  12286. preventAutoStart: boolean;
  12287. private _noiseTexture;
  12288. /**
  12289. * Gets or sets a texture used to add random noise to particle positions
  12290. */
  12291. get noiseTexture(): Nullable<ProceduralTexture>;
  12292. set noiseTexture(value: Nullable<ProceduralTexture>);
  12293. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12294. noiseStrength: Vector3;
  12295. /**
  12296. * Callback triggered when the particle animation is ending.
  12297. */
  12298. onAnimationEnd: Nullable<() => void>;
  12299. /**
  12300. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12301. */
  12302. blendMode: number;
  12303. /**
  12304. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12305. * to override the particles.
  12306. */
  12307. forceDepthWrite: boolean;
  12308. /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
  12309. preWarmCycles: number;
  12310. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12311. preWarmStepOffset: number;
  12312. /**
  12313. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  12314. */
  12315. spriteCellChangeSpeed: number;
  12316. /**
  12317. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12318. */
  12319. startSpriteCellID: number;
  12320. /**
  12321. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12322. */
  12323. endSpriteCellID: number;
  12324. /**
  12325. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12326. */
  12327. spriteCellWidth: number;
  12328. /**
  12329. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12330. */
  12331. spriteCellHeight: number;
  12332. /**
  12333. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12334. */
  12335. spriteRandomStartCell: boolean;
  12336. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12337. translationPivot: Vector2;
  12338. /** @hidden */
  12339. protected _isAnimationSheetEnabled: boolean;
  12340. /**
  12341. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12342. */
  12343. beginAnimationOnStart: boolean;
  12344. /**
  12345. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12346. */
  12347. beginAnimationFrom: number;
  12348. /**
  12349. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12350. */
  12351. beginAnimationTo: number;
  12352. /**
  12353. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12354. */
  12355. beginAnimationLoop: boolean;
  12356. /**
  12357. * Gets or sets a world offset applied to all particles
  12358. */
  12359. worldOffset: Vector3;
  12360. /**
  12361. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12362. */
  12363. get isAnimationSheetEnabled(): boolean;
  12364. set isAnimationSheetEnabled(value: boolean);
  12365. /**
  12366. * Get hosting scene
  12367. * @returns the scene
  12368. */
  12369. getScene(): Nullable<Scene>;
  12370. /**
  12371. * You can use gravity if you want to give an orientation to your particles.
  12372. */
  12373. gravity: Vector3;
  12374. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12375. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12376. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12377. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12378. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12379. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12380. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12381. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12382. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12383. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12384. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12385. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12386. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12387. /**
  12388. * Defines the delay in milliseconds before starting the system (0 by default)
  12389. */
  12390. startDelay: number;
  12391. /**
  12392. * Gets the current list of drag gradients.
  12393. * You must use addDragGradient and removeDragGradient to udpate this list
  12394. * @returns the list of drag gradients
  12395. */
  12396. getDragGradients(): Nullable<Array<FactorGradient>>;
  12397. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12398. limitVelocityDamping: number;
  12399. /**
  12400. * Gets the current list of limit velocity gradients.
  12401. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12402. * @returns the list of limit velocity gradients
  12403. */
  12404. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12405. /**
  12406. * Gets the current list of color gradients.
  12407. * You must use addColorGradient and removeColorGradient to udpate this list
  12408. * @returns the list of color gradients
  12409. */
  12410. getColorGradients(): Nullable<Array<ColorGradient>>;
  12411. /**
  12412. * Gets the current list of size gradients.
  12413. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12414. * @returns the list of size gradients
  12415. */
  12416. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12417. /**
  12418. * Gets the current list of color remap gradients.
  12419. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12420. * @returns the list of color remap gradients
  12421. */
  12422. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12423. /**
  12424. * Gets the current list of alpha remap gradients.
  12425. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12426. * @returns the list of alpha remap gradients
  12427. */
  12428. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12429. /**
  12430. * Gets the current list of life time gradients.
  12431. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12432. * @returns the list of life time gradients
  12433. */
  12434. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12435. /**
  12436. * Gets the current list of angular speed gradients.
  12437. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12438. * @returns the list of angular speed gradients
  12439. */
  12440. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12441. /**
  12442. * Gets the current list of velocity gradients.
  12443. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12444. * @returns the list of velocity gradients
  12445. */
  12446. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12447. /**
  12448. * Gets the current list of start size gradients.
  12449. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12450. * @returns the list of start size gradients
  12451. */
  12452. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12453. /**
  12454. * Gets the current list of emit rate gradients.
  12455. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12456. * @returns the list of emit rate gradients
  12457. */
  12458. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12459. /**
  12460. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12461. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12462. */
  12463. get direction1(): Vector3;
  12464. set direction1(value: Vector3);
  12465. /**
  12466. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12467. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12468. */
  12469. get direction2(): Vector3;
  12470. set direction2(value: Vector3);
  12471. /**
  12472. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12473. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12474. */
  12475. get minEmitBox(): Vector3;
  12476. set minEmitBox(value: Vector3);
  12477. /**
  12478. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12479. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12480. */
  12481. get maxEmitBox(): Vector3;
  12482. set maxEmitBox(value: Vector3);
  12483. /**
  12484. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12485. */
  12486. color1: Color4;
  12487. /**
  12488. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12489. */
  12490. color2: Color4;
  12491. /**
  12492. * Color the particle will have at the end of its lifetime
  12493. */
  12494. colorDead: Color4;
  12495. /**
  12496. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12497. */
  12498. textureMask: Color4;
  12499. /**
  12500. * The particle emitter type defines the emitter used by the particle system.
  12501. * It can be for example box, sphere, or cone...
  12502. */
  12503. particleEmitterType: IParticleEmitterType;
  12504. /** @hidden */
  12505. _isSubEmitter: boolean;
  12506. /**
  12507. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12508. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12509. */
  12510. billboardMode: number;
  12511. protected _isBillboardBased: boolean;
  12512. /**
  12513. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12514. */
  12515. get isBillboardBased(): boolean;
  12516. set isBillboardBased(value: boolean);
  12517. /**
  12518. * The scene the particle system belongs to.
  12519. */
  12520. protected _scene: Nullable<Scene>;
  12521. /**
  12522. * The engine the particle system belongs to.
  12523. */
  12524. protected _engine: ThinEngine;
  12525. /**
  12526. * Local cache of defines for image processing.
  12527. */
  12528. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12529. /**
  12530. * Default configuration related to image processing available in the standard Material.
  12531. */
  12532. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  12533. /**
  12534. * Gets the image processing configuration used either in this material.
  12535. */
  12536. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  12537. /**
  12538. * Sets the Default image processing configuration used either in the this material.
  12539. *
  12540. * If sets to null, the scene one is in use.
  12541. */
  12542. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  12543. /**
  12544. * Attaches a new image processing configuration to the Standard Material.
  12545. * @param configuration
  12546. */
  12547. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12548. /** @hidden */
  12549. protected _reset(): void;
  12550. /** @hidden */
  12551. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12552. /**
  12553. * Instantiates a particle system.
  12554. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12555. * @param name The name of the particle system
  12556. */
  12557. constructor(name: string);
  12558. /**
  12559. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12560. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12561. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12562. * @returns the emitter
  12563. */
  12564. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12565. /**
  12566. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12567. * @param radius The radius of the hemisphere to emit from
  12568. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12569. * @returns the emitter
  12570. */
  12571. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12572. /**
  12573. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12574. * @param radius The radius of the sphere to emit from
  12575. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12576. * @returns the emitter
  12577. */
  12578. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12579. /**
  12580. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12581. * @param radius The radius of the sphere to emit from
  12582. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12583. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12584. * @returns the emitter
  12585. */
  12586. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12587. /**
  12588. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12589. * @param radius The radius of the emission cylinder
  12590. * @param height The height of the emission cylinder
  12591. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12592. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12593. * @returns the emitter
  12594. */
  12595. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12596. /**
  12597. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12598. * @param radius The radius of the cylinder to emit from
  12599. * @param height The height of the emission cylinder
  12600. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12601. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12602. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12603. * @returns the emitter
  12604. */
  12605. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12606. /**
  12607. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12608. * @param radius The radius of the cone to emit from
  12609. * @param angle The base angle of the cone
  12610. * @returns the emitter
  12611. */
  12612. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12613. /**
  12614. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12615. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12616. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12617. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12618. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12619. * @returns the emitter
  12620. */
  12621. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12622. }
  12623. }
  12624. declare module "babylonjs/Particles/subEmitter" {
  12625. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12626. import { Scene } from "babylonjs/scene";
  12627. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12628. /**
  12629. * Type of sub emitter
  12630. */
  12631. export enum SubEmitterType {
  12632. /**
  12633. * Attached to the particle over it's lifetime
  12634. */
  12635. ATTACHED = 0,
  12636. /**
  12637. * Created when the particle dies
  12638. */
  12639. END = 1
  12640. }
  12641. /**
  12642. * Sub emitter class used to emit particles from an existing particle
  12643. */
  12644. export class SubEmitter {
  12645. /**
  12646. * the particle system to be used by the sub emitter
  12647. */
  12648. particleSystem: ParticleSystem;
  12649. /**
  12650. * Type of the submitter (Default: END)
  12651. */
  12652. type: SubEmitterType;
  12653. /**
  12654. * If the particle should inherit the direction from the particle it's attached to. (+Y will face the direction the particle is moving) (Default: false)
  12655. * Note: This only is supported when using an emitter of type Mesh
  12656. */
  12657. inheritDirection: boolean;
  12658. /**
  12659. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12660. */
  12661. inheritedVelocityAmount: number;
  12662. /**
  12663. * Creates a sub emitter
  12664. * @param particleSystem the particle system to be used by the sub emitter
  12665. */
  12666. constructor(
  12667. /**
  12668. * the particle system to be used by the sub emitter
  12669. */
  12670. particleSystem: ParticleSystem);
  12671. /**
  12672. * Clones the sub emitter
  12673. * @returns the cloned sub emitter
  12674. */
  12675. clone(): SubEmitter;
  12676. /**
  12677. * Serialize current object to a JSON object
  12678. * @returns the serialized object
  12679. */
  12680. serialize(): any;
  12681. /** @hidden */
  12682. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  12683. /**
  12684. * Creates a new SubEmitter from a serialized JSON version
  12685. * @param serializationObject defines the JSON object to read from
  12686. * @param sceneOrEngine defines the hosting scene or the hosting engine
  12687. * @param rootUrl defines the rootUrl for data loading
  12688. * @returns a new SubEmitter
  12689. */
  12690. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  12691. /** Release associated resources */
  12692. dispose(): void;
  12693. }
  12694. }
  12695. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12696. /** @hidden */
  12697. export var imageProcessingDeclaration: {
  12698. name: string;
  12699. shader: string;
  12700. };
  12701. }
  12702. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12703. /** @hidden */
  12704. export var imageProcessingFunctions: {
  12705. name: string;
  12706. shader: string;
  12707. };
  12708. }
  12709. declare module "babylonjs/Shaders/particles.fragment" {
  12710. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12711. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12712. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12713. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12714. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12715. /** @hidden */
  12716. export var particlesPixelShader: {
  12717. name: string;
  12718. shader: string;
  12719. };
  12720. }
  12721. declare module "babylonjs/Shaders/particles.vertex" {
  12722. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12723. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12724. /** @hidden */
  12725. export var particlesVertexShader: {
  12726. name: string;
  12727. shader: string;
  12728. };
  12729. }
  12730. declare module "babylonjs/Misc/interfaces/iClipPlanesHolder" {
  12731. import { Nullable } from "babylonjs/types";
  12732. import { Plane } from "babylonjs/Maths/math";
  12733. /**
  12734. * Interface used to define entities containing multiple clip planes
  12735. */
  12736. export interface IClipPlanesHolder {
  12737. /**
  12738. * Gets or sets the active clipplane 1
  12739. */
  12740. clipPlane: Nullable<Plane>;
  12741. /**
  12742. * Gets or sets the active clipplane 2
  12743. */
  12744. clipPlane2: Nullable<Plane>;
  12745. /**
  12746. * Gets or sets the active clipplane 3
  12747. */
  12748. clipPlane3: Nullable<Plane>;
  12749. /**
  12750. * Gets or sets the active clipplane 4
  12751. */
  12752. clipPlane4: Nullable<Plane>;
  12753. /**
  12754. * Gets or sets the active clipplane 5
  12755. */
  12756. clipPlane5: Nullable<Plane>;
  12757. /**
  12758. * Gets or sets the active clipplane 6
  12759. */
  12760. clipPlane6: Nullable<Plane>;
  12761. }
  12762. }
  12763. declare module "babylonjs/Materials/thinMaterialHelper" {
  12764. import { Effect } from "babylonjs/Materials/effect";
  12765. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  12766. /**
  12767. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  12768. *
  12769. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  12770. *
  12771. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  12772. */
  12773. export class ThinMaterialHelper {
  12774. /**
  12775. * Binds the clip plane information from the holder to the effect.
  12776. * @param effect The effect we are binding the data to
  12777. * @param holder The entity containing the clip plane information
  12778. */
  12779. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  12780. }
  12781. }
  12782. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  12783. module "babylonjs/Engines/thinEngine" {
  12784. interface ThinEngine {
  12785. /**
  12786. * Sets alpha constants used by some alpha blending modes
  12787. * @param r defines the red component
  12788. * @param g defines the green component
  12789. * @param b defines the blue component
  12790. * @param a defines the alpha component
  12791. */
  12792. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  12793. /**
  12794. * Sets the current alpha mode
  12795. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  12796. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  12797. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12798. */
  12799. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  12800. /**
  12801. * Gets the current alpha mode
  12802. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12803. * @returns the current alpha mode
  12804. */
  12805. getAlphaMode(): number;
  12806. /**
  12807. * Sets the current alpha equation
  12808. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  12809. */
  12810. setAlphaEquation(equation: number): void;
  12811. /**
  12812. * Gets the current alpha equation.
  12813. * @returns the current alpha equation
  12814. */
  12815. getAlphaEquation(): number;
  12816. }
  12817. }
  12818. }
  12819. declare module "babylonjs/Particles/particleSystem" {
  12820. import { Nullable } from "babylonjs/types";
  12821. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12822. import { Observable } from "babylonjs/Misc/observable";
  12823. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12824. import { Effect } from "babylonjs/Materials/effect";
  12825. import { IDisposable } from "babylonjs/scene";
  12826. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12827. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12828. import { Particle } from "babylonjs/Particles/particle";
  12829. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12830. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12831. import "babylonjs/Shaders/particles.fragment";
  12832. import "babylonjs/Shaders/particles.vertex";
  12833. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12834. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12835. import "babylonjs/Engines/Extensions/engine.alpha";
  12836. import { Scene } from "babylonjs/scene";
  12837. /**
  12838. * This represents a particle system in Babylon.
  12839. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12840. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12841. * @example https://doc.babylonjs.com/babylon101/particles
  12842. */
  12843. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12844. /**
  12845. * Billboard mode will only apply to Y axis
  12846. */
  12847. static readonly BILLBOARDMODE_Y: number;
  12848. /**
  12849. * Billboard mode will apply to all axes
  12850. */
  12851. static readonly BILLBOARDMODE_ALL: number;
  12852. /**
  12853. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12854. */
  12855. static readonly BILLBOARDMODE_STRETCHED: number;
  12856. /**
  12857. * This function can be defined to provide custom update for active particles.
  12858. * This function will be called instead of regular update (age, position, color, etc.).
  12859. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12860. */
  12861. updateFunction: (particles: Particle[]) => void;
  12862. private _emitterWorldMatrix;
  12863. /**
  12864. * This function can be defined to specify initial direction for every new particle.
  12865. * It by default use the emitterType defined function
  12866. */
  12867. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12868. /**
  12869. * This function can be defined to specify initial position for every new particle.
  12870. * It by default use the emitterType defined function
  12871. */
  12872. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12873. /**
  12874. * @hidden
  12875. */
  12876. _inheritedVelocityOffset: Vector3;
  12877. /**
  12878. * An event triggered when the system is disposed
  12879. */
  12880. onDisposeObservable: Observable<IParticleSystem>;
  12881. private _onDisposeObserver;
  12882. /**
  12883. * Sets a callback that will be triggered when the system is disposed
  12884. */
  12885. set onDispose(callback: () => void);
  12886. private _particles;
  12887. private _epsilon;
  12888. private _capacity;
  12889. private _stockParticles;
  12890. private _newPartsExcess;
  12891. private _vertexData;
  12892. private _vertexBuffer;
  12893. private _vertexBuffers;
  12894. private _spriteBuffer;
  12895. private _indexBuffer;
  12896. private _effect;
  12897. private _customEffect;
  12898. private _cachedDefines;
  12899. private _scaledColorStep;
  12900. private _colorDiff;
  12901. private _scaledDirection;
  12902. private _scaledGravity;
  12903. private _currentRenderId;
  12904. private _alive;
  12905. private _useInstancing;
  12906. private _started;
  12907. private _stopped;
  12908. private _actualFrame;
  12909. private _scaledUpdateSpeed;
  12910. private _vertexBufferSize;
  12911. /** @hidden */
  12912. _currentEmitRateGradient: Nullable<FactorGradient>;
  12913. /** @hidden */
  12914. _currentEmitRate1: number;
  12915. /** @hidden */
  12916. _currentEmitRate2: number;
  12917. /** @hidden */
  12918. _currentStartSizeGradient: Nullable<FactorGradient>;
  12919. /** @hidden */
  12920. _currentStartSize1: number;
  12921. /** @hidden */
  12922. _currentStartSize2: number;
  12923. private readonly _rawTextureWidth;
  12924. private _rampGradientsTexture;
  12925. private _useRampGradients;
  12926. /** Gets or sets a matrix to use to compute projection */
  12927. defaultProjectionMatrix: Matrix;
  12928. /** Gets or sets a matrix to use to compute view */
  12929. defaultViewMatrix: Matrix;
  12930. /** Gets or sets a boolean indicating that ramp gradients must be used
  12931. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12932. */
  12933. get useRampGradients(): boolean;
  12934. set useRampGradients(value: boolean);
  12935. /**
  12936. * The Sub-emitters templates that will be used to generate the sub particle system to be associated with the system, this property is used by the root particle system only.
  12937. * When a particle is spawned, an array will be chosen at random and all the emitters in that array will be attached to the particle. (Default: [])
  12938. */
  12939. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  12940. private _subEmitters;
  12941. /**
  12942. * @hidden
  12943. * If the particle systems emitter should be disposed when the particle system is disposed
  12944. */
  12945. _disposeEmitterOnDispose: boolean;
  12946. /**
  12947. * The current active Sub-systems, this property is used by the root particle system only.
  12948. */
  12949. activeSubSystems: Array<ParticleSystem>;
  12950. /**
  12951. * Specifies if the particles are updated in emitter local space or world space
  12952. */
  12953. isLocal: boolean;
  12954. private _rootParticleSystem;
  12955. /**
  12956. * Gets the current list of active particles
  12957. */
  12958. get particles(): Particle[];
  12959. /**
  12960. * Gets the number of particles active at the same time.
  12961. * @returns The number of active particles.
  12962. */
  12963. getActiveCount(): number;
  12964. /**
  12965. * Returns the string "ParticleSystem"
  12966. * @returns a string containing the class name
  12967. */
  12968. getClassName(): string;
  12969. /**
  12970. * Gets a boolean indicating that the system is stopping
  12971. * @returns true if the system is currently stopping
  12972. */
  12973. isStopping(): boolean;
  12974. /**
  12975. * Gets the custom effect used to render the particles
  12976. * @param blendMode Blend mode for which the effect should be retrieved
  12977. * @returns The effect
  12978. */
  12979. getCustomEffect(blendMode?: number): Nullable<Effect>;
  12980. /**
  12981. * Sets the custom effect used to render the particles
  12982. * @param effect The effect to set
  12983. * @param blendMode Blend mode for which the effect should be set
  12984. */
  12985. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  12986. /** @hidden */
  12987. private _onBeforeDrawParticlesObservable;
  12988. /**
  12989. * Observable that will be called just before the particles are drawn
  12990. */
  12991. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  12992. /**
  12993. * Gets the name of the particle vertex shader
  12994. */
  12995. get vertexShaderName(): string;
  12996. /**
  12997. * Instantiates a particle system.
  12998. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12999. * @param name The name of the particle system
  13000. * @param capacity The max number of particles alive at the same time
  13001. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  13002. * @param customEffect a custom effect used to change the way particles are rendered by default
  13003. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  13004. * @param epsilon Offset used to render the particles
  13005. */
  13006. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  13007. private _addFactorGradient;
  13008. private _removeFactorGradient;
  13009. /**
  13010. * Adds a new life time gradient
  13011. * @param gradient defines the gradient to use (between 0 and 1)
  13012. * @param factor defines the life time factor to affect to the specified gradient
  13013. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13014. * @returns the current particle system
  13015. */
  13016. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13017. /**
  13018. * Remove a specific life time gradient
  13019. * @param gradient defines the gradient to remove
  13020. * @returns the current particle system
  13021. */
  13022. removeLifeTimeGradient(gradient: number): IParticleSystem;
  13023. /**
  13024. * Adds a new size gradient
  13025. * @param gradient defines the gradient to use (between 0 and 1)
  13026. * @param factor defines the size factor to affect to the specified gradient
  13027. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13028. * @returns the current particle system
  13029. */
  13030. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13031. /**
  13032. * Remove a specific size gradient
  13033. * @param gradient defines the gradient to remove
  13034. * @returns the current particle system
  13035. */
  13036. removeSizeGradient(gradient: number): IParticleSystem;
  13037. /**
  13038. * Adds a new color remap gradient
  13039. * @param gradient defines the gradient to use (between 0 and 1)
  13040. * @param min defines the color remap minimal range
  13041. * @param max defines the color remap maximal range
  13042. * @returns the current particle system
  13043. */
  13044. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13045. /**
  13046. * Remove a specific color remap gradient
  13047. * @param gradient defines the gradient to remove
  13048. * @returns the current particle system
  13049. */
  13050. removeColorRemapGradient(gradient: number): IParticleSystem;
  13051. /**
  13052. * Adds a new alpha remap gradient
  13053. * @param gradient defines the gradient to use (between 0 and 1)
  13054. * @param min defines the alpha remap minimal range
  13055. * @param max defines the alpha remap maximal range
  13056. * @returns the current particle system
  13057. */
  13058. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13059. /**
  13060. * Remove a specific alpha remap gradient
  13061. * @param gradient defines the gradient to remove
  13062. * @returns the current particle system
  13063. */
  13064. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  13065. /**
  13066. * Adds a new angular speed gradient
  13067. * @param gradient defines the gradient to use (between 0 and 1)
  13068. * @param factor defines the angular speed to affect to the specified gradient
  13069. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13070. * @returns the current particle system
  13071. */
  13072. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13073. /**
  13074. * Remove a specific angular speed gradient
  13075. * @param gradient defines the gradient to remove
  13076. * @returns the current particle system
  13077. */
  13078. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  13079. /**
  13080. * Adds a new velocity gradient
  13081. * @param gradient defines the gradient to use (between 0 and 1)
  13082. * @param factor defines the velocity to affect to the specified gradient
  13083. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13084. * @returns the current particle system
  13085. */
  13086. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13087. /**
  13088. * Remove a specific velocity gradient
  13089. * @param gradient defines the gradient to remove
  13090. * @returns the current particle system
  13091. */
  13092. removeVelocityGradient(gradient: number): IParticleSystem;
  13093. /**
  13094. * Adds a new limit velocity gradient
  13095. * @param gradient defines the gradient to use (between 0 and 1)
  13096. * @param factor defines the limit velocity value to affect to the specified gradient
  13097. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13098. * @returns the current particle system
  13099. */
  13100. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13101. /**
  13102. * Remove a specific limit velocity gradient
  13103. * @param gradient defines the gradient to remove
  13104. * @returns the current particle system
  13105. */
  13106. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  13107. /**
  13108. * Adds a new drag gradient
  13109. * @param gradient defines the gradient to use (between 0 and 1)
  13110. * @param factor defines the drag value to affect to the specified gradient
  13111. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13112. * @returns the current particle system
  13113. */
  13114. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13115. /**
  13116. * Remove a specific drag gradient
  13117. * @param gradient defines the gradient to remove
  13118. * @returns the current particle system
  13119. */
  13120. removeDragGradient(gradient: number): IParticleSystem;
  13121. /**
  13122. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  13123. * @param gradient defines the gradient to use (between 0 and 1)
  13124. * @param factor defines the emit rate value to affect to the specified gradient
  13125. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13126. * @returns the current particle system
  13127. */
  13128. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13129. /**
  13130. * Remove a specific emit rate gradient
  13131. * @param gradient defines the gradient to remove
  13132. * @returns the current particle system
  13133. */
  13134. removeEmitRateGradient(gradient: number): IParticleSystem;
  13135. /**
  13136. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13137. * @param gradient defines the gradient to use (between 0 and 1)
  13138. * @param factor defines the start size value to affect to the specified gradient
  13139. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13140. * @returns the current particle system
  13141. */
  13142. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13143. /**
  13144. * Remove a specific start size gradient
  13145. * @param gradient defines the gradient to remove
  13146. * @returns the current particle system
  13147. */
  13148. removeStartSizeGradient(gradient: number): IParticleSystem;
  13149. private _createRampGradientTexture;
  13150. /**
  13151. * Gets the current list of ramp gradients.
  13152. * You must use addRampGradient and removeRampGradient to udpate this list
  13153. * @returns the list of ramp gradients
  13154. */
  13155. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13156. /** Force the system to rebuild all gradients that need to be resync */
  13157. forceRefreshGradients(): void;
  13158. private _syncRampGradientTexture;
  13159. /**
  13160. * Adds a new ramp gradient used to remap particle colors
  13161. * @param gradient defines the gradient to use (between 0 and 1)
  13162. * @param color defines the color to affect to the specified gradient
  13163. * @returns the current particle system
  13164. */
  13165. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13166. /**
  13167. * Remove a specific ramp gradient
  13168. * @param gradient defines the gradient to remove
  13169. * @returns the current particle system
  13170. */
  13171. removeRampGradient(gradient: number): ParticleSystem;
  13172. /**
  13173. * Adds a new color gradient
  13174. * @param gradient defines the gradient to use (between 0 and 1)
  13175. * @param color1 defines the color to affect to the specified gradient
  13176. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13177. * @returns this particle system
  13178. */
  13179. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13180. /**
  13181. * Remove a specific color gradient
  13182. * @param gradient defines the gradient to remove
  13183. * @returns this particle system
  13184. */
  13185. removeColorGradient(gradient: number): IParticleSystem;
  13186. private _fetchR;
  13187. protected _reset(): void;
  13188. private _resetEffect;
  13189. private _createVertexBuffers;
  13190. private _createIndexBuffer;
  13191. /**
  13192. * Gets the maximum number of particles active at the same time.
  13193. * @returns The max number of active particles.
  13194. */
  13195. getCapacity(): number;
  13196. /**
  13197. * Gets whether there are still active particles in the system.
  13198. * @returns True if it is alive, otherwise false.
  13199. */
  13200. isAlive(): boolean;
  13201. /**
  13202. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13203. * @returns True if it has been started, otherwise false.
  13204. */
  13205. isStarted(): boolean;
  13206. private _prepareSubEmitterInternalArray;
  13207. /**
  13208. * Starts the particle system and begins to emit
  13209. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13210. */
  13211. start(delay?: number): void;
  13212. /**
  13213. * Stops the particle system.
  13214. * @param stopSubEmitters if true it will stop the current system and all created sub-Systems if false it will stop the current root system only, this param is used by the root particle system only. the default value is true.
  13215. */
  13216. stop(stopSubEmitters?: boolean): void;
  13217. /**
  13218. * Remove all active particles
  13219. */
  13220. reset(): void;
  13221. /**
  13222. * @hidden (for internal use only)
  13223. */
  13224. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13225. /**
  13226. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13227. * Its lifetime will start back at 0.
  13228. */
  13229. recycleParticle: (particle: Particle) => void;
  13230. private _stopSubEmitters;
  13231. private _createParticle;
  13232. private _removeFromRoot;
  13233. private _emitFromParticle;
  13234. private _update;
  13235. /** @hidden */
  13236. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13237. /** @hidden */
  13238. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13239. /**
  13240. * Fill the defines array according to the current settings of the particle system
  13241. * @param defines Array to be updated
  13242. * @param blendMode blend mode to take into account when updating the array
  13243. */
  13244. fillDefines(defines: Array<string>, blendMode: number): void;
  13245. /**
  13246. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13247. * @param uniforms Uniforms array to fill
  13248. * @param attributes Attributes array to fill
  13249. * @param samplers Samplers array to fill
  13250. */
  13251. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13252. /** @hidden */
  13253. private _getEffect;
  13254. /**
  13255. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13256. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13257. */
  13258. animate(preWarmOnly?: boolean): void;
  13259. private _appendParticleVertices;
  13260. /**
  13261. * Rebuilds the particle system.
  13262. */
  13263. rebuild(): void;
  13264. /**
  13265. * Is this system ready to be used/rendered
  13266. * @return true if the system is ready
  13267. */
  13268. isReady(): boolean;
  13269. private _render;
  13270. /**
  13271. * Renders the particle system in its current state.
  13272. * @returns the current number of particles
  13273. */
  13274. render(): number;
  13275. /**
  13276. * Disposes the particle system and free the associated resources
  13277. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13278. */
  13279. dispose(disposeTexture?: boolean): void;
  13280. /**
  13281. * Clones the particle system.
  13282. * @param name The name of the cloned object
  13283. * @param newEmitter The new emitter to use
  13284. * @returns the cloned particle system
  13285. */
  13286. clone(name: string, newEmitter: any): ParticleSystem;
  13287. /**
  13288. * Serializes the particle system to a JSON object
  13289. * @param serializeTexture defines if the texture must be serialized as well
  13290. * @returns the JSON object
  13291. */
  13292. serialize(serializeTexture?: boolean): any;
  13293. /** @hidden */
  13294. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13295. /** @hidden */
  13296. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  13297. /**
  13298. * Parses a JSON object to create a particle system.
  13299. * @param parsedParticleSystem The JSON object to parse
  13300. * @param sceneOrEngine The scene or the engine to create the particle system in
  13301. * @param rootUrl The root url to use to load external dependencies like texture
  13302. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13303. * @returns the Parsed particle system
  13304. */
  13305. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13306. }
  13307. }
  13308. declare module "babylonjs/Particles/particle" {
  13309. import { Nullable } from "babylonjs/types";
  13310. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13311. import { Color4 } from "babylonjs/Maths/math.color";
  13312. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13313. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13314. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13315. /**
  13316. * A particle represents one of the element emitted by a particle system.
  13317. * This is mainly define by its coordinates, direction, velocity and age.
  13318. */
  13319. export class Particle {
  13320. /**
  13321. * The particle system the particle belongs to.
  13322. */
  13323. particleSystem: ParticleSystem;
  13324. private static _Count;
  13325. /**
  13326. * Unique ID of the particle
  13327. */
  13328. id: number;
  13329. /**
  13330. * The world position of the particle in the scene.
  13331. */
  13332. position: Vector3;
  13333. /**
  13334. * The world direction of the particle in the scene.
  13335. */
  13336. direction: Vector3;
  13337. /**
  13338. * The color of the particle.
  13339. */
  13340. color: Color4;
  13341. /**
  13342. * The color change of the particle per step.
  13343. */
  13344. colorStep: Color4;
  13345. /**
  13346. * Defines how long will the life of the particle be.
  13347. */
  13348. lifeTime: number;
  13349. /**
  13350. * The current age of the particle.
  13351. */
  13352. age: number;
  13353. /**
  13354. * The current size of the particle.
  13355. */
  13356. size: number;
  13357. /**
  13358. * The current scale of the particle.
  13359. */
  13360. scale: Vector2;
  13361. /**
  13362. * The current angle of the particle.
  13363. */
  13364. angle: number;
  13365. /**
  13366. * Defines how fast is the angle changing.
  13367. */
  13368. angularSpeed: number;
  13369. /**
  13370. * Defines the cell index used by the particle to be rendered from a sprite.
  13371. */
  13372. cellIndex: number;
  13373. /**
  13374. * The information required to support color remapping
  13375. */
  13376. remapData: Vector4;
  13377. /** @hidden */
  13378. _randomCellOffset?: number;
  13379. /** @hidden */
  13380. _initialDirection: Nullable<Vector3>;
  13381. /** @hidden */
  13382. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13383. /** @hidden */
  13384. _initialStartSpriteCellID: number;
  13385. /** @hidden */
  13386. _initialEndSpriteCellID: number;
  13387. /** @hidden */
  13388. _currentColorGradient: Nullable<ColorGradient>;
  13389. /** @hidden */
  13390. _currentColor1: Color4;
  13391. /** @hidden */
  13392. _currentColor2: Color4;
  13393. /** @hidden */
  13394. _currentSizeGradient: Nullable<FactorGradient>;
  13395. /** @hidden */
  13396. _currentSize1: number;
  13397. /** @hidden */
  13398. _currentSize2: number;
  13399. /** @hidden */
  13400. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13401. /** @hidden */
  13402. _currentAngularSpeed1: number;
  13403. /** @hidden */
  13404. _currentAngularSpeed2: number;
  13405. /** @hidden */
  13406. _currentVelocityGradient: Nullable<FactorGradient>;
  13407. /** @hidden */
  13408. _currentVelocity1: number;
  13409. /** @hidden */
  13410. _currentVelocity2: number;
  13411. /** @hidden */
  13412. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13413. /** @hidden */
  13414. _currentLimitVelocity1: number;
  13415. /** @hidden */
  13416. _currentLimitVelocity2: number;
  13417. /** @hidden */
  13418. _currentDragGradient: Nullable<FactorGradient>;
  13419. /** @hidden */
  13420. _currentDrag1: number;
  13421. /** @hidden */
  13422. _currentDrag2: number;
  13423. /** @hidden */
  13424. _randomNoiseCoordinates1: Vector3;
  13425. /** @hidden */
  13426. _randomNoiseCoordinates2: Vector3;
  13427. /** @hidden */
  13428. _localPosition?: Vector3;
  13429. /**
  13430. * Creates a new instance Particle
  13431. * @param particleSystem the particle system the particle belongs to
  13432. */
  13433. constructor(
  13434. /**
  13435. * The particle system the particle belongs to.
  13436. */
  13437. particleSystem: ParticleSystem);
  13438. private updateCellInfoFromSystem;
  13439. /**
  13440. * Defines how the sprite cell index is updated for the particle
  13441. */
  13442. updateCellIndex(): void;
  13443. /** @hidden */
  13444. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13445. /** @hidden */
  13446. _inheritParticleInfoToSubEmitters(): void;
  13447. /** @hidden */
  13448. _reset(): void;
  13449. /**
  13450. * Copy the properties of particle to another one.
  13451. * @param other the particle to copy the information to.
  13452. */
  13453. copyTo(other: Particle): void;
  13454. }
  13455. }
  13456. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13457. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13458. import { Effect } from "babylonjs/Materials/effect";
  13459. import { Particle } from "babylonjs/Particles/particle";
  13460. import { Nullable } from "babylonjs/types";
  13461. import { Scene } from "babylonjs/scene";
  13462. /**
  13463. * Particle emitter represents a volume emitting particles.
  13464. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13465. */
  13466. export interface IParticleEmitterType {
  13467. /**
  13468. * Called by the particle System when the direction is computed for the created particle.
  13469. * @param worldMatrix is the world matrix of the particle system
  13470. * @param directionToUpdate is the direction vector to update with the result
  13471. * @param particle is the particle we are computed the direction for
  13472. * @param isLocal defines if the direction should be set in local space
  13473. */
  13474. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13475. /**
  13476. * Called by the particle System when the position is computed for the created particle.
  13477. * @param worldMatrix is the world matrix of the particle system
  13478. * @param positionToUpdate is the position vector to update with the result
  13479. * @param particle is the particle we are computed the position for
  13480. * @param isLocal defines if the position should be set in local space
  13481. */
  13482. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13483. /**
  13484. * Clones the current emitter and returns a copy of it
  13485. * @returns the new emitter
  13486. */
  13487. clone(): IParticleEmitterType;
  13488. /**
  13489. * Called by the GPUParticleSystem to setup the update shader
  13490. * @param effect defines the update shader
  13491. */
  13492. applyToShader(effect: Effect): void;
  13493. /**
  13494. * Returns a string to use to update the GPU particles update shader
  13495. * @returns the effect defines string
  13496. */
  13497. getEffectDefines(): string;
  13498. /**
  13499. * Returns a string representing the class name
  13500. * @returns a string containing the class name
  13501. */
  13502. getClassName(): string;
  13503. /**
  13504. * Serializes the particle system to a JSON object.
  13505. * @returns the JSON object
  13506. */
  13507. serialize(): any;
  13508. /**
  13509. * Parse properties from a JSON object
  13510. * @param serializationObject defines the JSON object
  13511. * @param scene defines the hosting scene
  13512. */
  13513. parse(serializationObject: any, scene: Nullable<Scene>): void;
  13514. }
  13515. }
  13516. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13517. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13518. import { Effect } from "babylonjs/Materials/effect";
  13519. import { Particle } from "babylonjs/Particles/particle";
  13520. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13521. /**
  13522. * Particle emitter emitting particles from the inside of a box.
  13523. * It emits the particles randomly between 2 given directions.
  13524. */
  13525. export class BoxParticleEmitter implements IParticleEmitterType {
  13526. /**
  13527. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13528. */
  13529. direction1: Vector3;
  13530. /**
  13531. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13532. */
  13533. direction2: Vector3;
  13534. /**
  13535. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13536. */
  13537. minEmitBox: Vector3;
  13538. /**
  13539. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13540. */
  13541. maxEmitBox: Vector3;
  13542. /**
  13543. * Creates a new instance BoxParticleEmitter
  13544. */
  13545. constructor();
  13546. /**
  13547. * Called by the particle System when the direction is computed for the created particle.
  13548. * @param worldMatrix is the world matrix of the particle system
  13549. * @param directionToUpdate is the direction vector to update with the result
  13550. * @param particle is the particle we are computed the direction for
  13551. * @param isLocal defines if the direction should be set in local space
  13552. */
  13553. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13554. /**
  13555. * Called by the particle System when the position is computed for the created particle.
  13556. * @param worldMatrix is the world matrix of the particle system
  13557. * @param positionToUpdate is the position vector to update with the result
  13558. * @param particle is the particle we are computed the position for
  13559. * @param isLocal defines if the position should be set in local space
  13560. */
  13561. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13562. /**
  13563. * Clones the current emitter and returns a copy of it
  13564. * @returns the new emitter
  13565. */
  13566. clone(): BoxParticleEmitter;
  13567. /**
  13568. * Called by the GPUParticleSystem to setup the update shader
  13569. * @param effect defines the update shader
  13570. */
  13571. applyToShader(effect: Effect): void;
  13572. /**
  13573. * Returns a string to use to update the GPU particles update shader
  13574. * @returns a string containng the defines string
  13575. */
  13576. getEffectDefines(): string;
  13577. /**
  13578. * Returns the string "BoxParticleEmitter"
  13579. * @returns a string containing the class name
  13580. */
  13581. getClassName(): string;
  13582. /**
  13583. * Serializes the particle system to a JSON object.
  13584. * @returns the JSON object
  13585. */
  13586. serialize(): any;
  13587. /**
  13588. * Parse properties from a JSON object
  13589. * @param serializationObject defines the JSON object
  13590. */
  13591. parse(serializationObject: any): void;
  13592. }
  13593. }
  13594. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13595. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13596. import { Effect } from "babylonjs/Materials/effect";
  13597. import { Particle } from "babylonjs/Particles/particle";
  13598. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13599. /**
  13600. * Particle emitter emitting particles from the inside of a cone.
  13601. * It emits the particles alongside the cone volume from the base to the particle.
  13602. * The emission direction might be randomized.
  13603. */
  13604. export class ConeParticleEmitter implements IParticleEmitterType {
  13605. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13606. directionRandomizer: number;
  13607. private _radius;
  13608. private _angle;
  13609. private _height;
  13610. /**
  13611. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13612. */
  13613. radiusRange: number;
  13614. /**
  13615. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13616. */
  13617. heightRange: number;
  13618. /**
  13619. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13620. */
  13621. emitFromSpawnPointOnly: boolean;
  13622. /**
  13623. * Gets or sets the radius of the emission cone
  13624. */
  13625. get radius(): number;
  13626. set radius(value: number);
  13627. /**
  13628. * Gets or sets the angle of the emission cone
  13629. */
  13630. get angle(): number;
  13631. set angle(value: number);
  13632. private _buildHeight;
  13633. /**
  13634. * Creates a new instance ConeParticleEmitter
  13635. * @param radius the radius of the emission cone (1 by default)
  13636. * @param angle the cone base angle (PI by default)
  13637. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13638. */
  13639. constructor(radius?: number, angle?: number,
  13640. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13641. directionRandomizer?: number);
  13642. /**
  13643. * Called by the particle System when the direction is computed for the created particle.
  13644. * @param worldMatrix is the world matrix of the particle system
  13645. * @param directionToUpdate is the direction vector to update with the result
  13646. * @param particle is the particle we are computed the direction for
  13647. * @param isLocal defines if the direction should be set in local space
  13648. */
  13649. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13650. /**
  13651. * Called by the particle System when the position is computed for the created particle.
  13652. * @param worldMatrix is the world matrix of the particle system
  13653. * @param positionToUpdate is the position vector to update with the result
  13654. * @param particle is the particle we are computed the position for
  13655. * @param isLocal defines if the position should be set in local space
  13656. */
  13657. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13658. /**
  13659. * Clones the current emitter and returns a copy of it
  13660. * @returns the new emitter
  13661. */
  13662. clone(): ConeParticleEmitter;
  13663. /**
  13664. * Called by the GPUParticleSystem to setup the update shader
  13665. * @param effect defines the update shader
  13666. */
  13667. applyToShader(effect: Effect): void;
  13668. /**
  13669. * Returns a string to use to update the GPU particles update shader
  13670. * @returns a string containng the defines string
  13671. */
  13672. getEffectDefines(): string;
  13673. /**
  13674. * Returns the string "ConeParticleEmitter"
  13675. * @returns a string containing the class name
  13676. */
  13677. getClassName(): string;
  13678. /**
  13679. * Serializes the particle system to a JSON object.
  13680. * @returns the JSON object
  13681. */
  13682. serialize(): any;
  13683. /**
  13684. * Parse properties from a JSON object
  13685. * @param serializationObject defines the JSON object
  13686. */
  13687. parse(serializationObject: any): void;
  13688. }
  13689. }
  13690. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13691. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13692. import { Effect } from "babylonjs/Materials/effect";
  13693. import { Particle } from "babylonjs/Particles/particle";
  13694. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13695. /**
  13696. * Particle emitter emitting particles from the inside of a cylinder.
  13697. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13698. */
  13699. export class CylinderParticleEmitter implements IParticleEmitterType {
  13700. /**
  13701. * The radius of the emission cylinder.
  13702. */
  13703. radius: number;
  13704. /**
  13705. * The height of the emission cylinder.
  13706. */
  13707. height: number;
  13708. /**
  13709. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13710. */
  13711. radiusRange: number;
  13712. /**
  13713. * How much to randomize the particle direction [0-1].
  13714. */
  13715. directionRandomizer: number;
  13716. /**
  13717. * Creates a new instance CylinderParticleEmitter
  13718. * @param radius the radius of the emission cylinder (1 by default)
  13719. * @param height the height of the emission cylinder (1 by default)
  13720. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13721. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13722. */
  13723. constructor(
  13724. /**
  13725. * The radius of the emission cylinder.
  13726. */
  13727. radius?: number,
  13728. /**
  13729. * The height of the emission cylinder.
  13730. */
  13731. height?: number,
  13732. /**
  13733. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13734. */
  13735. radiusRange?: number,
  13736. /**
  13737. * How much to randomize the particle direction [0-1].
  13738. */
  13739. directionRandomizer?: number);
  13740. /**
  13741. * Called by the particle System when the direction is computed for the created particle.
  13742. * @param worldMatrix is the world matrix of the particle system
  13743. * @param directionToUpdate is the direction vector to update with the result
  13744. * @param particle is the particle we are computed the direction for
  13745. * @param isLocal defines if the direction should be set in local space
  13746. */
  13747. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13748. /**
  13749. * Called by the particle System when the position is computed for the created particle.
  13750. * @param worldMatrix is the world matrix of the particle system
  13751. * @param positionToUpdate is the position vector to update with the result
  13752. * @param particle is the particle we are computed the position for
  13753. * @param isLocal defines if the position should be set in local space
  13754. */
  13755. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13756. /**
  13757. * Clones the current emitter and returns a copy of it
  13758. * @returns the new emitter
  13759. */
  13760. clone(): CylinderParticleEmitter;
  13761. /**
  13762. * Called by the GPUParticleSystem to setup the update shader
  13763. * @param effect defines the update shader
  13764. */
  13765. applyToShader(effect: Effect): void;
  13766. /**
  13767. * Returns a string to use to update the GPU particles update shader
  13768. * @returns a string containng the defines string
  13769. */
  13770. getEffectDefines(): string;
  13771. /**
  13772. * Returns the string "CylinderParticleEmitter"
  13773. * @returns a string containing the class name
  13774. */
  13775. getClassName(): string;
  13776. /**
  13777. * Serializes the particle system to a JSON object.
  13778. * @returns the JSON object
  13779. */
  13780. serialize(): any;
  13781. /**
  13782. * Parse properties from a JSON object
  13783. * @param serializationObject defines the JSON object
  13784. */
  13785. parse(serializationObject: any): void;
  13786. }
  13787. /**
  13788. * Particle emitter emitting particles from the inside of a cylinder.
  13789. * It emits the particles randomly between two vectors.
  13790. */
  13791. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13792. /**
  13793. * The min limit of the emission direction.
  13794. */
  13795. direction1: Vector3;
  13796. /**
  13797. * The max limit of the emission direction.
  13798. */
  13799. direction2: Vector3;
  13800. /**
  13801. * Creates a new instance CylinderDirectedParticleEmitter
  13802. * @param radius the radius of the emission cylinder (1 by default)
  13803. * @param height the height of the emission cylinder (1 by default)
  13804. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13805. * @param direction1 the min limit of the emission direction (up vector by default)
  13806. * @param direction2 the max limit of the emission direction (up vector by default)
  13807. */
  13808. constructor(radius?: number, height?: number, radiusRange?: number,
  13809. /**
  13810. * The min limit of the emission direction.
  13811. */
  13812. direction1?: Vector3,
  13813. /**
  13814. * The max limit of the emission direction.
  13815. */
  13816. direction2?: Vector3);
  13817. /**
  13818. * Called by the particle System when the direction is computed for the created particle.
  13819. * @param worldMatrix is the world matrix of the particle system
  13820. * @param directionToUpdate is the direction vector to update with the result
  13821. * @param particle is the particle we are computed the direction for
  13822. */
  13823. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13824. /**
  13825. * Clones the current emitter and returns a copy of it
  13826. * @returns the new emitter
  13827. */
  13828. clone(): CylinderDirectedParticleEmitter;
  13829. /**
  13830. * Called by the GPUParticleSystem to setup the update shader
  13831. * @param effect defines the update shader
  13832. */
  13833. applyToShader(effect: Effect): void;
  13834. /**
  13835. * Returns a string to use to update the GPU particles update shader
  13836. * @returns a string containng the defines string
  13837. */
  13838. getEffectDefines(): string;
  13839. /**
  13840. * Returns the string "CylinderDirectedParticleEmitter"
  13841. * @returns a string containing the class name
  13842. */
  13843. getClassName(): string;
  13844. /**
  13845. * Serializes the particle system to a JSON object.
  13846. * @returns the JSON object
  13847. */
  13848. serialize(): any;
  13849. /**
  13850. * Parse properties from a JSON object
  13851. * @param serializationObject defines the JSON object
  13852. */
  13853. parse(serializationObject: any): void;
  13854. }
  13855. }
  13856. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13857. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13858. import { Effect } from "babylonjs/Materials/effect";
  13859. import { Particle } from "babylonjs/Particles/particle";
  13860. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13861. /**
  13862. * Particle emitter emitting particles from the inside of a hemisphere.
  13863. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13864. */
  13865. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13866. /**
  13867. * The radius of the emission hemisphere.
  13868. */
  13869. radius: number;
  13870. /**
  13871. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13872. */
  13873. radiusRange: number;
  13874. /**
  13875. * How much to randomize the particle direction [0-1].
  13876. */
  13877. directionRandomizer: number;
  13878. /**
  13879. * Creates a new instance HemisphericParticleEmitter
  13880. * @param radius the radius of the emission hemisphere (1 by default)
  13881. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13882. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13883. */
  13884. constructor(
  13885. /**
  13886. * The radius of the emission hemisphere.
  13887. */
  13888. radius?: number,
  13889. /**
  13890. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13891. */
  13892. radiusRange?: number,
  13893. /**
  13894. * How much to randomize the particle direction [0-1].
  13895. */
  13896. directionRandomizer?: number);
  13897. /**
  13898. * Called by the particle System when the direction is computed for the created particle.
  13899. * @param worldMatrix is the world matrix of the particle system
  13900. * @param directionToUpdate is the direction vector to update with the result
  13901. * @param particle is the particle we are computed the direction for
  13902. * @param isLocal defines if the direction should be set in local space
  13903. */
  13904. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13905. /**
  13906. * Called by the particle System when the position is computed for the created particle.
  13907. * @param worldMatrix is the world matrix of the particle system
  13908. * @param positionToUpdate is the position vector to update with the result
  13909. * @param particle is the particle we are computed the position for
  13910. * @param isLocal defines if the position should be set in local space
  13911. */
  13912. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13913. /**
  13914. * Clones the current emitter and returns a copy of it
  13915. * @returns the new emitter
  13916. */
  13917. clone(): HemisphericParticleEmitter;
  13918. /**
  13919. * Called by the GPUParticleSystem to setup the update shader
  13920. * @param effect defines the update shader
  13921. */
  13922. applyToShader(effect: Effect): void;
  13923. /**
  13924. * Returns a string to use to update the GPU particles update shader
  13925. * @returns a string containng the defines string
  13926. */
  13927. getEffectDefines(): string;
  13928. /**
  13929. * Returns the string "HemisphericParticleEmitter"
  13930. * @returns a string containing the class name
  13931. */
  13932. getClassName(): string;
  13933. /**
  13934. * Serializes the particle system to a JSON object.
  13935. * @returns the JSON object
  13936. */
  13937. serialize(): any;
  13938. /**
  13939. * Parse properties from a JSON object
  13940. * @param serializationObject defines the JSON object
  13941. */
  13942. parse(serializationObject: any): void;
  13943. }
  13944. }
  13945. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  13946. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13947. import { Effect } from "babylonjs/Materials/effect";
  13948. import { Particle } from "babylonjs/Particles/particle";
  13949. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13950. /**
  13951. * Particle emitter emitting particles from a point.
  13952. * It emits the particles randomly between 2 given directions.
  13953. */
  13954. export class PointParticleEmitter implements IParticleEmitterType {
  13955. /**
  13956. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13957. */
  13958. direction1: Vector3;
  13959. /**
  13960. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13961. */
  13962. direction2: Vector3;
  13963. /**
  13964. * Creates a new instance PointParticleEmitter
  13965. */
  13966. constructor();
  13967. /**
  13968. * Called by the particle System when the direction is computed for the created particle.
  13969. * @param worldMatrix is the world matrix of the particle system
  13970. * @param directionToUpdate is the direction vector to update with the result
  13971. * @param particle is the particle we are computed the direction for
  13972. * @param isLocal defines if the direction should be set in local space
  13973. */
  13974. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13975. /**
  13976. * Called by the particle System when the position is computed for the created particle.
  13977. * @param worldMatrix is the world matrix of the particle system
  13978. * @param positionToUpdate is the position vector to update with the result
  13979. * @param particle is the particle we are computed the position for
  13980. * @param isLocal defines if the position should be set in local space
  13981. */
  13982. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13983. /**
  13984. * Clones the current emitter and returns a copy of it
  13985. * @returns the new emitter
  13986. */
  13987. clone(): PointParticleEmitter;
  13988. /**
  13989. * Called by the GPUParticleSystem to setup the update shader
  13990. * @param effect defines the update shader
  13991. */
  13992. applyToShader(effect: Effect): void;
  13993. /**
  13994. * Returns a string to use to update the GPU particles update shader
  13995. * @returns a string containng the defines string
  13996. */
  13997. getEffectDefines(): string;
  13998. /**
  13999. * Returns the string "PointParticleEmitter"
  14000. * @returns a string containing the class name
  14001. */
  14002. getClassName(): string;
  14003. /**
  14004. * Serializes the particle system to a JSON object.
  14005. * @returns the JSON object
  14006. */
  14007. serialize(): any;
  14008. /**
  14009. * Parse properties from a JSON object
  14010. * @param serializationObject defines the JSON object
  14011. */
  14012. parse(serializationObject: any): void;
  14013. }
  14014. }
  14015. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  14016. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14017. import { Effect } from "babylonjs/Materials/effect";
  14018. import { Particle } from "babylonjs/Particles/particle";
  14019. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14020. /**
  14021. * Particle emitter emitting particles from the inside of a sphere.
  14022. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  14023. */
  14024. export class SphereParticleEmitter implements IParticleEmitterType {
  14025. /**
  14026. * The radius of the emission sphere.
  14027. */
  14028. radius: number;
  14029. /**
  14030. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14031. */
  14032. radiusRange: number;
  14033. /**
  14034. * How much to randomize the particle direction [0-1].
  14035. */
  14036. directionRandomizer: number;
  14037. /**
  14038. * Creates a new instance SphereParticleEmitter
  14039. * @param radius the radius of the emission sphere (1 by default)
  14040. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14041. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  14042. */
  14043. constructor(
  14044. /**
  14045. * The radius of the emission sphere.
  14046. */
  14047. radius?: number,
  14048. /**
  14049. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14050. */
  14051. radiusRange?: number,
  14052. /**
  14053. * How much to randomize the particle direction [0-1].
  14054. */
  14055. directionRandomizer?: number);
  14056. /**
  14057. * Called by the particle System when the direction is computed for the created particle.
  14058. * @param worldMatrix is the world matrix of the particle system
  14059. * @param directionToUpdate is the direction vector to update with the result
  14060. * @param particle is the particle we are computed the direction for
  14061. * @param isLocal defines if the direction should be set in local space
  14062. */
  14063. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14064. /**
  14065. * Called by the particle System when the position is computed for the created particle.
  14066. * @param worldMatrix is the world matrix of the particle system
  14067. * @param positionToUpdate is the position vector to update with the result
  14068. * @param particle is the particle we are computed the position for
  14069. * @param isLocal defines if the position should be set in local space
  14070. */
  14071. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14072. /**
  14073. * Clones the current emitter and returns a copy of it
  14074. * @returns the new emitter
  14075. */
  14076. clone(): SphereParticleEmitter;
  14077. /**
  14078. * Called by the GPUParticleSystem to setup the update shader
  14079. * @param effect defines the update shader
  14080. */
  14081. applyToShader(effect: Effect): void;
  14082. /**
  14083. * Returns a string to use to update the GPU particles update shader
  14084. * @returns a string containng the defines string
  14085. */
  14086. getEffectDefines(): string;
  14087. /**
  14088. * Returns the string "SphereParticleEmitter"
  14089. * @returns a string containing the class name
  14090. */
  14091. getClassName(): string;
  14092. /**
  14093. * Serializes the particle system to a JSON object.
  14094. * @returns the JSON object
  14095. */
  14096. serialize(): any;
  14097. /**
  14098. * Parse properties from a JSON object
  14099. * @param serializationObject defines the JSON object
  14100. */
  14101. parse(serializationObject: any): void;
  14102. }
  14103. /**
  14104. * Particle emitter emitting particles from the inside of a sphere.
  14105. * It emits the particles randomly between two vectors.
  14106. */
  14107. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  14108. /**
  14109. * The min limit of the emission direction.
  14110. */
  14111. direction1: Vector3;
  14112. /**
  14113. * The max limit of the emission direction.
  14114. */
  14115. direction2: Vector3;
  14116. /**
  14117. * Creates a new instance SphereDirectedParticleEmitter
  14118. * @param radius the radius of the emission sphere (1 by default)
  14119. * @param direction1 the min limit of the emission direction (up vector by default)
  14120. * @param direction2 the max limit of the emission direction (up vector by default)
  14121. */
  14122. constructor(radius?: number,
  14123. /**
  14124. * The min limit of the emission direction.
  14125. */
  14126. direction1?: Vector3,
  14127. /**
  14128. * The max limit of the emission direction.
  14129. */
  14130. direction2?: Vector3);
  14131. /**
  14132. * Called by the particle System when the direction is computed for the created particle.
  14133. * @param worldMatrix is the world matrix of the particle system
  14134. * @param directionToUpdate is the direction vector to update with the result
  14135. * @param particle is the particle we are computed the direction for
  14136. */
  14137. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14138. /**
  14139. * Clones the current emitter and returns a copy of it
  14140. * @returns the new emitter
  14141. */
  14142. clone(): SphereDirectedParticleEmitter;
  14143. /**
  14144. * Called by the GPUParticleSystem to setup the update shader
  14145. * @param effect defines the update shader
  14146. */
  14147. applyToShader(effect: Effect): void;
  14148. /**
  14149. * Returns a string to use to update the GPU particles update shader
  14150. * @returns a string containng the defines string
  14151. */
  14152. getEffectDefines(): string;
  14153. /**
  14154. * Returns the string "SphereDirectedParticleEmitter"
  14155. * @returns a string containing the class name
  14156. */
  14157. getClassName(): string;
  14158. /**
  14159. * Serializes the particle system to a JSON object.
  14160. * @returns the JSON object
  14161. */
  14162. serialize(): any;
  14163. /**
  14164. * Parse properties from a JSON object
  14165. * @param serializationObject defines the JSON object
  14166. */
  14167. parse(serializationObject: any): void;
  14168. }
  14169. }
  14170. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14171. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14172. import { Effect } from "babylonjs/Materials/effect";
  14173. import { Particle } from "babylonjs/Particles/particle";
  14174. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14175. import { Nullable } from "babylonjs/types";
  14176. /**
  14177. * Particle emitter emitting particles from a custom list of positions.
  14178. */
  14179. export class CustomParticleEmitter implements IParticleEmitterType {
  14180. /**
  14181. * Gets or sets the position generator that will create the inital position of each particle.
  14182. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14183. */
  14184. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14185. /**
  14186. * Gets or sets the destination generator that will create the final destination of each particle.
  14187. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14188. */
  14189. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14190. /**
  14191. * Creates a new instance CustomParticleEmitter
  14192. */
  14193. constructor();
  14194. /**
  14195. * Called by the particle System when the direction is computed for the created particle.
  14196. * @param worldMatrix is the world matrix of the particle system
  14197. * @param directionToUpdate is the direction vector to update with the result
  14198. * @param particle is the particle we are computed the direction for
  14199. * @param isLocal defines if the direction should be set in local space
  14200. */
  14201. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14202. /**
  14203. * Called by the particle System when the position is computed for the created particle.
  14204. * @param worldMatrix is the world matrix of the particle system
  14205. * @param positionToUpdate is the position vector to update with the result
  14206. * @param particle is the particle we are computed the position for
  14207. * @param isLocal defines if the position should be set in local space
  14208. */
  14209. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14210. /**
  14211. * Clones the current emitter and returns a copy of it
  14212. * @returns the new emitter
  14213. */
  14214. clone(): CustomParticleEmitter;
  14215. /**
  14216. * Called by the GPUParticleSystem to setup the update shader
  14217. * @param effect defines the update shader
  14218. */
  14219. applyToShader(effect: Effect): void;
  14220. /**
  14221. * Returns a string to use to update the GPU particles update shader
  14222. * @returns a string containng the defines string
  14223. */
  14224. getEffectDefines(): string;
  14225. /**
  14226. * Returns the string "PointParticleEmitter"
  14227. * @returns a string containing the class name
  14228. */
  14229. getClassName(): string;
  14230. /**
  14231. * Serializes the particle system to a JSON object.
  14232. * @returns the JSON object
  14233. */
  14234. serialize(): any;
  14235. /**
  14236. * Parse properties from a JSON object
  14237. * @param serializationObject defines the JSON object
  14238. */
  14239. parse(serializationObject: any): void;
  14240. }
  14241. }
  14242. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14243. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14244. import { Effect } from "babylonjs/Materials/effect";
  14245. import { Particle } from "babylonjs/Particles/particle";
  14246. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14247. import { Nullable } from "babylonjs/types";
  14248. import { Scene } from "babylonjs/scene";
  14249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14250. /**
  14251. * Particle emitter emitting particles from the inside of a box.
  14252. * It emits the particles randomly between 2 given directions.
  14253. */
  14254. export class MeshParticleEmitter implements IParticleEmitterType {
  14255. private _indices;
  14256. private _positions;
  14257. private _normals;
  14258. private _storedNormal;
  14259. private _mesh;
  14260. /**
  14261. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14262. */
  14263. direction1: Vector3;
  14264. /**
  14265. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14266. */
  14267. direction2: Vector3;
  14268. /**
  14269. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14270. */
  14271. useMeshNormalsForDirection: boolean;
  14272. /** Defines the mesh to use as source */
  14273. get mesh(): Nullable<AbstractMesh>;
  14274. set mesh(value: Nullable<AbstractMesh>);
  14275. /**
  14276. * Creates a new instance MeshParticleEmitter
  14277. * @param mesh defines the mesh to use as source
  14278. */
  14279. constructor(mesh?: Nullable<AbstractMesh>);
  14280. /**
  14281. * Called by the particle System when the direction is computed for the created particle.
  14282. * @param worldMatrix is the world matrix of the particle system
  14283. * @param directionToUpdate is the direction vector to update with the result
  14284. * @param particle is the particle we are computed the direction for
  14285. * @param isLocal defines if the direction should be set in local space
  14286. */
  14287. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14288. /**
  14289. * Called by the particle System when the position is computed for the created particle.
  14290. * @param worldMatrix is the world matrix of the particle system
  14291. * @param positionToUpdate is the position vector to update with the result
  14292. * @param particle is the particle we are computed the position for
  14293. * @param isLocal defines if the position should be set in local space
  14294. */
  14295. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14296. /**
  14297. * Clones the current emitter and returns a copy of it
  14298. * @returns the new emitter
  14299. */
  14300. clone(): MeshParticleEmitter;
  14301. /**
  14302. * Called by the GPUParticleSystem to setup the update shader
  14303. * @param effect defines the update shader
  14304. */
  14305. applyToShader(effect: Effect): void;
  14306. /**
  14307. * Returns a string to use to update the GPU particles update shader
  14308. * @returns a string containng the defines string
  14309. */
  14310. getEffectDefines(): string;
  14311. /**
  14312. * Returns the string "BoxParticleEmitter"
  14313. * @returns a string containing the class name
  14314. */
  14315. getClassName(): string;
  14316. /**
  14317. * Serializes the particle system to a JSON object.
  14318. * @returns the JSON object
  14319. */
  14320. serialize(): any;
  14321. /**
  14322. * Parse properties from a JSON object
  14323. * @param serializationObject defines the JSON object
  14324. * @param scene defines the hosting scene
  14325. */
  14326. parse(serializationObject: any, scene: Nullable<Scene>): void;
  14327. }
  14328. }
  14329. declare module "babylonjs/Particles/EmitterTypes/index" {
  14330. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14331. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14332. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14333. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14334. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14335. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14336. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14337. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14338. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14339. }
  14340. declare module "babylonjs/Particles/IParticleSystem" {
  14341. import { Nullable } from "babylonjs/types";
  14342. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14343. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14344. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14345. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14346. import { Scene } from "babylonjs/scene";
  14347. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14348. import { Effect } from "babylonjs/Materials/effect";
  14349. import { Observable } from "babylonjs/Misc/observable";
  14350. import { Animation } from "babylonjs/Animations/animation";
  14351. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14352. /**
  14353. * Interface representing a particle system in Babylon.js.
  14354. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14355. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14356. */
  14357. export interface IParticleSystem {
  14358. /**
  14359. * List of animations used by the particle system.
  14360. */
  14361. animations: Animation[];
  14362. /**
  14363. * The id of the Particle system.
  14364. */
  14365. id: string;
  14366. /**
  14367. * The name of the Particle system.
  14368. */
  14369. name: string;
  14370. /**
  14371. * The emitter represents the Mesh or position we are attaching the particle system to.
  14372. */
  14373. emitter: Nullable<AbstractMesh | Vector3>;
  14374. /**
  14375. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14376. */
  14377. isBillboardBased: boolean;
  14378. /**
  14379. * The rendering group used by the Particle system to chose when to render.
  14380. */
  14381. renderingGroupId: number;
  14382. /**
  14383. * The layer mask we are rendering the particles through.
  14384. */
  14385. layerMask: number;
  14386. /**
  14387. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14388. */
  14389. updateSpeed: number;
  14390. /**
  14391. * The amount of time the particle system is running (depends of the overall update speed).
  14392. */
  14393. targetStopDuration: number;
  14394. /**
  14395. * The texture used to render each particle. (this can be a spritesheet)
  14396. */
  14397. particleTexture: Nullable<BaseTexture>;
  14398. /**
  14399. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14400. */
  14401. blendMode: number;
  14402. /**
  14403. * Minimum life time of emitting particles.
  14404. */
  14405. minLifeTime: number;
  14406. /**
  14407. * Maximum life time of emitting particles.
  14408. */
  14409. maxLifeTime: number;
  14410. /**
  14411. * Minimum Size of emitting particles.
  14412. */
  14413. minSize: number;
  14414. /**
  14415. * Maximum Size of emitting particles.
  14416. */
  14417. maxSize: number;
  14418. /**
  14419. * Minimum scale of emitting particles on X axis.
  14420. */
  14421. minScaleX: number;
  14422. /**
  14423. * Maximum scale of emitting particles on X axis.
  14424. */
  14425. maxScaleX: number;
  14426. /**
  14427. * Minimum scale of emitting particles on Y axis.
  14428. */
  14429. minScaleY: number;
  14430. /**
  14431. * Maximum scale of emitting particles on Y axis.
  14432. */
  14433. maxScaleY: number;
  14434. /**
  14435. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14436. */
  14437. color1: Color4;
  14438. /**
  14439. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14440. */
  14441. color2: Color4;
  14442. /**
  14443. * Color the particle will have at the end of its lifetime.
  14444. */
  14445. colorDead: Color4;
  14446. /**
  14447. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14448. */
  14449. emitRate: number;
  14450. /**
  14451. * You can use gravity if you want to give an orientation to your particles.
  14452. */
  14453. gravity: Vector3;
  14454. /**
  14455. * Minimum power of emitting particles.
  14456. */
  14457. minEmitPower: number;
  14458. /**
  14459. * Maximum power of emitting particles.
  14460. */
  14461. maxEmitPower: number;
  14462. /**
  14463. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14464. */
  14465. minAngularSpeed: number;
  14466. /**
  14467. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14468. */
  14469. maxAngularSpeed: number;
  14470. /**
  14471. * Gets or sets the minimal initial rotation in radians.
  14472. */
  14473. minInitialRotation: number;
  14474. /**
  14475. * Gets or sets the maximal initial rotation in radians.
  14476. */
  14477. maxInitialRotation: number;
  14478. /**
  14479. * The particle emitter type defines the emitter used by the particle system.
  14480. * It can be for example box, sphere, or cone...
  14481. */
  14482. particleEmitterType: Nullable<IParticleEmitterType>;
  14483. /**
  14484. * Defines the delay in milliseconds before starting the system (0 by default)
  14485. */
  14486. startDelay: number;
  14487. /**
  14488. * Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0
  14489. */
  14490. preWarmCycles: number;
  14491. /**
  14492. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14493. */
  14494. preWarmStepOffset: number;
  14495. /**
  14496. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  14497. */
  14498. spriteCellChangeSpeed: number;
  14499. /**
  14500. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14501. */
  14502. startSpriteCellID: number;
  14503. /**
  14504. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14505. */
  14506. endSpriteCellID: number;
  14507. /**
  14508. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14509. */
  14510. spriteCellWidth: number;
  14511. /**
  14512. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14513. */
  14514. spriteCellHeight: number;
  14515. /**
  14516. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14517. */
  14518. spriteRandomStartCell: boolean;
  14519. /**
  14520. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14521. */
  14522. isAnimationSheetEnabled: boolean;
  14523. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14524. translationPivot: Vector2;
  14525. /**
  14526. * Gets or sets a texture used to add random noise to particle positions
  14527. */
  14528. noiseTexture: Nullable<BaseTexture>;
  14529. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14530. noiseStrength: Vector3;
  14531. /**
  14532. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14533. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14534. */
  14535. billboardMode: number;
  14536. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14537. limitVelocityDamping: number;
  14538. /**
  14539. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14540. */
  14541. beginAnimationOnStart: boolean;
  14542. /**
  14543. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14544. */
  14545. beginAnimationFrom: number;
  14546. /**
  14547. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14548. */
  14549. beginAnimationTo: number;
  14550. /**
  14551. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14552. */
  14553. beginAnimationLoop: boolean;
  14554. /**
  14555. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14556. */
  14557. disposeOnStop: boolean;
  14558. /**
  14559. * Specifies if the particles are updated in emitter local space or world space
  14560. */
  14561. isLocal: boolean;
  14562. /** Snippet ID if the particle system was created from the snippet server */
  14563. snippetId: string;
  14564. /** Gets or sets a matrix to use to compute projection */
  14565. defaultProjectionMatrix: Matrix;
  14566. /**
  14567. * Gets the maximum number of particles active at the same time.
  14568. * @returns The max number of active particles.
  14569. */
  14570. getCapacity(): number;
  14571. /**
  14572. * Gets the number of particles active at the same time.
  14573. * @returns The number of active particles.
  14574. */
  14575. getActiveCount(): number;
  14576. /**
  14577. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14578. * @returns True if it has been started, otherwise false.
  14579. */
  14580. isStarted(): boolean;
  14581. /**
  14582. * Animates the particle system for this frame.
  14583. */
  14584. animate(): void;
  14585. /**
  14586. * Renders the particle system in its current state.
  14587. * @returns the current number of particles
  14588. */
  14589. render(): number;
  14590. /**
  14591. * Dispose the particle system and frees its associated resources.
  14592. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14593. */
  14594. dispose(disposeTexture?: boolean): void;
  14595. /**
  14596. * An event triggered when the system is disposed
  14597. */
  14598. onDisposeObservable: Observable<IParticleSystem>;
  14599. /**
  14600. * Clones the particle system.
  14601. * @param name The name of the cloned object
  14602. * @param newEmitter The new emitter to use
  14603. * @returns the cloned particle system
  14604. */
  14605. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14606. /**
  14607. * Serializes the particle system to a JSON object
  14608. * @param serializeTexture defines if the texture must be serialized as well
  14609. * @returns the JSON object
  14610. */
  14611. serialize(serializeTexture: boolean): any;
  14612. /**
  14613. * Rebuild the particle system
  14614. */
  14615. rebuild(): void;
  14616. /** Force the system to rebuild all gradients that need to be resync */
  14617. forceRefreshGradients(): void;
  14618. /**
  14619. * Starts the particle system and begins to emit
  14620. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14621. */
  14622. start(delay?: number): void;
  14623. /**
  14624. * Stops the particle system.
  14625. */
  14626. stop(): void;
  14627. /**
  14628. * Remove all active particles
  14629. */
  14630. reset(): void;
  14631. /**
  14632. * Gets a boolean indicating that the system is stopping
  14633. * @returns true if the system is currently stopping
  14634. */
  14635. isStopping(): boolean;
  14636. /**
  14637. * Is this system ready to be used/rendered
  14638. * @return true if the system is ready
  14639. */
  14640. isReady(): boolean;
  14641. /**
  14642. * Returns the string "ParticleSystem"
  14643. * @returns a string containing the class name
  14644. */
  14645. getClassName(): string;
  14646. /**
  14647. * Gets the custom effect used to render the particles
  14648. * @param blendMode Blend mode for which the effect should be retrieved
  14649. * @returns The effect
  14650. */
  14651. getCustomEffect(blendMode: number): Nullable<Effect>;
  14652. /**
  14653. * Sets the custom effect used to render the particles
  14654. * @param effect The effect to set
  14655. * @param blendMode Blend mode for which the effect should be set
  14656. */
  14657. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14658. /**
  14659. * Fill the defines array according to the current settings of the particle system
  14660. * @param defines Array to be updated
  14661. * @param blendMode blend mode to take into account when updating the array
  14662. */
  14663. fillDefines(defines: Array<string>, blendMode: number): void;
  14664. /**
  14665. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14666. * @param uniforms Uniforms array to fill
  14667. * @param attributes Attributes array to fill
  14668. * @param samplers Samplers array to fill
  14669. */
  14670. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14671. /**
  14672. * Observable that will be called just before the particles are drawn
  14673. */
  14674. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14675. /**
  14676. * Gets the name of the particle vertex shader
  14677. */
  14678. vertexShaderName: string;
  14679. /**
  14680. * Adds a new color gradient
  14681. * @param gradient defines the gradient to use (between 0 and 1)
  14682. * @param color1 defines the color to affect to the specified gradient
  14683. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14684. * @returns the current particle system
  14685. */
  14686. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14687. /**
  14688. * Remove a specific color gradient
  14689. * @param gradient defines the gradient to remove
  14690. * @returns the current particle system
  14691. */
  14692. removeColorGradient(gradient: number): IParticleSystem;
  14693. /**
  14694. * Adds a new size gradient
  14695. * @param gradient defines the gradient to use (between 0 and 1)
  14696. * @param factor defines the size factor to affect to the specified gradient
  14697. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14698. * @returns the current particle system
  14699. */
  14700. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14701. /**
  14702. * Remove a specific size gradient
  14703. * @param gradient defines the gradient to remove
  14704. * @returns the current particle system
  14705. */
  14706. removeSizeGradient(gradient: number): IParticleSystem;
  14707. /**
  14708. * Gets the current list of color gradients.
  14709. * You must use addColorGradient and removeColorGradient to udpate this list
  14710. * @returns the list of color gradients
  14711. */
  14712. getColorGradients(): Nullable<Array<ColorGradient>>;
  14713. /**
  14714. * Gets the current list of size gradients.
  14715. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14716. * @returns the list of size gradients
  14717. */
  14718. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14719. /**
  14720. * Gets the current list of angular speed gradients.
  14721. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14722. * @returns the list of angular speed gradients
  14723. */
  14724. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14725. /**
  14726. * Adds a new angular speed gradient
  14727. * @param gradient defines the gradient to use (between 0 and 1)
  14728. * @param factor defines the angular speed to affect to the specified gradient
  14729. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14730. * @returns the current particle system
  14731. */
  14732. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14733. /**
  14734. * Remove a specific angular speed gradient
  14735. * @param gradient defines the gradient to remove
  14736. * @returns the current particle system
  14737. */
  14738. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14739. /**
  14740. * Gets the current list of velocity gradients.
  14741. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14742. * @returns the list of velocity gradients
  14743. */
  14744. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14745. /**
  14746. * Adds a new velocity gradient
  14747. * @param gradient defines the gradient to use (between 0 and 1)
  14748. * @param factor defines the velocity to affect to the specified gradient
  14749. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14750. * @returns the current particle system
  14751. */
  14752. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14753. /**
  14754. * Remove a specific velocity gradient
  14755. * @param gradient defines the gradient to remove
  14756. * @returns the current particle system
  14757. */
  14758. removeVelocityGradient(gradient: number): IParticleSystem;
  14759. /**
  14760. * Gets the current list of limit velocity gradients.
  14761. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14762. * @returns the list of limit velocity gradients
  14763. */
  14764. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14765. /**
  14766. * Adds a new limit velocity gradient
  14767. * @param gradient defines the gradient to use (between 0 and 1)
  14768. * @param factor defines the limit velocity to affect to the specified gradient
  14769. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14770. * @returns the current particle system
  14771. */
  14772. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14773. /**
  14774. * Remove a specific limit velocity gradient
  14775. * @param gradient defines the gradient to remove
  14776. * @returns the current particle system
  14777. */
  14778. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14779. /**
  14780. * Adds a new drag gradient
  14781. * @param gradient defines the gradient to use (between 0 and 1)
  14782. * @param factor defines the drag to affect to the specified gradient
  14783. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14784. * @returns the current particle system
  14785. */
  14786. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14787. /**
  14788. * Remove a specific drag gradient
  14789. * @param gradient defines the gradient to remove
  14790. * @returns the current particle system
  14791. */
  14792. removeDragGradient(gradient: number): IParticleSystem;
  14793. /**
  14794. * Gets the current list of drag gradients.
  14795. * You must use addDragGradient and removeDragGradient to udpate this list
  14796. * @returns the list of drag gradients
  14797. */
  14798. getDragGradients(): Nullable<Array<FactorGradient>>;
  14799. /**
  14800. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14801. * @param gradient defines the gradient to use (between 0 and 1)
  14802. * @param factor defines the emit rate to affect to the specified gradient
  14803. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14804. * @returns the current particle system
  14805. */
  14806. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14807. /**
  14808. * Remove a specific emit rate gradient
  14809. * @param gradient defines the gradient to remove
  14810. * @returns the current particle system
  14811. */
  14812. removeEmitRateGradient(gradient: number): IParticleSystem;
  14813. /**
  14814. * Gets the current list of emit rate gradients.
  14815. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14816. * @returns the list of emit rate gradients
  14817. */
  14818. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14819. /**
  14820. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14821. * @param gradient defines the gradient to use (between 0 and 1)
  14822. * @param factor defines the start size to affect to the specified gradient
  14823. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14824. * @returns the current particle system
  14825. */
  14826. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14827. /**
  14828. * Remove a specific start size gradient
  14829. * @param gradient defines the gradient to remove
  14830. * @returns the current particle system
  14831. */
  14832. removeStartSizeGradient(gradient: number): IParticleSystem;
  14833. /**
  14834. * Gets the current list of start size gradients.
  14835. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14836. * @returns the list of start size gradients
  14837. */
  14838. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14839. /**
  14840. * Adds a new life time gradient
  14841. * @param gradient defines the gradient to use (between 0 and 1)
  14842. * @param factor defines the life time factor to affect to the specified gradient
  14843. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14844. * @returns the current particle system
  14845. */
  14846. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14847. /**
  14848. * Remove a specific life time gradient
  14849. * @param gradient defines the gradient to remove
  14850. * @returns the current particle system
  14851. */
  14852. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14853. /**
  14854. * Gets the current list of life time gradients.
  14855. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14856. * @returns the list of life time gradients
  14857. */
  14858. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14859. /**
  14860. * Gets the current list of color gradients.
  14861. * You must use addColorGradient and removeColorGradient to udpate this list
  14862. * @returns the list of color gradients
  14863. */
  14864. getColorGradients(): Nullable<Array<ColorGradient>>;
  14865. /**
  14866. * Adds a new ramp gradient used to remap particle colors
  14867. * @param gradient defines the gradient to use (between 0 and 1)
  14868. * @param color defines the color to affect to the specified gradient
  14869. * @returns the current particle system
  14870. */
  14871. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14872. /**
  14873. * Gets the current list of ramp gradients.
  14874. * You must use addRampGradient and removeRampGradient to udpate this list
  14875. * @returns the list of ramp gradients
  14876. */
  14877. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14878. /** Gets or sets a boolean indicating that ramp gradients must be used
  14879. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14880. */
  14881. useRampGradients: boolean;
  14882. /**
  14883. * Adds a new color remap gradient
  14884. * @param gradient defines the gradient to use (between 0 and 1)
  14885. * @param min defines the color remap minimal range
  14886. * @param max defines the color remap maximal range
  14887. * @returns the current particle system
  14888. */
  14889. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14890. /**
  14891. * Gets the current list of color remap gradients.
  14892. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14893. * @returns the list of color remap gradients
  14894. */
  14895. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14896. /**
  14897. * Adds a new alpha remap gradient
  14898. * @param gradient defines the gradient to use (between 0 and 1)
  14899. * @param min defines the alpha remap minimal range
  14900. * @param max defines the alpha remap maximal range
  14901. * @returns the current particle system
  14902. */
  14903. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14904. /**
  14905. * Gets the current list of alpha remap gradients.
  14906. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14907. * @returns the list of alpha remap gradients
  14908. */
  14909. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14910. /**
  14911. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14912. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14913. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14914. * @returns the emitter
  14915. */
  14916. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14917. /**
  14918. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14919. * @param radius The radius of the hemisphere to emit from
  14920. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14921. * @returns the emitter
  14922. */
  14923. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14924. /**
  14925. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14926. * @param radius The radius of the sphere to emit from
  14927. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14928. * @returns the emitter
  14929. */
  14930. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14931. /**
  14932. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14933. * @param radius The radius of the sphere to emit from
  14934. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14935. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14936. * @returns the emitter
  14937. */
  14938. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14939. /**
  14940. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14941. * @param radius The radius of the emission cylinder
  14942. * @param height The height of the emission cylinder
  14943. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14944. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14945. * @returns the emitter
  14946. */
  14947. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  14948. /**
  14949. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14950. * @param radius The radius of the cylinder to emit from
  14951. * @param height The height of the emission cylinder
  14952. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14953. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14954. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14955. * @returns the emitter
  14956. */
  14957. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14958. /**
  14959. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14960. * @param radius The radius of the cone to emit from
  14961. * @param angle The base angle of the cone
  14962. * @returns the emitter
  14963. */
  14964. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  14965. /**
  14966. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14967. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14968. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14969. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14970. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14971. * @returns the emitter
  14972. */
  14973. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14974. /**
  14975. * Get hosting scene
  14976. * @returns the scene
  14977. */
  14978. getScene(): Nullable<Scene>;
  14979. }
  14980. }
  14981. declare module "babylonjs/Meshes/transformNode" {
  14982. import { DeepImmutable } from "babylonjs/types";
  14983. import { Observable } from "babylonjs/Misc/observable";
  14984. import { Nullable } from "babylonjs/types";
  14985. import { Camera } from "babylonjs/Cameras/camera";
  14986. import { Scene } from "babylonjs/scene";
  14987. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14988. import { Node } from "babylonjs/node";
  14989. import { Bone } from "babylonjs/Bones/bone";
  14990. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14991. import { Space } from "babylonjs/Maths/math.axis";
  14992. /**
  14993. * A TransformNode is an object that is not rendered but can be used as a center of transformation. This can decrease memory usage and increase rendering speed compared to using an empty mesh as a parent and is less complicated than using a pivot matrix.
  14994. * @see https://doc.babylonjs.com/how_to/transformnode
  14995. */
  14996. export class TransformNode extends Node {
  14997. /**
  14998. * Object will not rotate to face the camera
  14999. */
  15000. static BILLBOARDMODE_NONE: number;
  15001. /**
  15002. * Object will rotate to face the camera but only on the x axis
  15003. */
  15004. static BILLBOARDMODE_X: number;
  15005. /**
  15006. * Object will rotate to face the camera but only on the y axis
  15007. */
  15008. static BILLBOARDMODE_Y: number;
  15009. /**
  15010. * Object will rotate to face the camera but only on the z axis
  15011. */
  15012. static BILLBOARDMODE_Z: number;
  15013. /**
  15014. * Object will rotate to face the camera
  15015. */
  15016. static BILLBOARDMODE_ALL: number;
  15017. /**
  15018. * Object will rotate to face the camera's position instead of orientation
  15019. */
  15020. static BILLBOARDMODE_USE_POSITION: number;
  15021. private static _TmpRotation;
  15022. private static _TmpScaling;
  15023. private static _TmpTranslation;
  15024. private _forward;
  15025. private _forwardInverted;
  15026. private _up;
  15027. private _right;
  15028. private _rightInverted;
  15029. private _position;
  15030. private _rotation;
  15031. private _rotationQuaternion;
  15032. protected _scaling: Vector3;
  15033. protected _isDirty: boolean;
  15034. private _transformToBoneReferal;
  15035. private _isAbsoluteSynced;
  15036. private _billboardMode;
  15037. /**
  15038. * Gets or sets the billboard mode. Default is 0.
  15039. *
  15040. * | Value | Type | Description |
  15041. * | --- | --- | --- |
  15042. * | 0 | BILLBOARDMODE_NONE | |
  15043. * | 1 | BILLBOARDMODE_X | |
  15044. * | 2 | BILLBOARDMODE_Y | |
  15045. * | 4 | BILLBOARDMODE_Z | |
  15046. * | 7 | BILLBOARDMODE_ALL | |
  15047. *
  15048. */
  15049. get billboardMode(): number;
  15050. set billboardMode(value: number);
  15051. private _preserveParentRotationForBillboard;
  15052. /**
  15053. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  15054. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  15055. */
  15056. get preserveParentRotationForBillboard(): boolean;
  15057. set preserveParentRotationForBillboard(value: boolean);
  15058. /**
  15059. * Multiplication factor on scale x/y/z when computing the world matrix. Eg. for a 1x1x1 cube setting this to 2 will make it a 2x2x2 cube
  15060. */
  15061. scalingDeterminant: number;
  15062. private _infiniteDistance;
  15063. /**
  15064. * Gets or sets the distance of the object to max, often used by skybox
  15065. */
  15066. get infiniteDistance(): boolean;
  15067. set infiniteDistance(value: boolean);
  15068. /**
  15069. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  15070. * By default the system will update normals to compensate
  15071. */
  15072. ignoreNonUniformScaling: boolean;
  15073. /**
  15074. * Gets or sets a boolean indicating that even if rotationQuaternion is defined, you can keep updating rotation property and Babylon.js will just mix both
  15075. */
  15076. reIntegrateRotationIntoRotationQuaternion: boolean;
  15077. /** @hidden */
  15078. _poseMatrix: Nullable<Matrix>;
  15079. /** @hidden */
  15080. _localMatrix: Matrix;
  15081. private _usePivotMatrix;
  15082. private _absolutePosition;
  15083. private _absoluteScaling;
  15084. private _absoluteRotationQuaternion;
  15085. private _pivotMatrix;
  15086. private _pivotMatrixInverse;
  15087. protected _postMultiplyPivotMatrix: boolean;
  15088. protected _isWorldMatrixFrozen: boolean;
  15089. /** @hidden */
  15090. _indexInSceneTransformNodesArray: number;
  15091. /**
  15092. * An event triggered after the world matrix is updated
  15093. */
  15094. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15095. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15096. /**
  15097. * Gets a string identifying the name of the class
  15098. * @returns "TransformNode" string
  15099. */
  15100. getClassName(): string;
  15101. /**
  15102. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15103. */
  15104. get position(): Vector3;
  15105. set position(newPosition: Vector3);
  15106. /**
  15107. * Gets or sets the rotation property : a Vector3 defining the rotation value in radians around each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15108. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15109. */
  15110. get rotation(): Vector3;
  15111. set rotation(newRotation: Vector3);
  15112. /**
  15113. * Gets or sets the scaling property : a Vector3 defining the node scaling along each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15114. */
  15115. get scaling(): Vector3;
  15116. set scaling(newScaling: Vector3);
  15117. /**
  15118. * Gets or sets the rotation Quaternion property : this a Quaternion object defining the node rotation by using a unit quaternion (undefined by default, but can be null).
  15119. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15120. */
  15121. get rotationQuaternion(): Nullable<Quaternion>;
  15122. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15123. /**
  15124. * The forward direction of that transform in world space.
  15125. */
  15126. get forward(): Vector3;
  15127. /**
  15128. * The up direction of that transform in world space.
  15129. */
  15130. get up(): Vector3;
  15131. /**
  15132. * The right direction of that transform in world space.
  15133. */
  15134. get right(): Vector3;
  15135. /**
  15136. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15137. * @param matrix the matrix to copy the pose from
  15138. * @returns this TransformNode.
  15139. */
  15140. updatePoseMatrix(matrix: Matrix): TransformNode;
  15141. /**
  15142. * Returns the mesh Pose matrix.
  15143. * @returns the pose matrix
  15144. */
  15145. getPoseMatrix(): Matrix;
  15146. /** @hidden */
  15147. _isSynchronized(): boolean;
  15148. /** @hidden */
  15149. _initCache(): void;
  15150. /**
  15151. * Flag the transform node as dirty (Forcing it to update everything)
  15152. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15153. * @returns this transform node
  15154. */
  15155. markAsDirty(property: string): TransformNode;
  15156. /**
  15157. * Returns the current mesh absolute position.
  15158. * Returns a Vector3.
  15159. */
  15160. get absolutePosition(): Vector3;
  15161. /**
  15162. * Returns the current mesh absolute scaling.
  15163. * Returns a Vector3.
  15164. */
  15165. get absoluteScaling(): Vector3;
  15166. /**
  15167. * Returns the current mesh absolute rotation.
  15168. * Returns a Quaternion.
  15169. */
  15170. get absoluteRotationQuaternion(): Quaternion;
  15171. /**
  15172. * Sets a new matrix to apply before all other transformation
  15173. * @param matrix defines the transform matrix
  15174. * @returns the current TransformNode
  15175. */
  15176. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15177. /**
  15178. * Sets a new pivot matrix to the current node
  15179. * @param matrix defines the new pivot matrix to use
  15180. * @param postMultiplyPivotMatrix defines if the pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect
  15181. * @returns the current TransformNode
  15182. */
  15183. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15184. /**
  15185. * Returns the mesh pivot matrix.
  15186. * Default : Identity.
  15187. * @returns the matrix
  15188. */
  15189. getPivotMatrix(): Matrix;
  15190. /**
  15191. * Instantiate (when possible) or clone that node with its hierarchy
  15192. * @param newParent defines the new parent to use for the instance (or clone)
  15193. * @param options defines options to configure how copy is done
  15194. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15195. * @returns an instance (or a clone) of the current node with its hiearchy
  15196. */
  15197. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15198. doNotInstantiate: boolean;
  15199. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15200. /**
  15201. * Prevents the World matrix to be computed any longer
  15202. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15203. * @returns the TransformNode.
  15204. */
  15205. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15206. /**
  15207. * Allows back the World matrix computation.
  15208. * @returns the TransformNode.
  15209. */
  15210. unfreezeWorldMatrix(): this;
  15211. /**
  15212. * True if the World matrix has been frozen.
  15213. */
  15214. get isWorldMatrixFrozen(): boolean;
  15215. /**
  15216. * Retuns the mesh absolute position in the World.
  15217. * @returns a Vector3.
  15218. */
  15219. getAbsolutePosition(): Vector3;
  15220. /**
  15221. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15222. * @param absolutePosition the absolute position to set
  15223. * @returns the TransformNode.
  15224. */
  15225. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15226. /**
  15227. * Sets the mesh position in its local space.
  15228. * @param vector3 the position to set in localspace
  15229. * @returns the TransformNode.
  15230. */
  15231. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15232. /**
  15233. * Returns the mesh position in the local space from the current World matrix values.
  15234. * @returns a new Vector3.
  15235. */
  15236. getPositionExpressedInLocalSpace(): Vector3;
  15237. /**
  15238. * Translates the mesh along the passed Vector3 in its local space.
  15239. * @param vector3 the distance to translate in localspace
  15240. * @returns the TransformNode.
  15241. */
  15242. locallyTranslate(vector3: Vector3): TransformNode;
  15243. private static _lookAtVectorCache;
  15244. /**
  15245. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15246. * @param targetPoint the position (must be in same space as current mesh) to look at
  15247. * @param yawCor optional yaw (y-axis) correction in radians
  15248. * @param pitchCor optional pitch (x-axis) correction in radians
  15249. * @param rollCor optional roll (z-axis) correction in radians
  15250. * @param space the choosen space of the target
  15251. * @returns the TransformNode.
  15252. */
  15253. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15254. /**
  15255. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15256. * This Vector3 is expressed in the World space.
  15257. * @param localAxis axis to rotate
  15258. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15259. */
  15260. getDirection(localAxis: Vector3): Vector3;
  15261. /**
  15262. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15263. * localAxis is expressed in the mesh local space.
  15264. * result is computed in the Wordl space from the mesh World matrix.
  15265. * @param localAxis axis to rotate
  15266. * @param result the resulting transformnode
  15267. * @returns this TransformNode.
  15268. */
  15269. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15270. /**
  15271. * Sets this transform node rotation to the given local axis.
  15272. * @param localAxis the axis in local space
  15273. * @param yawCor optional yaw (y-axis) correction in radians
  15274. * @param pitchCor optional pitch (x-axis) correction in radians
  15275. * @param rollCor optional roll (z-axis) correction in radians
  15276. * @returns this TransformNode
  15277. */
  15278. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15279. /**
  15280. * Sets a new pivot point to the current node
  15281. * @param point defines the new pivot point to use
  15282. * @param space defines if the point is in world or local space (local by default)
  15283. * @returns the current TransformNode
  15284. */
  15285. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15286. /**
  15287. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15288. * @returns the pivot point
  15289. */
  15290. getPivotPoint(): Vector3;
  15291. /**
  15292. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15293. * @param result the vector3 to store the result
  15294. * @returns this TransformNode.
  15295. */
  15296. getPivotPointToRef(result: Vector3): TransformNode;
  15297. /**
  15298. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15299. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15300. */
  15301. getAbsolutePivotPoint(): Vector3;
  15302. /**
  15303. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15304. * @param result vector3 to store the result
  15305. * @returns this TransformNode.
  15306. */
  15307. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15308. /**
  15309. * Defines the passed node as the parent of the current node.
  15310. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15311. * @see https://doc.babylonjs.com/how_to/parenting
  15312. * @param node the node ot set as the parent
  15313. * @returns this TransformNode.
  15314. */
  15315. setParent(node: Nullable<Node>): TransformNode;
  15316. private _nonUniformScaling;
  15317. /**
  15318. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15319. */
  15320. get nonUniformScaling(): boolean;
  15321. /** @hidden */
  15322. _updateNonUniformScalingState(value: boolean): boolean;
  15323. /**
  15324. * Attach the current TransformNode to another TransformNode associated with a bone
  15325. * @param bone Bone affecting the TransformNode
  15326. * @param affectedTransformNode TransformNode associated with the bone
  15327. * @returns this object
  15328. */
  15329. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15330. /**
  15331. * Detach the transform node if its associated with a bone
  15332. * @returns this object
  15333. */
  15334. detachFromBone(): TransformNode;
  15335. private static _rotationAxisCache;
  15336. /**
  15337. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15338. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15339. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15340. * The passed axis is also normalized.
  15341. * @param axis the axis to rotate around
  15342. * @param amount the amount to rotate in radians
  15343. * @param space Space to rotate in (Default: local)
  15344. * @returns the TransformNode.
  15345. */
  15346. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15347. /**
  15348. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15349. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15350. * The passed axis is also normalized. .
  15351. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15352. * @param point the point to rotate around
  15353. * @param axis the axis to rotate around
  15354. * @param amount the amount to rotate in radians
  15355. * @returns the TransformNode
  15356. */
  15357. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15358. /**
  15359. * Translates the mesh along the axis vector for the passed distance in the given space.
  15360. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15361. * @param axis the axis to translate in
  15362. * @param distance the distance to translate
  15363. * @param space Space to rotate in (Default: local)
  15364. * @returns the TransformNode.
  15365. */
  15366. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15367. /**
  15368. * Adds a rotation step to the mesh current rotation.
  15369. * x, y, z are Euler angles expressed in radians.
  15370. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15371. * This means this rotation is made in the mesh local space only.
  15372. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15373. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15374. * ```javascript
  15375. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15376. * ```
  15377. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15378. * Under the hood, only quaternions are used. So it's a little faster is you use .rotationQuaternion because it doesn't need to translate them back to Euler angles.
  15379. * @param x Rotation to add
  15380. * @param y Rotation to add
  15381. * @param z Rotation to add
  15382. * @returns the TransformNode.
  15383. */
  15384. addRotation(x: number, y: number, z: number): TransformNode;
  15385. /**
  15386. * @hidden
  15387. */
  15388. protected _getEffectiveParent(): Nullable<Node>;
  15389. /**
  15390. * Computes the world matrix of the node
  15391. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15392. * @returns the world matrix
  15393. */
  15394. computeWorldMatrix(force?: boolean): Matrix;
  15395. /**
  15396. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15397. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15398. */
  15399. resetLocalMatrix(independentOfChildren?: boolean): void;
  15400. protected _afterComputeWorldMatrix(): void;
  15401. /**
  15402. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15403. * @param func callback function to add
  15404. *
  15405. * @returns the TransformNode.
  15406. */
  15407. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15408. /**
  15409. * Removes a registered callback function.
  15410. * @param func callback function to remove
  15411. * @returns the TransformNode.
  15412. */
  15413. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15414. /**
  15415. * Gets the position of the current mesh in camera space
  15416. * @param camera defines the camera to use
  15417. * @returns a position
  15418. */
  15419. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15420. /**
  15421. * Returns the distance from the mesh to the active camera
  15422. * @param camera defines the camera to use
  15423. * @returns the distance
  15424. */
  15425. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15426. /**
  15427. * Clone the current transform node
  15428. * @param name Name of the new clone
  15429. * @param newParent New parent for the clone
  15430. * @param doNotCloneChildren Do not clone children hierarchy
  15431. * @returns the new transform node
  15432. */
  15433. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15434. /**
  15435. * Serializes the objects information.
  15436. * @param currentSerializationObject defines the object to serialize in
  15437. * @returns the serialized object
  15438. */
  15439. serialize(currentSerializationObject?: any): any;
  15440. /**
  15441. * Returns a new TransformNode object parsed from the source provided.
  15442. * @param parsedTransformNode is the source.
  15443. * @param scene the scne the object belongs to
  15444. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15445. * @returns a new TransformNode object parsed from the source provided.
  15446. */
  15447. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15448. /**
  15449. * Get all child-transformNodes of this node
  15450. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  15451. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  15452. * @returns an array of TransformNode
  15453. */
  15454. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15455. /**
  15456. * Releases resources associated with this transform node.
  15457. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15458. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15459. */
  15460. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15461. /**
  15462. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15463. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15464. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15465. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15466. * @returns the current mesh
  15467. */
  15468. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15469. private _syncAbsoluteScalingAndRotation;
  15470. }
  15471. }
  15472. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15473. /**
  15474. * Class used to override all child animations of a given target
  15475. */
  15476. export class AnimationPropertiesOverride {
  15477. /**
  15478. * Gets or sets a value indicating if animation blending must be used
  15479. */
  15480. enableBlending: boolean;
  15481. /**
  15482. * Gets or sets the blending speed to use when enableBlending is true
  15483. */
  15484. blendingSpeed: number;
  15485. /**
  15486. * Gets or sets the default loop mode to use
  15487. */
  15488. loopMode: number;
  15489. }
  15490. }
  15491. declare module "babylonjs/Bones/bone" {
  15492. import { Skeleton } from "babylonjs/Bones/skeleton";
  15493. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15494. import { Nullable } from "babylonjs/types";
  15495. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15496. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15497. import { Node } from "babylonjs/node";
  15498. import { Space } from "babylonjs/Maths/math.axis";
  15499. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15500. /**
  15501. * Class used to store bone information
  15502. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15503. */
  15504. export class Bone extends Node {
  15505. /**
  15506. * defines the bone name
  15507. */
  15508. name: string;
  15509. private static _tmpVecs;
  15510. private static _tmpQuat;
  15511. private static _tmpMats;
  15512. /**
  15513. * Gets the list of child bones
  15514. */
  15515. children: Bone[];
  15516. /** Gets the animations associated with this bone */
  15517. animations: import("babylonjs/Animations/animation").Animation[];
  15518. /**
  15519. * Gets or sets bone length
  15520. */
  15521. length: number;
  15522. /**
  15523. * @hidden Internal only
  15524. * Set this value to map this bone to a different index in the transform matrices
  15525. * Set this value to -1 to exclude the bone from the transform matrices
  15526. */
  15527. _index: Nullable<number>;
  15528. private _skeleton;
  15529. private _localMatrix;
  15530. private _restPose;
  15531. private _bindPose;
  15532. private _baseMatrix;
  15533. private _absoluteTransform;
  15534. private _invertedAbsoluteTransform;
  15535. private _parent;
  15536. private _scalingDeterminant;
  15537. private _worldTransform;
  15538. private _localScaling;
  15539. private _localRotation;
  15540. private _localPosition;
  15541. private _needToDecompose;
  15542. private _needToCompose;
  15543. /** @hidden */
  15544. _linkedTransformNode: Nullable<TransformNode>;
  15545. /** @hidden */
  15546. _waitingTransformNodeId: Nullable<string>;
  15547. /** @hidden */
  15548. get _matrix(): Matrix;
  15549. /** @hidden */
  15550. set _matrix(value: Matrix);
  15551. /**
  15552. * Create a new bone
  15553. * @param name defines the bone name
  15554. * @param skeleton defines the parent skeleton
  15555. * @param parentBone defines the parent (can be null if the bone is the root)
  15556. * @param localMatrix defines the local matrix
  15557. * @param restPose defines the rest pose matrix
  15558. * @param baseMatrix defines the base matrix
  15559. * @param index defines index of the bone in the hiearchy
  15560. */
  15561. constructor(
  15562. /**
  15563. * defines the bone name
  15564. */
  15565. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15566. /**
  15567. * Gets the current object class name.
  15568. * @return the class name
  15569. */
  15570. getClassName(): string;
  15571. /**
  15572. * Gets the parent skeleton
  15573. * @returns a skeleton
  15574. */
  15575. getSkeleton(): Skeleton;
  15576. /**
  15577. * Gets parent bone
  15578. * @returns a bone or null if the bone is the root of the bone hierarchy
  15579. */
  15580. getParent(): Nullable<Bone>;
  15581. /**
  15582. * Returns an array containing the root bones
  15583. * @returns an array containing the root bones
  15584. */
  15585. getChildren(): Array<Bone>;
  15586. /**
  15587. * Gets the node index in matrix array generated for rendering
  15588. * @returns the node index
  15589. */
  15590. getIndex(): number;
  15591. /**
  15592. * Sets the parent bone
  15593. * @param parent defines the parent (can be null if the bone is the root)
  15594. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15595. */
  15596. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15597. /**
  15598. * Gets the local matrix
  15599. * @returns a matrix
  15600. */
  15601. getLocalMatrix(): Matrix;
  15602. /**
  15603. * Gets the base matrix (initial matrix which remains unchanged)
  15604. * @returns a matrix
  15605. */
  15606. getBaseMatrix(): Matrix;
  15607. /**
  15608. * Gets the rest pose matrix
  15609. * @returns a matrix
  15610. */
  15611. getRestPose(): Matrix;
  15612. /**
  15613. * Sets the rest pose matrix
  15614. * @param matrix the local-space rest pose to set for this bone
  15615. */
  15616. setRestPose(matrix: Matrix): void;
  15617. /**
  15618. * Gets the bind pose matrix
  15619. * @returns the bind pose matrix
  15620. */
  15621. getBindPose(): Matrix;
  15622. /**
  15623. * Sets the bind pose matrix
  15624. * @param matrix the local-space bind pose to set for this bone
  15625. */
  15626. setBindPose(matrix: Matrix): void;
  15627. /**
  15628. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15629. */
  15630. getWorldMatrix(): Matrix;
  15631. /**
  15632. * Sets the local matrix to rest pose matrix
  15633. */
  15634. returnToRest(): void;
  15635. /**
  15636. * Gets the inverse of the absolute transform matrix.
  15637. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15638. * @returns a matrix
  15639. */
  15640. getInvertedAbsoluteTransform(): Matrix;
  15641. /**
  15642. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15643. * @returns a matrix
  15644. */
  15645. getAbsoluteTransform(): Matrix;
  15646. /**
  15647. * Links with the given transform node.
  15648. * The local matrix of this bone is copied from the transform node every frame.
  15649. * @param transformNode defines the transform node to link to
  15650. */
  15651. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15652. /**
  15653. * Gets the node used to drive the bone's transformation
  15654. * @returns a transform node or null
  15655. */
  15656. getTransformNode(): Nullable<TransformNode>;
  15657. /** Gets or sets current position (in local space) */
  15658. get position(): Vector3;
  15659. set position(newPosition: Vector3);
  15660. /** Gets or sets current rotation (in local space) */
  15661. get rotation(): Vector3;
  15662. set rotation(newRotation: Vector3);
  15663. /** Gets or sets current rotation quaternion (in local space) */
  15664. get rotationQuaternion(): Quaternion;
  15665. set rotationQuaternion(newRotation: Quaternion);
  15666. /** Gets or sets current scaling (in local space) */
  15667. get scaling(): Vector3;
  15668. set scaling(newScaling: Vector3);
  15669. /**
  15670. * Gets the animation properties override
  15671. */
  15672. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15673. private _decompose;
  15674. private _compose;
  15675. /**
  15676. * Update the base and local matrices
  15677. * @param matrix defines the new base or local matrix
  15678. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15679. * @param updateLocalMatrix defines if the local matrix should be updated
  15680. */
  15681. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15682. /** @hidden */
  15683. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15684. /**
  15685. * Flag the bone as dirty (Forcing it to update everything)
  15686. */
  15687. markAsDirty(): void;
  15688. /** @hidden */
  15689. _markAsDirtyAndCompose(): void;
  15690. private _markAsDirtyAndDecompose;
  15691. /**
  15692. * Translate the bone in local or world space
  15693. * @param vec The amount to translate the bone
  15694. * @param space The space that the translation is in
  15695. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15696. */
  15697. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15698. /**
  15699. * Set the postion of the bone in local or world space
  15700. * @param position The position to set the bone
  15701. * @param space The space that the position is in
  15702. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15703. */
  15704. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15705. /**
  15706. * Set the absolute position of the bone (world space)
  15707. * @param position The position to set the bone
  15708. * @param mesh The mesh that this bone is attached to
  15709. */
  15710. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15711. /**
  15712. * Scale the bone on the x, y and z axes (in local space)
  15713. * @param x The amount to scale the bone on the x axis
  15714. * @param y The amount to scale the bone on the y axis
  15715. * @param z The amount to scale the bone on the z axis
  15716. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15717. */
  15718. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15719. /**
  15720. * Set the bone scaling in local space
  15721. * @param scale defines the scaling vector
  15722. */
  15723. setScale(scale: Vector3): void;
  15724. /**
  15725. * Gets the current scaling in local space
  15726. * @returns the current scaling vector
  15727. */
  15728. getScale(): Vector3;
  15729. /**
  15730. * Gets the current scaling in local space and stores it in a target vector
  15731. * @param result defines the target vector
  15732. */
  15733. getScaleToRef(result: Vector3): void;
  15734. /**
  15735. * Set the yaw, pitch, and roll of the bone in local or world space
  15736. * @param yaw The rotation of the bone on the y axis
  15737. * @param pitch The rotation of the bone on the x axis
  15738. * @param roll The rotation of the bone on the z axis
  15739. * @param space The space that the axes of rotation are in
  15740. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15741. */
  15742. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15743. /**
  15744. * Add a rotation to the bone on an axis in local or world space
  15745. * @param axis The axis to rotate the bone on
  15746. * @param amount The amount to rotate the bone
  15747. * @param space The space that the axis is in
  15748. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15749. */
  15750. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15751. /**
  15752. * Set the rotation of the bone to a particular axis angle in local or world space
  15753. * @param axis The axis to rotate the bone on
  15754. * @param angle The angle that the bone should be rotated to
  15755. * @param space The space that the axis is in
  15756. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15757. */
  15758. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15759. /**
  15760. * Set the euler rotation of the bone in local of world space
  15761. * @param rotation The euler rotation that the bone should be set to
  15762. * @param space The space that the rotation is in
  15763. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15764. */
  15765. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15766. /**
  15767. * Set the quaternion rotation of the bone in local of world space
  15768. * @param quat The quaternion rotation that the bone should be set to
  15769. * @param space The space that the rotation is in
  15770. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15771. */
  15772. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15773. /**
  15774. * Set the rotation matrix of the bone in local of world space
  15775. * @param rotMat The rotation matrix that the bone should be set to
  15776. * @param space The space that the rotation is in
  15777. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15778. */
  15779. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15780. private _rotateWithMatrix;
  15781. private _getNegativeRotationToRef;
  15782. /**
  15783. * Get the position of the bone in local or world space
  15784. * @param space The space that the returned position is in
  15785. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15786. * @returns The position of the bone
  15787. */
  15788. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15789. /**
  15790. * Copy the position of the bone to a vector3 in local or world space
  15791. * @param space The space that the returned position is in
  15792. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15793. * @param result The vector3 to copy the position to
  15794. */
  15795. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15796. /**
  15797. * Get the absolute position of the bone (world space)
  15798. * @param mesh The mesh that this bone is attached to
  15799. * @returns The absolute position of the bone
  15800. */
  15801. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15802. /**
  15803. * Copy the absolute position of the bone (world space) to the result param
  15804. * @param mesh The mesh that this bone is attached to
  15805. * @param result The vector3 to copy the absolute position to
  15806. */
  15807. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15808. /**
  15809. * Compute the absolute transforms of this bone and its children
  15810. */
  15811. computeAbsoluteTransforms(): void;
  15812. /**
  15813. * Get the world direction from an axis that is in the local space of the bone
  15814. * @param localAxis The local direction that is used to compute the world direction
  15815. * @param mesh The mesh that this bone is attached to
  15816. * @returns The world direction
  15817. */
  15818. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15819. /**
  15820. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15821. * @param localAxis The local direction that is used to compute the world direction
  15822. * @param mesh The mesh that this bone is attached to
  15823. * @param result The vector3 that the world direction will be copied to
  15824. */
  15825. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15826. /**
  15827. * Get the euler rotation of the bone in local or world space
  15828. * @param space The space that the rotation should be in
  15829. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15830. * @returns The euler rotation
  15831. */
  15832. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15833. /**
  15834. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15835. * @param space The space that the rotation should be in
  15836. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15837. * @param result The vector3 that the rotation should be copied to
  15838. */
  15839. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15840. /**
  15841. * Get the quaternion rotation of the bone in either local or world space
  15842. * @param space The space that the rotation should be in
  15843. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15844. * @returns The quaternion rotation
  15845. */
  15846. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15847. /**
  15848. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15849. * @param space The space that the rotation should be in
  15850. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15851. * @param result The quaternion that the rotation should be copied to
  15852. */
  15853. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15854. /**
  15855. * Get the rotation matrix of the bone in local or world space
  15856. * @param space The space that the rotation should be in
  15857. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15858. * @returns The rotation matrix
  15859. */
  15860. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15861. /**
  15862. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15863. * @param space The space that the rotation should be in
  15864. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15865. * @param result The quaternion that the rotation should be copied to
  15866. */
  15867. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15868. /**
  15869. * Get the world position of a point that is in the local space of the bone
  15870. * @param position The local position
  15871. * @param mesh The mesh that this bone is attached to
  15872. * @returns The world position
  15873. */
  15874. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15875. /**
  15876. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15877. * @param position The local position
  15878. * @param mesh The mesh that this bone is attached to
  15879. * @param result The vector3 that the world position should be copied to
  15880. */
  15881. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15882. /**
  15883. * Get the local position of a point that is in world space
  15884. * @param position The world position
  15885. * @param mesh The mesh that this bone is attached to
  15886. * @returns The local position
  15887. */
  15888. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15889. /**
  15890. * Get the local position of a point that is in world space and copy it to the result param
  15891. * @param position The world position
  15892. * @param mesh The mesh that this bone is attached to
  15893. * @param result The vector3 that the local position should be copied to
  15894. */
  15895. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15896. }
  15897. }
  15898. declare module "babylonjs/Animations/runtimeAnimation" {
  15899. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15900. import { Animatable } from "babylonjs/Animations/animatable";
  15901. import { Scene } from "babylonjs/scene";
  15902. /**
  15903. * Defines a runtime animation
  15904. */
  15905. export class RuntimeAnimation {
  15906. private _events;
  15907. /**
  15908. * The current frame of the runtime animation
  15909. */
  15910. private _currentFrame;
  15911. /**
  15912. * The animation used by the runtime animation
  15913. */
  15914. private _animation;
  15915. /**
  15916. * The target of the runtime animation
  15917. */
  15918. private _target;
  15919. /**
  15920. * The initiating animatable
  15921. */
  15922. private _host;
  15923. /**
  15924. * The original value of the runtime animation
  15925. */
  15926. private _originalValue;
  15927. /**
  15928. * The original blend value of the runtime animation
  15929. */
  15930. private _originalBlendValue;
  15931. /**
  15932. * The offsets cache of the runtime animation
  15933. */
  15934. private _offsetsCache;
  15935. /**
  15936. * The high limits cache of the runtime animation
  15937. */
  15938. private _highLimitsCache;
  15939. /**
  15940. * Specifies if the runtime animation has been stopped
  15941. */
  15942. private _stopped;
  15943. /**
  15944. * The blending factor of the runtime animation
  15945. */
  15946. private _blendingFactor;
  15947. /**
  15948. * The BabylonJS scene
  15949. */
  15950. private _scene;
  15951. /**
  15952. * The current value of the runtime animation
  15953. */
  15954. private _currentValue;
  15955. /** @hidden */
  15956. _animationState: _IAnimationState;
  15957. /**
  15958. * The active target of the runtime animation
  15959. */
  15960. private _activeTargets;
  15961. private _currentActiveTarget;
  15962. private _directTarget;
  15963. /**
  15964. * The target path of the runtime animation
  15965. */
  15966. private _targetPath;
  15967. /**
  15968. * The weight of the runtime animation
  15969. */
  15970. private _weight;
  15971. /**
  15972. * The ratio offset of the runtime animation
  15973. */
  15974. private _ratioOffset;
  15975. /**
  15976. * The previous delay of the runtime animation
  15977. */
  15978. private _previousDelay;
  15979. /**
  15980. * The previous ratio of the runtime animation
  15981. */
  15982. private _previousRatio;
  15983. private _enableBlending;
  15984. private _keys;
  15985. private _minFrame;
  15986. private _maxFrame;
  15987. private _minValue;
  15988. private _maxValue;
  15989. private _targetIsArray;
  15990. /**
  15991. * Gets the current frame of the runtime animation
  15992. */
  15993. get currentFrame(): number;
  15994. /**
  15995. * Gets the weight of the runtime animation
  15996. */
  15997. get weight(): number;
  15998. /**
  15999. * Gets the current value of the runtime animation
  16000. */
  16001. get currentValue(): any;
  16002. /**
  16003. * Gets the target path of the runtime animation
  16004. */
  16005. get targetPath(): string;
  16006. /**
  16007. * Gets the actual target of the runtime animation
  16008. */
  16009. get target(): any;
  16010. /**
  16011. * Gets the additive state of the runtime animation
  16012. */
  16013. get isAdditive(): boolean;
  16014. /** @hidden */
  16015. _onLoop: () => void;
  16016. /**
  16017. * Create a new RuntimeAnimation object
  16018. * @param target defines the target of the animation
  16019. * @param animation defines the source animation object
  16020. * @param scene defines the hosting scene
  16021. * @param host defines the initiating Animatable
  16022. */
  16023. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16024. private _preparePath;
  16025. /**
  16026. * Gets the animation from the runtime animation
  16027. */
  16028. get animation(): Animation;
  16029. /**
  16030. * Resets the runtime animation to the beginning
  16031. * @param restoreOriginal defines whether to restore the target property to the original value
  16032. */
  16033. reset(restoreOriginal?: boolean): void;
  16034. /**
  16035. * Specifies if the runtime animation is stopped
  16036. * @returns Boolean specifying if the runtime animation is stopped
  16037. */
  16038. isStopped(): boolean;
  16039. /**
  16040. * Disposes of the runtime animation
  16041. */
  16042. dispose(): void;
  16043. /**
  16044. * Apply the interpolated value to the target
  16045. * @param currentValue defines the value computed by the animation
  16046. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16047. */
  16048. setValue(currentValue: any, weight: number): void;
  16049. private _getOriginalValues;
  16050. private _setValue;
  16051. /**
  16052. * Gets the loop pmode of the runtime animation
  16053. * @returns Loop Mode
  16054. */
  16055. private _getCorrectLoopMode;
  16056. /**
  16057. * Move the current animation to a given frame
  16058. * @param frame defines the frame to move to
  16059. */
  16060. goToFrame(frame: number): void;
  16061. /**
  16062. * @hidden Internal use only
  16063. */
  16064. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16065. /**
  16066. * Execute the current animation
  16067. * @param delay defines the delay to add to the current frame
  16068. * @param from defines the lower bound of the animation range
  16069. * @param to defines the upper bound of the animation range
  16070. * @param loop defines if the current animation must loop
  16071. * @param speedRatio defines the current speed ratio
  16072. * @param weight defines the weight of the animation (default is -1 so no weight)
  16073. * @param onLoop optional callback called when animation loops
  16074. * @returns a boolean indicating if the animation is running
  16075. */
  16076. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16077. }
  16078. }
  16079. declare module "babylonjs/Animations/animatable" {
  16080. import { Animation } from "babylonjs/Animations/animation";
  16081. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16082. import { Nullable } from "babylonjs/types";
  16083. import { Observable } from "babylonjs/Misc/observable";
  16084. import { Scene } from "babylonjs/scene";
  16085. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16086. import { Node } from "babylonjs/node";
  16087. /**
  16088. * Class used to store an actual running animation
  16089. */
  16090. export class Animatable {
  16091. /** defines the target object */
  16092. target: any;
  16093. /** defines the starting frame number (default is 0) */
  16094. fromFrame: number;
  16095. /** defines the ending frame number (default is 100) */
  16096. toFrame: number;
  16097. /** defines if the animation must loop (default is false) */
  16098. loopAnimation: boolean;
  16099. /** defines a callback to call when animation ends if it is not looping */
  16100. onAnimationEnd?: (() => void) | null | undefined;
  16101. /** defines a callback to call when animation loops */
  16102. onAnimationLoop?: (() => void) | null | undefined;
  16103. /** defines whether the animation should be evaluated additively */
  16104. isAdditive: boolean;
  16105. private _localDelayOffset;
  16106. private _pausedDelay;
  16107. private _runtimeAnimations;
  16108. private _paused;
  16109. private _scene;
  16110. private _speedRatio;
  16111. private _weight;
  16112. private _syncRoot;
  16113. /**
  16114. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16115. * This will only apply for non looping animation (default is true)
  16116. */
  16117. disposeOnEnd: boolean;
  16118. /**
  16119. * Gets a boolean indicating if the animation has started
  16120. */
  16121. animationStarted: boolean;
  16122. /**
  16123. * Observer raised when the animation ends
  16124. */
  16125. onAnimationEndObservable: Observable<Animatable>;
  16126. /**
  16127. * Observer raised when the animation loops
  16128. */
  16129. onAnimationLoopObservable: Observable<Animatable>;
  16130. /**
  16131. * Gets the root Animatable used to synchronize and normalize animations
  16132. */
  16133. get syncRoot(): Nullable<Animatable>;
  16134. /**
  16135. * Gets the current frame of the first RuntimeAnimation
  16136. * Used to synchronize Animatables
  16137. */
  16138. get masterFrame(): number;
  16139. /**
  16140. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16141. */
  16142. get weight(): number;
  16143. set weight(value: number);
  16144. /**
  16145. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16146. */
  16147. get speedRatio(): number;
  16148. set speedRatio(value: number);
  16149. /**
  16150. * Creates a new Animatable
  16151. * @param scene defines the hosting scene
  16152. * @param target defines the target object
  16153. * @param fromFrame defines the starting frame number (default is 0)
  16154. * @param toFrame defines the ending frame number (default is 100)
  16155. * @param loopAnimation defines if the animation must loop (default is false)
  16156. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16157. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16158. * @param animations defines a group of animation to add to the new Animatable
  16159. * @param onAnimationLoop defines a callback to call when animation loops
  16160. * @param isAdditive defines whether the animation should be evaluated additively
  16161. */
  16162. constructor(scene: Scene,
  16163. /** defines the target object */
  16164. target: any,
  16165. /** defines the starting frame number (default is 0) */
  16166. fromFrame?: number,
  16167. /** defines the ending frame number (default is 100) */
  16168. toFrame?: number,
  16169. /** defines if the animation must loop (default is false) */
  16170. loopAnimation?: boolean, speedRatio?: number,
  16171. /** defines a callback to call when animation ends if it is not looping */
  16172. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16173. /** defines a callback to call when animation loops */
  16174. onAnimationLoop?: (() => void) | null | undefined,
  16175. /** defines whether the animation should be evaluated additively */
  16176. isAdditive?: boolean);
  16177. /**
  16178. * Synchronize and normalize current Animatable with a source Animatable
  16179. * This is useful when using animation weights and when animations are not of the same length
  16180. * @param root defines the root Animatable to synchronize with
  16181. * @returns the current Animatable
  16182. */
  16183. syncWith(root: Animatable): Animatable;
  16184. /**
  16185. * Gets the list of runtime animations
  16186. * @returns an array of RuntimeAnimation
  16187. */
  16188. getAnimations(): RuntimeAnimation[];
  16189. /**
  16190. * Adds more animations to the current animatable
  16191. * @param target defines the target of the animations
  16192. * @param animations defines the new animations to add
  16193. */
  16194. appendAnimations(target: any, animations: Animation[]): void;
  16195. /**
  16196. * Gets the source animation for a specific property
  16197. * @param property defines the propertyu to look for
  16198. * @returns null or the source animation for the given property
  16199. */
  16200. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16201. /**
  16202. * Gets the runtime animation for a specific property
  16203. * @param property defines the propertyu to look for
  16204. * @returns null or the runtime animation for the given property
  16205. */
  16206. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16207. /**
  16208. * Resets the animatable to its original state
  16209. */
  16210. reset(): void;
  16211. /**
  16212. * Allows the animatable to blend with current running animations
  16213. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16214. * @param blendingSpeed defines the blending speed to use
  16215. */
  16216. enableBlending(blendingSpeed: number): void;
  16217. /**
  16218. * Disable animation blending
  16219. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16220. */
  16221. disableBlending(): void;
  16222. /**
  16223. * Jump directly to a given frame
  16224. * @param frame defines the frame to jump to
  16225. */
  16226. goToFrame(frame: number): void;
  16227. /**
  16228. * Pause the animation
  16229. */
  16230. pause(): void;
  16231. /**
  16232. * Restart the animation
  16233. */
  16234. restart(): void;
  16235. private _raiseOnAnimationEnd;
  16236. /**
  16237. * Stop and delete the current animation
  16238. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16239. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  16240. */
  16241. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16242. /**
  16243. * Wait asynchronously for the animation to end
  16244. * @returns a promise which will be fullfilled when the animation ends
  16245. */
  16246. waitAsync(): Promise<Animatable>;
  16247. /** @hidden */
  16248. _animate(delay: number): boolean;
  16249. }
  16250. module "babylonjs/scene" {
  16251. interface Scene {
  16252. /** @hidden */
  16253. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16254. /** @hidden */
  16255. _processLateAnimationBindingsForMatrices(holder: {
  16256. totalWeight: number;
  16257. totalAdditiveWeight: number;
  16258. animations: RuntimeAnimation[];
  16259. additiveAnimations: RuntimeAnimation[];
  16260. originalValue: Matrix;
  16261. }): any;
  16262. /** @hidden */
  16263. _processLateAnimationBindingsForQuaternions(holder: {
  16264. totalWeight: number;
  16265. totalAdditiveWeight: number;
  16266. animations: RuntimeAnimation[];
  16267. additiveAnimations: RuntimeAnimation[];
  16268. originalValue: Quaternion;
  16269. }, refQuaternion: Quaternion): Quaternion;
  16270. /** @hidden */
  16271. _processLateAnimationBindings(): void;
  16272. /**
  16273. * Will start the animation sequence of a given target
  16274. * @param target defines the target
  16275. * @param from defines from which frame should animation start
  16276. * @param to defines until which frame should animation run.
  16277. * @param weight defines the weight to apply to the animation (1.0 by default)
  16278. * @param loop defines if the animation loops
  16279. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16280. * @param onAnimationEnd defines the function to be executed when the animation ends
  16281. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16282. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16283. * @param onAnimationLoop defines the callback to call when an animation loops
  16284. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16285. * @returns the animatable object created for this animation
  16286. */
  16287. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16288. /**
  16289. * Will start the animation sequence of a given target
  16290. * @param target defines the target
  16291. * @param from defines from which frame should animation start
  16292. * @param to defines until which frame should animation run.
  16293. * @param loop defines if the animation loops
  16294. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16295. * @param onAnimationEnd defines the function to be executed when the animation ends
  16296. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16297. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16298. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16299. * @param onAnimationLoop defines the callback to call when an animation loops
  16300. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16301. * @returns the animatable object created for this animation
  16302. */
  16303. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16304. /**
  16305. * Will start the animation sequence of a given target and its hierarchy
  16306. * @param target defines the target
  16307. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16308. * @param from defines from which frame should animation start
  16309. * @param to defines until which frame should animation run.
  16310. * @param loop defines if the animation loops
  16311. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16312. * @param onAnimationEnd defines the function to be executed when the animation ends
  16313. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16314. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16315. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16316. * @param onAnimationLoop defines the callback to call when an animation loops
  16317. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16318. * @returns the list of created animatables
  16319. */
  16320. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16321. /**
  16322. * Begin a new animation on a given node
  16323. * @param target defines the target where the animation will take place
  16324. * @param animations defines the list of animations to start
  16325. * @param from defines the initial value
  16326. * @param to defines the final value
  16327. * @param loop defines if you want animation to loop (off by default)
  16328. * @param speedRatio defines the speed ratio to apply to all animations
  16329. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16330. * @param onAnimationLoop defines the callback to call when an animation loops
  16331. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16332. * @returns the list of created animatables
  16333. */
  16334. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16335. /**
  16336. * Begin a new animation on a given node and its hierarchy
  16337. * @param target defines the root node where the animation will take place
  16338. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16339. * @param animations defines the list of animations to start
  16340. * @param from defines the initial value
  16341. * @param to defines the final value
  16342. * @param loop defines if you want animation to loop (off by default)
  16343. * @param speedRatio defines the speed ratio to apply to all animations
  16344. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16345. * @param onAnimationLoop defines the callback to call when an animation loops
  16346. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16347. * @returns the list of animatables created for all nodes
  16348. */
  16349. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16350. /**
  16351. * Gets the animatable associated with a specific target
  16352. * @param target defines the target of the animatable
  16353. * @returns the required animatable if found
  16354. */
  16355. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16356. /**
  16357. * Gets all animatables associated with a given target
  16358. * @param target defines the target to look animatables for
  16359. * @returns an array of Animatables
  16360. */
  16361. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16362. /**
  16363. * Stops and removes all animations that have been applied to the scene
  16364. */
  16365. stopAllAnimations(): void;
  16366. /**
  16367. * Gets the current delta time used by animation engine
  16368. */
  16369. deltaTime: number;
  16370. }
  16371. }
  16372. module "babylonjs/Bones/bone" {
  16373. interface Bone {
  16374. /**
  16375. * Copy an animation range from another bone
  16376. * @param source defines the source bone
  16377. * @param rangeName defines the range name to copy
  16378. * @param frameOffset defines the frame offset
  16379. * @param rescaleAsRequired defines if rescaling must be applied if required
  16380. * @param skelDimensionsRatio defines the scaling ratio
  16381. * @returns true if operation was successful
  16382. */
  16383. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16384. }
  16385. }
  16386. }
  16387. declare module "babylonjs/Bones/skeleton" {
  16388. import { Bone } from "babylonjs/Bones/bone";
  16389. import { Observable } from "babylonjs/Misc/observable";
  16390. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16391. import { Scene } from "babylonjs/scene";
  16392. import { Nullable } from "babylonjs/types";
  16393. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16394. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16395. import { Animatable } from "babylonjs/Animations/animatable";
  16396. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16397. import { Animation } from "babylonjs/Animations/animation";
  16398. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16399. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16400. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16401. /**
  16402. * Class used to handle skinning animations
  16403. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16404. */
  16405. export class Skeleton implements IAnimatable {
  16406. /** defines the skeleton name */
  16407. name: string;
  16408. /** defines the skeleton Id */
  16409. id: string;
  16410. /**
  16411. * Defines the list of child bones
  16412. */
  16413. bones: Bone[];
  16414. /**
  16415. * Defines an estimate of the dimension of the skeleton at rest
  16416. */
  16417. dimensionsAtRest: Vector3;
  16418. /**
  16419. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16420. */
  16421. needInitialSkinMatrix: boolean;
  16422. /**
  16423. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16424. */
  16425. overrideMesh: Nullable<AbstractMesh>;
  16426. /**
  16427. * Gets the list of animations attached to this skeleton
  16428. */
  16429. animations: Array<Animation>;
  16430. private _scene;
  16431. private _isDirty;
  16432. private _transformMatrices;
  16433. private _transformMatrixTexture;
  16434. private _meshesWithPoseMatrix;
  16435. private _animatables;
  16436. private _identity;
  16437. private _synchronizedWithMesh;
  16438. private _ranges;
  16439. private _lastAbsoluteTransformsUpdateId;
  16440. private _canUseTextureForBones;
  16441. private _uniqueId;
  16442. /** @hidden */
  16443. _numBonesWithLinkedTransformNode: number;
  16444. /** @hidden */
  16445. _hasWaitingData: Nullable<boolean>;
  16446. /** @hidden */
  16447. _waitingOverrideMeshId: Nullable<string>;
  16448. /**
  16449. * Specifies if the skeleton should be serialized
  16450. */
  16451. doNotSerialize: boolean;
  16452. private _useTextureToStoreBoneMatrices;
  16453. /**
  16454. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16455. * Please note that this option is not available if the hardware does not support it
  16456. */
  16457. get useTextureToStoreBoneMatrices(): boolean;
  16458. set useTextureToStoreBoneMatrices(value: boolean);
  16459. private _animationPropertiesOverride;
  16460. /**
  16461. * Gets or sets the animation properties override
  16462. */
  16463. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16464. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16465. /**
  16466. * List of inspectable custom properties (used by the Inspector)
  16467. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16468. */
  16469. inspectableCustomProperties: IInspectable[];
  16470. /**
  16471. * An observable triggered before computing the skeleton's matrices
  16472. */
  16473. onBeforeComputeObservable: Observable<Skeleton>;
  16474. /**
  16475. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16476. */
  16477. get isUsingTextureForMatrices(): boolean;
  16478. /**
  16479. * Gets the unique ID of this skeleton
  16480. */
  16481. get uniqueId(): number;
  16482. /**
  16483. * Creates a new skeleton
  16484. * @param name defines the skeleton name
  16485. * @param id defines the skeleton Id
  16486. * @param scene defines the hosting scene
  16487. */
  16488. constructor(
  16489. /** defines the skeleton name */
  16490. name: string,
  16491. /** defines the skeleton Id */
  16492. id: string, scene: Scene);
  16493. /**
  16494. * Gets the current object class name.
  16495. * @return the class name
  16496. */
  16497. getClassName(): string;
  16498. /**
  16499. * Returns an array containing the root bones
  16500. * @returns an array containing the root bones
  16501. */
  16502. getChildren(): Array<Bone>;
  16503. /**
  16504. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16505. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16506. * @returns a Float32Array containing matrices data
  16507. */
  16508. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16509. /**
  16510. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16511. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16512. * @returns a raw texture containing the data
  16513. */
  16514. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16515. /**
  16516. * Gets the current hosting scene
  16517. * @returns a scene object
  16518. */
  16519. getScene(): Scene;
  16520. /**
  16521. * Gets a string representing the current skeleton data
  16522. * @param fullDetails defines a boolean indicating if we want a verbose version
  16523. * @returns a string representing the current skeleton data
  16524. */
  16525. toString(fullDetails?: boolean): string;
  16526. /**
  16527. * Get bone's index searching by name
  16528. * @param name defines bone's name to search for
  16529. * @return the indice of the bone. Returns -1 if not found
  16530. */
  16531. getBoneIndexByName(name: string): number;
  16532. /**
  16533. * Creater a new animation range
  16534. * @param name defines the name of the range
  16535. * @param from defines the start key
  16536. * @param to defines the end key
  16537. */
  16538. createAnimationRange(name: string, from: number, to: number): void;
  16539. /**
  16540. * Delete a specific animation range
  16541. * @param name defines the name of the range
  16542. * @param deleteFrames defines if frames must be removed as well
  16543. */
  16544. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16545. /**
  16546. * Gets a specific animation range
  16547. * @param name defines the name of the range to look for
  16548. * @returns the requested animation range or null if not found
  16549. */
  16550. getAnimationRange(name: string): Nullable<AnimationRange>;
  16551. /**
  16552. * Gets the list of all animation ranges defined on this skeleton
  16553. * @returns an array
  16554. */
  16555. getAnimationRanges(): Nullable<AnimationRange>[];
  16556. /**
  16557. * Copy animation range from a source skeleton.
  16558. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16559. * @param source defines the source skeleton
  16560. * @param name defines the name of the range to copy
  16561. * @param rescaleAsRequired defines if rescaling must be applied if required
  16562. * @returns true if operation was successful
  16563. */
  16564. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16565. /**
  16566. * Forces the skeleton to go to rest pose
  16567. */
  16568. returnToRest(): void;
  16569. private _getHighestAnimationFrame;
  16570. /**
  16571. * Begin a specific animation range
  16572. * @param name defines the name of the range to start
  16573. * @param loop defines if looping must be turned on (false by default)
  16574. * @param speedRatio defines the speed ratio to apply (1 by default)
  16575. * @param onAnimationEnd defines a callback which will be called when animation will end
  16576. * @returns a new animatable
  16577. */
  16578. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16579. /**
  16580. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16581. * @param skeleton defines the Skeleton containing the animation range to convert
  16582. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16583. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16584. * @returns the original skeleton
  16585. */
  16586. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16587. /** @hidden */
  16588. _markAsDirty(): void;
  16589. /** @hidden */
  16590. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16591. /** @hidden */
  16592. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16593. private _computeTransformMatrices;
  16594. /**
  16595. * Build all resources required to render a skeleton
  16596. */
  16597. prepare(): void;
  16598. /**
  16599. * Gets the list of animatables currently running for this skeleton
  16600. * @returns an array of animatables
  16601. */
  16602. getAnimatables(): IAnimatable[];
  16603. /**
  16604. * Clone the current skeleton
  16605. * @param name defines the name of the new skeleton
  16606. * @param id defines the id of the new skeleton
  16607. * @returns the new skeleton
  16608. */
  16609. clone(name: string, id?: string): Skeleton;
  16610. /**
  16611. * Enable animation blending for this skeleton
  16612. * @param blendingSpeed defines the blending speed to apply
  16613. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16614. */
  16615. enableBlending(blendingSpeed?: number): void;
  16616. /**
  16617. * Releases all resources associated with the current skeleton
  16618. */
  16619. dispose(): void;
  16620. /**
  16621. * Serialize the skeleton in a JSON object
  16622. * @returns a JSON object
  16623. */
  16624. serialize(): any;
  16625. /**
  16626. * Creates a new skeleton from serialized data
  16627. * @param parsedSkeleton defines the serialized data
  16628. * @param scene defines the hosting scene
  16629. * @returns a new skeleton
  16630. */
  16631. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16632. /**
  16633. * Compute all node absolute transforms
  16634. * @param forceUpdate defines if computation must be done even if cache is up to date
  16635. */
  16636. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16637. /**
  16638. * Gets the root pose matrix
  16639. * @returns a matrix
  16640. */
  16641. getPoseMatrix(): Nullable<Matrix>;
  16642. /**
  16643. * Sorts bones per internal index
  16644. */
  16645. sortBones(): void;
  16646. private _sortBones;
  16647. }
  16648. }
  16649. declare module "babylonjs/Meshes/instancedMesh" {
  16650. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16651. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16652. import { Camera } from "babylonjs/Cameras/camera";
  16653. import { Node } from "babylonjs/node";
  16654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16655. import { Mesh } from "babylonjs/Meshes/mesh";
  16656. import { Material } from "babylonjs/Materials/material";
  16657. import { Skeleton } from "babylonjs/Bones/skeleton";
  16658. import { Light } from "babylonjs/Lights/light";
  16659. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16660. /**
  16661. * Creates an instance based on a source mesh.
  16662. */
  16663. export class InstancedMesh extends AbstractMesh {
  16664. private _sourceMesh;
  16665. private _currentLOD;
  16666. /** @hidden */
  16667. _indexInSourceMeshInstanceArray: number;
  16668. constructor(name: string, source: Mesh);
  16669. /**
  16670. * Returns the string "InstancedMesh".
  16671. */
  16672. getClassName(): string;
  16673. /** Gets the list of lights affecting that mesh */
  16674. get lightSources(): Light[];
  16675. _resyncLightSources(): void;
  16676. _resyncLightSource(light: Light): void;
  16677. _removeLightSource(light: Light, dispose: boolean): void;
  16678. /**
  16679. * If the source mesh receives shadows
  16680. */
  16681. get receiveShadows(): boolean;
  16682. /**
  16683. * The material of the source mesh
  16684. */
  16685. get material(): Nullable<Material>;
  16686. /**
  16687. * Visibility of the source mesh
  16688. */
  16689. get visibility(): number;
  16690. /**
  16691. * Skeleton of the source mesh
  16692. */
  16693. get skeleton(): Nullable<Skeleton>;
  16694. /**
  16695. * Rendering ground id of the source mesh
  16696. */
  16697. get renderingGroupId(): number;
  16698. set renderingGroupId(value: number);
  16699. /**
  16700. * Returns the total number of vertices (integer).
  16701. */
  16702. getTotalVertices(): number;
  16703. /**
  16704. * Returns a positive integer : the total number of indices in this mesh geometry.
  16705. * @returns the numner of indices or zero if the mesh has no geometry.
  16706. */
  16707. getTotalIndices(): number;
  16708. /**
  16709. * The source mesh of the instance
  16710. */
  16711. get sourceMesh(): Mesh;
  16712. /**
  16713. * Creates a new InstancedMesh object from the mesh model.
  16714. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16715. * @param name defines the name of the new instance
  16716. * @returns a new InstancedMesh
  16717. */
  16718. createInstance(name: string): InstancedMesh;
  16719. /**
  16720. * Is this node ready to be used/rendered
  16721. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16722. * @return {boolean} is it ready
  16723. */
  16724. isReady(completeCheck?: boolean): boolean;
  16725. /**
  16726. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16727. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16728. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  16729. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16730. */
  16731. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16732. /**
  16733. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16734. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16735. * The `data` are either a numeric array either a Float32Array.
  16736. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16737. * The parameter `stride` is an optional positive integer, it is usually automatically deducted from the `kind` (3 for positions or normals, 2 for UV, etc).
  16738. * Note that a new underlying VertexBuffer object is created each call.
  16739. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16740. *
  16741. * Possible `kind` values :
  16742. * - VertexBuffer.PositionKind
  16743. * - VertexBuffer.UVKind
  16744. * - VertexBuffer.UV2Kind
  16745. * - VertexBuffer.UV3Kind
  16746. * - VertexBuffer.UV4Kind
  16747. * - VertexBuffer.UV5Kind
  16748. * - VertexBuffer.UV6Kind
  16749. * - VertexBuffer.ColorKind
  16750. * - VertexBuffer.MatricesIndicesKind
  16751. * - VertexBuffer.MatricesIndicesExtraKind
  16752. * - VertexBuffer.MatricesWeightsKind
  16753. * - VertexBuffer.MatricesWeightsExtraKind
  16754. *
  16755. * Returns the Mesh.
  16756. */
  16757. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16758. /**
  16759. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16760. * If the mesh has no geometry, it is simply returned as it is.
  16761. * The `data` are either a numeric array either a Float32Array.
  16762. * No new underlying VertexBuffer object is created.
  16763. * If the `kind` is the `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16764. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16765. *
  16766. * Possible `kind` values :
  16767. * - VertexBuffer.PositionKind
  16768. * - VertexBuffer.UVKind
  16769. * - VertexBuffer.UV2Kind
  16770. * - VertexBuffer.UV3Kind
  16771. * - VertexBuffer.UV4Kind
  16772. * - VertexBuffer.UV5Kind
  16773. * - VertexBuffer.UV6Kind
  16774. * - VertexBuffer.ColorKind
  16775. * - VertexBuffer.MatricesIndicesKind
  16776. * - VertexBuffer.MatricesIndicesExtraKind
  16777. * - VertexBuffer.MatricesWeightsKind
  16778. * - VertexBuffer.MatricesWeightsExtraKind
  16779. *
  16780. * Returns the Mesh.
  16781. */
  16782. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16783. /**
  16784. * Sets the mesh indices.
  16785. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16786. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16787. * This method creates a new index buffer each call.
  16788. * Returns the Mesh.
  16789. */
  16790. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16791. /**
  16792. * Boolean : True if the mesh owns the requested kind of data.
  16793. */
  16794. isVerticesDataPresent(kind: string): boolean;
  16795. /**
  16796. * Returns an array of indices (IndicesArray).
  16797. */
  16798. getIndices(): Nullable<IndicesArray>;
  16799. get _positions(): Nullable<Vector3[]>;
  16800. /**
  16801. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16802. * This means the mesh underlying bounding box and sphere are recomputed.
  16803. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16804. * @returns the current mesh
  16805. */
  16806. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16807. /** @hidden */
  16808. _preActivate(): InstancedMesh;
  16809. /** @hidden */
  16810. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16811. /** @hidden */
  16812. _postActivate(): void;
  16813. getWorldMatrix(): Matrix;
  16814. get isAnInstance(): boolean;
  16815. /**
  16816. * Returns the current associated LOD AbstractMesh.
  16817. */
  16818. getLOD(camera: Camera): AbstractMesh;
  16819. /** @hidden */
  16820. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16821. /** @hidden */
  16822. _syncSubMeshes(): InstancedMesh;
  16823. /** @hidden */
  16824. _generatePointsArray(): boolean;
  16825. /** @hidden */
  16826. _updateBoundingInfo(): AbstractMesh;
  16827. /**
  16828. * Creates a new InstancedMesh from the current mesh.
  16829. * - name (string) : the cloned mesh name
  16830. * - newParent (optional Node) : the optional Node to parent the clone to.
  16831. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16832. *
  16833. * Returns the clone.
  16834. */
  16835. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16836. /**
  16837. * Disposes the InstancedMesh.
  16838. * Returns nothing.
  16839. */
  16840. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16841. }
  16842. module "babylonjs/Meshes/mesh" {
  16843. interface Mesh {
  16844. /**
  16845. * Register a custom buffer that will be instanced
  16846. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16847. * @param kind defines the buffer kind
  16848. * @param stride defines the stride in floats
  16849. */
  16850. registerInstancedBuffer(kind: string, stride: number): void;
  16851. /**
  16852. * true to use the edge renderer for all instances of this mesh
  16853. */
  16854. edgesShareWithInstances: boolean;
  16855. /** @hidden */
  16856. _userInstancedBuffersStorage: {
  16857. data: {
  16858. [key: string]: Float32Array;
  16859. };
  16860. sizes: {
  16861. [key: string]: number;
  16862. };
  16863. vertexBuffers: {
  16864. [key: string]: Nullable<VertexBuffer>;
  16865. };
  16866. strides: {
  16867. [key: string]: number;
  16868. };
  16869. };
  16870. }
  16871. }
  16872. module "babylonjs/Meshes/abstractMesh" {
  16873. interface AbstractMesh {
  16874. /**
  16875. * Object used to store instanced buffers defined by user
  16876. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16877. */
  16878. instancedBuffers: {
  16879. [key: string]: any;
  16880. };
  16881. }
  16882. }
  16883. }
  16884. declare module "babylonjs/Materials/shaderMaterial" {
  16885. import { Nullable } from "babylonjs/types";
  16886. import { Scene } from "babylonjs/scene";
  16887. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16888. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16889. import { Mesh } from "babylonjs/Meshes/mesh";
  16890. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16891. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16892. import { Effect } from "babylonjs/Materials/effect";
  16893. import { Material } from "babylonjs/Materials/material";
  16894. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16895. /**
  16896. * Defines the options associated with the creation of a shader material.
  16897. */
  16898. export interface IShaderMaterialOptions {
  16899. /**
  16900. * Does the material work in alpha blend mode
  16901. */
  16902. needAlphaBlending: boolean;
  16903. /**
  16904. * Does the material work in alpha test mode
  16905. */
  16906. needAlphaTesting: boolean;
  16907. /**
  16908. * The list of attribute names used in the shader
  16909. */
  16910. attributes: string[];
  16911. /**
  16912. * The list of unifrom names used in the shader
  16913. */
  16914. uniforms: string[];
  16915. /**
  16916. * The list of UBO names used in the shader
  16917. */
  16918. uniformBuffers: string[];
  16919. /**
  16920. * The list of sampler names used in the shader
  16921. */
  16922. samplers: string[];
  16923. /**
  16924. * The list of defines used in the shader
  16925. */
  16926. defines: string[];
  16927. }
  16928. /**
  16929. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16930. *
  16931. * This returned material effects how the mesh will look based on the code in the shaders.
  16932. *
  16933. * @see https://doc.babylonjs.com/how_to/shader_material
  16934. */
  16935. export class ShaderMaterial extends Material {
  16936. private _shaderPath;
  16937. private _options;
  16938. private _textures;
  16939. private _textureArrays;
  16940. private _floats;
  16941. private _ints;
  16942. private _floatsArrays;
  16943. private _colors3;
  16944. private _colors3Arrays;
  16945. private _colors4;
  16946. private _colors4Arrays;
  16947. private _vectors2;
  16948. private _vectors3;
  16949. private _vectors4;
  16950. private _matrices;
  16951. private _matrixArrays;
  16952. private _matrices3x3;
  16953. private _matrices2x2;
  16954. private _vectors2Arrays;
  16955. private _vectors3Arrays;
  16956. private _vectors4Arrays;
  16957. private _cachedWorldViewMatrix;
  16958. private _cachedWorldViewProjectionMatrix;
  16959. private _renderId;
  16960. private _multiview;
  16961. private _cachedDefines;
  16962. /** Define the Url to load snippets */
  16963. static SnippetUrl: string;
  16964. /** Snippet ID if the material was created from the snippet server */
  16965. snippetId: string;
  16966. /**
  16967. * Instantiate a new shader material.
  16968. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16969. * This returned material effects how the mesh will look based on the code in the shaders.
  16970. * @see https://doc.babylonjs.com/how_to/shader_material
  16971. * @param name Define the name of the material in the scene
  16972. * @param scene Define the scene the material belongs to
  16973. * @param shaderPath Defines the route to the shader code in one of three ways:
  16974. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16975. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16976. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16977. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16978. * @param options Define the options used to create the shader
  16979. */
  16980. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16981. /**
  16982. * Gets the shader path used to define the shader code
  16983. * It can be modified to trigger a new compilation
  16984. */
  16985. get shaderPath(): any;
  16986. /**
  16987. * Sets the shader path used to define the shader code
  16988. * It can be modified to trigger a new compilation
  16989. */
  16990. set shaderPath(shaderPath: any);
  16991. /**
  16992. * Gets the options used to compile the shader.
  16993. * They can be modified to trigger a new compilation
  16994. */
  16995. get options(): IShaderMaterialOptions;
  16996. /**
  16997. * Gets the current class name of the material e.g. "ShaderMaterial"
  16998. * Mainly use in serialization.
  16999. * @returns the class name
  17000. */
  17001. getClassName(): string;
  17002. /**
  17003. * Specifies if the material will require alpha blending
  17004. * @returns a boolean specifying if alpha blending is needed
  17005. */
  17006. needAlphaBlending(): boolean;
  17007. /**
  17008. * Specifies if this material should be rendered in alpha test mode
  17009. * @returns a boolean specifying if an alpha test is needed.
  17010. */
  17011. needAlphaTesting(): boolean;
  17012. private _checkUniform;
  17013. /**
  17014. * Set a texture in the shader.
  17015. * @param name Define the name of the uniform samplers as defined in the shader
  17016. * @param texture Define the texture to bind to this sampler
  17017. * @return the material itself allowing "fluent" like uniform updates
  17018. */
  17019. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17020. /**
  17021. * Set a texture array in the shader.
  17022. * @param name Define the name of the uniform sampler array as defined in the shader
  17023. * @param textures Define the list of textures to bind to this sampler
  17024. * @return the material itself allowing "fluent" like uniform updates
  17025. */
  17026. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17027. /**
  17028. * Set a float in the shader.
  17029. * @param name Define the name of the uniform as defined in the shader
  17030. * @param value Define the value to give to the uniform
  17031. * @return the material itself allowing "fluent" like uniform updates
  17032. */
  17033. setFloat(name: string, value: number): ShaderMaterial;
  17034. /**
  17035. * Set a int in the shader.
  17036. * @param name Define the name of the uniform as defined in the shader
  17037. * @param value Define the value to give to the uniform
  17038. * @return the material itself allowing "fluent" like uniform updates
  17039. */
  17040. setInt(name: string, value: number): ShaderMaterial;
  17041. /**
  17042. * Set an array of floats in the shader.
  17043. * @param name Define the name of the uniform as defined in the shader
  17044. * @param value Define the value to give to the uniform
  17045. * @return the material itself allowing "fluent" like uniform updates
  17046. */
  17047. setFloats(name: string, value: number[]): ShaderMaterial;
  17048. /**
  17049. * Set a vec3 in the shader from a Color3.
  17050. * @param name Define the name of the uniform as defined in the shader
  17051. * @param value Define the value to give to the uniform
  17052. * @return the material itself allowing "fluent" like uniform updates
  17053. */
  17054. setColor3(name: string, value: Color3): ShaderMaterial;
  17055. /**
  17056. * Set a vec3 array in the shader from a Color3 array.
  17057. * @param name Define the name of the uniform as defined in the shader
  17058. * @param value Define the value to give to the uniform
  17059. * @return the material itself allowing "fluent" like uniform updates
  17060. */
  17061. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17062. /**
  17063. * Set a vec4 in the shader from a Color4.
  17064. * @param name Define the name of the uniform as defined in the shader
  17065. * @param value Define the value to give to the uniform
  17066. * @return the material itself allowing "fluent" like uniform updates
  17067. */
  17068. setColor4(name: string, value: Color4): ShaderMaterial;
  17069. /**
  17070. * Set a vec4 array in the shader from a Color4 array.
  17071. * @param name Define the name of the uniform as defined in the shader
  17072. * @param value Define the value to give to the uniform
  17073. * @return the material itself allowing "fluent" like uniform updates
  17074. */
  17075. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17076. /**
  17077. * Set a vec2 in the shader from a Vector2.
  17078. * @param name Define the name of the uniform as defined in the shader
  17079. * @param value Define the value to give to the uniform
  17080. * @return the material itself allowing "fluent" like uniform updates
  17081. */
  17082. setVector2(name: string, value: Vector2): ShaderMaterial;
  17083. /**
  17084. * Set a vec3 in the shader from a Vector3.
  17085. * @param name Define the name of the uniform as defined in the shader
  17086. * @param value Define the value to give to the uniform
  17087. * @return the material itself allowing "fluent" like uniform updates
  17088. */
  17089. setVector3(name: string, value: Vector3): ShaderMaterial;
  17090. /**
  17091. * Set a vec4 in the shader from a Vector4.
  17092. * @param name Define the name of the uniform as defined in the shader
  17093. * @param value Define the value to give to the uniform
  17094. * @return the material itself allowing "fluent" like uniform updates
  17095. */
  17096. setVector4(name: string, value: Vector4): ShaderMaterial;
  17097. /**
  17098. * Set a mat4 in the shader from a Matrix.
  17099. * @param name Define the name of the uniform as defined in the shader
  17100. * @param value Define the value to give to the uniform
  17101. * @return the material itself allowing "fluent" like uniform updates
  17102. */
  17103. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17104. /**
  17105. * Set a float32Array in the shader from a matrix array.
  17106. * @param name Define the name of the uniform as defined in the shader
  17107. * @param value Define the value to give to the uniform
  17108. * @return the material itself allowing "fluent" like uniform updates
  17109. */
  17110. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17111. /**
  17112. * Set a mat3 in the shader from a Float32Array.
  17113. * @param name Define the name of the uniform as defined in the shader
  17114. * @param value Define the value to give to the uniform
  17115. * @return the material itself allowing "fluent" like uniform updates
  17116. */
  17117. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17118. /**
  17119. * Set a mat2 in the shader from a Float32Array.
  17120. * @param name Define the name of the uniform as defined in the shader
  17121. * @param value Define the value to give to the uniform
  17122. * @return the material itself allowing "fluent" like uniform updates
  17123. */
  17124. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17125. /**
  17126. * Set a vec2 array in the shader from a number array.
  17127. * @param name Define the name of the uniform as defined in the shader
  17128. * @param value Define the value to give to the uniform
  17129. * @return the material itself allowing "fluent" like uniform updates
  17130. */
  17131. setArray2(name: string, value: number[]): ShaderMaterial;
  17132. /**
  17133. * Set a vec3 array in the shader from a number array.
  17134. * @param name Define the name of the uniform as defined in the shader
  17135. * @param value Define the value to give to the uniform
  17136. * @return the material itself allowing "fluent" like uniform updates
  17137. */
  17138. setArray3(name: string, value: number[]): ShaderMaterial;
  17139. /**
  17140. * Set a vec4 array in the shader from a number array.
  17141. * @param name Define the name of the uniform as defined in the shader
  17142. * @param value Define the value to give to the uniform
  17143. * @return the material itself allowing "fluent" like uniform updates
  17144. */
  17145. setArray4(name: string, value: number[]): ShaderMaterial;
  17146. private _checkCache;
  17147. /**
  17148. * Specifies that the submesh is ready to be used
  17149. * @param mesh defines the mesh to check
  17150. * @param subMesh defines which submesh to check
  17151. * @param useInstances specifies that instances should be used
  17152. * @returns a boolean indicating that the submesh is ready or not
  17153. */
  17154. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17155. /**
  17156. * Checks if the material is ready to render the requested mesh
  17157. * @param mesh Define the mesh to render
  17158. * @param useInstances Define whether or not the material is used with instances
  17159. * @returns true if ready, otherwise false
  17160. */
  17161. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17162. /**
  17163. * Binds the world matrix to the material
  17164. * @param world defines the world transformation matrix
  17165. * @param effectOverride - If provided, use this effect instead of internal effect
  17166. */
  17167. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17168. /**
  17169. * Binds the submesh to this material by preparing the effect and shader to draw
  17170. * @param world defines the world transformation matrix
  17171. * @param mesh defines the mesh containing the submesh
  17172. * @param subMesh defines the submesh to bind the material to
  17173. */
  17174. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17175. /**
  17176. * Binds the material to the mesh
  17177. * @param world defines the world transformation matrix
  17178. * @param mesh defines the mesh to bind the material to
  17179. * @param effectOverride - If provided, use this effect instead of internal effect
  17180. */
  17181. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17182. protected _afterBind(mesh?: Mesh): void;
  17183. /**
  17184. * Gets the active textures from the material
  17185. * @returns an array of textures
  17186. */
  17187. getActiveTextures(): BaseTexture[];
  17188. /**
  17189. * Specifies if the material uses a texture
  17190. * @param texture defines the texture to check against the material
  17191. * @returns a boolean specifying if the material uses the texture
  17192. */
  17193. hasTexture(texture: BaseTexture): boolean;
  17194. /**
  17195. * Makes a duplicate of the material, and gives it a new name
  17196. * @param name defines the new name for the duplicated material
  17197. * @returns the cloned material
  17198. */
  17199. clone(name: string): ShaderMaterial;
  17200. /**
  17201. * Disposes the material
  17202. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17203. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17204. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17205. */
  17206. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17207. /**
  17208. * Serializes this material in a JSON representation
  17209. * @returns the serialized material object
  17210. */
  17211. serialize(): any;
  17212. /**
  17213. * Creates a shader material from parsed shader material data
  17214. * @param source defines the JSON represnetation of the material
  17215. * @param scene defines the hosting scene
  17216. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17217. * @returns a new material
  17218. */
  17219. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17220. /**
  17221. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17222. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17223. * @param url defines the url to load from
  17224. * @param scene defines the hosting scene
  17225. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17226. * @returns a promise that will resolve to the new ShaderMaterial
  17227. */
  17228. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17229. /**
  17230. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17231. * @param snippetId defines the snippet to load
  17232. * @param scene defines the hosting scene
  17233. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17234. * @returns a promise that will resolve to the new ShaderMaterial
  17235. */
  17236. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17237. }
  17238. }
  17239. declare module "babylonjs/Shaders/color.fragment" {
  17240. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17241. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17242. /** @hidden */
  17243. export var colorPixelShader: {
  17244. name: string;
  17245. shader: string;
  17246. };
  17247. }
  17248. declare module "babylonjs/Shaders/color.vertex" {
  17249. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17250. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17251. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17252. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17253. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17254. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17255. /** @hidden */
  17256. export var colorVertexShader: {
  17257. name: string;
  17258. shader: string;
  17259. };
  17260. }
  17261. declare module "babylonjs/Meshes/linesMesh" {
  17262. import { Nullable } from "babylonjs/types";
  17263. import { Scene } from "babylonjs/scene";
  17264. import { Color3 } from "babylonjs/Maths/math.color";
  17265. import { Node } from "babylonjs/node";
  17266. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17267. import { Mesh } from "babylonjs/Meshes/mesh";
  17268. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17269. import { Effect } from "babylonjs/Materials/effect";
  17270. import { Material } from "babylonjs/Materials/material";
  17271. import "babylonjs/Shaders/color.fragment";
  17272. import "babylonjs/Shaders/color.vertex";
  17273. /**
  17274. * Line mesh
  17275. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17276. */
  17277. export class LinesMesh extends Mesh {
  17278. /**
  17279. * If vertex color should be applied to the mesh
  17280. */
  17281. readonly useVertexColor?: boolean | undefined;
  17282. /**
  17283. * If vertex alpha should be applied to the mesh
  17284. */
  17285. readonly useVertexAlpha?: boolean | undefined;
  17286. /**
  17287. * Color of the line (Default: White)
  17288. */
  17289. color: Color3;
  17290. /**
  17291. * Alpha of the line (Default: 1)
  17292. */
  17293. alpha: number;
  17294. /**
  17295. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17296. * This margin is expressed in world space coordinates, so its value may vary.
  17297. * Default value is 0.1
  17298. */
  17299. intersectionThreshold: number;
  17300. private _colorShader;
  17301. private color4;
  17302. /**
  17303. * Creates a new LinesMesh
  17304. * @param name defines the name
  17305. * @param scene defines the hosting scene
  17306. * @param parent defines the parent mesh if any
  17307. * @param source defines the optional source LinesMesh used to clone data from
  17308. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17309. * When false, achieved by calling a clone(), also passing False.
  17310. * This will make creation of children, recursive.
  17311. * @param useVertexColor defines if this LinesMesh supports vertex color
  17312. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17313. */
  17314. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17315. /**
  17316. * If vertex color should be applied to the mesh
  17317. */
  17318. useVertexColor?: boolean | undefined,
  17319. /**
  17320. * If vertex alpha should be applied to the mesh
  17321. */
  17322. useVertexAlpha?: boolean | undefined);
  17323. private _addClipPlaneDefine;
  17324. private _removeClipPlaneDefine;
  17325. isReady(): boolean;
  17326. /**
  17327. * Returns the string "LineMesh"
  17328. */
  17329. getClassName(): string;
  17330. /**
  17331. * @hidden
  17332. */
  17333. get material(): Material;
  17334. /**
  17335. * @hidden
  17336. */
  17337. set material(value: Material);
  17338. /**
  17339. * @hidden
  17340. */
  17341. get checkCollisions(): boolean;
  17342. /** @hidden */
  17343. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17344. /** @hidden */
  17345. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17346. /**
  17347. * Disposes of the line mesh
  17348. * @param doNotRecurse If children should be disposed
  17349. */
  17350. dispose(doNotRecurse?: boolean): void;
  17351. /**
  17352. * Returns a new LineMesh object cloned from the current one.
  17353. */
  17354. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17355. /**
  17356. * Creates a new InstancedLinesMesh object from the mesh model.
  17357. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17358. * @param name defines the name of the new instance
  17359. * @returns a new InstancedLinesMesh
  17360. */
  17361. createInstance(name: string): InstancedLinesMesh;
  17362. }
  17363. /**
  17364. * Creates an instance based on a source LinesMesh
  17365. */
  17366. export class InstancedLinesMesh extends InstancedMesh {
  17367. /**
  17368. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17369. * This margin is expressed in world space coordinates, so its value may vary.
  17370. * Initilized with the intersectionThreshold value of the source LinesMesh
  17371. */
  17372. intersectionThreshold: number;
  17373. constructor(name: string, source: LinesMesh);
  17374. /**
  17375. * Returns the string "InstancedLinesMesh".
  17376. */
  17377. getClassName(): string;
  17378. }
  17379. }
  17380. declare module "babylonjs/Shaders/line.fragment" {
  17381. /** @hidden */
  17382. export var linePixelShader: {
  17383. name: string;
  17384. shader: string;
  17385. };
  17386. }
  17387. declare module "babylonjs/Shaders/line.vertex" {
  17388. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17389. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17390. /** @hidden */
  17391. export var lineVertexShader: {
  17392. name: string;
  17393. shader: string;
  17394. };
  17395. }
  17396. declare module "babylonjs/Rendering/edgesRenderer" {
  17397. import { Nullable } from "babylonjs/types";
  17398. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17399. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17400. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17401. import { IDisposable } from "babylonjs/scene";
  17402. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17403. import "babylonjs/Shaders/line.fragment";
  17404. import "babylonjs/Shaders/line.vertex";
  17405. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17406. import { SmartArray } from "babylonjs/Misc/smartArray";
  17407. module "babylonjs/scene" {
  17408. interface Scene {
  17409. /** @hidden */
  17410. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17411. }
  17412. }
  17413. module "babylonjs/Meshes/abstractMesh" {
  17414. interface AbstractMesh {
  17415. /**
  17416. * Gets the edgesRenderer associated with the mesh
  17417. */
  17418. edgesRenderer: Nullable<EdgesRenderer>;
  17419. }
  17420. }
  17421. module "babylonjs/Meshes/linesMesh" {
  17422. interface LinesMesh {
  17423. /**
  17424. * Enables the edge rendering mode on the mesh.
  17425. * This mode makes the mesh edges visible
  17426. * @param epsilon defines the maximal distance between two angles to detect a face
  17427. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17428. * @returns the currentAbstractMesh
  17429. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17430. */
  17431. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17432. }
  17433. }
  17434. module "babylonjs/Meshes/linesMesh" {
  17435. interface InstancedLinesMesh {
  17436. /**
  17437. * Enables the edge rendering mode on the mesh.
  17438. * This mode makes the mesh edges visible
  17439. * @param epsilon defines the maximal distance between two angles to detect a face
  17440. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17441. * @returns the current InstancedLinesMesh
  17442. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17443. */
  17444. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17445. }
  17446. }
  17447. /**
  17448. * Defines the minimum contract an Edges renderer should follow.
  17449. */
  17450. export interface IEdgesRenderer extends IDisposable {
  17451. /**
  17452. * Gets or sets a boolean indicating if the edgesRenderer is active
  17453. */
  17454. isEnabled: boolean;
  17455. /**
  17456. * Renders the edges of the attached mesh,
  17457. */
  17458. render(): void;
  17459. /**
  17460. * Checks wether or not the edges renderer is ready to render.
  17461. * @return true if ready, otherwise false.
  17462. */
  17463. isReady(): boolean;
  17464. /**
  17465. * List of instances to render in case the source mesh has instances
  17466. */
  17467. customInstances: SmartArray<Matrix>;
  17468. }
  17469. /**
  17470. * Defines the additional options of the edges renderer
  17471. */
  17472. export interface IEdgesRendererOptions {
  17473. /**
  17474. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17475. * If not defined, the default value is true
  17476. */
  17477. useAlternateEdgeFinder?: boolean;
  17478. /**
  17479. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17480. * If not defined, the default value is true.
  17481. * You should normally leave it undefined (or set it to true), except if you see some artifacts in the edges rendering (can happen with complex geometries)
  17482. * This option is used only if useAlternateEdgeFinder = true
  17483. */
  17484. useFastVertexMerger?: boolean;
  17485. /**
  17486. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17487. * The default value is 1e-6
  17488. * This option is used only if useAlternateEdgeFinder = true
  17489. */
  17490. epsilonVertexMerge?: number;
  17491. /**
  17492. * Gets or sets a boolean indicating that tessellation should be applied before finding the edges. You may need to activate this option if your geometry is a bit
  17493. * unusual, like having a vertex of a triangle in-between two vertices of an edge of another triangle. It happens often when using CSG to construct meshes.
  17494. * This option is used only if useAlternateEdgeFinder = true
  17495. */
  17496. applyTessellation?: boolean;
  17497. /**
  17498. * The limit under which 3 vertices are considered to be aligned. 3 vertices PQR are considered aligned if distance(PQ) + distance(QR) - distance(PR) < epsilonVertexAligned
  17499. * The default value is 1e-6
  17500. * This option is used only if useAlternateEdgeFinder = true
  17501. */
  17502. epsilonVertexAligned?: number;
  17503. }
  17504. /**
  17505. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17506. */
  17507. export class EdgesRenderer implements IEdgesRenderer {
  17508. /**
  17509. * Define the size of the edges with an orthographic camera
  17510. */
  17511. edgesWidthScalerForOrthographic: number;
  17512. /**
  17513. * Define the size of the edges with a perspective camera
  17514. */
  17515. edgesWidthScalerForPerspective: number;
  17516. protected _source: AbstractMesh;
  17517. protected _linesPositions: number[];
  17518. protected _linesNormals: number[];
  17519. protected _linesIndices: number[];
  17520. protected _epsilon: number;
  17521. protected _indicesCount: number;
  17522. protected _lineShader: ShaderMaterial;
  17523. protected _ib: DataBuffer;
  17524. protected _buffers: {
  17525. [key: string]: Nullable<VertexBuffer>;
  17526. };
  17527. protected _buffersForInstances: {
  17528. [key: string]: Nullable<VertexBuffer>;
  17529. };
  17530. protected _checkVerticesInsteadOfIndices: boolean;
  17531. protected _options: Nullable<IEdgesRendererOptions>;
  17532. private _meshRebuildObserver;
  17533. private _meshDisposeObserver;
  17534. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17535. isEnabled: boolean;
  17536. /**
  17537. * List of instances to render in case the source mesh has instances
  17538. */
  17539. customInstances: SmartArray<Matrix>;
  17540. private static GetShader;
  17541. /**
  17542. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17543. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17544. * @param source Mesh used to create edges
  17545. * @param epsilon sum of angles in adjacency to check for edge
  17546. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17547. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17548. * @param options The options to apply when generating the edges
  17549. */
  17550. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17551. protected _prepareRessources(): void;
  17552. /** @hidden */
  17553. _rebuild(): void;
  17554. /**
  17555. * Releases the required resources for the edges renderer
  17556. */
  17557. dispose(): void;
  17558. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17559. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17560. /**
  17561. * Checks if the pair of p0 and p1 is en edge
  17562. * @param faceIndex
  17563. * @param edge
  17564. * @param faceNormals
  17565. * @param p0
  17566. * @param p1
  17567. * @private
  17568. */
  17569. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17570. /**
  17571. * push line into the position, normal and index buffer
  17572. * @protected
  17573. */
  17574. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17575. /**
  17576. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17577. */
  17578. private _tessellateTriangle;
  17579. private _generateEdgesLinesAlternate;
  17580. /**
  17581. * Generates lines edges from adjacencjes
  17582. * @private
  17583. */
  17584. _generateEdgesLines(): void;
  17585. /**
  17586. * Checks wether or not the edges renderer is ready to render.
  17587. * @return true if ready, otherwise false.
  17588. */
  17589. isReady(): boolean;
  17590. /**
  17591. * Renders the edges of the attached mesh,
  17592. */
  17593. render(): void;
  17594. }
  17595. /**
  17596. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17597. */
  17598. export class LineEdgesRenderer extends EdgesRenderer {
  17599. /**
  17600. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17601. * @param source LineMesh used to generate edges
  17602. * @param epsilon not important (specified angle for edge detection)
  17603. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17604. */
  17605. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17606. /**
  17607. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17608. */
  17609. _generateEdgesLines(): void;
  17610. }
  17611. }
  17612. declare module "babylonjs/Rendering/renderingGroup" {
  17613. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17614. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17615. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17616. import { Nullable } from "babylonjs/types";
  17617. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17618. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17619. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17620. import { Material } from "babylonjs/Materials/material";
  17621. import { Scene } from "babylonjs/scene";
  17622. /**
  17623. * This represents the object necessary to create a rendering group.
  17624. * This is exclusively used and created by the rendering manager.
  17625. * To modify the behavior, you use the available helpers in your scene or meshes.
  17626. * @hidden
  17627. */
  17628. export class RenderingGroup {
  17629. index: number;
  17630. private static _zeroVector;
  17631. private _scene;
  17632. private _opaqueSubMeshes;
  17633. private _transparentSubMeshes;
  17634. private _alphaTestSubMeshes;
  17635. private _depthOnlySubMeshes;
  17636. private _particleSystems;
  17637. private _spriteManagers;
  17638. private _opaqueSortCompareFn;
  17639. private _alphaTestSortCompareFn;
  17640. private _transparentSortCompareFn;
  17641. private _renderOpaque;
  17642. private _renderAlphaTest;
  17643. private _renderTransparent;
  17644. /** @hidden */
  17645. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17646. onBeforeTransparentRendering: () => void;
  17647. /**
  17648. * Set the opaque sort comparison function.
  17649. * If null the sub meshes will be render in the order they were created
  17650. */
  17651. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17652. /**
  17653. * Set the alpha test sort comparison function.
  17654. * If null the sub meshes will be render in the order they were created
  17655. */
  17656. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17657. /**
  17658. * Set the transparent sort comparison function.
  17659. * If null the sub meshes will be render in the order they were created
  17660. */
  17661. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17662. /**
  17663. * Creates a new rendering group.
  17664. * @param index The rendering group index
  17665. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17666. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17667. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17668. */
  17669. constructor(index: number, scene: Scene, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17670. /**
  17671. * Render all the sub meshes contained in the group.
  17672. * @param customRenderFunction Used to override the default render behaviour of the group.
  17673. * @returns true if rendered some submeshes.
  17674. */
  17675. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17676. /**
  17677. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17678. * @param subMeshes The submeshes to render
  17679. */
  17680. private renderOpaqueSorted;
  17681. /**
  17682. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17683. * @param subMeshes The submeshes to render
  17684. */
  17685. private renderAlphaTestSorted;
  17686. /**
  17687. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17688. * @param subMeshes The submeshes to render
  17689. */
  17690. private renderTransparentSorted;
  17691. /**
  17692. * Renders the submeshes in a specified order.
  17693. * @param subMeshes The submeshes to sort before render
  17694. * @param sortCompareFn The comparison function use to sort
  17695. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17696. * @param transparent Specifies to activate blending if true
  17697. */
  17698. private static renderSorted;
  17699. /**
  17700. * Renders the submeshes in the order they were dispatched (no sort applied).
  17701. * @param subMeshes The submeshes to render
  17702. */
  17703. private static renderUnsorted;
  17704. /**
  17705. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17706. * are rendered back to front if in the same alpha index.
  17707. *
  17708. * @param a The first submesh
  17709. * @param b The second submesh
  17710. * @returns The result of the comparison
  17711. */
  17712. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17713. /**
  17714. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17715. * are rendered back to front.
  17716. *
  17717. * @param a The first submesh
  17718. * @param b The second submesh
  17719. * @returns The result of the comparison
  17720. */
  17721. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17722. /**
  17723. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17724. * are rendered front to back (prevent overdraw).
  17725. *
  17726. * @param a The first submesh
  17727. * @param b The second submesh
  17728. * @returns The result of the comparison
  17729. */
  17730. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17731. /**
  17732. * Resets the different lists of submeshes to prepare a new frame.
  17733. */
  17734. prepare(): void;
  17735. dispose(): void;
  17736. /**
  17737. * Inserts the submesh in its correct queue depending on its material.
  17738. * @param subMesh The submesh to dispatch
  17739. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17740. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17741. */
  17742. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17743. dispatchSprites(spriteManager: ISpriteManager): void;
  17744. dispatchParticles(particleSystem: IParticleSystem): void;
  17745. private _renderParticles;
  17746. private _renderSprites;
  17747. }
  17748. }
  17749. declare module "babylonjs/Rendering/renderingManager" {
  17750. import { Nullable } from "babylonjs/types";
  17751. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17752. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17753. import { SmartArray } from "babylonjs/Misc/smartArray";
  17754. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17755. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17756. import { Material } from "babylonjs/Materials/material";
  17757. import { Scene } from "babylonjs/scene";
  17758. import { Camera } from "babylonjs/Cameras/camera";
  17759. /**
  17760. * Interface describing the different options available in the rendering manager
  17761. * regarding Auto Clear between groups.
  17762. */
  17763. export interface IRenderingManagerAutoClearSetup {
  17764. /**
  17765. * Defines whether or not autoclear is enable.
  17766. */
  17767. autoClear: boolean;
  17768. /**
  17769. * Defines whether or not to autoclear the depth buffer.
  17770. */
  17771. depth: boolean;
  17772. /**
  17773. * Defines whether or not to autoclear the stencil buffer.
  17774. */
  17775. stencil: boolean;
  17776. }
  17777. /**
  17778. * This class is used by the onRenderingGroupObservable
  17779. */
  17780. export class RenderingGroupInfo {
  17781. /**
  17782. * The Scene that being rendered
  17783. */
  17784. scene: Scene;
  17785. /**
  17786. * The camera currently used for the rendering pass
  17787. */
  17788. camera: Nullable<Camera>;
  17789. /**
  17790. * The ID of the renderingGroup being processed
  17791. */
  17792. renderingGroupId: number;
  17793. }
  17794. /**
  17795. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17796. * It is enable to manage the different groups as well as the different necessary sort functions.
  17797. * This should not be used directly aside of the few static configurations
  17798. */
  17799. export class RenderingManager {
  17800. /**
  17801. * The max id used for rendering groups (not included)
  17802. */
  17803. static MAX_RENDERINGGROUPS: number;
  17804. /**
  17805. * The min id used for rendering groups (included)
  17806. */
  17807. static MIN_RENDERINGGROUPS: number;
  17808. /**
  17809. * Used to globally prevent autoclearing scenes.
  17810. */
  17811. static AUTOCLEAR: boolean;
  17812. /**
  17813. * @hidden
  17814. */
  17815. _useSceneAutoClearSetup: boolean;
  17816. private _scene;
  17817. private _renderingGroups;
  17818. private _depthStencilBufferAlreadyCleaned;
  17819. private _autoClearDepthStencil;
  17820. private _customOpaqueSortCompareFn;
  17821. private _customAlphaTestSortCompareFn;
  17822. private _customTransparentSortCompareFn;
  17823. private _renderingGroupInfo;
  17824. /**
  17825. * Instantiates a new rendering group for a particular scene
  17826. * @param scene Defines the scene the groups belongs to
  17827. */
  17828. constructor(scene: Scene);
  17829. private _clearDepthStencilBuffer;
  17830. /**
  17831. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17832. * @hidden
  17833. */
  17834. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17835. /**
  17836. * Resets the different information of the group to prepare a new frame
  17837. * @hidden
  17838. */
  17839. reset(): void;
  17840. /**
  17841. * Dispose and release the group and its associated resources.
  17842. * @hidden
  17843. */
  17844. dispose(): void;
  17845. /**
  17846. * Clear the info related to rendering groups preventing retention points during dispose.
  17847. */
  17848. freeRenderingGroups(): void;
  17849. private _prepareRenderingGroup;
  17850. /**
  17851. * Add a sprite manager to the rendering manager in order to render it this frame.
  17852. * @param spriteManager Define the sprite manager to render
  17853. */
  17854. dispatchSprites(spriteManager: ISpriteManager): void;
  17855. /**
  17856. * Add a particle system to the rendering manager in order to render it this frame.
  17857. * @param particleSystem Define the particle system to render
  17858. */
  17859. dispatchParticles(particleSystem: IParticleSystem): void;
  17860. /**
  17861. * Add a submesh to the manager in order to render it this frame
  17862. * @param subMesh The submesh to dispatch
  17863. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17864. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17865. */
  17866. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17867. /**
  17868. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17869. * This allowed control for front to back rendering or reversly depending of the special needs.
  17870. *
  17871. * @param renderingGroupId The rendering group id corresponding to its index
  17872. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17873. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17874. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17875. */
  17876. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  17877. /**
  17878. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17879. *
  17880. * @param renderingGroupId The rendering group id corresponding to its index
  17881. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17882. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17883. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17884. */
  17885. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17886. /**
  17887. * Gets the current auto clear configuration for one rendering group of the rendering
  17888. * manager.
  17889. * @param index the rendering group index to get the information for
  17890. * @returns The auto clear setup for the requested rendering group
  17891. */
  17892. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17893. }
  17894. }
  17895. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17896. import { SmartArray } from "babylonjs/Misc/smartArray";
  17897. import { Nullable } from "babylonjs/types";
  17898. import { Scene } from "babylonjs/scene";
  17899. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17900. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17901. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17902. import { Mesh } from "babylonjs/Meshes/mesh";
  17903. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17904. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17905. import { Effect } from "babylonjs/Materials/effect";
  17906. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17907. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17908. import "babylonjs/Shaders/shadowMap.fragment";
  17909. import "babylonjs/Shaders/shadowMap.vertex";
  17910. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17911. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17912. import { Observable } from "babylonjs/Misc/observable";
  17913. /**
  17914. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17915. */
  17916. export interface ICustomShaderOptions {
  17917. /**
  17918. * Gets or sets the custom shader name to use
  17919. */
  17920. shaderName: string;
  17921. /**
  17922. * The list of attribute names used in the shader
  17923. */
  17924. attributes?: string[];
  17925. /**
  17926. * The list of unifrom names used in the shader
  17927. */
  17928. uniforms?: string[];
  17929. /**
  17930. * The list of sampler names used in the shader
  17931. */
  17932. samplers?: string[];
  17933. /**
  17934. * The list of defines used in the shader
  17935. */
  17936. defines?: string[];
  17937. }
  17938. /**
  17939. * Interface to implement to create a shadow generator compatible with BJS.
  17940. */
  17941. export interface IShadowGenerator {
  17942. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  17943. id: string;
  17944. /**
  17945. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17946. * @returns The render target texture if present otherwise, null
  17947. */
  17948. getShadowMap(): Nullable<RenderTargetTexture>;
  17949. /**
  17950. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17951. * @param subMesh The submesh we want to render in the shadow map
  17952. * @param useInstances Defines wether will draw in the map using instances
  17953. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17954. * @returns true if ready otherwise, false
  17955. */
  17956. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17957. /**
  17958. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17959. * @param defines Defines of the material we want to update
  17960. * @param lightIndex Index of the light in the enabled light list of the material
  17961. */
  17962. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17963. /**
  17964. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17965. * defined in the generator but impacting the effect).
  17966. * It implies the unifroms available on the materials are the standard BJS ones.
  17967. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17968. * @param effect The effect we are binfing the information for
  17969. */
  17970. bindShadowLight(lightIndex: string, effect: Effect): void;
  17971. /**
  17972. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17973. * (eq to shadow prjection matrix * light transform matrix)
  17974. * @returns The transform matrix used to create the shadow map
  17975. */
  17976. getTransformMatrix(): Matrix;
  17977. /**
  17978. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17979. * Cube and 2D textures for instance.
  17980. */
  17981. recreateShadowMap(): void;
  17982. /**
  17983. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17984. * @param onCompiled Callback triggered at the and of the effects compilation
  17985. * @param options Sets of optional options forcing the compilation with different modes
  17986. */
  17987. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17988. useInstances: boolean;
  17989. }>): void;
  17990. /**
  17991. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17992. * @param options Sets of optional options forcing the compilation with different modes
  17993. * @returns A promise that resolves when the compilation completes
  17994. */
  17995. forceCompilationAsync(options?: Partial<{
  17996. useInstances: boolean;
  17997. }>): Promise<void>;
  17998. /**
  17999. * Serializes the shadow generator setup to a json object.
  18000. * @returns The serialized JSON object
  18001. */
  18002. serialize(): any;
  18003. /**
  18004. * Disposes the Shadow map and related Textures and effects.
  18005. */
  18006. dispose(): void;
  18007. }
  18008. /**
  18009. * Default implementation IShadowGenerator.
  18010. * This is the main object responsible of generating shadows in the framework.
  18011. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18012. */
  18013. export class ShadowGenerator implements IShadowGenerator {
  18014. /**
  18015. * Name of the shadow generator class
  18016. */
  18017. static CLASSNAME: string;
  18018. /**
  18019. * Shadow generator mode None: no filtering applied.
  18020. */
  18021. static readonly FILTER_NONE: number;
  18022. /**
  18023. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18024. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18025. */
  18026. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18027. /**
  18028. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18029. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18030. */
  18031. static readonly FILTER_POISSONSAMPLING: number;
  18032. /**
  18033. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18034. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18035. */
  18036. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18037. /**
  18038. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18039. * edge artifacts on steep falloff.
  18040. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18041. */
  18042. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18043. /**
  18044. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18045. * edge artifacts on steep falloff.
  18046. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18047. */
  18048. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18049. /**
  18050. * Shadow generator mode PCF: Percentage Closer Filtering
  18051. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18052. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18053. */
  18054. static readonly FILTER_PCF: number;
  18055. /**
  18056. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18057. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18058. * Contact Hardening
  18059. */
  18060. static readonly FILTER_PCSS: number;
  18061. /**
  18062. * Reserved for PCF and PCSS
  18063. * Highest Quality.
  18064. *
  18065. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18066. *
  18067. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18068. */
  18069. static readonly QUALITY_HIGH: number;
  18070. /**
  18071. * Reserved for PCF and PCSS
  18072. * Good tradeoff for quality/perf cross devices
  18073. *
  18074. * Execute PCF on a 3*3 kernel.
  18075. *
  18076. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18077. */
  18078. static readonly QUALITY_MEDIUM: number;
  18079. /**
  18080. * Reserved for PCF and PCSS
  18081. * The lowest quality but the fastest.
  18082. *
  18083. * Execute PCF on a 1*1 kernel.
  18084. *
  18085. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18086. */
  18087. static readonly QUALITY_LOW: number;
  18088. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18089. id: string;
  18090. /** Gets or sets the custom shader name to use */
  18091. customShaderOptions: ICustomShaderOptions;
  18092. /**
  18093. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18094. */
  18095. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18096. /**
  18097. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18098. */
  18099. onAfterShadowMapRenderObservable: Observable<Effect>;
  18100. /**
  18101. * Observable triggered before a mesh is rendered in the shadow map.
  18102. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18103. */
  18104. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18105. /**
  18106. * Observable triggered after a mesh is rendered in the shadow map.
  18107. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18108. */
  18109. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18110. protected _bias: number;
  18111. /**
  18112. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18113. */
  18114. get bias(): number;
  18115. /**
  18116. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18117. */
  18118. set bias(bias: number);
  18119. protected _normalBias: number;
  18120. /**
  18121. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18122. */
  18123. get normalBias(): number;
  18124. /**
  18125. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18126. */
  18127. set normalBias(normalBias: number);
  18128. protected _blurBoxOffset: number;
  18129. /**
  18130. * Gets the blur box offset: offset applied during the blur pass.
  18131. * Only useful if useKernelBlur = false
  18132. */
  18133. get blurBoxOffset(): number;
  18134. /**
  18135. * Sets the blur box offset: offset applied during the blur pass.
  18136. * Only useful if useKernelBlur = false
  18137. */
  18138. set blurBoxOffset(value: number);
  18139. protected _blurScale: number;
  18140. /**
  18141. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18142. * 2 means half of the size.
  18143. */
  18144. get blurScale(): number;
  18145. /**
  18146. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18147. * 2 means half of the size.
  18148. */
  18149. set blurScale(value: number);
  18150. protected _blurKernel: number;
  18151. /**
  18152. * Gets the blur kernel: kernel size of the blur pass.
  18153. * Only useful if useKernelBlur = true
  18154. */
  18155. get blurKernel(): number;
  18156. /**
  18157. * Sets the blur kernel: kernel size of the blur pass.
  18158. * Only useful if useKernelBlur = true
  18159. */
  18160. set blurKernel(value: number);
  18161. protected _useKernelBlur: boolean;
  18162. /**
  18163. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18164. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18165. */
  18166. get useKernelBlur(): boolean;
  18167. /**
  18168. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18169. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18170. */
  18171. set useKernelBlur(value: boolean);
  18172. protected _depthScale: number;
  18173. /**
  18174. * Gets the depth scale used in ESM mode.
  18175. */
  18176. get depthScale(): number;
  18177. /**
  18178. * Sets the depth scale used in ESM mode.
  18179. * This can override the scale stored on the light.
  18180. */
  18181. set depthScale(value: number);
  18182. protected _validateFilter(filter: number): number;
  18183. protected _filter: number;
  18184. /**
  18185. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18186. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18187. */
  18188. get filter(): number;
  18189. /**
  18190. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18191. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18192. */
  18193. set filter(value: number);
  18194. /**
  18195. * Gets if the current filter is set to Poisson Sampling.
  18196. */
  18197. get usePoissonSampling(): boolean;
  18198. /**
  18199. * Sets the current filter to Poisson Sampling.
  18200. */
  18201. set usePoissonSampling(value: boolean);
  18202. /**
  18203. * Gets if the current filter is set to ESM.
  18204. */
  18205. get useExponentialShadowMap(): boolean;
  18206. /**
  18207. * Sets the current filter is to ESM.
  18208. */
  18209. set useExponentialShadowMap(value: boolean);
  18210. /**
  18211. * Gets if the current filter is set to filtered ESM.
  18212. */
  18213. get useBlurExponentialShadowMap(): boolean;
  18214. /**
  18215. * Gets if the current filter is set to filtered ESM.
  18216. */
  18217. set useBlurExponentialShadowMap(value: boolean);
  18218. /**
  18219. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18220. * exponential to prevent steep falloff artifacts).
  18221. */
  18222. get useCloseExponentialShadowMap(): boolean;
  18223. /**
  18224. * Sets the current filter to "close ESM" (using the inverse of the
  18225. * exponential to prevent steep falloff artifacts).
  18226. */
  18227. set useCloseExponentialShadowMap(value: boolean);
  18228. /**
  18229. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18230. * exponential to prevent steep falloff artifacts).
  18231. */
  18232. get useBlurCloseExponentialShadowMap(): boolean;
  18233. /**
  18234. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18235. * exponential to prevent steep falloff artifacts).
  18236. */
  18237. set useBlurCloseExponentialShadowMap(value: boolean);
  18238. /**
  18239. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18240. */
  18241. get usePercentageCloserFiltering(): boolean;
  18242. /**
  18243. * Sets the current filter to "PCF" (percentage closer filtering).
  18244. */
  18245. set usePercentageCloserFiltering(value: boolean);
  18246. protected _filteringQuality: number;
  18247. /**
  18248. * Gets the PCF or PCSS Quality.
  18249. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18250. */
  18251. get filteringQuality(): number;
  18252. /**
  18253. * Sets the PCF or PCSS Quality.
  18254. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18255. */
  18256. set filteringQuality(filteringQuality: number);
  18257. /**
  18258. * Gets if the current filter is set to "PCSS" (contact hardening).
  18259. */
  18260. get useContactHardeningShadow(): boolean;
  18261. /**
  18262. * Sets the current filter to "PCSS" (contact hardening).
  18263. */
  18264. set useContactHardeningShadow(value: boolean);
  18265. protected _contactHardeningLightSizeUVRatio: number;
  18266. /**
  18267. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18268. * Using a ratio helps keeping shape stability independently of the map size.
  18269. *
  18270. * It does not account for the light projection as it was having too much
  18271. * instability during the light setup or during light position changes.
  18272. *
  18273. * Only valid if useContactHardeningShadow is true.
  18274. */
  18275. get contactHardeningLightSizeUVRatio(): number;
  18276. /**
  18277. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18278. * Using a ratio helps keeping shape stability independently of the map size.
  18279. *
  18280. * It does not account for the light projection as it was having too much
  18281. * instability during the light setup or during light position changes.
  18282. *
  18283. * Only valid if useContactHardeningShadow is true.
  18284. */
  18285. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18286. protected _darkness: number;
  18287. /** Gets or sets the actual darkness of a shadow */
  18288. get darkness(): number;
  18289. set darkness(value: number);
  18290. /**
  18291. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18292. * 0 means strongest and 1 would means no shadow.
  18293. * @returns the darkness.
  18294. */
  18295. getDarkness(): number;
  18296. /**
  18297. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18298. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18299. * @returns the shadow generator allowing fluent coding.
  18300. */
  18301. setDarkness(darkness: number): ShadowGenerator;
  18302. protected _transparencyShadow: boolean;
  18303. /** Gets or sets the ability to have transparent shadow */
  18304. get transparencyShadow(): boolean;
  18305. set transparencyShadow(value: boolean);
  18306. /**
  18307. * Sets the ability to have transparent shadow (boolean).
  18308. * @param transparent True if transparent else False
  18309. * @returns the shadow generator allowing fluent coding
  18310. */
  18311. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18312. /**
  18313. * Enables or disables shadows with varying strength based on the transparency
  18314. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18315. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18316. * mesh.visibility * alphaTexture.a
  18317. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18318. */
  18319. enableSoftTransparentShadow: boolean;
  18320. protected _shadowMap: Nullable<RenderTargetTexture>;
  18321. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18322. /**
  18323. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18324. * @returns The render target texture if present otherwise, null
  18325. */
  18326. getShadowMap(): Nullable<RenderTargetTexture>;
  18327. /**
  18328. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18329. * @returns The render target texture if the shadow map is present otherwise, null
  18330. */
  18331. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18332. /**
  18333. * Gets the class name of that object
  18334. * @returns "ShadowGenerator"
  18335. */
  18336. getClassName(): string;
  18337. /**
  18338. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18339. * @param mesh Mesh to add
  18340. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18341. * @returns the Shadow Generator itself
  18342. */
  18343. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18344. /**
  18345. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18346. * @param mesh Mesh to remove
  18347. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18348. * @returns the Shadow Generator itself
  18349. */
  18350. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18351. /**
  18352. * Controls the extent to which the shadows fade out at the edge of the frustum
  18353. */
  18354. frustumEdgeFalloff: number;
  18355. protected _light: IShadowLight;
  18356. /**
  18357. * Returns the associated light object.
  18358. * @returns the light generating the shadow
  18359. */
  18360. getLight(): IShadowLight;
  18361. /**
  18362. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18363. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18364. * It might on the other hand introduce peter panning.
  18365. */
  18366. forceBackFacesOnly: boolean;
  18367. protected _scene: Scene;
  18368. protected _lightDirection: Vector3;
  18369. protected _effect: Effect;
  18370. protected _viewMatrix: Matrix;
  18371. protected _projectionMatrix: Matrix;
  18372. protected _transformMatrix: Matrix;
  18373. protected _cachedPosition: Vector3;
  18374. protected _cachedDirection: Vector3;
  18375. protected _cachedDefines: string;
  18376. protected _currentRenderID: number;
  18377. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18378. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18379. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18380. protected _blurPostProcesses: PostProcess[];
  18381. protected _mapSize: number;
  18382. protected _currentFaceIndex: number;
  18383. protected _currentFaceIndexCache: number;
  18384. protected _textureType: number;
  18385. protected _defaultTextureMatrix: Matrix;
  18386. protected _storedUniqueId: Nullable<number>;
  18387. /** @hidden */
  18388. static _SceneComponentInitialization: (scene: Scene) => void;
  18389. /**
  18390. * Creates a ShadowGenerator object.
  18391. * A ShadowGenerator is the required tool to use the shadows.
  18392. * Each light casting shadows needs to use its own ShadowGenerator.
  18393. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18394. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18395. * @param light The light object generating the shadows.
  18396. * @param usefulFloatFirst By default the generator will try to use half float textures but if you need precision (for self shadowing for instance), you can use this option to enforce full float texture.
  18397. */
  18398. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18399. protected _initializeGenerator(): void;
  18400. protected _createTargetRenderTexture(): void;
  18401. protected _initializeShadowMap(): void;
  18402. protected _initializeBlurRTTAndPostProcesses(): void;
  18403. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18404. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18405. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18406. protected _applyFilterValues(): void;
  18407. /**
  18408. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18409. * @param onCompiled Callback triggered at the and of the effects compilation
  18410. * @param options Sets of optional options forcing the compilation with different modes
  18411. */
  18412. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18413. useInstances: boolean;
  18414. }>): void;
  18415. /**
  18416. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18417. * @param options Sets of optional options forcing the compilation with different modes
  18418. * @returns A promise that resolves when the compilation completes
  18419. */
  18420. forceCompilationAsync(options?: Partial<{
  18421. useInstances: boolean;
  18422. }>): Promise<void>;
  18423. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18424. private _prepareShadowDefines;
  18425. /**
  18426. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18427. * @param subMesh The submesh we want to render in the shadow map
  18428. * @param useInstances Defines wether will draw in the map using instances
  18429. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18430. * @returns true if ready otherwise, false
  18431. */
  18432. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18433. /**
  18434. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18435. * @param defines Defines of the material we want to update
  18436. * @param lightIndex Index of the light in the enabled light list of the material
  18437. */
  18438. prepareDefines(defines: any, lightIndex: number): void;
  18439. /**
  18440. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18441. * defined in the generator but impacting the effect).
  18442. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18443. * @param effect The effect we are binfing the information for
  18444. */
  18445. bindShadowLight(lightIndex: string, effect: Effect): void;
  18446. /**
  18447. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18448. * (eq to shadow prjection matrix * light transform matrix)
  18449. * @returns The transform matrix used to create the shadow map
  18450. */
  18451. getTransformMatrix(): Matrix;
  18452. /**
  18453. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18454. * Cube and 2D textures for instance.
  18455. */
  18456. recreateShadowMap(): void;
  18457. protected _disposeBlurPostProcesses(): void;
  18458. protected _disposeRTTandPostProcesses(): void;
  18459. /**
  18460. * Disposes the ShadowGenerator.
  18461. * Returns nothing.
  18462. */
  18463. dispose(): void;
  18464. /**
  18465. * Serializes the shadow generator setup to a json object.
  18466. * @returns The serialized JSON object
  18467. */
  18468. serialize(): any;
  18469. /**
  18470. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18471. * @param parsedShadowGenerator The JSON object to parse
  18472. * @param scene The scene to create the shadow map for
  18473. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18474. * @returns The parsed shadow generator
  18475. */
  18476. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18477. }
  18478. }
  18479. declare module "babylonjs/Lights/light" {
  18480. import { Nullable } from "babylonjs/types";
  18481. import { Scene } from "babylonjs/scene";
  18482. import { Vector3 } from "babylonjs/Maths/math.vector";
  18483. import { Color3 } from "babylonjs/Maths/math.color";
  18484. import { Node } from "babylonjs/node";
  18485. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18486. import { Effect } from "babylonjs/Materials/effect";
  18487. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18488. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18489. /**
  18490. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18491. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18492. * All meshes allow light to pass through them unless shadow generation is activated. The default number of lights allowed is four but this can be increased.
  18493. */
  18494. export abstract class Light extends Node {
  18495. /**
  18496. * Falloff Default: light is falling off following the material specification:
  18497. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18498. */
  18499. static readonly FALLOFF_DEFAULT: number;
  18500. /**
  18501. * Falloff Physical: light is falling off following the inverse squared distance law.
  18502. */
  18503. static readonly FALLOFF_PHYSICAL: number;
  18504. /**
  18505. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18506. * to enhance interoperability with other engines.
  18507. */
  18508. static readonly FALLOFF_GLTF: number;
  18509. /**
  18510. * Falloff Standard: light is falling off like in the standard material
  18511. * to enhance interoperability with other materials.
  18512. */
  18513. static readonly FALLOFF_STANDARD: number;
  18514. /**
  18515. * If every light affecting the material is in this lightmapMode,
  18516. * material.lightmapTexture adds or multiplies
  18517. * (depends on material.useLightmapAsShadowmap)
  18518. * after every other light calculations.
  18519. */
  18520. static readonly LIGHTMAP_DEFAULT: number;
  18521. /**
  18522. * material.lightmapTexture as only diffuse lighting from this light
  18523. * adds only specular lighting from this light
  18524. * adds dynamic shadows
  18525. */
  18526. static readonly LIGHTMAP_SPECULAR: number;
  18527. /**
  18528. * material.lightmapTexture as only lighting
  18529. * no light calculation from this light
  18530. * only adds dynamic shadows from this light
  18531. */
  18532. static readonly LIGHTMAP_SHADOWSONLY: number;
  18533. /**
  18534. * Each light type uses the default quantity according to its type:
  18535. * point/spot lights use luminous intensity
  18536. * directional lights use illuminance
  18537. */
  18538. static readonly INTENSITYMODE_AUTOMATIC: number;
  18539. /**
  18540. * lumen (lm)
  18541. */
  18542. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18543. /**
  18544. * candela (lm/sr)
  18545. */
  18546. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18547. /**
  18548. * lux (lm/m^2)
  18549. */
  18550. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18551. /**
  18552. * nit (cd/m^2)
  18553. */
  18554. static readonly INTENSITYMODE_LUMINANCE: number;
  18555. /**
  18556. * Light type const id of the point light.
  18557. */
  18558. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18559. /**
  18560. * Light type const id of the directional light.
  18561. */
  18562. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18563. /**
  18564. * Light type const id of the spot light.
  18565. */
  18566. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18567. /**
  18568. * Light type const id of the hemispheric light.
  18569. */
  18570. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18571. /**
  18572. * Diffuse gives the basic color to an object.
  18573. */
  18574. diffuse: Color3;
  18575. /**
  18576. * Specular produces a highlight color on an object.
  18577. * Note: This is note affecting PBR materials.
  18578. */
  18579. specular: Color3;
  18580. /**
  18581. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18582. * falling off base on range or angle.
  18583. * This can be set to any values in Light.FALLOFF_x.
  18584. *
  18585. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18586. * other types of materials.
  18587. */
  18588. falloffType: number;
  18589. /**
  18590. * Strength of the light.
  18591. * Note: By default it is define in the framework own unit.
  18592. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18593. */
  18594. intensity: number;
  18595. private _range;
  18596. protected _inverseSquaredRange: number;
  18597. /**
  18598. * Defines how far from the source the light is impacting in scene units.
  18599. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18600. */
  18601. get range(): number;
  18602. /**
  18603. * Defines how far from the source the light is impacting in scene units.
  18604. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18605. */
  18606. set range(value: number);
  18607. /**
  18608. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18609. * of light.
  18610. */
  18611. private _photometricScale;
  18612. private _intensityMode;
  18613. /**
  18614. * Gets the photometric scale used to interpret the intensity.
  18615. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18616. */
  18617. get intensityMode(): number;
  18618. /**
  18619. * Sets the photometric scale used to interpret the intensity.
  18620. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18621. */
  18622. set intensityMode(value: number);
  18623. private _radius;
  18624. /**
  18625. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18626. */
  18627. get radius(): number;
  18628. /**
  18629. * sets the light radius used by PBR Materials to simulate soft area lights.
  18630. */
  18631. set radius(value: number);
  18632. private _renderPriority;
  18633. /**
  18634. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18635. * exceeding the number allowed of the materials.
  18636. */
  18637. renderPriority: number;
  18638. private _shadowEnabled;
  18639. /**
  18640. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18641. * the current shadow generator.
  18642. */
  18643. get shadowEnabled(): boolean;
  18644. /**
  18645. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18646. * the current shadow generator.
  18647. */
  18648. set shadowEnabled(value: boolean);
  18649. private _includedOnlyMeshes;
  18650. /**
  18651. * Gets the only meshes impacted by this light.
  18652. */
  18653. get includedOnlyMeshes(): AbstractMesh[];
  18654. /**
  18655. * Sets the only meshes impacted by this light.
  18656. */
  18657. set includedOnlyMeshes(value: AbstractMesh[]);
  18658. private _excludedMeshes;
  18659. /**
  18660. * Gets the meshes not impacted by this light.
  18661. */
  18662. get excludedMeshes(): AbstractMesh[];
  18663. /**
  18664. * Sets the meshes not impacted by this light.
  18665. */
  18666. set excludedMeshes(value: AbstractMesh[]);
  18667. private _excludeWithLayerMask;
  18668. /**
  18669. * Gets the layer id use to find what meshes are not impacted by the light.
  18670. * Inactive if 0
  18671. */
  18672. get excludeWithLayerMask(): number;
  18673. /**
  18674. * Sets the layer id use to find what meshes are not impacted by the light.
  18675. * Inactive if 0
  18676. */
  18677. set excludeWithLayerMask(value: number);
  18678. private _includeOnlyWithLayerMask;
  18679. /**
  18680. * Gets the layer id use to find what meshes are impacted by the light.
  18681. * Inactive if 0
  18682. */
  18683. get includeOnlyWithLayerMask(): number;
  18684. /**
  18685. * Sets the layer id use to find what meshes are impacted by the light.
  18686. * Inactive if 0
  18687. */
  18688. set includeOnlyWithLayerMask(value: number);
  18689. private _lightmapMode;
  18690. /**
  18691. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18692. */
  18693. get lightmapMode(): number;
  18694. /**
  18695. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18696. */
  18697. set lightmapMode(value: number);
  18698. /**
  18699. * Shadow generator associted to the light.
  18700. * @hidden Internal use only.
  18701. */
  18702. _shadowGenerator: Nullable<IShadowGenerator>;
  18703. /**
  18704. * @hidden Internal use only.
  18705. */
  18706. _excludedMeshesIds: string[];
  18707. /**
  18708. * @hidden Internal use only.
  18709. */
  18710. _includedOnlyMeshesIds: string[];
  18711. /**
  18712. * The current light unifom buffer.
  18713. * @hidden Internal use only.
  18714. */
  18715. _uniformBuffer: UniformBuffer;
  18716. /** @hidden */
  18717. _renderId: number;
  18718. /**
  18719. * Creates a Light object in the scene.
  18720. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18721. * @param name The firendly name of the light
  18722. * @param scene The scene the light belongs too
  18723. */
  18724. constructor(name: string, scene: Scene);
  18725. protected abstract _buildUniformLayout(): void;
  18726. /**
  18727. * Sets the passed Effect "effect" with the Light information.
  18728. * @param effect The effect to update
  18729. * @param lightIndex The index of the light in the effect to update
  18730. * @returns The light
  18731. */
  18732. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18733. /**
  18734. * Sets the passed Effect "effect" with the Light textures.
  18735. * @param effect The effect to update
  18736. * @param lightIndex The index of the light in the effect to update
  18737. * @returns The light
  18738. */
  18739. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18740. /**
  18741. * Binds the lights information from the scene to the effect for the given mesh.
  18742. * @param lightIndex Light index
  18743. * @param scene The scene where the light belongs to
  18744. * @param effect The effect we are binding the data to
  18745. * @param useSpecular Defines if specular is supported
  18746. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18747. */
  18748. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18749. /**
  18750. * Sets the passed Effect "effect" with the Light information.
  18751. * @param effect The effect to update
  18752. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18753. * @returns The light
  18754. */
  18755. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18756. /**
  18757. * Returns the string "Light".
  18758. * @returns the class name
  18759. */
  18760. getClassName(): string;
  18761. /** @hidden */
  18762. readonly _isLight: boolean;
  18763. /**
  18764. * Converts the light information to a readable string for debug purpose.
  18765. * @param fullDetails Supports for multiple levels of logging within scene loading
  18766. * @returns the human readable light info
  18767. */
  18768. toString(fullDetails?: boolean): string;
  18769. /** @hidden */
  18770. protected _syncParentEnabledState(): void;
  18771. /**
  18772. * Set the enabled state of this node.
  18773. * @param value - the new enabled state
  18774. */
  18775. setEnabled(value: boolean): void;
  18776. /**
  18777. * Returns the Light associated shadow generator if any.
  18778. * @return the associated shadow generator.
  18779. */
  18780. getShadowGenerator(): Nullable<IShadowGenerator>;
  18781. /**
  18782. * Returns a Vector3, the absolute light position in the World.
  18783. * @returns the world space position of the light
  18784. */
  18785. getAbsolutePosition(): Vector3;
  18786. /**
  18787. * Specifies if the light will affect the passed mesh.
  18788. * @param mesh The mesh to test against the light
  18789. * @return true the mesh is affected otherwise, false.
  18790. */
  18791. canAffectMesh(mesh: AbstractMesh): boolean;
  18792. /**
  18793. * Sort function to order lights for rendering.
  18794. * @param a First Light object to compare to second.
  18795. * @param b Second Light object to compare first.
  18796. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18797. */
  18798. static CompareLightsPriority(a: Light, b: Light): number;
  18799. /**
  18800. * Releases resources associated with this node.
  18801. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18802. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18803. */
  18804. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18805. /**
  18806. * Returns the light type ID (integer).
  18807. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18808. */
  18809. getTypeID(): number;
  18810. /**
  18811. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18812. * @returns the scaled intensity in intensity mode unit
  18813. */
  18814. getScaledIntensity(): number;
  18815. /**
  18816. * Returns a new Light object, named "name", from the current one.
  18817. * @param name The name of the cloned light
  18818. * @param newParent The parent of this light, if it has one
  18819. * @returns the new created light
  18820. */
  18821. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18822. /**
  18823. * Serializes the current light into a Serialization object.
  18824. * @returns the serialized object.
  18825. */
  18826. serialize(): any;
  18827. /**
  18828. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18829. * This new light is named "name" and added to the passed scene.
  18830. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18831. * @param name The friendly name of the light
  18832. * @param scene The scene the new light will belong to
  18833. * @returns the constructor function
  18834. */
  18835. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18836. /**
  18837. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18838. * @param parsedLight The JSON representation of the light
  18839. * @param scene The scene to create the parsed light in
  18840. * @returns the created light after parsing
  18841. */
  18842. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18843. private _hookArrayForExcluded;
  18844. private _hookArrayForIncludedOnly;
  18845. private _resyncMeshes;
  18846. /**
  18847. * Forces the meshes to update their light related information in their rendering used effects
  18848. * @hidden Internal Use Only
  18849. */
  18850. _markMeshesAsLightDirty(): void;
  18851. /**
  18852. * Recomputes the cached photometric scale if needed.
  18853. */
  18854. private _computePhotometricScale;
  18855. /**
  18856. * Returns the Photometric Scale according to the light type and intensity mode.
  18857. */
  18858. private _getPhotometricScale;
  18859. /**
  18860. * Reorder the light in the scene according to their defined priority.
  18861. * @hidden Internal Use Only
  18862. */
  18863. _reorderLightsInScene(): void;
  18864. /**
  18865. * Prepares the list of defines specific to the light type.
  18866. * @param defines the list of defines
  18867. * @param lightIndex defines the index of the light for the effect
  18868. */
  18869. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18870. }
  18871. }
  18872. declare module "babylonjs/Cameras/targetCamera" {
  18873. import { Nullable } from "babylonjs/types";
  18874. import { Camera } from "babylonjs/Cameras/camera";
  18875. import { Scene } from "babylonjs/scene";
  18876. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18877. /**
  18878. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18879. * This is the base of the follow, arc rotate cameras and Free camera
  18880. * @see https://doc.babylonjs.com/features/cameras
  18881. */
  18882. export class TargetCamera extends Camera {
  18883. private static _RigCamTransformMatrix;
  18884. private static _TargetTransformMatrix;
  18885. private static _TargetFocalPoint;
  18886. private _tmpUpVector;
  18887. private _tmpTargetVector;
  18888. /**
  18889. * Define the current direction the camera is moving to
  18890. */
  18891. cameraDirection: Vector3;
  18892. /**
  18893. * Define the current rotation the camera is rotating to
  18894. */
  18895. cameraRotation: Vector2;
  18896. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18897. ignoreParentScaling: boolean;
  18898. /**
  18899. * When set, the up vector of the camera will be updated by the rotation of the camera
  18900. */
  18901. updateUpVectorFromRotation: boolean;
  18902. private _tmpQuaternion;
  18903. /**
  18904. * Define the current rotation of the camera
  18905. */
  18906. rotation: Vector3;
  18907. /**
  18908. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18909. */
  18910. rotationQuaternion: Quaternion;
  18911. /**
  18912. * Define the current speed of the camera
  18913. */
  18914. speed: number;
  18915. /**
  18916. * Add constraint to the camera to prevent it to move freely in all directions and
  18917. * around all axis.
  18918. */
  18919. noRotationConstraint: boolean;
  18920. /**
  18921. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18922. * panning
  18923. */
  18924. invertRotation: boolean;
  18925. /**
  18926. * Speed multiplier for inverse camera panning
  18927. */
  18928. inverseRotationSpeed: number;
  18929. /**
  18930. * Define the current target of the camera as an object or a position.
  18931. */
  18932. lockedTarget: any;
  18933. /** @hidden */
  18934. _currentTarget: Vector3;
  18935. /** @hidden */
  18936. _initialFocalDistance: number;
  18937. /** @hidden */
  18938. _viewMatrix: Matrix;
  18939. /** @hidden */
  18940. _camMatrix: Matrix;
  18941. /** @hidden */
  18942. _cameraTransformMatrix: Matrix;
  18943. /** @hidden */
  18944. _cameraRotationMatrix: Matrix;
  18945. /** @hidden */
  18946. _referencePoint: Vector3;
  18947. /** @hidden */
  18948. _transformedReferencePoint: Vector3;
  18949. /** @hidden */
  18950. _reset: () => void;
  18951. private _defaultUp;
  18952. /**
  18953. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18954. * This is the base of the follow, arc rotate cameras and Free camera
  18955. * @see https://doc.babylonjs.com/features/cameras
  18956. * @param name Defines the name of the camera in the scene
  18957. * @param position Defines the start position of the camera in the scene
  18958. * @param scene Defines the scene the camera belongs to
  18959. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18960. */
  18961. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18962. /**
  18963. * Gets the position in front of the camera at a given distance.
  18964. * @param distance The distance from the camera we want the position to be
  18965. * @returns the position
  18966. */
  18967. getFrontPosition(distance: number): Vector3;
  18968. /** @hidden */
  18969. _getLockedTargetPosition(): Nullable<Vector3>;
  18970. private _storedPosition;
  18971. private _storedRotation;
  18972. private _storedRotationQuaternion;
  18973. /**
  18974. * Store current camera state of the camera (fov, position, rotation, etc..)
  18975. * @returns the camera
  18976. */
  18977. storeState(): Camera;
  18978. /**
  18979. * Restored camera state. You must call storeState() first
  18980. * @returns whether it was successful or not
  18981. * @hidden
  18982. */
  18983. _restoreStateValues(): boolean;
  18984. /** @hidden */
  18985. _initCache(): void;
  18986. /** @hidden */
  18987. _updateCache(ignoreParentClass?: boolean): void;
  18988. /** @hidden */
  18989. _isSynchronizedViewMatrix(): boolean;
  18990. /** @hidden */
  18991. _computeLocalCameraSpeed(): number;
  18992. /**
  18993. * Defines the target the camera should look at.
  18994. * @param target Defines the new target as a Vector or a mesh
  18995. */
  18996. setTarget(target: Vector3): void;
  18997. /**
  18998. * Defines the target point of the camera.
  18999. * The camera looks towards it form the radius distance.
  19000. */
  19001. get target(): Vector3;
  19002. set target(value: Vector3);
  19003. /**
  19004. * Return the current target position of the camera. This value is expressed in local space.
  19005. * @returns the target position
  19006. */
  19007. getTarget(): Vector3;
  19008. /** @hidden */
  19009. _decideIfNeedsToMove(): boolean;
  19010. /** @hidden */
  19011. _updatePosition(): void;
  19012. /** @hidden */
  19013. _checkInputs(): void;
  19014. protected _updateCameraRotationMatrix(): void;
  19015. /**
  19016. * Update the up vector to apply the rotation of the camera (So if you changed the camera rotation.z this will let you update the up vector as well)
  19017. * @returns the current camera
  19018. */
  19019. private _rotateUpVectorWithCameraRotationMatrix;
  19020. private _cachedRotationZ;
  19021. private _cachedQuaternionRotationZ;
  19022. /** @hidden */
  19023. _getViewMatrix(): Matrix;
  19024. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19025. /**
  19026. * @hidden
  19027. */
  19028. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19029. /**
  19030. * @hidden
  19031. */
  19032. _updateRigCameras(): void;
  19033. private _getRigCamPositionAndTarget;
  19034. /**
  19035. * Gets the current object class name.
  19036. * @return the class name
  19037. */
  19038. getClassName(): string;
  19039. }
  19040. }
  19041. declare module "babylonjs/Events/keyboardEvents" {
  19042. /**
  19043. * Gather the list of keyboard event types as constants.
  19044. */
  19045. export class KeyboardEventTypes {
  19046. /**
  19047. * The keydown event is fired when a key becomes active (pressed).
  19048. */
  19049. static readonly KEYDOWN: number;
  19050. /**
  19051. * The keyup event is fired when a key has been released.
  19052. */
  19053. static readonly KEYUP: number;
  19054. }
  19055. /**
  19056. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19057. */
  19058. export class KeyboardInfo {
  19059. /**
  19060. * Defines the type of event (KeyboardEventTypes)
  19061. */
  19062. type: number;
  19063. /**
  19064. * Defines the related dom event
  19065. */
  19066. event: KeyboardEvent;
  19067. /**
  19068. * Instantiates a new keyboard info.
  19069. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19070. * @param type Defines the type of event (KeyboardEventTypes)
  19071. * @param event Defines the related dom event
  19072. */
  19073. constructor(
  19074. /**
  19075. * Defines the type of event (KeyboardEventTypes)
  19076. */
  19077. type: number,
  19078. /**
  19079. * Defines the related dom event
  19080. */
  19081. event: KeyboardEvent);
  19082. }
  19083. /**
  19084. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19085. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19086. */
  19087. export class KeyboardInfoPre extends KeyboardInfo {
  19088. /**
  19089. * Defines the type of event (KeyboardEventTypes)
  19090. */
  19091. type: number;
  19092. /**
  19093. * Defines the related dom event
  19094. */
  19095. event: KeyboardEvent;
  19096. /**
  19097. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19098. */
  19099. skipOnPointerObservable: boolean;
  19100. /**
  19101. * Instantiates a new keyboard pre info.
  19102. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19103. * @param type Defines the type of event (KeyboardEventTypes)
  19104. * @param event Defines the related dom event
  19105. */
  19106. constructor(
  19107. /**
  19108. * Defines the type of event (KeyboardEventTypes)
  19109. */
  19110. type: number,
  19111. /**
  19112. * Defines the related dom event
  19113. */
  19114. event: KeyboardEvent);
  19115. }
  19116. }
  19117. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19118. import { Nullable } from "babylonjs/types";
  19119. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19120. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19121. /**
  19122. * Manage the keyboard inputs to control the movement of a free camera.
  19123. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19124. */
  19125. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19126. /**
  19127. * Defines the camera the input is attached to.
  19128. */
  19129. camera: FreeCamera;
  19130. /**
  19131. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19132. */
  19133. keysUp: number[];
  19134. /**
  19135. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19136. */
  19137. keysUpward: number[];
  19138. /**
  19139. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19140. */
  19141. keysDown: number[];
  19142. /**
  19143. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19144. */
  19145. keysDownward: number[];
  19146. /**
  19147. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19148. */
  19149. keysLeft: number[];
  19150. /**
  19151. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19152. */
  19153. keysRight: number[];
  19154. private _keys;
  19155. private _onCanvasBlurObserver;
  19156. private _onKeyboardObserver;
  19157. private _engine;
  19158. private _scene;
  19159. /**
  19160. * Attach the input controls to a specific dom element to get the input from.
  19161. * @param element Defines the element the controls should be listened from
  19162. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19163. */
  19164. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19165. /**
  19166. * Detach the current controls from the specified dom element.
  19167. * @param element Defines the element to stop listening the inputs from
  19168. */
  19169. detachControl(element: Nullable<HTMLElement>): void;
  19170. /**
  19171. * Update the current camera state depending on the inputs that have been used this frame.
  19172. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19173. */
  19174. checkInputs(): void;
  19175. /**
  19176. * Gets the class name of the current intput.
  19177. * @returns the class name
  19178. */
  19179. getClassName(): string;
  19180. /** @hidden */
  19181. _onLostFocus(): void;
  19182. /**
  19183. * Get the friendly name associated with the input class.
  19184. * @returns the input friendly name
  19185. */
  19186. getSimpleName(): string;
  19187. }
  19188. }
  19189. declare module "babylonjs/Events/pointerEvents" {
  19190. import { Nullable } from "babylonjs/types";
  19191. import { Vector2 } from "babylonjs/Maths/math.vector";
  19192. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19193. import { Ray } from "babylonjs/Culling/ray";
  19194. /**
  19195. * Gather the list of pointer event types as constants.
  19196. */
  19197. export class PointerEventTypes {
  19198. /**
  19199. * The pointerdown event is fired when a pointer becomes active. For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed. For touch, it is fired when physical contact is made with the digitizer. For pen, it is fired when the stylus makes physical contact with the digitizer.
  19200. */
  19201. static readonly POINTERDOWN: number;
  19202. /**
  19203. * The pointerup event is fired when a pointer is no longer active.
  19204. */
  19205. static readonly POINTERUP: number;
  19206. /**
  19207. * The pointermove event is fired when a pointer changes coordinates.
  19208. */
  19209. static readonly POINTERMOVE: number;
  19210. /**
  19211. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19212. */
  19213. static readonly POINTERWHEEL: number;
  19214. /**
  19215. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19216. */
  19217. static readonly POINTERPICK: number;
  19218. /**
  19219. * The pointertap event is fired when a the object has been touched and released without drag.
  19220. */
  19221. static readonly POINTERTAP: number;
  19222. /**
  19223. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19224. */
  19225. static readonly POINTERDOUBLETAP: number;
  19226. }
  19227. /**
  19228. * Base class of pointer info types.
  19229. */
  19230. export class PointerInfoBase {
  19231. /**
  19232. * Defines the type of event (PointerEventTypes)
  19233. */
  19234. type: number;
  19235. /**
  19236. * Defines the related dom event
  19237. */
  19238. event: PointerEvent | MouseWheelEvent;
  19239. /**
  19240. * Instantiates the base class of pointers info.
  19241. * @param type Defines the type of event (PointerEventTypes)
  19242. * @param event Defines the related dom event
  19243. */
  19244. constructor(
  19245. /**
  19246. * Defines the type of event (PointerEventTypes)
  19247. */
  19248. type: number,
  19249. /**
  19250. * Defines the related dom event
  19251. */
  19252. event: PointerEvent | MouseWheelEvent);
  19253. }
  19254. /**
  19255. * This class is used to store pointer related info for the onPrePointerObservable event.
  19256. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19257. */
  19258. export class PointerInfoPre extends PointerInfoBase {
  19259. /**
  19260. * Ray from a pointer if availible (eg. 6dof controller)
  19261. */
  19262. ray: Nullable<Ray>;
  19263. /**
  19264. * Defines the local position of the pointer on the canvas.
  19265. */
  19266. localPosition: Vector2;
  19267. /**
  19268. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19269. */
  19270. skipOnPointerObservable: boolean;
  19271. /**
  19272. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19273. * @param type Defines the type of event (PointerEventTypes)
  19274. * @param event Defines the related dom event
  19275. * @param localX Defines the local x coordinates of the pointer when the event occured
  19276. * @param localY Defines the local y coordinates of the pointer when the event occured
  19277. */
  19278. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19279. }
  19280. /**
  19281. * This type contains all the data related to a pointer event in Babylon.js.
  19282. * The event member is an instance of PointerEvent for all types except PointerWheel and is of type MouseWheelEvent when type equals PointerWheel. The different event types can be found in the PointerEventTypes class.
  19283. */
  19284. export class PointerInfo extends PointerInfoBase {
  19285. /**
  19286. * Defines the picking info associated to the info (if any)\
  19287. */
  19288. pickInfo: Nullable<PickingInfo>;
  19289. /**
  19290. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19291. * @param type Defines the type of event (PointerEventTypes)
  19292. * @param event Defines the related dom event
  19293. * @param pickInfo Defines the picking info associated to the info (if any)\
  19294. */
  19295. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19296. /**
  19297. * Defines the picking info associated to the info (if any)\
  19298. */
  19299. pickInfo: Nullable<PickingInfo>);
  19300. }
  19301. /**
  19302. * Data relating to a touch event on the screen.
  19303. */
  19304. export interface PointerTouch {
  19305. /**
  19306. * X coordinate of touch.
  19307. */
  19308. x: number;
  19309. /**
  19310. * Y coordinate of touch.
  19311. */
  19312. y: number;
  19313. /**
  19314. * Id of touch. Unique for each finger.
  19315. */
  19316. pointerId: number;
  19317. /**
  19318. * Event type passed from DOM.
  19319. */
  19320. type: any;
  19321. }
  19322. }
  19323. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19324. import { Observable } from "babylonjs/Misc/observable";
  19325. import { Nullable } from "babylonjs/types";
  19326. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19327. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19328. /**
  19329. * Manage the mouse inputs to control the movement of a free camera.
  19330. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19331. */
  19332. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19333. /**
  19334. * Define if touch is enabled in the mouse input
  19335. */
  19336. touchEnabled: boolean;
  19337. /**
  19338. * Defines the camera the input is attached to.
  19339. */
  19340. camera: FreeCamera;
  19341. /**
  19342. * Defines the buttons associated with the input to handle camera move.
  19343. */
  19344. buttons: number[];
  19345. /**
  19346. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19347. */
  19348. angularSensibility: number;
  19349. private _pointerInput;
  19350. private _onMouseMove;
  19351. private _observer;
  19352. private previousPosition;
  19353. /**
  19354. * Observable for when a pointer move event occurs containing the move offset
  19355. */
  19356. onPointerMovedObservable: Observable<{
  19357. offsetX: number;
  19358. offsetY: number;
  19359. }>;
  19360. /**
  19361. * @hidden
  19362. * If the camera should be rotated automatically based on pointer movement
  19363. */
  19364. _allowCameraRotation: boolean;
  19365. /**
  19366. * Manage the mouse inputs to control the movement of a free camera.
  19367. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19368. * @param touchEnabled Defines if touch is enabled or not
  19369. */
  19370. constructor(
  19371. /**
  19372. * Define if touch is enabled in the mouse input
  19373. */
  19374. touchEnabled?: boolean);
  19375. /**
  19376. * Attach the input controls to a specific dom element to get the input from.
  19377. * @param element Defines the element the controls should be listened from
  19378. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19379. */
  19380. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19381. /**
  19382. * Called on JS contextmenu event.
  19383. * Override this method to provide functionality.
  19384. */
  19385. protected onContextMenu(evt: PointerEvent): void;
  19386. /**
  19387. * Detach the current controls from the specified dom element.
  19388. * @param element Defines the element to stop listening the inputs from
  19389. */
  19390. detachControl(element: Nullable<HTMLElement>): void;
  19391. /**
  19392. * Gets the class name of the current intput.
  19393. * @returns the class name
  19394. */
  19395. getClassName(): string;
  19396. /**
  19397. * Get the friendly name associated with the input class.
  19398. * @returns the input friendly name
  19399. */
  19400. getSimpleName(): string;
  19401. }
  19402. }
  19403. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19404. import { Nullable } from "babylonjs/types";
  19405. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19406. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19407. /**
  19408. * Manage the touch inputs to control the movement of a free camera.
  19409. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19410. */
  19411. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19412. /**
  19413. * Define if mouse events can be treated as touch events
  19414. */
  19415. allowMouse: boolean;
  19416. /**
  19417. * Defines the camera the input is attached to.
  19418. */
  19419. camera: FreeCamera;
  19420. /**
  19421. * Defines the touch sensibility for rotation.
  19422. * The higher the faster.
  19423. */
  19424. touchAngularSensibility: number;
  19425. /**
  19426. * Defines the touch sensibility for move.
  19427. * The higher the faster.
  19428. */
  19429. touchMoveSensibility: number;
  19430. private _offsetX;
  19431. private _offsetY;
  19432. private _pointerPressed;
  19433. private _pointerInput;
  19434. private _observer;
  19435. private _onLostFocus;
  19436. /**
  19437. * Manage the touch inputs to control the movement of a free camera.
  19438. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19439. * @param allowMouse Defines if mouse events can be treated as touch events
  19440. */
  19441. constructor(
  19442. /**
  19443. * Define if mouse events can be treated as touch events
  19444. */
  19445. allowMouse?: boolean);
  19446. /**
  19447. * Attach the input controls to a specific dom element to get the input from.
  19448. * @param element Defines the element the controls should be listened from
  19449. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19450. */
  19451. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19452. /**
  19453. * Detach the current controls from the specified dom element.
  19454. * @param element Defines the element to stop listening the inputs from
  19455. */
  19456. detachControl(element: Nullable<HTMLElement>): void;
  19457. /**
  19458. * Update the current camera state depending on the inputs that have been used this frame.
  19459. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19460. */
  19461. checkInputs(): void;
  19462. /**
  19463. * Gets the class name of the current intput.
  19464. * @returns the class name
  19465. */
  19466. getClassName(): string;
  19467. /**
  19468. * Get the friendly name associated with the input class.
  19469. * @returns the input friendly name
  19470. */
  19471. getSimpleName(): string;
  19472. }
  19473. }
  19474. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19475. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19476. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19477. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19478. import { Nullable } from "babylonjs/types";
  19479. /**
  19480. * Default Inputs manager for the FreeCamera.
  19481. * It groups all the default supported inputs for ease of use.
  19482. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19483. */
  19484. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19485. /**
  19486. * @hidden
  19487. */
  19488. _mouseInput: Nullable<FreeCameraMouseInput>;
  19489. /**
  19490. * Instantiates a new FreeCameraInputsManager.
  19491. * @param camera Defines the camera the inputs belong to
  19492. */
  19493. constructor(camera: FreeCamera);
  19494. /**
  19495. * Add keyboard input support to the input manager.
  19496. * @returns the current input manager
  19497. */
  19498. addKeyboard(): FreeCameraInputsManager;
  19499. /**
  19500. * Add mouse input support to the input manager.
  19501. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19502. * @returns the current input manager
  19503. */
  19504. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19505. /**
  19506. * Removes the mouse input support from the manager
  19507. * @returns the current input manager
  19508. */
  19509. removeMouse(): FreeCameraInputsManager;
  19510. /**
  19511. * Add touch input support to the input manager.
  19512. * @returns the current input manager
  19513. */
  19514. addTouch(): FreeCameraInputsManager;
  19515. /**
  19516. * Remove all attached input methods from a camera
  19517. */
  19518. clear(): void;
  19519. }
  19520. }
  19521. declare module "babylonjs/Cameras/freeCamera" {
  19522. import { Vector3 } from "babylonjs/Maths/math.vector";
  19523. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19524. import { Scene } from "babylonjs/scene";
  19525. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19526. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19527. /**
  19528. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19529. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19530. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19531. */
  19532. export class FreeCamera extends TargetCamera {
  19533. /**
  19534. * Define the collision ellipsoid of the camera.
  19535. * This is helpful to simulate a camera body like the player body around the camera
  19536. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19537. */
  19538. ellipsoid: Vector3;
  19539. /**
  19540. * Define an offset for the position of the ellipsoid around the camera.
  19541. * This can be helpful to determine the center of the body near the gravity center of the body
  19542. * instead of its head.
  19543. */
  19544. ellipsoidOffset: Vector3;
  19545. /**
  19546. * Enable or disable collisions of the camera with the rest of the scene objects.
  19547. */
  19548. checkCollisions: boolean;
  19549. /**
  19550. * Enable or disable gravity on the camera.
  19551. */
  19552. applyGravity: boolean;
  19553. /**
  19554. * Define the input manager associated to the camera.
  19555. */
  19556. inputs: FreeCameraInputsManager;
  19557. /**
  19558. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19559. * Higher values reduce sensitivity.
  19560. */
  19561. get angularSensibility(): number;
  19562. /**
  19563. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19564. * Higher values reduce sensitivity.
  19565. */
  19566. set angularSensibility(value: number);
  19567. /**
  19568. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19569. */
  19570. get keysUp(): number[];
  19571. set keysUp(value: number[]);
  19572. /**
  19573. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19574. */
  19575. get keysUpward(): number[];
  19576. set keysUpward(value: number[]);
  19577. /**
  19578. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19579. */
  19580. get keysDown(): number[];
  19581. set keysDown(value: number[]);
  19582. /**
  19583. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19584. */
  19585. get keysDownward(): number[];
  19586. set keysDownward(value: number[]);
  19587. /**
  19588. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19589. */
  19590. get keysLeft(): number[];
  19591. set keysLeft(value: number[]);
  19592. /**
  19593. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19594. */
  19595. get keysRight(): number[];
  19596. set keysRight(value: number[]);
  19597. /**
  19598. * Event raised when the camera collide with a mesh in the scene.
  19599. */
  19600. onCollide: (collidedMesh: AbstractMesh) => void;
  19601. private _collider;
  19602. private _needMoveForGravity;
  19603. private _oldPosition;
  19604. private _diffPosition;
  19605. private _newPosition;
  19606. /** @hidden */
  19607. _localDirection: Vector3;
  19608. /** @hidden */
  19609. _transformedDirection: Vector3;
  19610. /**
  19611. * Instantiates a Free Camera.
  19612. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19613. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19614. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19615. * @param name Define the name of the camera in the scene
  19616. * @param position Define the start position of the camera in the scene
  19617. * @param scene Define the scene the camera belongs to
  19618. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19619. */
  19620. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19621. /**
  19622. * Attached controls to the current camera.
  19623. * @param element Defines the element the controls should be listened from
  19624. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19625. */
  19626. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19627. /**
  19628. * Detach the current controls from the camera.
  19629. * The camera will stop reacting to inputs.
  19630. * @param element Defines the element to stop listening the inputs from
  19631. */
  19632. detachControl(element: HTMLElement): void;
  19633. private _collisionMask;
  19634. /**
  19635. * Define a collision mask to limit the list of object the camera can collide with
  19636. */
  19637. get collisionMask(): number;
  19638. set collisionMask(mask: number);
  19639. /** @hidden */
  19640. _collideWithWorld(displacement: Vector3): void;
  19641. private _onCollisionPositionChange;
  19642. /** @hidden */
  19643. _checkInputs(): void;
  19644. /** @hidden */
  19645. _decideIfNeedsToMove(): boolean;
  19646. /** @hidden */
  19647. _updatePosition(): void;
  19648. /**
  19649. * Destroy the camera and release the current resources hold by it.
  19650. */
  19651. dispose(): void;
  19652. /**
  19653. * Gets the current object class name.
  19654. * @return the class name
  19655. */
  19656. getClassName(): string;
  19657. }
  19658. }
  19659. declare module "babylonjs/Gamepads/gamepad" {
  19660. import { Observable } from "babylonjs/Misc/observable";
  19661. /**
  19662. * Represents a gamepad control stick position
  19663. */
  19664. export class StickValues {
  19665. /**
  19666. * The x component of the control stick
  19667. */
  19668. x: number;
  19669. /**
  19670. * The y component of the control stick
  19671. */
  19672. y: number;
  19673. /**
  19674. * Initializes the gamepad x and y control stick values
  19675. * @param x The x component of the gamepad control stick value
  19676. * @param y The y component of the gamepad control stick value
  19677. */
  19678. constructor(
  19679. /**
  19680. * The x component of the control stick
  19681. */
  19682. x: number,
  19683. /**
  19684. * The y component of the control stick
  19685. */
  19686. y: number);
  19687. }
  19688. /**
  19689. * An interface which manages callbacks for gamepad button changes
  19690. */
  19691. export interface GamepadButtonChanges {
  19692. /**
  19693. * Called when a gamepad has been changed
  19694. */
  19695. changed: boolean;
  19696. /**
  19697. * Called when a gamepad press event has been triggered
  19698. */
  19699. pressChanged: boolean;
  19700. /**
  19701. * Called when a touch event has been triggered
  19702. */
  19703. touchChanged: boolean;
  19704. /**
  19705. * Called when a value has changed
  19706. */
  19707. valueChanged: boolean;
  19708. }
  19709. /**
  19710. * Represents a gamepad
  19711. */
  19712. export class Gamepad {
  19713. /**
  19714. * The id of the gamepad
  19715. */
  19716. id: string;
  19717. /**
  19718. * The index of the gamepad
  19719. */
  19720. index: number;
  19721. /**
  19722. * The browser gamepad
  19723. */
  19724. browserGamepad: any;
  19725. /**
  19726. * Specifies what type of gamepad this represents
  19727. */
  19728. type: number;
  19729. private _leftStick;
  19730. private _rightStick;
  19731. /** @hidden */
  19732. _isConnected: boolean;
  19733. private _leftStickAxisX;
  19734. private _leftStickAxisY;
  19735. private _rightStickAxisX;
  19736. private _rightStickAxisY;
  19737. /**
  19738. * Triggered when the left control stick has been changed
  19739. */
  19740. private _onleftstickchanged;
  19741. /**
  19742. * Triggered when the right control stick has been changed
  19743. */
  19744. private _onrightstickchanged;
  19745. /**
  19746. * Represents a gamepad controller
  19747. */
  19748. static GAMEPAD: number;
  19749. /**
  19750. * Represents a generic controller
  19751. */
  19752. static GENERIC: number;
  19753. /**
  19754. * Represents an XBox controller
  19755. */
  19756. static XBOX: number;
  19757. /**
  19758. * Represents a pose-enabled controller
  19759. */
  19760. static POSE_ENABLED: number;
  19761. /**
  19762. * Represents an Dual Shock controller
  19763. */
  19764. static DUALSHOCK: number;
  19765. /**
  19766. * Specifies whether the left control stick should be Y-inverted
  19767. */
  19768. protected _invertLeftStickY: boolean;
  19769. /**
  19770. * Specifies if the gamepad has been connected
  19771. */
  19772. get isConnected(): boolean;
  19773. /**
  19774. * Initializes the gamepad
  19775. * @param id The id of the gamepad
  19776. * @param index The index of the gamepad
  19777. * @param browserGamepad The browser gamepad
  19778. * @param leftStickX The x component of the left joystick
  19779. * @param leftStickY The y component of the left joystick
  19780. * @param rightStickX The x component of the right joystick
  19781. * @param rightStickY The y component of the right joystick
  19782. */
  19783. constructor(
  19784. /**
  19785. * The id of the gamepad
  19786. */
  19787. id: string,
  19788. /**
  19789. * The index of the gamepad
  19790. */
  19791. index: number,
  19792. /**
  19793. * The browser gamepad
  19794. */
  19795. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19796. /**
  19797. * Callback triggered when the left joystick has changed
  19798. * @param callback
  19799. */
  19800. onleftstickchanged(callback: (values: StickValues) => void): void;
  19801. /**
  19802. * Callback triggered when the right joystick has changed
  19803. * @param callback
  19804. */
  19805. onrightstickchanged(callback: (values: StickValues) => void): void;
  19806. /**
  19807. * Gets the left joystick
  19808. */
  19809. get leftStick(): StickValues;
  19810. /**
  19811. * Sets the left joystick values
  19812. */
  19813. set leftStick(newValues: StickValues);
  19814. /**
  19815. * Gets the right joystick
  19816. */
  19817. get rightStick(): StickValues;
  19818. /**
  19819. * Sets the right joystick value
  19820. */
  19821. set rightStick(newValues: StickValues);
  19822. /**
  19823. * Updates the gamepad joystick positions
  19824. */
  19825. update(): void;
  19826. /**
  19827. * Disposes the gamepad
  19828. */
  19829. dispose(): void;
  19830. }
  19831. /**
  19832. * Represents a generic gamepad
  19833. */
  19834. export class GenericPad extends Gamepad {
  19835. private _buttons;
  19836. private _onbuttondown;
  19837. private _onbuttonup;
  19838. /**
  19839. * Observable triggered when a button has been pressed
  19840. */
  19841. onButtonDownObservable: Observable<number>;
  19842. /**
  19843. * Observable triggered when a button has been released
  19844. */
  19845. onButtonUpObservable: Observable<number>;
  19846. /**
  19847. * Callback triggered when a button has been pressed
  19848. * @param callback Called when a button has been pressed
  19849. */
  19850. onbuttondown(callback: (buttonPressed: number) => void): void;
  19851. /**
  19852. * Callback triggered when a button has been released
  19853. * @param callback Called when a button has been released
  19854. */
  19855. onbuttonup(callback: (buttonReleased: number) => void): void;
  19856. /**
  19857. * Initializes the generic gamepad
  19858. * @param id The id of the generic gamepad
  19859. * @param index The index of the generic gamepad
  19860. * @param browserGamepad The browser gamepad
  19861. */
  19862. constructor(id: string, index: number, browserGamepad: any);
  19863. private _setButtonValue;
  19864. /**
  19865. * Updates the generic gamepad
  19866. */
  19867. update(): void;
  19868. /**
  19869. * Disposes the generic gamepad
  19870. */
  19871. dispose(): void;
  19872. }
  19873. }
  19874. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19875. import { Observable } from "babylonjs/Misc/observable";
  19876. import { Nullable } from "babylonjs/types";
  19877. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19878. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19879. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19880. import { Ray } from "babylonjs/Culling/ray";
  19881. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19882. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19883. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19884. /**
  19885. * Defines the types of pose enabled controllers that are supported
  19886. */
  19887. export enum PoseEnabledControllerType {
  19888. /**
  19889. * HTC Vive
  19890. */
  19891. VIVE = 0,
  19892. /**
  19893. * Oculus Rift
  19894. */
  19895. OCULUS = 1,
  19896. /**
  19897. * Windows mixed reality
  19898. */
  19899. WINDOWS = 2,
  19900. /**
  19901. * Samsung gear VR
  19902. */
  19903. GEAR_VR = 3,
  19904. /**
  19905. * Google Daydream
  19906. */
  19907. DAYDREAM = 4,
  19908. /**
  19909. * Generic
  19910. */
  19911. GENERIC = 5
  19912. }
  19913. /**
  19914. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19915. */
  19916. export interface MutableGamepadButton {
  19917. /**
  19918. * Value of the button/trigger
  19919. */
  19920. value: number;
  19921. /**
  19922. * If the button/trigger is currently touched
  19923. */
  19924. touched: boolean;
  19925. /**
  19926. * If the button/trigger is currently pressed
  19927. */
  19928. pressed: boolean;
  19929. }
  19930. /**
  19931. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19932. * @hidden
  19933. */
  19934. export interface ExtendedGamepadButton extends GamepadButton {
  19935. /**
  19936. * If the button/trigger is currently pressed
  19937. */
  19938. readonly pressed: boolean;
  19939. /**
  19940. * If the button/trigger is currently touched
  19941. */
  19942. readonly touched: boolean;
  19943. /**
  19944. * Value of the button/trigger
  19945. */
  19946. readonly value: number;
  19947. }
  19948. /** @hidden */
  19949. export interface _GamePadFactory {
  19950. /**
  19951. * Returns whether or not the current gamepad can be created for this type of controller.
  19952. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19953. * @returns true if it can be created, otherwise false
  19954. */
  19955. canCreate(gamepadInfo: any): boolean;
  19956. /**
  19957. * Creates a new instance of the Gamepad.
  19958. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19959. * @returns the new gamepad instance
  19960. */
  19961. create(gamepadInfo: any): Gamepad;
  19962. }
  19963. /**
  19964. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19965. */
  19966. export class PoseEnabledControllerHelper {
  19967. /** @hidden */
  19968. static _ControllerFactories: _GamePadFactory[];
  19969. /** @hidden */
  19970. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19971. /**
  19972. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19973. * @param vrGamepad the gamepad to initialized
  19974. * @returns a vr controller of the type the gamepad identified as
  19975. */
  19976. static InitiateController(vrGamepad: any): Gamepad;
  19977. }
  19978. /**
  19979. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19980. */
  19981. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19982. /**
  19983. * If the controller is used in a webXR session
  19984. */
  19985. isXR: boolean;
  19986. private _deviceRoomPosition;
  19987. private _deviceRoomRotationQuaternion;
  19988. /**
  19989. * The device position in babylon space
  19990. */
  19991. devicePosition: Vector3;
  19992. /**
  19993. * The device rotation in babylon space
  19994. */
  19995. deviceRotationQuaternion: Quaternion;
  19996. /**
  19997. * The scale factor of the device in babylon space
  19998. */
  19999. deviceScaleFactor: number;
  20000. /**
  20001. * (Likely devicePosition should be used instead) The device position in its room space
  20002. */
  20003. position: Vector3;
  20004. /**
  20005. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20006. */
  20007. rotationQuaternion: Quaternion;
  20008. /**
  20009. * The type of controller (Eg. Windows mixed reality)
  20010. */
  20011. controllerType: PoseEnabledControllerType;
  20012. protected _calculatedPosition: Vector3;
  20013. private _calculatedRotation;
  20014. /**
  20015. * The raw pose from the device
  20016. */
  20017. rawPose: DevicePose;
  20018. private _trackPosition;
  20019. private _maxRotationDistFromHeadset;
  20020. private _draggedRoomRotation;
  20021. /**
  20022. * @hidden
  20023. */
  20024. _disableTrackPosition(fixedPosition: Vector3): void;
  20025. /**
  20026. * Internal, the mesh attached to the controller
  20027. * @hidden
  20028. */
  20029. _mesh: Nullable<AbstractMesh>;
  20030. private _poseControlledCamera;
  20031. private _leftHandSystemQuaternion;
  20032. /**
  20033. * Internal, matrix used to convert room space to babylon space
  20034. * @hidden
  20035. */
  20036. _deviceToWorld: Matrix;
  20037. /**
  20038. * Node to be used when casting a ray from the controller
  20039. * @hidden
  20040. */
  20041. _pointingPoseNode: Nullable<TransformNode>;
  20042. /**
  20043. * Name of the child mesh that can be used to cast a ray from the controller
  20044. */
  20045. static readonly POINTING_POSE: string;
  20046. /**
  20047. * Creates a new PoseEnabledController from a gamepad
  20048. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20049. */
  20050. constructor(browserGamepad: any);
  20051. private _workingMatrix;
  20052. /**
  20053. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20054. */
  20055. update(): void;
  20056. /**
  20057. * Updates only the pose device and mesh without doing any button event checking
  20058. */
  20059. protected _updatePoseAndMesh(): void;
  20060. /**
  20061. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20062. * @param poseData raw pose fromthe device
  20063. */
  20064. updateFromDevice(poseData: DevicePose): void;
  20065. /**
  20066. * @hidden
  20067. */
  20068. _meshAttachedObservable: Observable<AbstractMesh>;
  20069. /**
  20070. * Attaches a mesh to the controller
  20071. * @param mesh the mesh to be attached
  20072. */
  20073. attachToMesh(mesh: AbstractMesh): void;
  20074. /**
  20075. * Attaches the controllers mesh to a camera
  20076. * @param camera the camera the mesh should be attached to
  20077. */
  20078. attachToPoseControlledCamera(camera: TargetCamera): void;
  20079. /**
  20080. * Disposes of the controller
  20081. */
  20082. dispose(): void;
  20083. /**
  20084. * The mesh that is attached to the controller
  20085. */
  20086. get mesh(): Nullable<AbstractMesh>;
  20087. /**
  20088. * Gets the ray of the controller in the direction the controller is pointing
  20089. * @param length the length the resulting ray should be
  20090. * @returns a ray in the direction the controller is pointing
  20091. */
  20092. getForwardRay(length?: number): Ray;
  20093. }
  20094. }
  20095. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20096. import { Observable } from "babylonjs/Misc/observable";
  20097. import { Scene } from "babylonjs/scene";
  20098. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20099. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20100. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20101. import { Nullable } from "babylonjs/types";
  20102. /**
  20103. * Defines the WebVRController object that represents controllers tracked in 3D space
  20104. */
  20105. export abstract class WebVRController extends PoseEnabledController {
  20106. /**
  20107. * Internal, the default controller model for the controller
  20108. */
  20109. protected _defaultModel: Nullable<AbstractMesh>;
  20110. /**
  20111. * Fired when the trigger state has changed
  20112. */
  20113. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20114. /**
  20115. * Fired when the main button state has changed
  20116. */
  20117. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20118. /**
  20119. * Fired when the secondary button state has changed
  20120. */
  20121. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20122. /**
  20123. * Fired when the pad state has changed
  20124. */
  20125. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20126. /**
  20127. * Fired when controllers stick values have changed
  20128. */
  20129. onPadValuesChangedObservable: Observable<StickValues>;
  20130. /**
  20131. * Array of button availible on the controller
  20132. */
  20133. protected _buttons: Array<MutableGamepadButton>;
  20134. private _onButtonStateChange;
  20135. /**
  20136. * Fired when a controller button's state has changed
  20137. * @param callback the callback containing the button that was modified
  20138. */
  20139. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20140. /**
  20141. * X and Y axis corresponding to the controllers joystick
  20142. */
  20143. pad: StickValues;
  20144. /**
  20145. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20146. */
  20147. hand: string;
  20148. /**
  20149. * The default controller model for the controller
  20150. */
  20151. get defaultModel(): Nullable<AbstractMesh>;
  20152. /**
  20153. * Creates a new WebVRController from a gamepad
  20154. * @param vrGamepad the gamepad that the WebVRController should be created from
  20155. */
  20156. constructor(vrGamepad: any);
  20157. /**
  20158. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20159. */
  20160. update(): void;
  20161. /**
  20162. * Function to be called when a button is modified
  20163. */
  20164. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20165. /**
  20166. * Loads a mesh and attaches it to the controller
  20167. * @param scene the scene the mesh should be added to
  20168. * @param meshLoaded callback for when the mesh has been loaded
  20169. */
  20170. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20171. private _setButtonValue;
  20172. private _changes;
  20173. private _checkChanges;
  20174. /**
  20175. * Disposes of th webVRCOntroller
  20176. */
  20177. dispose(): void;
  20178. }
  20179. }
  20180. declare module "babylonjs/Lights/hemisphericLight" {
  20181. import { Nullable } from "babylonjs/types";
  20182. import { Scene } from "babylonjs/scene";
  20183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20184. import { Color3 } from "babylonjs/Maths/math.color";
  20185. import { Effect } from "babylonjs/Materials/effect";
  20186. import { Light } from "babylonjs/Lights/light";
  20187. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20188. /**
  20189. * The HemisphericLight simulates the ambient environment light,
  20190. * so the passed direction is the light reflection direction, not the incoming direction.
  20191. */
  20192. export class HemisphericLight extends Light {
  20193. /**
  20194. * The groundColor is the light in the opposite direction to the one specified during creation.
  20195. * You can think of the diffuse and specular light as coming from the centre of the object in the given direction and the groundColor light in the opposite direction.
  20196. */
  20197. groundColor: Color3;
  20198. /**
  20199. * The light reflection direction, not the incoming direction.
  20200. */
  20201. direction: Vector3;
  20202. /**
  20203. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20204. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20205. * The HemisphericLight can't cast shadows.
  20206. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20207. * @param name The friendly name of the light
  20208. * @param direction The direction of the light reflection
  20209. * @param scene The scene the light belongs to
  20210. */
  20211. constructor(name: string, direction: Vector3, scene: Scene);
  20212. protected _buildUniformLayout(): void;
  20213. /**
  20214. * Returns the string "HemisphericLight".
  20215. * @return The class name
  20216. */
  20217. getClassName(): string;
  20218. /**
  20219. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20220. * Returns the updated direction.
  20221. * @param target The target the direction should point to
  20222. * @return The computed direction
  20223. */
  20224. setDirectionToTarget(target: Vector3): Vector3;
  20225. /**
  20226. * Returns the shadow generator associated to the light.
  20227. * @returns Always null for hemispheric lights because it does not support shadows.
  20228. */
  20229. getShadowGenerator(): Nullable<IShadowGenerator>;
  20230. /**
  20231. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20232. * @param effect The effect to update
  20233. * @param lightIndex The index of the light in the effect to update
  20234. * @returns The hemispheric light
  20235. */
  20236. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20237. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20238. /**
  20239. * Computes the world matrix of the node
  20240. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20241. * @param useWasUpdatedFlag defines a reserved property
  20242. * @returns the world matrix
  20243. */
  20244. computeWorldMatrix(): Matrix;
  20245. /**
  20246. * Returns the integer 3.
  20247. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20248. */
  20249. getTypeID(): number;
  20250. /**
  20251. * Prepares the list of defines specific to the light type.
  20252. * @param defines the list of defines
  20253. * @param lightIndex defines the index of the light for the effect
  20254. */
  20255. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20256. }
  20257. }
  20258. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20259. /** @hidden */
  20260. export var vrMultiviewToSingleviewPixelShader: {
  20261. name: string;
  20262. shader: string;
  20263. };
  20264. }
  20265. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20266. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20267. import { Scene } from "babylonjs/scene";
  20268. /**
  20269. * Renders to multiple views with a single draw call
  20270. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20271. */
  20272. export class MultiviewRenderTarget extends RenderTargetTexture {
  20273. /**
  20274. * Creates a multiview render target
  20275. * @param scene scene used with the render target
  20276. * @param size the size of the render target (used for each view)
  20277. */
  20278. constructor(scene: Scene, size?: number | {
  20279. width: number;
  20280. height: number;
  20281. } | {
  20282. ratio: number;
  20283. });
  20284. /**
  20285. * @hidden
  20286. * @param faceIndex the face index, if its a cube texture
  20287. */
  20288. _bindFrameBuffer(faceIndex?: number): void;
  20289. /**
  20290. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20291. * @returns the view count
  20292. */
  20293. getViewCount(): number;
  20294. }
  20295. }
  20296. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20297. import { Camera } from "babylonjs/Cameras/camera";
  20298. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20299. import { Nullable } from "babylonjs/types";
  20300. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20301. import { Matrix } from "babylonjs/Maths/math.vector";
  20302. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20303. module "babylonjs/Engines/engine" {
  20304. interface Engine {
  20305. /**
  20306. * Creates a new multiview render target
  20307. * @param width defines the width of the texture
  20308. * @param height defines the height of the texture
  20309. * @returns the created multiview texture
  20310. */
  20311. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20312. /**
  20313. * Binds a multiview framebuffer to be drawn to
  20314. * @param multiviewTexture texture to bind
  20315. */
  20316. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20317. }
  20318. }
  20319. module "babylonjs/Cameras/camera" {
  20320. interface Camera {
  20321. /**
  20322. * @hidden
  20323. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20324. */
  20325. _useMultiviewToSingleView: boolean;
  20326. /**
  20327. * @hidden
  20328. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20329. */
  20330. _multiviewTexture: Nullable<RenderTargetTexture>;
  20331. /**
  20332. * @hidden
  20333. * ensures the multiview texture of the camera exists and has the specified width/height
  20334. * @param width height to set on the multiview texture
  20335. * @param height width to set on the multiview texture
  20336. */
  20337. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20338. }
  20339. }
  20340. module "babylonjs/scene" {
  20341. interface Scene {
  20342. /** @hidden */
  20343. _transformMatrixR: Matrix;
  20344. /** @hidden */
  20345. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20346. /** @hidden */
  20347. _createMultiviewUbo(): void;
  20348. /** @hidden */
  20349. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20350. /** @hidden */
  20351. _renderMultiviewToSingleView(camera: Camera): void;
  20352. }
  20353. }
  20354. }
  20355. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20356. import { Camera } from "babylonjs/Cameras/camera";
  20357. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20358. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20359. import "babylonjs/Engines/Extensions/engine.multiview";
  20360. /**
  20361. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20362. * This will not be used for webXR as it supports displaying texture arrays directly
  20363. */
  20364. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20365. /**
  20366. * Gets a string identifying the name of the class
  20367. * @returns "VRMultiviewToSingleviewPostProcess" string
  20368. */
  20369. getClassName(): string;
  20370. /**
  20371. * Initializes a VRMultiviewToSingleview
  20372. * @param name name of the post process
  20373. * @param camera camera to be applied to
  20374. * @param scaleFactor scaling factor to the size of the output texture
  20375. */
  20376. constructor(name: string, camera: Camera, scaleFactor: number);
  20377. }
  20378. }
  20379. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20380. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20381. import { Nullable } from "babylonjs/types";
  20382. import { Size } from "babylonjs/Maths/math.size";
  20383. import { Observable } from "babylonjs/Misc/observable";
  20384. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20385. /**
  20386. * Interface used to define additional presentation attributes
  20387. */
  20388. export interface IVRPresentationAttributes {
  20389. /**
  20390. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20391. */
  20392. highRefreshRate: boolean;
  20393. /**
  20394. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20395. */
  20396. foveationLevel: number;
  20397. }
  20398. module "babylonjs/Engines/engine" {
  20399. interface Engine {
  20400. /** @hidden */
  20401. _vrDisplay: any;
  20402. /** @hidden */
  20403. _vrSupported: boolean;
  20404. /** @hidden */
  20405. _oldSize: Size;
  20406. /** @hidden */
  20407. _oldHardwareScaleFactor: number;
  20408. /** @hidden */
  20409. _vrExclusivePointerMode: boolean;
  20410. /** @hidden */
  20411. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20412. /** @hidden */
  20413. _onVRDisplayPointerRestricted: () => void;
  20414. /** @hidden */
  20415. _onVRDisplayPointerUnrestricted: () => void;
  20416. /** @hidden */
  20417. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20418. /** @hidden */
  20419. _onVrDisplayDisconnect: Nullable<() => void>;
  20420. /** @hidden */
  20421. _onVrDisplayPresentChange: Nullable<() => void>;
  20422. /**
  20423. * Observable signaled when VR display mode changes
  20424. */
  20425. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20426. /**
  20427. * Observable signaled when VR request present is complete
  20428. */
  20429. onVRRequestPresentComplete: Observable<boolean>;
  20430. /**
  20431. * Observable signaled when VR request present starts
  20432. */
  20433. onVRRequestPresentStart: Observable<Engine>;
  20434. /**
  20435. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20436. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20437. */
  20438. isInVRExclusivePointerMode: boolean;
  20439. /**
  20440. * Gets a boolean indicating if a webVR device was detected
  20441. * @returns true if a webVR device was detected
  20442. */
  20443. isVRDevicePresent(): boolean;
  20444. /**
  20445. * Gets the current webVR device
  20446. * @returns the current webVR device (or null)
  20447. */
  20448. getVRDevice(): any;
  20449. /**
  20450. * Initializes a webVR display and starts listening to display change events
  20451. * The onVRDisplayChangedObservable will be notified upon these changes
  20452. * @returns A promise containing a VRDisplay and if vr is supported
  20453. */
  20454. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20455. /** @hidden */
  20456. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20457. /**
  20458. * Gets or sets the presentation attributes used to configure VR rendering
  20459. */
  20460. vrPresentationAttributes?: IVRPresentationAttributes;
  20461. /**
  20462. * Call this function to switch to webVR mode
  20463. * Will do nothing if webVR is not supported or if there is no webVR device
  20464. * @param options the webvr options provided to the camera. mainly used for multiview
  20465. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20466. */
  20467. enableVR(options: WebVROptions): void;
  20468. /** @hidden */
  20469. _onVRFullScreenTriggered(): void;
  20470. }
  20471. }
  20472. }
  20473. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20474. import { Nullable } from "babylonjs/types";
  20475. import { Observable } from "babylonjs/Misc/observable";
  20476. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20477. import { Scene } from "babylonjs/scene";
  20478. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20479. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20480. import { Node } from "babylonjs/node";
  20481. import { Ray } from "babylonjs/Culling/ray";
  20482. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20483. import "babylonjs/Engines/Extensions/engine.webVR";
  20484. /**
  20485. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20486. * IMPORTANT!! The data is right-hand data.
  20487. * @export
  20488. * @interface DevicePose
  20489. */
  20490. export interface DevicePose {
  20491. /**
  20492. * The position of the device, values in array are [x,y,z].
  20493. */
  20494. readonly position: Nullable<Float32Array>;
  20495. /**
  20496. * The linearVelocity of the device, values in array are [x,y,z].
  20497. */
  20498. readonly linearVelocity: Nullable<Float32Array>;
  20499. /**
  20500. * The linearAcceleration of the device, values in array are [x,y,z].
  20501. */
  20502. readonly linearAcceleration: Nullable<Float32Array>;
  20503. /**
  20504. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20505. */
  20506. readonly orientation: Nullable<Float32Array>;
  20507. /**
  20508. * The angularVelocity of the device, values in array are [x,y,z].
  20509. */
  20510. readonly angularVelocity: Nullable<Float32Array>;
  20511. /**
  20512. * The angularAcceleration of the device, values in array are [x,y,z].
  20513. */
  20514. readonly angularAcceleration: Nullable<Float32Array>;
  20515. }
  20516. /**
  20517. * Interface representing a pose controlled object in Babylon.
  20518. * A pose controlled object has both regular pose values as well as pose values
  20519. * from an external device such as a VR head mounted display
  20520. */
  20521. export interface PoseControlled {
  20522. /**
  20523. * The position of the object in babylon space.
  20524. */
  20525. position: Vector3;
  20526. /**
  20527. * The rotation quaternion of the object in babylon space.
  20528. */
  20529. rotationQuaternion: Quaternion;
  20530. /**
  20531. * The position of the device in babylon space.
  20532. */
  20533. devicePosition?: Vector3;
  20534. /**
  20535. * The rotation quaternion of the device in babylon space.
  20536. */
  20537. deviceRotationQuaternion: Quaternion;
  20538. /**
  20539. * The raw pose coming from the device.
  20540. */
  20541. rawPose: Nullable<DevicePose>;
  20542. /**
  20543. * The scale of the device to be used when translating from device space to babylon space.
  20544. */
  20545. deviceScaleFactor: number;
  20546. /**
  20547. * Updates the poseControlled values based on the input device pose.
  20548. * @param poseData the pose data to update the object with
  20549. */
  20550. updateFromDevice(poseData: DevicePose): void;
  20551. }
  20552. /**
  20553. * Set of options to customize the webVRCamera
  20554. */
  20555. export interface WebVROptions {
  20556. /**
  20557. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20558. */
  20559. trackPosition?: boolean;
  20560. /**
  20561. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20562. */
  20563. positionScale?: number;
  20564. /**
  20565. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20566. */
  20567. displayName?: string;
  20568. /**
  20569. * Should the native controller meshes be initialized. (default: true)
  20570. */
  20571. controllerMeshes?: boolean;
  20572. /**
  20573. * Creating a default HemiLight only on controllers. (default: true)
  20574. */
  20575. defaultLightingOnControllers?: boolean;
  20576. /**
  20577. * If you don't want to use the default VR button of the helper. (default: false)
  20578. */
  20579. useCustomVRButton?: boolean;
  20580. /**
  20581. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20582. */
  20583. customVRButton?: HTMLButtonElement;
  20584. /**
  20585. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20586. */
  20587. rayLength?: number;
  20588. /**
  20589. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20590. */
  20591. defaultHeight?: number;
  20592. /**
  20593. * If multiview should be used if availible (default: false)
  20594. */
  20595. useMultiview?: boolean;
  20596. }
  20597. /**
  20598. * This represents a WebVR camera.
  20599. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20600. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20601. */
  20602. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20603. private webVROptions;
  20604. /**
  20605. * @hidden
  20606. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20607. */
  20608. _vrDevice: any;
  20609. /**
  20610. * The rawPose of the vrDevice.
  20611. */
  20612. rawPose: Nullable<DevicePose>;
  20613. private _onVREnabled;
  20614. private _specsVersion;
  20615. private _attached;
  20616. private _frameData;
  20617. protected _descendants: Array<Node>;
  20618. private _deviceRoomPosition;
  20619. /** @hidden */
  20620. _deviceRoomRotationQuaternion: Quaternion;
  20621. private _standingMatrix;
  20622. /**
  20623. * Represents device position in babylon space.
  20624. */
  20625. devicePosition: Vector3;
  20626. /**
  20627. * Represents device rotation in babylon space.
  20628. */
  20629. deviceRotationQuaternion: Quaternion;
  20630. /**
  20631. * The scale of the device to be used when translating from device space to babylon space.
  20632. */
  20633. deviceScaleFactor: number;
  20634. private _deviceToWorld;
  20635. private _worldToDevice;
  20636. /**
  20637. * References to the webVR controllers for the vrDevice.
  20638. */
  20639. controllers: Array<WebVRController>;
  20640. /**
  20641. * Emits an event when a controller is attached.
  20642. */
  20643. onControllersAttachedObservable: Observable<WebVRController[]>;
  20644. /**
  20645. * Emits an event when a controller's mesh has been loaded;
  20646. */
  20647. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20648. /**
  20649. * Emits an event when the HMD's pose has been updated.
  20650. */
  20651. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20652. private _poseSet;
  20653. /**
  20654. * If the rig cameras be used as parent instead of this camera.
  20655. */
  20656. rigParenting: boolean;
  20657. private _lightOnControllers;
  20658. private _defaultHeight?;
  20659. /**
  20660. * Instantiates a WebVRFreeCamera.
  20661. * @param name The name of the WebVRFreeCamera
  20662. * @param position The starting anchor position for the camera
  20663. * @param scene The scene the camera belongs to
  20664. * @param webVROptions a set of customizable options for the webVRCamera
  20665. */
  20666. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20667. /**
  20668. * Gets the device distance from the ground in meters.
  20669. * @returns the distance in meters from the vrDevice to ground in device space. If standing matrix is not supported for the vrDevice 0 is returned.
  20670. */
  20671. deviceDistanceToRoomGround(): number;
  20672. /**
  20673. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20674. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20675. */
  20676. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20677. /**
  20678. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20679. * @returns A promise with a boolean set to if the standing matrix is supported.
  20680. */
  20681. useStandingMatrixAsync(): Promise<boolean>;
  20682. /**
  20683. * Disposes the camera
  20684. */
  20685. dispose(): void;
  20686. /**
  20687. * Gets a vrController by name.
  20688. * @param name The name of the controller to retreive
  20689. * @returns the controller matching the name specified or null if not found
  20690. */
  20691. getControllerByName(name: string): Nullable<WebVRController>;
  20692. private _leftController;
  20693. /**
  20694. * The controller corresponding to the users left hand.
  20695. */
  20696. get leftController(): Nullable<WebVRController>;
  20697. private _rightController;
  20698. /**
  20699. * The controller corresponding to the users right hand.
  20700. */
  20701. get rightController(): Nullable<WebVRController>;
  20702. /**
  20703. * Casts a ray forward from the vrCamera's gaze.
  20704. * @param length Length of the ray (default: 100)
  20705. * @returns the ray corresponding to the gaze
  20706. */
  20707. getForwardRay(length?: number): Ray;
  20708. /**
  20709. * @hidden
  20710. * Updates the camera based on device's frame data
  20711. */
  20712. _checkInputs(): void;
  20713. /**
  20714. * Updates the poseControlled values based on the input device pose.
  20715. * @param poseData Pose coming from the device
  20716. */
  20717. updateFromDevice(poseData: DevicePose): void;
  20718. private _htmlElementAttached;
  20719. private _detachIfAttached;
  20720. /**
  20721. * WebVR's attach control will start broadcasting frames to the device.
  20722. * Note that in certain browsers (chrome for example) this function must be called
  20723. * within a user-interaction callback. Example:
  20724. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20725. *
  20726. * @param element html element to attach the vrDevice to
  20727. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20728. */
  20729. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20730. /**
  20731. * Detaches the camera from the html element and disables VR
  20732. *
  20733. * @param element html element to detach from
  20734. */
  20735. detachControl(element: HTMLElement): void;
  20736. /**
  20737. * @returns the name of this class
  20738. */
  20739. getClassName(): string;
  20740. /**
  20741. * Calls resetPose on the vrDisplay
  20742. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20743. */
  20744. resetToCurrentRotation(): void;
  20745. /**
  20746. * @hidden
  20747. * Updates the rig cameras (left and right eye)
  20748. */
  20749. _updateRigCameras(): void;
  20750. private _workingVector;
  20751. private _oneVector;
  20752. private _workingMatrix;
  20753. private updateCacheCalled;
  20754. private _correctPositionIfNotTrackPosition;
  20755. /**
  20756. * @hidden
  20757. * Updates the cached values of the camera
  20758. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20759. */
  20760. _updateCache(ignoreParentClass?: boolean): void;
  20761. /**
  20762. * @hidden
  20763. * Get current device position in babylon world
  20764. */
  20765. _computeDevicePosition(): void;
  20766. /**
  20767. * Updates the current device position and rotation in the babylon world
  20768. */
  20769. update(): void;
  20770. /**
  20771. * @hidden
  20772. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20773. * @returns an identity matrix
  20774. */
  20775. _getViewMatrix(): Matrix;
  20776. private _tmpMatrix;
  20777. /**
  20778. * This function is called by the two RIG cameras.
  20779. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20780. * @hidden
  20781. */
  20782. _getWebVRViewMatrix(): Matrix;
  20783. /** @hidden */
  20784. _getWebVRProjectionMatrix(): Matrix;
  20785. private _onGamepadConnectedObserver;
  20786. private _onGamepadDisconnectedObserver;
  20787. private _updateCacheWhenTrackingDisabledObserver;
  20788. /**
  20789. * Initializes the controllers and their meshes
  20790. */
  20791. initControllers(): void;
  20792. }
  20793. }
  20794. declare module "babylonjs/Materials/materialHelper" {
  20795. import { Nullable } from "babylonjs/types";
  20796. import { Scene } from "babylonjs/scene";
  20797. import { Engine } from "babylonjs/Engines/engine";
  20798. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20799. import { Light } from "babylonjs/Lights/light";
  20800. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20801. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20802. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20803. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20804. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20805. /**
  20806. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20807. *
  20808. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20809. *
  20810. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20811. */
  20812. export class MaterialHelper {
  20813. /**
  20814. * Bind the current view position to an effect.
  20815. * @param effect The effect to be bound
  20816. * @param scene The scene the eyes position is used from
  20817. * @param variableName name of the shader variable that will hold the eye position
  20818. */
  20819. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20820. /**
  20821. * Helps preparing the defines values about the UVs in used in the effect.
  20822. * UVs are shared as much as we can accross channels in the shaders.
  20823. * @param texture The texture we are preparing the UVs for
  20824. * @param defines The defines to update
  20825. * @param key The channel key "diffuse", "specular"... used in the shader
  20826. */
  20827. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20828. /**
  20829. * Binds a texture matrix value to its corrsponding uniform
  20830. * @param texture The texture to bind the matrix for
  20831. * @param uniformBuffer The uniform buffer receivin the data
  20832. * @param key The channel key "diffuse", "specular"... used in the shader
  20833. */
  20834. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20835. /**
  20836. * Gets the current status of the fog (should it be enabled?)
  20837. * @param mesh defines the mesh to evaluate for fog support
  20838. * @param scene defines the hosting scene
  20839. * @returns true if fog must be enabled
  20840. */
  20841. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20842. /**
  20843. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20844. * @param mesh defines the current mesh
  20845. * @param scene defines the current scene
  20846. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20847. * @param pointsCloud defines if point cloud rendering has to be turned on
  20848. * @param fogEnabled defines if fog has to be turned on
  20849. * @param alphaTest defines if alpha testing has to be turned on
  20850. * @param defines defines the current list of defines
  20851. */
  20852. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20853. /**
  20854. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20855. * @param scene defines the current scene
  20856. * @param engine defines the current engine
  20857. * @param defines specifies the list of active defines
  20858. * @param useInstances defines if instances have to be turned on
  20859. * @param useClipPlane defines if clip plane have to be turned on
  20860. * @param useInstances defines if instances have to be turned on
  20861. * @param useThinInstances defines if thin instances have to be turned on
  20862. */
  20863. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20864. /**
  20865. * Prepares the defines for bones
  20866. * @param mesh The mesh containing the geometry data we will draw
  20867. * @param defines The defines to update
  20868. */
  20869. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20870. /**
  20871. * Prepares the defines for morph targets
  20872. * @param mesh The mesh containing the geometry data we will draw
  20873. * @param defines The defines to update
  20874. */
  20875. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20876. /**
  20877. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20878. * @param mesh The mesh containing the geometry data we will draw
  20879. * @param defines The defines to update
  20880. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20881. * @param useBones Precise whether bones should be used or not (override mesh info)
  20882. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20883. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20884. * @returns false if defines are considered not dirty and have not been checked
  20885. */
  20886. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20887. /**
  20888. * Prepares the defines related to multiview
  20889. * @param scene The scene we are intending to draw
  20890. * @param defines The defines to update
  20891. */
  20892. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20893. /**
  20894. * Prepares the defines related to the prepass
  20895. * @param scene The scene we are intending to draw
  20896. * @param defines The defines to update
  20897. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20898. */
  20899. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20900. /**
  20901. * Prepares the defines related to the light information passed in parameter
  20902. * @param scene The scene we are intending to draw
  20903. * @param mesh The mesh the effect is compiling for
  20904. * @param light The light the effect is compiling for
  20905. * @param lightIndex The index of the light
  20906. * @param defines The defines to update
  20907. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20908. * @param state Defines the current state regarding what is needed (normals, etc...)
  20909. */
  20910. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20911. needNormals: boolean;
  20912. needRebuild: boolean;
  20913. shadowEnabled: boolean;
  20914. specularEnabled: boolean;
  20915. lightmapMode: boolean;
  20916. }): void;
  20917. /**
  20918. * Prepares the defines related to the light information passed in parameter
  20919. * @param scene The scene we are intending to draw
  20920. * @param mesh The mesh the effect is compiling for
  20921. * @param defines The defines to update
  20922. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20923. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20924. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20925. * @returns true if normals will be required for the rest of the effect
  20926. */
  20927. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20928. /**
  20929. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20930. * @param lightIndex defines the light index
  20931. * @param uniformsList The uniform list
  20932. * @param samplersList The sampler list
  20933. * @param projectedLightTexture defines if projected texture must be used
  20934. * @param uniformBuffersList defines an optional list of uniform buffers
  20935. */
  20936. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20937. /**
  20938. * Prepares the uniforms and samplers list to be used in the effect
  20939. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20940. * @param samplersList The sampler list
  20941. * @param defines The defines helping in the list generation
  20942. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20943. */
  20944. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20945. /**
  20946. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20947. * @param defines The defines to update while falling back
  20948. * @param fallbacks The authorized effect fallbacks
  20949. * @param maxSimultaneousLights The maximum number of lights allowed
  20950. * @param rank the current rank of the Effect
  20951. * @returns The newly affected rank
  20952. */
  20953. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20954. private static _TmpMorphInfluencers;
  20955. /**
  20956. * Prepares the list of attributes required for morph targets according to the effect defines.
  20957. * @param attribs The current list of supported attribs
  20958. * @param mesh The mesh to prepare the morph targets attributes for
  20959. * @param influencers The number of influencers
  20960. */
  20961. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20962. /**
  20963. * Prepares the list of attributes required for morph targets according to the effect defines.
  20964. * @param attribs The current list of supported attribs
  20965. * @param mesh The mesh to prepare the morph targets attributes for
  20966. * @param defines The current Defines of the effect
  20967. */
  20968. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20969. /**
  20970. * Prepares the list of attributes required for bones according to the effect defines.
  20971. * @param attribs The current list of supported attribs
  20972. * @param mesh The mesh to prepare the bones attributes for
  20973. * @param defines The current Defines of the effect
  20974. * @param fallbacks The current efffect fallback strategy
  20975. */
  20976. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20977. /**
  20978. * Check and prepare the list of attributes required for instances according to the effect defines.
  20979. * @param attribs The current list of supported attribs
  20980. * @param defines The current MaterialDefines of the effect
  20981. */
  20982. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20983. /**
  20984. * Add the list of attributes required for instances to the attribs array.
  20985. * @param attribs The current list of supported attribs
  20986. */
  20987. static PushAttributesForInstances(attribs: string[]): void;
  20988. /**
  20989. * Binds the light information to the effect.
  20990. * @param light The light containing the generator
  20991. * @param effect The effect we are binding the data to
  20992. * @param lightIndex The light index in the effect used to render
  20993. */
  20994. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20995. /**
  20996. * Binds the lights information from the scene to the effect for the given mesh.
  20997. * @param light Light to bind
  20998. * @param lightIndex Light index
  20999. * @param scene The scene where the light belongs to
  21000. * @param effect The effect we are binding the data to
  21001. * @param useSpecular Defines if specular is supported
  21002. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21003. */
  21004. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21005. /**
  21006. * Binds the lights information from the scene to the effect for the given mesh.
  21007. * @param scene The scene the lights belongs to
  21008. * @param mesh The mesh we are binding the information to render
  21009. * @param effect The effect we are binding the data to
  21010. * @param defines The generated defines for the effect
  21011. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21012. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21013. */
  21014. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21015. private static _tempFogColor;
  21016. /**
  21017. * Binds the fog information from the scene to the effect for the given mesh.
  21018. * @param scene The scene the lights belongs to
  21019. * @param mesh The mesh we are binding the information to render
  21020. * @param effect The effect we are binding the data to
  21021. * @param linearSpace Defines if the fog effect is applied in linear space
  21022. */
  21023. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21024. /**
  21025. * Binds the bones information from the mesh to the effect.
  21026. * @param mesh The mesh we are binding the information to render
  21027. * @param effect The effect we are binding the data to
  21028. */
  21029. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21030. /**
  21031. * Binds the morph targets information from the mesh to the effect.
  21032. * @param abstractMesh The mesh we are binding the information to render
  21033. * @param effect The effect we are binding the data to
  21034. */
  21035. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21036. /**
  21037. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21038. * @param defines The generated defines used in the effect
  21039. * @param effect The effect we are binding the data to
  21040. * @param scene The scene we are willing to render with logarithmic scale for
  21041. */
  21042. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21043. /**
  21044. * Binds the clip plane information from the scene to the effect.
  21045. * @param scene The scene the clip plane information are extracted from
  21046. * @param effect The effect we are binding the data to
  21047. */
  21048. static BindClipPlane(effect: Effect, scene: Scene): void;
  21049. }
  21050. }
  21051. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21052. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21053. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21054. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21055. import { Nullable } from "babylonjs/types";
  21056. import { Effect } from "babylonjs/Materials/effect";
  21057. import { Matrix } from "babylonjs/Maths/math.vector";
  21058. import { Scene } from "babylonjs/scene";
  21059. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21060. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21061. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21062. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21063. import { Observable } from "babylonjs/Misc/observable";
  21064. /**
  21065. * Block used to expose an input value
  21066. */
  21067. export class InputBlock extends NodeMaterialBlock {
  21068. private _mode;
  21069. private _associatedVariableName;
  21070. private _storedValue;
  21071. private _valueCallback;
  21072. private _type;
  21073. private _animationType;
  21074. /** Gets or set a value used to limit the range of float values */
  21075. min: number;
  21076. /** Gets or set a value used to limit the range of float values */
  21077. max: number;
  21078. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21079. isBoolean: boolean;
  21080. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21081. matrixMode: number;
  21082. /** @hidden */
  21083. _systemValue: Nullable<NodeMaterialSystemValues>;
  21084. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  21085. visibleInInspector: boolean;
  21086. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21087. isConstant: boolean;
  21088. /** Gets or sets the group to use to display this block in the Inspector */
  21089. groupInInspector: string;
  21090. /** Gets an observable raised when the value is changed */
  21091. onValueChangedObservable: Observable<InputBlock>;
  21092. /**
  21093. * Gets or sets the connection point type (default is float)
  21094. */
  21095. get type(): NodeMaterialBlockConnectionPointTypes;
  21096. /**
  21097. * Creates a new InputBlock
  21098. * @param name defines the block name
  21099. * @param target defines the target of that block (Vertex by default)
  21100. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21101. */
  21102. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21103. /**
  21104. * Validates if a name is a reserve word.
  21105. * @param newName the new name to be given to the node.
  21106. * @returns false if the name is a reserve word, else true.
  21107. */
  21108. validateBlockName(newName: string): boolean;
  21109. /**
  21110. * Gets the output component
  21111. */
  21112. get output(): NodeMaterialConnectionPoint;
  21113. /**
  21114. * Set the source of this connection point to a vertex attribute
  21115. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21116. * @returns the current connection point
  21117. */
  21118. setAsAttribute(attributeName?: string): InputBlock;
  21119. /**
  21120. * Set the source of this connection point to a system value
  21121. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21122. * @returns the current connection point
  21123. */
  21124. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21125. /**
  21126. * Gets or sets the value of that point.
  21127. * Please note that this value will be ignored if valueCallback is defined
  21128. */
  21129. get value(): any;
  21130. set value(value: any);
  21131. /**
  21132. * Gets or sets a callback used to get the value of that point.
  21133. * Please note that setting this value will force the connection point to ignore the value property
  21134. */
  21135. get valueCallback(): () => any;
  21136. set valueCallback(value: () => any);
  21137. /**
  21138. * Gets or sets the associated variable name in the shader
  21139. */
  21140. get associatedVariableName(): string;
  21141. set associatedVariableName(value: string);
  21142. /** Gets or sets the type of animation applied to the input */
  21143. get animationType(): AnimatedInputBlockTypes;
  21144. set animationType(value: AnimatedInputBlockTypes);
  21145. /**
  21146. * Gets a boolean indicating that this connection point not defined yet
  21147. */
  21148. get isUndefined(): boolean;
  21149. /**
  21150. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21151. * In this case the connection point name must be the name of the uniform to use.
  21152. * Can only be set on inputs
  21153. */
  21154. get isUniform(): boolean;
  21155. set isUniform(value: boolean);
  21156. /**
  21157. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21158. * In this case the connection point name must be the name of the attribute to use
  21159. * Can only be set on inputs
  21160. */
  21161. get isAttribute(): boolean;
  21162. set isAttribute(value: boolean);
  21163. /**
  21164. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21165. * Can only be set on exit points
  21166. */
  21167. get isVarying(): boolean;
  21168. set isVarying(value: boolean);
  21169. /**
  21170. * Gets a boolean indicating that the current connection point is a system value
  21171. */
  21172. get isSystemValue(): boolean;
  21173. /**
  21174. * Gets or sets the current well known value or null if not defined as a system value
  21175. */
  21176. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21177. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21178. /**
  21179. * Gets the current class name
  21180. * @returns the class name
  21181. */
  21182. getClassName(): string;
  21183. /**
  21184. * Animate the input if animationType !== None
  21185. * @param scene defines the rendering scene
  21186. */
  21187. animate(scene: Scene): void;
  21188. private _emitDefine;
  21189. initialize(state: NodeMaterialBuildState): void;
  21190. /**
  21191. * Set the input block to its default value (based on its type)
  21192. */
  21193. setDefaultValue(): void;
  21194. private _emitConstant;
  21195. /** @hidden */
  21196. get _noContextSwitch(): boolean;
  21197. private _emit;
  21198. /** @hidden */
  21199. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21200. /** @hidden */
  21201. _transmit(effect: Effect, scene: Scene): void;
  21202. protected _buildBlock(state: NodeMaterialBuildState): void;
  21203. protected _dumpPropertiesCode(): string;
  21204. dispose(): void;
  21205. serialize(): any;
  21206. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21207. }
  21208. }
  21209. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21210. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21211. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21212. import { Nullable } from "babylonjs/types";
  21213. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21214. import { Observable } from "babylonjs/Misc/observable";
  21215. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21216. /**
  21217. * Enum used to define the compatibility state between two connection points
  21218. */
  21219. export enum NodeMaterialConnectionPointCompatibilityStates {
  21220. /** Points are compatibles */
  21221. Compatible = 0,
  21222. /** Points are incompatible because of their types */
  21223. TypeIncompatible = 1,
  21224. /** Points are incompatible because of their targets (vertex vs fragment) */
  21225. TargetIncompatible = 2
  21226. }
  21227. /**
  21228. * Defines the direction of a connection point
  21229. */
  21230. export enum NodeMaterialConnectionPointDirection {
  21231. /** Input */
  21232. Input = 0,
  21233. /** Output */
  21234. Output = 1
  21235. }
  21236. /**
  21237. * Defines a connection point for a block
  21238. */
  21239. export class NodeMaterialConnectionPoint {
  21240. /** @hidden */
  21241. _ownerBlock: NodeMaterialBlock;
  21242. /** @hidden */
  21243. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21244. private _endpoints;
  21245. private _associatedVariableName;
  21246. private _direction;
  21247. /** @hidden */
  21248. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21249. /** @hidden */
  21250. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21251. private _type;
  21252. /** @hidden */
  21253. _enforceAssociatedVariableName: boolean;
  21254. /** Gets the direction of the point */
  21255. get direction(): NodeMaterialConnectionPointDirection;
  21256. /** Indicates that this connection point needs dual validation before being connected to another point */
  21257. needDualDirectionValidation: boolean;
  21258. /**
  21259. * Gets or sets the additional types supported by this connection point
  21260. */
  21261. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21262. /**
  21263. * Gets or sets the additional types excluded by this connection point
  21264. */
  21265. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21266. /**
  21267. * Observable triggered when this point is connected
  21268. */
  21269. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21270. /**
  21271. * Gets or sets the associated variable name in the shader
  21272. */
  21273. get associatedVariableName(): string;
  21274. set associatedVariableName(value: string);
  21275. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21276. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21277. /**
  21278. * Gets or sets the connection point type (default is float)
  21279. */
  21280. get type(): NodeMaterialBlockConnectionPointTypes;
  21281. set type(value: NodeMaterialBlockConnectionPointTypes);
  21282. /**
  21283. * Gets or sets the connection point name
  21284. */
  21285. name: string;
  21286. /**
  21287. * Gets or sets the connection point name
  21288. */
  21289. displayName: string;
  21290. /**
  21291. * Gets or sets a boolean indicating that this connection point can be omitted
  21292. */
  21293. isOptional: boolean;
  21294. /**
  21295. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21296. */
  21297. isExposedOnFrame: boolean;
  21298. /**
  21299. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21300. */
  21301. define: string;
  21302. /** @hidden */
  21303. _prioritizeVertex: boolean;
  21304. private _target;
  21305. /** Gets or sets the target of that connection point */
  21306. get target(): NodeMaterialBlockTargets;
  21307. set target(value: NodeMaterialBlockTargets);
  21308. /**
  21309. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21310. */
  21311. get isConnected(): boolean;
  21312. /**
  21313. * Gets a boolean indicating that the current point is connected to an input block
  21314. */
  21315. get isConnectedToInputBlock(): boolean;
  21316. /**
  21317. * Gets a the connected input block (if any)
  21318. */
  21319. get connectInputBlock(): Nullable<InputBlock>;
  21320. /** Get the other side of the connection (if any) */
  21321. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21322. /** Get the block that owns this connection point */
  21323. get ownerBlock(): NodeMaterialBlock;
  21324. /** Get the block connected on the other side of this connection (if any) */
  21325. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21326. /** Get the block connected on the endpoints of this connection (if any) */
  21327. get connectedBlocks(): Array<NodeMaterialBlock>;
  21328. /** Gets the list of connected endpoints */
  21329. get endpoints(): NodeMaterialConnectionPoint[];
  21330. /** Gets a boolean indicating if that output point is connected to at least one input */
  21331. get hasEndpoints(): boolean;
  21332. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21333. get isConnectedInVertexShader(): boolean;
  21334. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21335. get isConnectedInFragmentShader(): boolean;
  21336. /**
  21337. * Creates a block suitable to be used as an input for this input point.
  21338. * If null is returned, a block based on the point type will be created.
  21339. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21340. */
  21341. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21342. /**
  21343. * Creates a new connection point
  21344. * @param name defines the connection point name
  21345. * @param ownerBlock defines the block hosting this connection point
  21346. * @param direction defines the direction of the connection point
  21347. */
  21348. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21349. /**
  21350. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21351. * @returns the class name
  21352. */
  21353. getClassName(): string;
  21354. /**
  21355. * Gets a boolean indicating if the current point can be connected to another point
  21356. * @param connectionPoint defines the other connection point
  21357. * @returns a boolean
  21358. */
  21359. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21360. /**
  21361. * Gets a number indicating if the current point can be connected to another point
  21362. * @param connectionPoint defines the other connection point
  21363. * @returns a number defining the compatibility state
  21364. */
  21365. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21366. /**
  21367. * Connect this point to another connection point
  21368. * @param connectionPoint defines the other connection point
  21369. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21370. * @returns the current connection point
  21371. */
  21372. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21373. /**
  21374. * Disconnect this point from one of his endpoint
  21375. * @param endpoint defines the other connection point
  21376. * @returns the current connection point
  21377. */
  21378. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21379. /**
  21380. * Serializes this point in a JSON representation
  21381. * @param isInput defines if the connection point is an input (default is true)
  21382. * @returns the serialized point object
  21383. */
  21384. serialize(isInput?: boolean): any;
  21385. /**
  21386. * Release resources
  21387. */
  21388. dispose(): void;
  21389. }
  21390. }
  21391. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21392. /**
  21393. * Enum used to define the material modes
  21394. */
  21395. export enum NodeMaterialModes {
  21396. /** Regular material */
  21397. Material = 0,
  21398. /** For post process */
  21399. PostProcess = 1,
  21400. /** For particle system */
  21401. Particle = 2
  21402. }
  21403. }
  21404. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21405. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21406. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21407. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21408. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21409. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21410. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21411. import { Effect } from "babylonjs/Materials/effect";
  21412. import { Mesh } from "babylonjs/Meshes/mesh";
  21413. import { Nullable } from "babylonjs/types";
  21414. import { Texture } from "babylonjs/Materials/Textures/texture";
  21415. import { Scene } from "babylonjs/scene";
  21416. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21417. /**
  21418. * Block used to read a texture from a sampler
  21419. */
  21420. export class TextureBlock extends NodeMaterialBlock {
  21421. private _defineName;
  21422. private _linearDefineName;
  21423. private _gammaDefineName;
  21424. private _tempTextureRead;
  21425. private _samplerName;
  21426. private _transformedUVName;
  21427. private _textureTransformName;
  21428. private _textureInfoName;
  21429. private _mainUVName;
  21430. private _mainUVDefineName;
  21431. private _fragmentOnly;
  21432. /**
  21433. * Gets or sets the texture associated with the node
  21434. */
  21435. texture: Nullable<Texture>;
  21436. /**
  21437. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21438. */
  21439. convertToGammaSpace: boolean;
  21440. /**
  21441. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21442. */
  21443. convertToLinearSpace: boolean;
  21444. /**
  21445. * Create a new TextureBlock
  21446. * @param name defines the block name
  21447. */
  21448. constructor(name: string, fragmentOnly?: boolean);
  21449. /**
  21450. * Gets the current class name
  21451. * @returns the class name
  21452. */
  21453. getClassName(): string;
  21454. /**
  21455. * Gets the uv input component
  21456. */
  21457. get uv(): NodeMaterialConnectionPoint;
  21458. /**
  21459. * Gets the rgba output component
  21460. */
  21461. get rgba(): NodeMaterialConnectionPoint;
  21462. /**
  21463. * Gets the rgb output component
  21464. */
  21465. get rgb(): NodeMaterialConnectionPoint;
  21466. /**
  21467. * Gets the r output component
  21468. */
  21469. get r(): NodeMaterialConnectionPoint;
  21470. /**
  21471. * Gets the g output component
  21472. */
  21473. get g(): NodeMaterialConnectionPoint;
  21474. /**
  21475. * Gets the b output component
  21476. */
  21477. get b(): NodeMaterialConnectionPoint;
  21478. /**
  21479. * Gets the a output component
  21480. */
  21481. get a(): NodeMaterialConnectionPoint;
  21482. get target(): NodeMaterialBlockTargets;
  21483. autoConfigure(material: NodeMaterial): void;
  21484. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21485. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21486. isReady(): boolean;
  21487. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21488. private get _isMixed();
  21489. private _injectVertexCode;
  21490. private _writeTextureRead;
  21491. private _writeOutput;
  21492. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21493. protected _dumpPropertiesCode(): string;
  21494. serialize(): any;
  21495. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21496. }
  21497. }
  21498. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21499. /** @hidden */
  21500. export var reflectionFunction: {
  21501. name: string;
  21502. shader: string;
  21503. };
  21504. }
  21505. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21506. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21507. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21508. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21509. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21510. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21511. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21512. import { Effect } from "babylonjs/Materials/effect";
  21513. import { Mesh } from "babylonjs/Meshes/mesh";
  21514. import { Nullable } from "babylonjs/types";
  21515. import { Scene } from "babylonjs/scene";
  21516. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21517. /**
  21518. * Base block used to read a reflection texture from a sampler
  21519. */
  21520. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21521. /** @hidden */
  21522. _define3DName: string;
  21523. /** @hidden */
  21524. _defineCubicName: string;
  21525. /** @hidden */
  21526. _defineExplicitName: string;
  21527. /** @hidden */
  21528. _defineProjectionName: string;
  21529. /** @hidden */
  21530. _defineLocalCubicName: string;
  21531. /** @hidden */
  21532. _defineSphericalName: string;
  21533. /** @hidden */
  21534. _definePlanarName: string;
  21535. /** @hidden */
  21536. _defineEquirectangularName: string;
  21537. /** @hidden */
  21538. _defineMirroredEquirectangularFixedName: string;
  21539. /** @hidden */
  21540. _defineEquirectangularFixedName: string;
  21541. /** @hidden */
  21542. _defineSkyboxName: string;
  21543. /** @hidden */
  21544. _defineOppositeZ: string;
  21545. /** @hidden */
  21546. _cubeSamplerName: string;
  21547. /** @hidden */
  21548. _2DSamplerName: string;
  21549. protected _positionUVWName: string;
  21550. protected _directionWName: string;
  21551. protected _reflectionVectorName: string;
  21552. /** @hidden */
  21553. _reflectionCoordsName: string;
  21554. /** @hidden */
  21555. _reflectionMatrixName: string;
  21556. protected _reflectionColorName: string;
  21557. /**
  21558. * Gets or sets the texture associated with the node
  21559. */
  21560. texture: Nullable<BaseTexture>;
  21561. /**
  21562. * Create a new ReflectionTextureBaseBlock
  21563. * @param name defines the block name
  21564. */
  21565. constructor(name: string);
  21566. /**
  21567. * Gets the current class name
  21568. * @returns the class name
  21569. */
  21570. getClassName(): string;
  21571. /**
  21572. * Gets the world position input component
  21573. */
  21574. abstract get position(): NodeMaterialConnectionPoint;
  21575. /**
  21576. * Gets the world position input component
  21577. */
  21578. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21579. /**
  21580. * Gets the world normal input component
  21581. */
  21582. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21583. /**
  21584. * Gets the world input component
  21585. */
  21586. abstract get world(): NodeMaterialConnectionPoint;
  21587. /**
  21588. * Gets the camera (or eye) position component
  21589. */
  21590. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21591. /**
  21592. * Gets the view input component
  21593. */
  21594. abstract get view(): NodeMaterialConnectionPoint;
  21595. protected _getTexture(): Nullable<BaseTexture>;
  21596. autoConfigure(material: NodeMaterial): void;
  21597. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21598. isReady(): boolean;
  21599. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21600. /**
  21601. * Gets the code to inject in the vertex shader
  21602. * @param state current state of the node material building
  21603. * @returns the shader code
  21604. */
  21605. handleVertexSide(state: NodeMaterialBuildState): string;
  21606. /**
  21607. * Handles the inits for the fragment code path
  21608. * @param state node material build state
  21609. */
  21610. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21611. /**
  21612. * Generates the reflection coords code for the fragment code path
  21613. * @param worldNormalVarName name of the world normal variable
  21614. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21615. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21616. * @returns the shader code
  21617. */
  21618. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21619. /**
  21620. * Generates the reflection color code for the fragment code path
  21621. * @param lodVarName name of the lod variable
  21622. * @param swizzleLookupTexture swizzle to use for the final color variable
  21623. * @returns the shader code
  21624. */
  21625. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21626. /**
  21627. * Generates the code corresponding to the connected output points
  21628. * @param state node material build state
  21629. * @param varName name of the variable to output
  21630. * @returns the shader code
  21631. */
  21632. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21633. protected _buildBlock(state: NodeMaterialBuildState): this;
  21634. protected _dumpPropertiesCode(): string;
  21635. serialize(): any;
  21636. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21637. }
  21638. }
  21639. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21640. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21641. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21642. import { Nullable } from "babylonjs/types";
  21643. /**
  21644. * Defines a connection point to be used for points with a custom object type
  21645. */
  21646. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21647. private _blockType;
  21648. private _blockName;
  21649. private _nameForCheking?;
  21650. /**
  21651. * Creates a new connection point
  21652. * @param name defines the connection point name
  21653. * @param ownerBlock defines the block hosting this connection point
  21654. * @param direction defines the direction of the connection point
  21655. */
  21656. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21657. /**
  21658. * Gets a number indicating if the current point can be connected to another point
  21659. * @param connectionPoint defines the other connection point
  21660. * @returns a number defining the compatibility state
  21661. */
  21662. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21663. /**
  21664. * Creates a block suitable to be used as an input for this input point.
  21665. * If null is returned, a block based on the point type will be created.
  21666. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21667. */
  21668. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21669. }
  21670. }
  21671. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21672. /**
  21673. * Enum defining the type of properties that can be edited in the property pages in the NME
  21674. */
  21675. export enum PropertyTypeForEdition {
  21676. /** property is a boolean */
  21677. Boolean = 0,
  21678. /** property is a float */
  21679. Float = 1,
  21680. /** property is a Vector2 */
  21681. Vector2 = 2,
  21682. /** property is a list of values */
  21683. List = 3
  21684. }
  21685. /**
  21686. * Interface that defines an option in a variable of type list
  21687. */
  21688. export interface IEditablePropertyListOption {
  21689. /** label of the option */
  21690. "label": string;
  21691. /** value of the option */
  21692. "value": number;
  21693. }
  21694. /**
  21695. * Interface that defines the options available for an editable property
  21696. */
  21697. export interface IEditablePropertyOption {
  21698. /** min value */
  21699. "min"?: number;
  21700. /** max value */
  21701. "max"?: number;
  21702. /** notifiers: indicates which actions to take when the property is changed */
  21703. "notifiers"?: {
  21704. /** the material should be rebuilt */
  21705. "rebuild"?: boolean;
  21706. /** the preview should be updated */
  21707. "update"?: boolean;
  21708. };
  21709. /** list of the options for a variable of type list */
  21710. "options"?: IEditablePropertyListOption[];
  21711. }
  21712. /**
  21713. * Interface that describes an editable property
  21714. */
  21715. export interface IPropertyDescriptionForEdition {
  21716. /** name of the property */
  21717. "propertyName": string;
  21718. /** display name of the property */
  21719. "displayName": string;
  21720. /** type of the property */
  21721. "type": PropertyTypeForEdition;
  21722. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21723. "groupName": string;
  21724. /** options for the property */
  21725. "options": IEditablePropertyOption;
  21726. }
  21727. /**
  21728. * Decorator that flags a property in a node material block as being editable
  21729. */
  21730. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21731. }
  21732. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21733. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21734. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21735. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21736. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21737. import { Nullable } from "babylonjs/types";
  21738. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21739. import { Mesh } from "babylonjs/Meshes/mesh";
  21740. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21741. import { Effect } from "babylonjs/Materials/effect";
  21742. import { Scene } from "babylonjs/scene";
  21743. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21744. /**
  21745. * Block used to implement the refraction part of the sub surface module of the PBR material
  21746. */
  21747. export class RefractionBlock extends NodeMaterialBlock {
  21748. /** @hidden */
  21749. _define3DName: string;
  21750. /** @hidden */
  21751. _refractionMatrixName: string;
  21752. /** @hidden */
  21753. _defineLODRefractionAlpha: string;
  21754. /** @hidden */
  21755. _defineLinearSpecularRefraction: string;
  21756. /** @hidden */
  21757. _defineOppositeZ: string;
  21758. /** @hidden */
  21759. _cubeSamplerName: string;
  21760. /** @hidden */
  21761. _2DSamplerName: string;
  21762. /** @hidden */
  21763. _vRefractionMicrosurfaceInfosName: string;
  21764. /** @hidden */
  21765. _vRefractionInfosName: string;
  21766. private _scene;
  21767. /**
  21768. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21769. * Materials half opaque for instance using refraction could benefit from this control.
  21770. */
  21771. linkRefractionWithTransparency: boolean;
  21772. /**
  21773. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21774. */
  21775. invertRefractionY: boolean;
  21776. /**
  21777. * Gets or sets the texture associated with the node
  21778. */
  21779. texture: Nullable<BaseTexture>;
  21780. /**
  21781. * Create a new RefractionBlock
  21782. * @param name defines the block name
  21783. */
  21784. constructor(name: string);
  21785. /**
  21786. * Gets the current class name
  21787. * @returns the class name
  21788. */
  21789. getClassName(): string;
  21790. /**
  21791. * Gets the intensity input component
  21792. */
  21793. get intensity(): NodeMaterialConnectionPoint;
  21794. /**
  21795. * Gets the index of refraction input component
  21796. */
  21797. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21798. /**
  21799. * Gets the tint at distance input component
  21800. */
  21801. get tintAtDistance(): NodeMaterialConnectionPoint;
  21802. /**
  21803. * Gets the view input component
  21804. */
  21805. get view(): NodeMaterialConnectionPoint;
  21806. /**
  21807. * Gets the refraction object output component
  21808. */
  21809. get refraction(): NodeMaterialConnectionPoint;
  21810. /**
  21811. * Returns true if the block has a texture
  21812. */
  21813. get hasTexture(): boolean;
  21814. protected _getTexture(): Nullable<BaseTexture>;
  21815. autoConfigure(material: NodeMaterial): void;
  21816. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21817. isReady(): boolean;
  21818. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21819. /**
  21820. * Gets the main code of the block (fragment side)
  21821. * @param state current state of the node material building
  21822. * @returns the shader code
  21823. */
  21824. getCode(state: NodeMaterialBuildState): string;
  21825. protected _buildBlock(state: NodeMaterialBuildState): this;
  21826. protected _dumpPropertiesCode(): string;
  21827. serialize(): any;
  21828. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21829. }
  21830. }
  21831. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21832. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21833. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21834. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21835. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21836. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21837. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21838. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21839. import { Nullable } from "babylonjs/types";
  21840. import { Scene } from "babylonjs/scene";
  21841. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21842. /**
  21843. * Base block used as input for post process
  21844. */
  21845. export class CurrentScreenBlock extends NodeMaterialBlock {
  21846. private _samplerName;
  21847. private _linearDefineName;
  21848. private _gammaDefineName;
  21849. private _mainUVName;
  21850. private _tempTextureRead;
  21851. /**
  21852. * Gets or sets the texture associated with the node
  21853. */
  21854. texture: Nullable<BaseTexture>;
  21855. /**
  21856. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21857. */
  21858. convertToGammaSpace: boolean;
  21859. /**
  21860. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21861. */
  21862. convertToLinearSpace: boolean;
  21863. /**
  21864. * Create a new CurrentScreenBlock
  21865. * @param name defines the block name
  21866. */
  21867. constructor(name: string);
  21868. /**
  21869. * Gets the current class name
  21870. * @returns the class name
  21871. */
  21872. getClassName(): string;
  21873. /**
  21874. * Gets the uv input component
  21875. */
  21876. get uv(): NodeMaterialConnectionPoint;
  21877. /**
  21878. * Gets the rgba output component
  21879. */
  21880. get rgba(): NodeMaterialConnectionPoint;
  21881. /**
  21882. * Gets the rgb output component
  21883. */
  21884. get rgb(): NodeMaterialConnectionPoint;
  21885. /**
  21886. * Gets the r output component
  21887. */
  21888. get r(): NodeMaterialConnectionPoint;
  21889. /**
  21890. * Gets the g output component
  21891. */
  21892. get g(): NodeMaterialConnectionPoint;
  21893. /**
  21894. * Gets the b output component
  21895. */
  21896. get b(): NodeMaterialConnectionPoint;
  21897. /**
  21898. * Gets the a output component
  21899. */
  21900. get a(): NodeMaterialConnectionPoint;
  21901. /**
  21902. * Initialize the block and prepare the context for build
  21903. * @param state defines the state that will be used for the build
  21904. */
  21905. initialize(state: NodeMaterialBuildState): void;
  21906. get target(): NodeMaterialBlockTargets;
  21907. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21908. isReady(): boolean;
  21909. private _injectVertexCode;
  21910. private _writeTextureRead;
  21911. private _writeOutput;
  21912. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21913. serialize(): any;
  21914. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21915. }
  21916. }
  21917. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21918. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21919. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21920. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21921. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21922. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21923. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21924. import { Nullable } from "babylonjs/types";
  21925. import { Scene } from "babylonjs/scene";
  21926. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21927. /**
  21928. * Base block used for the particle texture
  21929. */
  21930. export class ParticleTextureBlock extends NodeMaterialBlock {
  21931. private _samplerName;
  21932. private _linearDefineName;
  21933. private _gammaDefineName;
  21934. private _tempTextureRead;
  21935. /**
  21936. * Gets or sets the texture associated with the node
  21937. */
  21938. texture: Nullable<BaseTexture>;
  21939. /**
  21940. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21941. */
  21942. convertToGammaSpace: boolean;
  21943. /**
  21944. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21945. */
  21946. convertToLinearSpace: boolean;
  21947. /**
  21948. * Create a new ParticleTextureBlock
  21949. * @param name defines the block name
  21950. */
  21951. constructor(name: string);
  21952. /**
  21953. * Gets the current class name
  21954. * @returns the class name
  21955. */
  21956. getClassName(): string;
  21957. /**
  21958. * Gets the uv input component
  21959. */
  21960. get uv(): NodeMaterialConnectionPoint;
  21961. /**
  21962. * Gets the rgba output component
  21963. */
  21964. get rgba(): NodeMaterialConnectionPoint;
  21965. /**
  21966. * Gets the rgb output component
  21967. */
  21968. get rgb(): NodeMaterialConnectionPoint;
  21969. /**
  21970. * Gets the r output component
  21971. */
  21972. get r(): NodeMaterialConnectionPoint;
  21973. /**
  21974. * Gets the g output component
  21975. */
  21976. get g(): NodeMaterialConnectionPoint;
  21977. /**
  21978. * Gets the b output component
  21979. */
  21980. get b(): NodeMaterialConnectionPoint;
  21981. /**
  21982. * Gets the a output component
  21983. */
  21984. get a(): NodeMaterialConnectionPoint;
  21985. /**
  21986. * Initialize the block and prepare the context for build
  21987. * @param state defines the state that will be used for the build
  21988. */
  21989. initialize(state: NodeMaterialBuildState): void;
  21990. autoConfigure(material: NodeMaterial): void;
  21991. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21992. isReady(): boolean;
  21993. private _writeOutput;
  21994. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21995. serialize(): any;
  21996. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21997. }
  21998. }
  21999. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  22000. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22001. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22002. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22003. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22004. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22005. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22006. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22007. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22008. import { Scene } from "babylonjs/scene";
  22009. /**
  22010. * Class used to store shared data between 2 NodeMaterialBuildState
  22011. */
  22012. export class NodeMaterialBuildStateSharedData {
  22013. /**
  22014. * Gets the list of emitted varyings
  22015. */
  22016. temps: string[];
  22017. /**
  22018. * Gets the list of emitted varyings
  22019. */
  22020. varyings: string[];
  22021. /**
  22022. * Gets the varying declaration string
  22023. */
  22024. varyingDeclaration: string;
  22025. /**
  22026. * Input blocks
  22027. */
  22028. inputBlocks: InputBlock[];
  22029. /**
  22030. * Input blocks
  22031. */
  22032. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22033. /**
  22034. * Bindable blocks (Blocks that need to set data to the effect)
  22035. */
  22036. bindableBlocks: NodeMaterialBlock[];
  22037. /**
  22038. * List of blocks that can provide a compilation fallback
  22039. */
  22040. blocksWithFallbacks: NodeMaterialBlock[];
  22041. /**
  22042. * List of blocks that can provide a define update
  22043. */
  22044. blocksWithDefines: NodeMaterialBlock[];
  22045. /**
  22046. * List of blocks that can provide a repeatable content
  22047. */
  22048. repeatableContentBlocks: NodeMaterialBlock[];
  22049. /**
  22050. * List of blocks that can provide a dynamic list of uniforms
  22051. */
  22052. dynamicUniformBlocks: NodeMaterialBlock[];
  22053. /**
  22054. * List of blocks that can block the isReady function for the material
  22055. */
  22056. blockingBlocks: NodeMaterialBlock[];
  22057. /**
  22058. * Gets the list of animated inputs
  22059. */
  22060. animatedInputs: InputBlock[];
  22061. /**
  22062. * Build Id used to avoid multiple recompilations
  22063. */
  22064. buildId: number;
  22065. /** List of emitted variables */
  22066. variableNames: {
  22067. [key: string]: number;
  22068. };
  22069. /** List of emitted defines */
  22070. defineNames: {
  22071. [key: string]: number;
  22072. };
  22073. /** Should emit comments? */
  22074. emitComments: boolean;
  22075. /** Emit build activity */
  22076. verbose: boolean;
  22077. /** Gets or sets the hosting scene */
  22078. scene: Scene;
  22079. /**
  22080. * Gets the compilation hints emitted at compilation time
  22081. */
  22082. hints: {
  22083. needWorldViewMatrix: boolean;
  22084. needWorldViewProjectionMatrix: boolean;
  22085. needAlphaBlending: boolean;
  22086. needAlphaTesting: boolean;
  22087. };
  22088. /**
  22089. * List of compilation checks
  22090. */
  22091. checks: {
  22092. emitVertex: boolean;
  22093. emitFragment: boolean;
  22094. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22095. };
  22096. /**
  22097. * Is vertex program allowed to be empty?
  22098. */
  22099. allowEmptyVertexProgram: boolean;
  22100. /** Creates a new shared data */
  22101. constructor();
  22102. /**
  22103. * Emits console errors and exceptions if there is a failing check
  22104. */
  22105. emitErrors(): void;
  22106. }
  22107. }
  22108. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22109. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22110. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22111. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22112. /**
  22113. * Class used to store node based material build state
  22114. */
  22115. export class NodeMaterialBuildState {
  22116. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22117. supportUniformBuffers: boolean;
  22118. /**
  22119. * Gets the list of emitted attributes
  22120. */
  22121. attributes: string[];
  22122. /**
  22123. * Gets the list of emitted uniforms
  22124. */
  22125. uniforms: string[];
  22126. /**
  22127. * Gets the list of emitted constants
  22128. */
  22129. constants: string[];
  22130. /**
  22131. * Gets the list of emitted samplers
  22132. */
  22133. samplers: string[];
  22134. /**
  22135. * Gets the list of emitted functions
  22136. */
  22137. functions: {
  22138. [key: string]: string;
  22139. };
  22140. /**
  22141. * Gets the list of emitted extensions
  22142. */
  22143. extensions: {
  22144. [key: string]: string;
  22145. };
  22146. /**
  22147. * Gets the target of the compilation state
  22148. */
  22149. target: NodeMaterialBlockTargets;
  22150. /**
  22151. * Gets the list of emitted counters
  22152. */
  22153. counters: {
  22154. [key: string]: number;
  22155. };
  22156. /**
  22157. * Shared data between multiple NodeMaterialBuildState instances
  22158. */
  22159. sharedData: NodeMaterialBuildStateSharedData;
  22160. /** @hidden */
  22161. _vertexState: NodeMaterialBuildState;
  22162. /** @hidden */
  22163. _attributeDeclaration: string;
  22164. /** @hidden */
  22165. _uniformDeclaration: string;
  22166. /** @hidden */
  22167. _constantDeclaration: string;
  22168. /** @hidden */
  22169. _samplerDeclaration: string;
  22170. /** @hidden */
  22171. _varyingTransfer: string;
  22172. /** @hidden */
  22173. _injectAtEnd: string;
  22174. private _repeatableContentAnchorIndex;
  22175. /** @hidden */
  22176. _builtCompilationString: string;
  22177. /**
  22178. * Gets the emitted compilation strings
  22179. */
  22180. compilationString: string;
  22181. /**
  22182. * Finalize the compilation strings
  22183. * @param state defines the current compilation state
  22184. */
  22185. finalize(state: NodeMaterialBuildState): void;
  22186. /** @hidden */
  22187. get _repeatableContentAnchor(): string;
  22188. /** @hidden */
  22189. _getFreeVariableName(prefix: string): string;
  22190. /** @hidden */
  22191. _getFreeDefineName(prefix: string): string;
  22192. /** @hidden */
  22193. _excludeVariableName(name: string): void;
  22194. /** @hidden */
  22195. _emit2DSampler(name: string): void;
  22196. /** @hidden */
  22197. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22198. /** @hidden */
  22199. _emitExtension(name: string, extension: string, define?: string): void;
  22200. /** @hidden */
  22201. _emitFunction(name: string, code: string, comments: string): void;
  22202. /** @hidden */
  22203. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22204. replaceStrings?: {
  22205. search: RegExp;
  22206. replace: string;
  22207. }[];
  22208. repeatKey?: string;
  22209. }): string;
  22210. /** @hidden */
  22211. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22212. repeatKey?: string;
  22213. removeAttributes?: boolean;
  22214. removeUniforms?: boolean;
  22215. removeVaryings?: boolean;
  22216. removeIfDef?: boolean;
  22217. replaceStrings?: {
  22218. search: RegExp;
  22219. replace: string;
  22220. }[];
  22221. }, storeKey?: string): void;
  22222. /** @hidden */
  22223. _registerTempVariable(name: string): boolean;
  22224. /** @hidden */
  22225. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22226. /** @hidden */
  22227. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22228. /** @hidden */
  22229. _emitFloat(value: number): string;
  22230. }
  22231. }
  22232. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22233. /**
  22234. * Helper class used to generate session unique ID
  22235. */
  22236. export class UniqueIdGenerator {
  22237. private static _UniqueIdCounter;
  22238. /**
  22239. * Gets an unique (relatively to the current scene) Id
  22240. */
  22241. static get UniqueId(): number;
  22242. }
  22243. }
  22244. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22245. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22246. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22247. import { Nullable } from "babylonjs/types";
  22248. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22249. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22250. import { Effect } from "babylonjs/Materials/effect";
  22251. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22252. import { Mesh } from "babylonjs/Meshes/mesh";
  22253. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22254. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22255. import { Scene } from "babylonjs/scene";
  22256. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22257. /**
  22258. * Defines a block that can be used inside a node based material
  22259. */
  22260. export class NodeMaterialBlock {
  22261. private _buildId;
  22262. private _buildTarget;
  22263. private _target;
  22264. private _isFinalMerger;
  22265. private _isInput;
  22266. private _name;
  22267. protected _isUnique: boolean;
  22268. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22269. inputsAreExclusive: boolean;
  22270. /** @hidden */
  22271. _codeVariableName: string;
  22272. /** @hidden */
  22273. _inputs: NodeMaterialConnectionPoint[];
  22274. /** @hidden */
  22275. _outputs: NodeMaterialConnectionPoint[];
  22276. /** @hidden */
  22277. _preparationId: number;
  22278. /**
  22279. * Gets the name of the block
  22280. */
  22281. get name(): string;
  22282. /**
  22283. * Sets the name of the block. Will check if the name is valid.
  22284. */
  22285. set name(newName: string);
  22286. /**
  22287. * Gets or sets the unique id of the node
  22288. */
  22289. uniqueId: number;
  22290. /**
  22291. * Gets or sets the comments associated with this block
  22292. */
  22293. comments: string;
  22294. /**
  22295. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22296. */
  22297. get isUnique(): boolean;
  22298. /**
  22299. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22300. */
  22301. get isFinalMerger(): boolean;
  22302. /**
  22303. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22304. */
  22305. get isInput(): boolean;
  22306. /**
  22307. * Gets or sets the build Id
  22308. */
  22309. get buildId(): number;
  22310. set buildId(value: number);
  22311. /**
  22312. * Gets or sets the target of the block
  22313. */
  22314. get target(): NodeMaterialBlockTargets;
  22315. set target(value: NodeMaterialBlockTargets);
  22316. /**
  22317. * Gets the list of input points
  22318. */
  22319. get inputs(): NodeMaterialConnectionPoint[];
  22320. /** Gets the list of output points */
  22321. get outputs(): NodeMaterialConnectionPoint[];
  22322. /**
  22323. * Find an input by its name
  22324. * @param name defines the name of the input to look for
  22325. * @returns the input or null if not found
  22326. */
  22327. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22328. /**
  22329. * Find an output by its name
  22330. * @param name defines the name of the outputto look for
  22331. * @returns the output or null if not found
  22332. */
  22333. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22334. /**
  22335. * Creates a new NodeMaterialBlock
  22336. * @param name defines the block name
  22337. * @param target defines the target of that block (Vertex by default)
  22338. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22339. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22340. */
  22341. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22342. /**
  22343. * Initialize the block and prepare the context for build
  22344. * @param state defines the state that will be used for the build
  22345. */
  22346. initialize(state: NodeMaterialBuildState): void;
  22347. /**
  22348. * Bind data to effect. Will only be called for blocks with isBindable === true
  22349. * @param effect defines the effect to bind data to
  22350. * @param nodeMaterial defines the hosting NodeMaterial
  22351. * @param mesh defines the mesh that will be rendered
  22352. * @param subMesh defines the submesh that will be rendered
  22353. */
  22354. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22355. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22356. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22357. protected _writeFloat(value: number): string;
  22358. /**
  22359. * Gets the current class name e.g. "NodeMaterialBlock"
  22360. * @returns the class name
  22361. */
  22362. getClassName(): string;
  22363. /**
  22364. * Register a new input. Must be called inside a block constructor
  22365. * @param name defines the connection point name
  22366. * @param type defines the connection point type
  22367. * @param isOptional defines a boolean indicating that this input can be omitted
  22368. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22369. * @param point an already created connection point. If not provided, create a new one
  22370. * @returns the current block
  22371. */
  22372. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22373. /**
  22374. * Register a new output. Must be called inside a block constructor
  22375. * @param name defines the connection point name
  22376. * @param type defines the connection point type
  22377. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22378. * @param point an already created connection point. If not provided, create a new one
  22379. * @returns the current block
  22380. */
  22381. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22382. /**
  22383. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22384. * @param forOutput defines an optional connection point to check compatibility with
  22385. * @returns the first available input or null
  22386. */
  22387. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22388. /**
  22389. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22390. * @param forBlock defines an optional block to check compatibility with
  22391. * @returns the first available input or null
  22392. */
  22393. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22394. /**
  22395. * Gets the sibling of the given output
  22396. * @param current defines the current output
  22397. * @returns the next output in the list or null
  22398. */
  22399. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22400. /**
  22401. * Connect current block with another block
  22402. * @param other defines the block to connect with
  22403. * @param options define the various options to help pick the right connections
  22404. * @returns the current block
  22405. */
  22406. connectTo(other: NodeMaterialBlock, options?: {
  22407. input?: string;
  22408. output?: string;
  22409. outputSwizzle?: string;
  22410. }): this | undefined;
  22411. protected _buildBlock(state: NodeMaterialBuildState): void;
  22412. /**
  22413. * Add uniforms, samplers and uniform buffers at compilation time
  22414. * @param state defines the state to update
  22415. * @param nodeMaterial defines the node material requesting the update
  22416. * @param defines defines the material defines to update
  22417. * @param uniformBuffers defines the list of uniform buffer names
  22418. */
  22419. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22420. /**
  22421. * Add potential fallbacks if shader compilation fails
  22422. * @param mesh defines the mesh to be rendered
  22423. * @param fallbacks defines the current prioritized list of fallbacks
  22424. */
  22425. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22426. /**
  22427. * Initialize defines for shader compilation
  22428. * @param mesh defines the mesh to be rendered
  22429. * @param nodeMaterial defines the node material requesting the update
  22430. * @param defines defines the material defines to update
  22431. * @param useInstances specifies that instances should be used
  22432. */
  22433. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22434. /**
  22435. * Update defines for shader compilation
  22436. * @param mesh defines the mesh to be rendered
  22437. * @param nodeMaterial defines the node material requesting the update
  22438. * @param defines defines the material defines to update
  22439. * @param useInstances specifies that instances should be used
  22440. * @param subMesh defines which submesh to render
  22441. */
  22442. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22443. /**
  22444. * Lets the block try to connect some inputs automatically
  22445. * @param material defines the hosting NodeMaterial
  22446. */
  22447. autoConfigure(material: NodeMaterial): void;
  22448. /**
  22449. * Function called when a block is declared as repeatable content generator
  22450. * @param vertexShaderState defines the current compilation state for the vertex shader
  22451. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22452. * @param mesh defines the mesh to be rendered
  22453. * @param defines defines the material defines to update
  22454. */
  22455. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22456. /**
  22457. * Checks if the block is ready
  22458. * @param mesh defines the mesh to be rendered
  22459. * @param nodeMaterial defines the node material requesting the update
  22460. * @param defines defines the material defines to update
  22461. * @param useInstances specifies that instances should be used
  22462. * @returns true if the block is ready
  22463. */
  22464. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22465. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22466. private _processBuild;
  22467. /**
  22468. * Validates the new name for the block node.
  22469. * @param newName the new name to be given to the node.
  22470. * @returns false if the name is a reserve word, else true.
  22471. */
  22472. validateBlockName(newName: string): boolean;
  22473. /**
  22474. * Compile the current node and generate the shader code
  22475. * @param state defines the current compilation state (uniforms, samplers, current string)
  22476. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22477. * @returns true if already built
  22478. */
  22479. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22480. protected _inputRename(name: string): string;
  22481. protected _outputRename(name: string): string;
  22482. protected _dumpPropertiesCode(): string;
  22483. /** @hidden */
  22484. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22485. /** @hidden */
  22486. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22487. /**
  22488. * Clone the current block to a new identical block
  22489. * @param scene defines the hosting scene
  22490. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22491. * @returns a copy of the current block
  22492. */
  22493. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22494. /**
  22495. * Serializes this block in a JSON representation
  22496. * @returns the serialized block object
  22497. */
  22498. serialize(): any;
  22499. /** @hidden */
  22500. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22501. private _deserializePortDisplayNamesAndExposedOnFrame;
  22502. /**
  22503. * Release resources
  22504. */
  22505. dispose(): void;
  22506. }
  22507. }
  22508. declare module "babylonjs/Materials/pushMaterial" {
  22509. import { Nullable } from "babylonjs/types";
  22510. import { Scene } from "babylonjs/scene";
  22511. import { Matrix } from "babylonjs/Maths/math.vector";
  22512. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22513. import { Mesh } from "babylonjs/Meshes/mesh";
  22514. import { Material } from "babylonjs/Materials/material";
  22515. import { Effect } from "babylonjs/Materials/effect";
  22516. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22517. /**
  22518. * Base class of materials working in push mode in babylon JS
  22519. * @hidden
  22520. */
  22521. export class PushMaterial extends Material {
  22522. protected _activeEffect: Effect;
  22523. protected _normalMatrix: Matrix;
  22524. constructor(name: string, scene: Scene);
  22525. getEffect(): Effect;
  22526. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22527. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22528. /**
  22529. * Binds the given world matrix to the active effect
  22530. *
  22531. * @param world the matrix to bind
  22532. */
  22533. bindOnlyWorldMatrix(world: Matrix): void;
  22534. /**
  22535. * Binds the given normal matrix to the active effect
  22536. *
  22537. * @param normalMatrix the matrix to bind
  22538. */
  22539. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22540. bind(world: Matrix, mesh?: Mesh): void;
  22541. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22542. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22543. }
  22544. }
  22545. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22546. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22547. /**
  22548. * Root class for all node material optimizers
  22549. */
  22550. export class NodeMaterialOptimizer {
  22551. /**
  22552. * Function used to optimize a NodeMaterial graph
  22553. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22554. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22555. */
  22556. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22557. }
  22558. }
  22559. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22560. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22561. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22562. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22563. import { Scene } from "babylonjs/scene";
  22564. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22565. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22566. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22567. /**
  22568. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22569. */
  22570. export class TransformBlock extends NodeMaterialBlock {
  22571. /**
  22572. * Defines the value to use to complement W value to transform it to a Vector4
  22573. */
  22574. complementW: number;
  22575. /**
  22576. * Defines the value to use to complement z value to transform it to a Vector4
  22577. */
  22578. complementZ: number;
  22579. /**
  22580. * Creates a new TransformBlock
  22581. * @param name defines the block name
  22582. */
  22583. constructor(name: string);
  22584. /**
  22585. * Gets the current class name
  22586. * @returns the class name
  22587. */
  22588. getClassName(): string;
  22589. /**
  22590. * Gets the vector input
  22591. */
  22592. get vector(): NodeMaterialConnectionPoint;
  22593. /**
  22594. * Gets the output component
  22595. */
  22596. get output(): NodeMaterialConnectionPoint;
  22597. /**
  22598. * Gets the xyz output component
  22599. */
  22600. get xyz(): NodeMaterialConnectionPoint;
  22601. /**
  22602. * Gets the matrix transform input
  22603. */
  22604. get transform(): NodeMaterialConnectionPoint;
  22605. protected _buildBlock(state: NodeMaterialBuildState): this;
  22606. /**
  22607. * Update defines for shader compilation
  22608. * @param mesh defines the mesh to be rendered
  22609. * @param nodeMaterial defines the node material requesting the update
  22610. * @param defines defines the material defines to update
  22611. * @param useInstances specifies that instances should be used
  22612. * @param subMesh defines which submesh to render
  22613. */
  22614. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22615. serialize(): any;
  22616. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22617. protected _dumpPropertiesCode(): string;
  22618. }
  22619. }
  22620. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22621. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22622. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22623. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22624. /**
  22625. * Block used to output the vertex position
  22626. */
  22627. export class VertexOutputBlock extends NodeMaterialBlock {
  22628. /**
  22629. * Creates a new VertexOutputBlock
  22630. * @param name defines the block name
  22631. */
  22632. constructor(name: string);
  22633. /**
  22634. * Gets the current class name
  22635. * @returns the class name
  22636. */
  22637. getClassName(): string;
  22638. /**
  22639. * Gets the vector input component
  22640. */
  22641. get vector(): NodeMaterialConnectionPoint;
  22642. protected _buildBlock(state: NodeMaterialBuildState): this;
  22643. }
  22644. }
  22645. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22646. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22647. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22648. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22649. /**
  22650. * Block used to output the final color
  22651. */
  22652. export class FragmentOutputBlock extends NodeMaterialBlock {
  22653. /**
  22654. * Create a new FragmentOutputBlock
  22655. * @param name defines the block name
  22656. */
  22657. constructor(name: string);
  22658. /**
  22659. * Gets the current class name
  22660. * @returns the class name
  22661. */
  22662. getClassName(): string;
  22663. /**
  22664. * Gets the rgba input component
  22665. */
  22666. get rgba(): NodeMaterialConnectionPoint;
  22667. /**
  22668. * Gets the rgb input component
  22669. */
  22670. get rgb(): NodeMaterialConnectionPoint;
  22671. /**
  22672. * Gets the a input component
  22673. */
  22674. get a(): NodeMaterialConnectionPoint;
  22675. protected _buildBlock(state: NodeMaterialBuildState): this;
  22676. }
  22677. }
  22678. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22679. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22680. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22681. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22682. /**
  22683. * Block used for the particle ramp gradient section
  22684. */
  22685. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22686. /**
  22687. * Create a new ParticleRampGradientBlock
  22688. * @param name defines the block name
  22689. */
  22690. constructor(name: string);
  22691. /**
  22692. * Gets the current class name
  22693. * @returns the class name
  22694. */
  22695. getClassName(): string;
  22696. /**
  22697. * Gets the color input component
  22698. */
  22699. get color(): NodeMaterialConnectionPoint;
  22700. /**
  22701. * Gets the rampColor output component
  22702. */
  22703. get rampColor(): NodeMaterialConnectionPoint;
  22704. /**
  22705. * Initialize the block and prepare the context for build
  22706. * @param state defines the state that will be used for the build
  22707. */
  22708. initialize(state: NodeMaterialBuildState): void;
  22709. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22710. }
  22711. }
  22712. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22713. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22714. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22715. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22716. /**
  22717. * Block used for the particle blend multiply section
  22718. */
  22719. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22720. /**
  22721. * Create a new ParticleBlendMultiplyBlock
  22722. * @param name defines the block name
  22723. */
  22724. constructor(name: string);
  22725. /**
  22726. * Gets the current class name
  22727. * @returns the class name
  22728. */
  22729. getClassName(): string;
  22730. /**
  22731. * Gets the color input component
  22732. */
  22733. get color(): NodeMaterialConnectionPoint;
  22734. /**
  22735. * Gets the alphaTexture input component
  22736. */
  22737. get alphaTexture(): NodeMaterialConnectionPoint;
  22738. /**
  22739. * Gets the alphaColor input component
  22740. */
  22741. get alphaColor(): NodeMaterialConnectionPoint;
  22742. /**
  22743. * Gets the blendColor output component
  22744. */
  22745. get blendColor(): NodeMaterialConnectionPoint;
  22746. /**
  22747. * Initialize the block and prepare the context for build
  22748. * @param state defines the state that will be used for the build
  22749. */
  22750. initialize(state: NodeMaterialBuildState): void;
  22751. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22752. }
  22753. }
  22754. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22755. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22756. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22757. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22758. /**
  22759. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22760. */
  22761. export class VectorMergerBlock extends NodeMaterialBlock {
  22762. /**
  22763. * Create a new VectorMergerBlock
  22764. * @param name defines the block name
  22765. */
  22766. constructor(name: string);
  22767. /**
  22768. * Gets the current class name
  22769. * @returns the class name
  22770. */
  22771. getClassName(): string;
  22772. /**
  22773. * Gets the xyz component (input)
  22774. */
  22775. get xyzIn(): NodeMaterialConnectionPoint;
  22776. /**
  22777. * Gets the xy component (input)
  22778. */
  22779. get xyIn(): NodeMaterialConnectionPoint;
  22780. /**
  22781. * Gets the x component (input)
  22782. */
  22783. get x(): NodeMaterialConnectionPoint;
  22784. /**
  22785. * Gets the y component (input)
  22786. */
  22787. get y(): NodeMaterialConnectionPoint;
  22788. /**
  22789. * Gets the z component (input)
  22790. */
  22791. get z(): NodeMaterialConnectionPoint;
  22792. /**
  22793. * Gets the w component (input)
  22794. */
  22795. get w(): NodeMaterialConnectionPoint;
  22796. /**
  22797. * Gets the xyzw component (output)
  22798. */
  22799. get xyzw(): NodeMaterialConnectionPoint;
  22800. /**
  22801. * Gets the xyz component (output)
  22802. */
  22803. get xyzOut(): NodeMaterialConnectionPoint;
  22804. /**
  22805. * Gets the xy component (output)
  22806. */
  22807. get xyOut(): NodeMaterialConnectionPoint;
  22808. /**
  22809. * Gets the xy component (output)
  22810. * @deprecated Please use xyOut instead.
  22811. */
  22812. get xy(): NodeMaterialConnectionPoint;
  22813. /**
  22814. * Gets the xyz component (output)
  22815. * @deprecated Please use xyzOut instead.
  22816. */
  22817. get xyz(): NodeMaterialConnectionPoint;
  22818. protected _buildBlock(state: NodeMaterialBuildState): this;
  22819. }
  22820. }
  22821. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22822. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22823. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22824. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22825. import { Vector2 } from "babylonjs/Maths/math.vector";
  22826. import { Scene } from "babylonjs/scene";
  22827. /**
  22828. * Block used to remap a float from a range to a new one
  22829. */
  22830. export class RemapBlock extends NodeMaterialBlock {
  22831. /**
  22832. * Gets or sets the source range
  22833. */
  22834. sourceRange: Vector2;
  22835. /**
  22836. * Gets or sets the target range
  22837. */
  22838. targetRange: Vector2;
  22839. /**
  22840. * Creates a new RemapBlock
  22841. * @param name defines the block name
  22842. */
  22843. constructor(name: string);
  22844. /**
  22845. * Gets the current class name
  22846. * @returns the class name
  22847. */
  22848. getClassName(): string;
  22849. /**
  22850. * Gets the input component
  22851. */
  22852. get input(): NodeMaterialConnectionPoint;
  22853. /**
  22854. * Gets the source min input component
  22855. */
  22856. get sourceMin(): NodeMaterialConnectionPoint;
  22857. /**
  22858. * Gets the source max input component
  22859. */
  22860. get sourceMax(): NodeMaterialConnectionPoint;
  22861. /**
  22862. * Gets the target min input component
  22863. */
  22864. get targetMin(): NodeMaterialConnectionPoint;
  22865. /**
  22866. * Gets the target max input component
  22867. */
  22868. get targetMax(): NodeMaterialConnectionPoint;
  22869. /**
  22870. * Gets the output component
  22871. */
  22872. get output(): NodeMaterialConnectionPoint;
  22873. protected _buildBlock(state: NodeMaterialBuildState): this;
  22874. protected _dumpPropertiesCode(): string;
  22875. serialize(): any;
  22876. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22877. }
  22878. }
  22879. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22880. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22881. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22882. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22883. /**
  22884. * Block used to multiply 2 values
  22885. */
  22886. export class MultiplyBlock extends NodeMaterialBlock {
  22887. /**
  22888. * Creates a new MultiplyBlock
  22889. * @param name defines the block name
  22890. */
  22891. constructor(name: string);
  22892. /**
  22893. * Gets the current class name
  22894. * @returns the class name
  22895. */
  22896. getClassName(): string;
  22897. /**
  22898. * Gets the left operand input component
  22899. */
  22900. get left(): NodeMaterialConnectionPoint;
  22901. /**
  22902. * Gets the right operand input component
  22903. */
  22904. get right(): NodeMaterialConnectionPoint;
  22905. /**
  22906. * Gets the output component
  22907. */
  22908. get output(): NodeMaterialConnectionPoint;
  22909. protected _buildBlock(state: NodeMaterialBuildState): this;
  22910. }
  22911. }
  22912. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22913. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22914. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22915. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22916. /**
  22917. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22918. */
  22919. export class ColorSplitterBlock extends NodeMaterialBlock {
  22920. /**
  22921. * Create a new ColorSplitterBlock
  22922. * @param name defines the block name
  22923. */
  22924. constructor(name: string);
  22925. /**
  22926. * Gets the current class name
  22927. * @returns the class name
  22928. */
  22929. getClassName(): string;
  22930. /**
  22931. * Gets the rgba component (input)
  22932. */
  22933. get rgba(): NodeMaterialConnectionPoint;
  22934. /**
  22935. * Gets the rgb component (input)
  22936. */
  22937. get rgbIn(): NodeMaterialConnectionPoint;
  22938. /**
  22939. * Gets the rgb component (output)
  22940. */
  22941. get rgbOut(): NodeMaterialConnectionPoint;
  22942. /**
  22943. * Gets the r component (output)
  22944. */
  22945. get r(): NodeMaterialConnectionPoint;
  22946. /**
  22947. * Gets the g component (output)
  22948. */
  22949. get g(): NodeMaterialConnectionPoint;
  22950. /**
  22951. * Gets the b component (output)
  22952. */
  22953. get b(): NodeMaterialConnectionPoint;
  22954. /**
  22955. * Gets the a component (output)
  22956. */
  22957. get a(): NodeMaterialConnectionPoint;
  22958. protected _inputRename(name: string): string;
  22959. protected _outputRename(name: string): string;
  22960. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22961. }
  22962. }
  22963. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22964. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22965. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22966. import { Scene } from "babylonjs/scene";
  22967. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22968. import { Matrix } from "babylonjs/Maths/math.vector";
  22969. import { Mesh } from "babylonjs/Meshes/mesh";
  22970. import { Engine } from "babylonjs/Engines/engine";
  22971. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22972. import { Observable } from "babylonjs/Misc/observable";
  22973. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22974. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22975. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22976. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22977. import { Nullable } from "babylonjs/types";
  22978. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22979. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22980. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22981. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22982. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22983. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22984. import { Effect } from "babylonjs/Materials/effect";
  22985. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22986. import { Camera } from "babylonjs/Cameras/camera";
  22987. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22988. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22989. /**
  22990. * Interface used to configure the node material editor
  22991. */
  22992. export interface INodeMaterialEditorOptions {
  22993. /** Define the URl to load node editor script */
  22994. editorURL?: string;
  22995. }
  22996. /** @hidden */
  22997. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22998. NORMAL: boolean;
  22999. TANGENT: boolean;
  23000. UV1: boolean;
  23001. /** BONES */
  23002. NUM_BONE_INFLUENCERS: number;
  23003. BonesPerMesh: number;
  23004. BONETEXTURE: boolean;
  23005. /** MORPH TARGETS */
  23006. MORPHTARGETS: boolean;
  23007. MORPHTARGETS_NORMAL: boolean;
  23008. MORPHTARGETS_TANGENT: boolean;
  23009. MORPHTARGETS_UV: boolean;
  23010. NUM_MORPH_INFLUENCERS: number;
  23011. /** IMAGE PROCESSING */
  23012. IMAGEPROCESSING: boolean;
  23013. VIGNETTE: boolean;
  23014. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23015. VIGNETTEBLENDMODEOPAQUE: boolean;
  23016. TONEMAPPING: boolean;
  23017. TONEMAPPING_ACES: boolean;
  23018. CONTRAST: boolean;
  23019. EXPOSURE: boolean;
  23020. COLORCURVES: boolean;
  23021. COLORGRADING: boolean;
  23022. COLORGRADING3D: boolean;
  23023. SAMPLER3DGREENDEPTH: boolean;
  23024. SAMPLER3DBGRMAP: boolean;
  23025. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23026. /** MISC. */
  23027. BUMPDIRECTUV: number;
  23028. constructor();
  23029. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23030. }
  23031. /**
  23032. * Class used to configure NodeMaterial
  23033. */
  23034. export interface INodeMaterialOptions {
  23035. /**
  23036. * Defines if blocks should emit comments
  23037. */
  23038. emitComments: boolean;
  23039. }
  23040. /**
  23041. * Class used to create a node based material built by assembling shader blocks
  23042. */
  23043. export class NodeMaterial extends PushMaterial {
  23044. private static _BuildIdGenerator;
  23045. private _options;
  23046. private _vertexCompilationState;
  23047. private _fragmentCompilationState;
  23048. private _sharedData;
  23049. private _buildId;
  23050. private _buildWasSuccessful;
  23051. private _cachedWorldViewMatrix;
  23052. private _cachedWorldViewProjectionMatrix;
  23053. private _optimizers;
  23054. private _animationFrame;
  23055. /** Define the Url to load node editor script */
  23056. static EditorURL: string;
  23057. /** Define the Url to load snippets */
  23058. static SnippetUrl: string;
  23059. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23060. static IgnoreTexturesAtLoadTime: boolean;
  23061. private BJSNODEMATERIALEDITOR;
  23062. /** Get the inspector from bundle or global */
  23063. private _getGlobalNodeMaterialEditor;
  23064. /**
  23065. * Snippet ID if the material was created from the snippet server
  23066. */
  23067. snippetId: string;
  23068. /**
  23069. * Gets or sets data used by visual editor
  23070. * @see https://nme.babylonjs.com
  23071. */
  23072. editorData: any;
  23073. /**
  23074. * Gets or sets a boolean indicating that alpha value must be ignored (This will turn alpha blending off even if an alpha value is produced by the material)
  23075. */
  23076. ignoreAlpha: boolean;
  23077. /**
  23078. * Defines the maximum number of lights that can be used in the material
  23079. */
  23080. maxSimultaneousLights: number;
  23081. /**
  23082. * Observable raised when the material is built
  23083. */
  23084. onBuildObservable: Observable<NodeMaterial>;
  23085. /**
  23086. * Gets or sets the root nodes of the material vertex shader
  23087. */
  23088. _vertexOutputNodes: NodeMaterialBlock[];
  23089. /**
  23090. * Gets or sets the root nodes of the material fragment (pixel) shader
  23091. */
  23092. _fragmentOutputNodes: NodeMaterialBlock[];
  23093. /** Gets or sets options to control the node material overall behavior */
  23094. get options(): INodeMaterialOptions;
  23095. set options(options: INodeMaterialOptions);
  23096. /**
  23097. * Default configuration related to image processing available in the standard Material.
  23098. */
  23099. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23100. /**
  23101. * Gets the image processing configuration used either in this material.
  23102. */
  23103. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23104. /**
  23105. * Sets the Default image processing configuration used either in the this material.
  23106. *
  23107. * If sets to null, the scene one is in use.
  23108. */
  23109. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23110. /**
  23111. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23112. */
  23113. attachedBlocks: NodeMaterialBlock[];
  23114. /**
  23115. * Specifies the mode of the node material
  23116. * @hidden
  23117. */
  23118. _mode: NodeMaterialModes;
  23119. /**
  23120. * Gets the mode property
  23121. */
  23122. get mode(): NodeMaterialModes;
  23123. /**
  23124. * Create a new node based material
  23125. * @param name defines the material name
  23126. * @param scene defines the hosting scene
  23127. * @param options defines creation option
  23128. */
  23129. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23130. /**
  23131. * Gets the current class name of the material e.g. "NodeMaterial"
  23132. * @returns the class name
  23133. */
  23134. getClassName(): string;
  23135. /**
  23136. * Keep track of the image processing observer to allow dispose and replace.
  23137. */
  23138. private _imageProcessingObserver;
  23139. /**
  23140. * Attaches a new image processing configuration to the Standard Material.
  23141. * @param configuration
  23142. */
  23143. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23144. /**
  23145. * Get a block by its name
  23146. * @param name defines the name of the block to retrieve
  23147. * @returns the required block or null if not found
  23148. */
  23149. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23150. /**
  23151. * Get a block by its name
  23152. * @param predicate defines the predicate used to find the good candidate
  23153. * @returns the required block or null if not found
  23154. */
  23155. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23156. /**
  23157. * Get an input block by its name
  23158. * @param predicate defines the predicate used to find the good candidate
  23159. * @returns the required input block or null if not found
  23160. */
  23161. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23162. /**
  23163. * Gets the list of input blocks attached to this material
  23164. * @returns an array of InputBlocks
  23165. */
  23166. getInputBlocks(): InputBlock[];
  23167. /**
  23168. * Adds a new optimizer to the list of optimizers
  23169. * @param optimizer defines the optimizers to add
  23170. * @returns the current material
  23171. */
  23172. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23173. /**
  23174. * Remove an optimizer from the list of optimizers
  23175. * @param optimizer defines the optimizers to remove
  23176. * @returns the current material
  23177. */
  23178. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23179. /**
  23180. * Add a new block to the list of output nodes
  23181. * @param node defines the node to add
  23182. * @returns the current material
  23183. */
  23184. addOutputNode(node: NodeMaterialBlock): this;
  23185. /**
  23186. * Remove a block from the list of root nodes
  23187. * @param node defines the node to remove
  23188. * @returns the current material
  23189. */
  23190. removeOutputNode(node: NodeMaterialBlock): this;
  23191. private _addVertexOutputNode;
  23192. private _removeVertexOutputNode;
  23193. private _addFragmentOutputNode;
  23194. private _removeFragmentOutputNode;
  23195. /**
  23196. * Specifies if the material will require alpha blending
  23197. * @returns a boolean specifying if alpha blending is needed
  23198. */
  23199. needAlphaBlending(): boolean;
  23200. /**
  23201. * Specifies if this material should be rendered in alpha test mode
  23202. * @returns a boolean specifying if an alpha test is needed.
  23203. */
  23204. needAlphaTesting(): boolean;
  23205. private _initializeBlock;
  23206. private _resetDualBlocks;
  23207. /**
  23208. * Remove a block from the current node material
  23209. * @param block defines the block to remove
  23210. */
  23211. removeBlock(block: NodeMaterialBlock): void;
  23212. /**
  23213. * Build the material and generates the inner effect
  23214. * @param verbose defines if the build should log activity
  23215. */
  23216. build(verbose?: boolean): void;
  23217. /**
  23218. * Runs an otpimization phase to try to improve the shader code
  23219. */
  23220. optimize(): void;
  23221. private _prepareDefinesForAttributes;
  23222. /**
  23223. * Create a post process from the material
  23224. * @param camera The camera to apply the render pass to.
  23225. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23226. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23227. * @param engine The engine which the post process will be applied. (default: current engine)
  23228. * @param reusable If the post process can be reused on the same frame. (default: false)
  23229. * @param textureType Type of textures used when performing the post process. (default: 0)
  23230. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23231. * @returns the post process created
  23232. */
  23233. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23234. /**
  23235. * Create the post process effect from the material
  23236. * @param postProcess The post process to create the effect for
  23237. */
  23238. createEffectForPostProcess(postProcess: PostProcess): void;
  23239. private _createEffectOrPostProcess;
  23240. private _createEffectForParticles;
  23241. /**
  23242. * Create the effect to be used as the custom effect for a particle system
  23243. * @param particleSystem Particle system to create the effect for
  23244. * @param onCompiled defines a function to call when the effect creation is successful
  23245. * @param onError defines a function to call when the effect creation has failed
  23246. */
  23247. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23248. private _processDefines;
  23249. /**
  23250. * Get if the submesh is ready to be used and all its information available.
  23251. * Child classes can use it to update shaders
  23252. * @param mesh defines the mesh to check
  23253. * @param subMesh defines which submesh to check
  23254. * @param useInstances specifies that instances should be used
  23255. * @returns a boolean indicating that the submesh is ready or not
  23256. */
  23257. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23258. /**
  23259. * Get a string representing the shaders built by the current node graph
  23260. */
  23261. get compiledShaders(): string;
  23262. /**
  23263. * Binds the world matrix to the material
  23264. * @param world defines the world transformation matrix
  23265. */
  23266. bindOnlyWorldMatrix(world: Matrix): void;
  23267. /**
  23268. * Binds the submesh to this material by preparing the effect and shader to draw
  23269. * @param world defines the world transformation matrix
  23270. * @param mesh defines the mesh containing the submesh
  23271. * @param subMesh defines the submesh to bind the material to
  23272. */
  23273. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23274. /**
  23275. * Gets the active textures from the material
  23276. * @returns an array of textures
  23277. */
  23278. getActiveTextures(): BaseTexture[];
  23279. /**
  23280. * Gets the list of texture blocks
  23281. * @returns an array of texture blocks
  23282. */
  23283. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23284. /**
  23285. * Specifies if the material uses a texture
  23286. * @param texture defines the texture to check against the material
  23287. * @returns a boolean specifying if the material uses the texture
  23288. */
  23289. hasTexture(texture: BaseTexture): boolean;
  23290. /**
  23291. * Disposes the material
  23292. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23293. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23294. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23295. */
  23296. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23297. /** Creates the node editor window. */
  23298. private _createNodeEditor;
  23299. /**
  23300. * Launch the node material editor
  23301. * @param config Define the configuration of the editor
  23302. * @return a promise fulfilled when the node editor is visible
  23303. */
  23304. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23305. /**
  23306. * Clear the current material
  23307. */
  23308. clear(): void;
  23309. /**
  23310. * Clear the current material and set it to a default state
  23311. */
  23312. setToDefault(): void;
  23313. /**
  23314. * Clear the current material and set it to a default state for post process
  23315. */
  23316. setToDefaultPostProcess(): void;
  23317. /**
  23318. * Clear the current material and set it to a default state for particle
  23319. */
  23320. setToDefaultParticle(): void;
  23321. /**
  23322. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23323. * @param url defines the url to load from
  23324. * @returns a promise that will fullfil when the material is fully loaded
  23325. */
  23326. loadAsync(url: string): Promise<void>;
  23327. private _gatherBlocks;
  23328. /**
  23329. * Generate a string containing the code declaration required to create an equivalent of this material
  23330. * @returns a string
  23331. */
  23332. generateCode(): string;
  23333. /**
  23334. * Serializes this material in a JSON representation
  23335. * @returns the serialized material object
  23336. */
  23337. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23338. private _restoreConnections;
  23339. /**
  23340. * Clear the current graph and load a new one from a serialization object
  23341. * @param source defines the JSON representation of the material
  23342. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23343. * @param merge defines whether or not the source must be merged or replace the current content
  23344. */
  23345. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23346. /**
  23347. * Makes a duplicate of the current material.
  23348. * @param name - name to use for the new material.
  23349. */
  23350. clone(name: string): NodeMaterial;
  23351. /**
  23352. * Creates a node material from parsed material data
  23353. * @param source defines the JSON representation of the material
  23354. * @param scene defines the hosting scene
  23355. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23356. * @returns a new node material
  23357. */
  23358. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23359. /**
  23360. * Creates a node material from a snippet saved in a remote file
  23361. * @param name defines the name of the material to create
  23362. * @param url defines the url to load from
  23363. * @param scene defines the hosting scene
  23364. * @returns a promise that will resolve to the new node material
  23365. */
  23366. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23367. /**
  23368. * Creates a node material from a snippet saved by the node material editor
  23369. * @param snippetId defines the snippet to load
  23370. * @param scene defines the hosting scene
  23371. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23372. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23373. * @returns a promise that will resolve to the new node material
  23374. */
  23375. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23376. /**
  23377. * Creates a new node material set to default basic configuration
  23378. * @param name defines the name of the material
  23379. * @param scene defines the hosting scene
  23380. * @returns a new NodeMaterial
  23381. */
  23382. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23383. }
  23384. }
  23385. declare module "babylonjs/PostProcesses/postProcess" {
  23386. import { Nullable } from "babylonjs/types";
  23387. import { SmartArray } from "babylonjs/Misc/smartArray";
  23388. import { Observable } from "babylonjs/Misc/observable";
  23389. import { Vector2 } from "babylonjs/Maths/math.vector";
  23390. import { Camera } from "babylonjs/Cameras/camera";
  23391. import { Effect } from "babylonjs/Materials/effect";
  23392. import "babylonjs/Shaders/postprocess.vertex";
  23393. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23394. import { Engine } from "babylonjs/Engines/engine";
  23395. import { Color4 } from "babylonjs/Maths/math.color";
  23396. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23397. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23398. import { Scene } from "babylonjs/scene";
  23399. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23400. /**
  23401. * Size options for a post process
  23402. */
  23403. export type PostProcessOptions = {
  23404. width: number;
  23405. height: number;
  23406. };
  23407. /**
  23408. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23409. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23410. */
  23411. export class PostProcess {
  23412. /**
  23413. * Gets or sets the unique id of the post process
  23414. */
  23415. uniqueId: number;
  23416. /** Name of the PostProcess. */
  23417. name: string;
  23418. /**
  23419. * Width of the texture to apply the post process on
  23420. */
  23421. width: number;
  23422. /**
  23423. * Height of the texture to apply the post process on
  23424. */
  23425. height: number;
  23426. /**
  23427. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23428. */
  23429. nodeMaterialSource: Nullable<NodeMaterial>;
  23430. /**
  23431. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23432. * @hidden
  23433. */
  23434. _outputTexture: Nullable<InternalTexture>;
  23435. /**
  23436. * Sampling mode used by the shader
  23437. * See https://doc.babylonjs.com/classes/3.1/texture
  23438. */
  23439. renderTargetSamplingMode: number;
  23440. /**
  23441. * Clear color to use when screen clearing
  23442. */
  23443. clearColor: Color4;
  23444. /**
  23445. * If the buffer needs to be cleared before applying the post process. (default: true)
  23446. * Should be set to false if shader will overwrite all previous pixels.
  23447. */
  23448. autoClear: boolean;
  23449. /**
  23450. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23451. */
  23452. alphaMode: number;
  23453. /**
  23454. * Sets the setAlphaBlendConstants of the babylon engine
  23455. */
  23456. alphaConstants: Color4;
  23457. /**
  23458. * Animations to be used for the post processing
  23459. */
  23460. animations: import("babylonjs/Animations/animation").Animation[];
  23461. /**
  23462. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23463. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23464. */
  23465. enablePixelPerfectMode: boolean;
  23466. /**
  23467. * Force the postprocess to be applied without taking in account viewport
  23468. */
  23469. forceFullscreenViewport: boolean;
  23470. /**
  23471. * List of inspectable custom properties (used by the Inspector)
  23472. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23473. */
  23474. inspectableCustomProperties: IInspectable[];
  23475. /**
  23476. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23477. *
  23478. * | Value | Type | Description |
  23479. * | ----- | ----------------------------------- | ----------- |
  23480. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23481. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23482. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23483. *
  23484. */
  23485. scaleMode: number;
  23486. /**
  23487. * Force textures to be a power of two (default: false)
  23488. */
  23489. alwaysForcePOT: boolean;
  23490. private _samples;
  23491. /**
  23492. * Number of sample textures (default: 1)
  23493. */
  23494. get samples(): number;
  23495. set samples(n: number);
  23496. /**
  23497. * Modify the scale of the post process to be the same as the viewport (default: false)
  23498. */
  23499. adaptScaleToCurrentViewport: boolean;
  23500. private _camera;
  23501. protected _scene: Scene;
  23502. private _engine;
  23503. private _options;
  23504. private _reusable;
  23505. private _textureType;
  23506. private _textureFormat;
  23507. /**
  23508. * Smart array of input and output textures for the post process.
  23509. * @hidden
  23510. */
  23511. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23512. /**
  23513. * The index in _textures that corresponds to the output texture.
  23514. * @hidden
  23515. */
  23516. _currentRenderTextureInd: number;
  23517. private _effect;
  23518. private _samplers;
  23519. private _fragmentUrl;
  23520. private _vertexUrl;
  23521. private _parameters;
  23522. private _scaleRatio;
  23523. protected _indexParameters: any;
  23524. private _shareOutputWithPostProcess;
  23525. private _texelSize;
  23526. private _forcedOutputTexture;
  23527. /**
  23528. * Returns the fragment url or shader name used in the post process.
  23529. * @returns the fragment url or name in the shader store.
  23530. */
  23531. getEffectName(): string;
  23532. /**
  23533. * An event triggered when the postprocess is activated.
  23534. */
  23535. onActivateObservable: Observable<Camera>;
  23536. private _onActivateObserver;
  23537. /**
  23538. * A function that is added to the onActivateObservable
  23539. */
  23540. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23541. /**
  23542. * An event triggered when the postprocess changes its size.
  23543. */
  23544. onSizeChangedObservable: Observable<PostProcess>;
  23545. private _onSizeChangedObserver;
  23546. /**
  23547. * A function that is added to the onSizeChangedObservable
  23548. */
  23549. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23550. /**
  23551. * An event triggered when the postprocess applies its effect.
  23552. */
  23553. onApplyObservable: Observable<Effect>;
  23554. private _onApplyObserver;
  23555. /**
  23556. * A function that is added to the onApplyObservable
  23557. */
  23558. set onApply(callback: (effect: Effect) => void);
  23559. /**
  23560. * An event triggered before rendering the postprocess
  23561. */
  23562. onBeforeRenderObservable: Observable<Effect>;
  23563. private _onBeforeRenderObserver;
  23564. /**
  23565. * A function that is added to the onBeforeRenderObservable
  23566. */
  23567. set onBeforeRender(callback: (effect: Effect) => void);
  23568. /**
  23569. * An event triggered after rendering the postprocess
  23570. */
  23571. onAfterRenderObservable: Observable<Effect>;
  23572. private _onAfterRenderObserver;
  23573. /**
  23574. * A function that is added to the onAfterRenderObservable
  23575. */
  23576. set onAfterRender(callback: (efect: Effect) => void);
  23577. /**
  23578. * The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will
  23579. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23580. */
  23581. get inputTexture(): InternalTexture;
  23582. set inputTexture(value: InternalTexture);
  23583. /**
  23584. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23585. * the only way to unset it is to use this function to restore its internal state
  23586. */
  23587. restoreDefaultInputTexture(): void;
  23588. /**
  23589. * Gets the camera which post process is applied to.
  23590. * @returns The camera the post process is applied to.
  23591. */
  23592. getCamera(): Camera;
  23593. /**
  23594. * Gets the texel size of the postprocess.
  23595. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23596. */
  23597. get texelSize(): Vector2;
  23598. /**
  23599. * Creates a new instance PostProcess
  23600. * @param name The name of the PostProcess.
  23601. * @param fragmentUrl The url of the fragment shader to be used.
  23602. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23603. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23604. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23605. * @param camera The camera to apply the render pass to.
  23606. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23607. * @param engine The engine which the post process will be applied. (default: current engine)
  23608. * @param reusable If the post process can be reused on the same frame. (default: false)
  23609. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23610. * @param textureType Type of textures used when performing the post process. (default: 0)
  23611. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23612. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23613. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23614. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23615. */
  23616. constructor(name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean, textureFormat?: number);
  23617. /**
  23618. * Gets a string identifying the name of the class
  23619. * @returns "PostProcess" string
  23620. */
  23621. getClassName(): string;
  23622. /**
  23623. * Gets the engine which this post process belongs to.
  23624. * @returns The engine the post process was enabled with.
  23625. */
  23626. getEngine(): Engine;
  23627. /**
  23628. * The effect that is created when initializing the post process.
  23629. * @returns The created effect corresponding the the postprocess.
  23630. */
  23631. getEffect(): Effect;
  23632. /**
  23633. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23634. * @param postProcess The post process to share the output with.
  23635. * @returns This post process.
  23636. */
  23637. shareOutputWith(postProcess: PostProcess): PostProcess;
  23638. /**
  23639. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23640. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23641. */
  23642. useOwnOutput(): void;
  23643. /**
  23644. * Updates the effect with the current post process compile time values and recompiles the shader.
  23645. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23646. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23647. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23648. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23649. * @param onCompiled Called when the shader has been compiled.
  23650. * @param onError Called if there is an error when compiling a shader.
  23651. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23652. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23653. */
  23654. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  23655. /**
  23656. * The post process is reusable if it can be used multiple times within one frame.
  23657. * @returns If the post process is reusable
  23658. */
  23659. isReusable(): boolean;
  23660. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23661. markTextureDirty(): void;
  23662. /**
  23663. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23664. * When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.
  23665. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23666. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23667. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23668. * @returns The target texture that was bound to be written to.
  23669. */
  23670. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23671. /**
  23672. * If the post process is supported.
  23673. */
  23674. get isSupported(): boolean;
  23675. /**
  23676. * The aspect ratio of the output texture.
  23677. */
  23678. get aspectRatio(): number;
  23679. /**
  23680. * Get a value indicating if the post-process is ready to be used
  23681. * @returns true if the post-process is ready (shader is compiled)
  23682. */
  23683. isReady(): boolean;
  23684. /**
  23685. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23686. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23687. */
  23688. apply(): Nullable<Effect>;
  23689. private _disposeTextures;
  23690. /**
  23691. * Disposes the post process.
  23692. * @param camera The camera to dispose the post process on.
  23693. */
  23694. dispose(camera?: Camera): void;
  23695. /**
  23696. * Serializes the particle system to a JSON object
  23697. * @returns the JSON object
  23698. */
  23699. serialize(): any;
  23700. /**
  23701. * Creates a material from parsed material data
  23702. * @param parsedPostProcess defines parsed post process data
  23703. * @param scene defines the hosting scene
  23704. * @param rootUrl defines the root URL to use to load textures
  23705. * @returns a new post process
  23706. */
  23707. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23708. }
  23709. }
  23710. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23711. /** @hidden */
  23712. export var kernelBlurVaryingDeclaration: {
  23713. name: string;
  23714. shader: string;
  23715. };
  23716. }
  23717. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23718. /** @hidden */
  23719. export var kernelBlurFragment: {
  23720. name: string;
  23721. shader: string;
  23722. };
  23723. }
  23724. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23725. /** @hidden */
  23726. export var kernelBlurFragment2: {
  23727. name: string;
  23728. shader: string;
  23729. };
  23730. }
  23731. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23732. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23733. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23734. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23735. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23736. /** @hidden */
  23737. export var kernelBlurPixelShader: {
  23738. name: string;
  23739. shader: string;
  23740. };
  23741. }
  23742. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23743. /** @hidden */
  23744. export var kernelBlurVertex: {
  23745. name: string;
  23746. shader: string;
  23747. };
  23748. }
  23749. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23750. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23751. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23752. /** @hidden */
  23753. export var kernelBlurVertexShader: {
  23754. name: string;
  23755. shader: string;
  23756. };
  23757. }
  23758. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23759. import { Vector2 } from "babylonjs/Maths/math.vector";
  23760. import { Nullable } from "babylonjs/types";
  23761. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23762. import { Camera } from "babylonjs/Cameras/camera";
  23763. import { Effect } from "babylonjs/Materials/effect";
  23764. import { Engine } from "babylonjs/Engines/engine";
  23765. import "babylonjs/Shaders/kernelBlur.fragment";
  23766. import "babylonjs/Shaders/kernelBlur.vertex";
  23767. import { Scene } from "babylonjs/scene";
  23768. /**
  23769. * The Blur Post Process which blurs an image based on a kernel and direction.
  23770. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23771. */
  23772. export class BlurPostProcess extends PostProcess {
  23773. private blockCompilation;
  23774. protected _kernel: number;
  23775. protected _idealKernel: number;
  23776. protected _packedFloat: boolean;
  23777. private _staticDefines;
  23778. /** The direction in which to blur the image. */
  23779. direction: Vector2;
  23780. /**
  23781. * Sets the length in pixels of the blur sample region
  23782. */
  23783. set kernel(v: number);
  23784. /**
  23785. * Gets the length in pixels of the blur sample region
  23786. */
  23787. get kernel(): number;
  23788. /**
  23789. * Sets wether or not the blur needs to unpack/repack floats
  23790. */
  23791. set packedFloat(v: boolean);
  23792. /**
  23793. * Gets wether or not the blur is unpacking/repacking floats
  23794. */
  23795. get packedFloat(): boolean;
  23796. /**
  23797. * Gets a string identifying the name of the class
  23798. * @returns "BlurPostProcess" string
  23799. */
  23800. getClassName(): string;
  23801. /**
  23802. * Creates a new instance BlurPostProcess
  23803. * @param name The name of the effect.
  23804. * @param direction The direction in which to blur the image.
  23805. * @param kernel The size of the kernel to be used when computing the blur. eg. Size of 3 will blur the center pixel by 2 pixels surrounding it.
  23806. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23807. * @param camera The camera to apply the render pass to.
  23808. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23809. * @param engine The engine which the post process will be applied. (default: current engine)
  23810. * @param reusable If the post process can be reused on the same frame. (default: false)
  23811. * @param textureType Type of textures used when performing the post process. (default: 0)
  23812. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  23813. */
  23814. constructor(name: string, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  23815. /**
  23816. * Updates the effect with the current post process compile time values and recompiles the shader.
  23817. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23818. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23819. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23820. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23821. * @param onCompiled Called when the shader has been compiled.
  23822. * @param onError Called if there is an error when compiling a shader.
  23823. */
  23824. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23825. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23826. /**
  23827. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23828. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23829. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23830. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23831. * The gaps between physical kernels are compensated for in the weighting of the samples
  23832. * @param idealKernel Ideal blur kernel.
  23833. * @return Nearest best kernel.
  23834. */
  23835. protected _nearestBestKernel(idealKernel: number): number;
  23836. /**
  23837. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23838. * @param x The point on the Gaussian distribution to sample.
  23839. * @return the value of the Gaussian function at x.
  23840. */
  23841. protected _gaussianWeight(x: number): number;
  23842. /**
  23843. * Generates a string that can be used as a floating point number in GLSL.
  23844. * @param x Value to print.
  23845. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23846. * @return GLSL float string.
  23847. */
  23848. protected _glslFloat(x: number, decimalFigures?: number): string;
  23849. /** @hidden */
  23850. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  23851. }
  23852. }
  23853. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23854. import { Scene } from "babylonjs/scene";
  23855. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23856. import { Plane } from "babylonjs/Maths/math.plane";
  23857. /**
  23858. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23859. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23860. * You can then easily use it as a reflectionTexture on a flat surface.
  23861. * In case the surface is not a plane, please consider relying on reflection probes.
  23862. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23863. */
  23864. export class MirrorTexture extends RenderTargetTexture {
  23865. private scene;
  23866. /**
  23867. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23868. * It is possible to directly set the mirrorPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the mirrorPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the reflector as stated in the doc.
  23869. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23870. */
  23871. mirrorPlane: Plane;
  23872. /**
  23873. * Define the blur ratio used to blur the reflection if needed.
  23874. */
  23875. set blurRatio(value: number);
  23876. get blurRatio(): number;
  23877. /**
  23878. * Define the adaptive blur kernel used to blur the reflection if needed.
  23879. * This will autocompute the closest best match for the `blurKernel`
  23880. */
  23881. set adaptiveBlurKernel(value: number);
  23882. /**
  23883. * Define the blur kernel used to blur the reflection if needed.
  23884. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23885. */
  23886. set blurKernel(value: number);
  23887. /**
  23888. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23889. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23890. */
  23891. set blurKernelX(value: number);
  23892. get blurKernelX(): number;
  23893. /**
  23894. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23895. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23896. */
  23897. set blurKernelY(value: number);
  23898. get blurKernelY(): number;
  23899. private _autoComputeBlurKernel;
  23900. protected _onRatioRescale(): void;
  23901. private _updateGammaSpace;
  23902. private _imageProcessingConfigChangeObserver;
  23903. private _transformMatrix;
  23904. private _mirrorMatrix;
  23905. private _savedViewMatrix;
  23906. private _blurX;
  23907. private _blurY;
  23908. private _adaptiveBlurKernel;
  23909. private _blurKernelX;
  23910. private _blurKernelY;
  23911. private _blurRatio;
  23912. /**
  23913. * Instantiates a Mirror Texture.
  23914. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23915. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23916. * You can then easily use it as a reflectionTexture on a flat surface.
  23917. * In case the surface is not a plane, please consider relying on reflection probes.
  23918. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23919. * @param name
  23920. * @param size
  23921. * @param scene
  23922. * @param generateMipMaps
  23923. * @param type
  23924. * @param samplingMode
  23925. * @param generateDepthBuffer
  23926. */
  23927. constructor(name: string, size: number | {
  23928. width: number;
  23929. height: number;
  23930. } | {
  23931. ratio: number;
  23932. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23933. private _preparePostProcesses;
  23934. /**
  23935. * Clone the mirror texture.
  23936. * @returns the cloned texture
  23937. */
  23938. clone(): MirrorTexture;
  23939. /**
  23940. * Serialize the texture to a JSON representation you could use in Parse later on
  23941. * @returns the serialized JSON representation
  23942. */
  23943. serialize(): any;
  23944. /**
  23945. * Dispose the texture and release its associated resources.
  23946. */
  23947. dispose(): void;
  23948. }
  23949. }
  23950. declare module "babylonjs/Materials/Textures/texture" {
  23951. import { Observable } from "babylonjs/Misc/observable";
  23952. import { Nullable } from "babylonjs/types";
  23953. import { Matrix } from "babylonjs/Maths/math.vector";
  23954. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23955. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23956. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23957. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23958. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23959. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23960. import { Scene } from "babylonjs/scene";
  23961. /**
  23962. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23963. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23964. */
  23965. export class Texture extends BaseTexture {
  23966. /**
  23967. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23968. */
  23969. static SerializeBuffers: boolean;
  23970. /** @hidden */
  23971. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23972. /** @hidden */
  23973. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23974. /** @hidden */
  23975. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23976. /** nearest is mag = nearest and min = nearest and mip = linear */
  23977. static readonly NEAREST_SAMPLINGMODE: number;
  23978. /** nearest is mag = nearest and min = nearest and mip = linear */
  23979. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23980. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23981. static readonly BILINEAR_SAMPLINGMODE: number;
  23982. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23983. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23984. /** Trilinear is mag = linear and min = linear and mip = linear */
  23985. static readonly TRILINEAR_SAMPLINGMODE: number;
  23986. /** Trilinear is mag = linear and min = linear and mip = linear */
  23987. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23988. /** mag = nearest and min = nearest and mip = nearest */
  23989. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23990. /** mag = nearest and min = linear and mip = nearest */
  23991. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23992. /** mag = nearest and min = linear and mip = linear */
  23993. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23994. /** mag = nearest and min = linear and mip = none */
  23995. static readonly NEAREST_LINEAR: number;
  23996. /** mag = nearest and min = nearest and mip = none */
  23997. static readonly NEAREST_NEAREST: number;
  23998. /** mag = linear and min = nearest and mip = nearest */
  23999. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  24000. /** mag = linear and min = nearest and mip = linear */
  24001. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24002. /** mag = linear and min = linear and mip = none */
  24003. static readonly LINEAR_LINEAR: number;
  24004. /** mag = linear and min = nearest and mip = none */
  24005. static readonly LINEAR_NEAREST: number;
  24006. /** Explicit coordinates mode */
  24007. static readonly EXPLICIT_MODE: number;
  24008. /** Spherical coordinates mode */
  24009. static readonly SPHERICAL_MODE: number;
  24010. /** Planar coordinates mode */
  24011. static readonly PLANAR_MODE: number;
  24012. /** Cubic coordinates mode */
  24013. static readonly CUBIC_MODE: number;
  24014. /** Projection coordinates mode */
  24015. static readonly PROJECTION_MODE: number;
  24016. /** Inverse Cubic coordinates mode */
  24017. static readonly SKYBOX_MODE: number;
  24018. /** Inverse Cubic coordinates mode */
  24019. static readonly INVCUBIC_MODE: number;
  24020. /** Equirectangular coordinates mode */
  24021. static readonly EQUIRECTANGULAR_MODE: number;
  24022. /** Equirectangular Fixed coordinates mode */
  24023. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24024. /** Equirectangular Fixed Mirrored coordinates mode */
  24025. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24026. /** Texture is not repeating outside of 0..1 UVs */
  24027. static readonly CLAMP_ADDRESSMODE: number;
  24028. /** Texture is repeating outside of 0..1 UVs */
  24029. static readonly WRAP_ADDRESSMODE: number;
  24030. /** Texture is repeating and mirrored */
  24031. static readonly MIRROR_ADDRESSMODE: number;
  24032. /**
  24033. * Gets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file
  24034. */
  24035. static UseSerializedUrlIfAny: boolean;
  24036. /**
  24037. * Define the url of the texture.
  24038. */
  24039. url: Nullable<string>;
  24040. /**
  24041. * Define an offset on the texture to offset the u coordinates of the UVs
  24042. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24043. */
  24044. uOffset: number;
  24045. /**
  24046. * Define an offset on the texture to offset the v coordinates of the UVs
  24047. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24048. */
  24049. vOffset: number;
  24050. /**
  24051. * Define an offset on the texture to scale the u coordinates of the UVs
  24052. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24053. */
  24054. uScale: number;
  24055. /**
  24056. * Define an offset on the texture to scale the v coordinates of the UVs
  24057. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24058. */
  24059. vScale: number;
  24060. /**
  24061. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24062. * @see https://doc.babylonjs.com/how_to/more_materials
  24063. */
  24064. uAng: number;
  24065. /**
  24066. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24067. * @see https://doc.babylonjs.com/how_to/more_materials
  24068. */
  24069. vAng: number;
  24070. /**
  24071. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24072. * @see https://doc.babylonjs.com/how_to/more_materials
  24073. */
  24074. wAng: number;
  24075. /**
  24076. * Defines the center of rotation (U)
  24077. */
  24078. uRotationCenter: number;
  24079. /**
  24080. * Defines the center of rotation (V)
  24081. */
  24082. vRotationCenter: number;
  24083. /**
  24084. * Defines the center of rotation (W)
  24085. */
  24086. wRotationCenter: number;
  24087. /**
  24088. * Are mip maps generated for this texture or not.
  24089. */
  24090. get noMipmap(): boolean;
  24091. /**
  24092. * List of inspectable custom properties (used by the Inspector)
  24093. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24094. */
  24095. inspectableCustomProperties: Nullable<IInspectable[]>;
  24096. private _noMipmap;
  24097. /** @hidden */
  24098. _invertY: boolean;
  24099. private _rowGenerationMatrix;
  24100. private _cachedTextureMatrix;
  24101. private _projectionModeMatrix;
  24102. private _t0;
  24103. private _t1;
  24104. private _t2;
  24105. private _cachedUOffset;
  24106. private _cachedVOffset;
  24107. private _cachedUScale;
  24108. private _cachedVScale;
  24109. private _cachedUAng;
  24110. private _cachedVAng;
  24111. private _cachedWAng;
  24112. private _cachedProjectionMatrixId;
  24113. private _cachedCoordinatesMode;
  24114. /** @hidden */
  24115. protected _initialSamplingMode: number;
  24116. /** @hidden */
  24117. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24118. private _deleteBuffer;
  24119. protected _format: Nullable<number>;
  24120. private _delayedOnLoad;
  24121. private _delayedOnError;
  24122. private _mimeType?;
  24123. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  24124. get mimeType(): string | undefined;
  24125. /**
  24126. * Observable triggered once the texture has been loaded.
  24127. */
  24128. onLoadObservable: Observable<Texture>;
  24129. protected _isBlocking: boolean;
  24130. /**
  24131. * Is the texture preventing material to render while loading.
  24132. * If false, a default texture will be used instead of the loading one during the preparation step.
  24133. */
  24134. set isBlocking(value: boolean);
  24135. get isBlocking(): boolean;
  24136. /**
  24137. * Get the current sampling mode associated with the texture.
  24138. */
  24139. get samplingMode(): number;
  24140. /**
  24141. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24142. */
  24143. get invertY(): boolean;
  24144. /**
  24145. * Instantiates a new texture.
  24146. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24147. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24148. * @param url defines the url of the picture to load as a texture
  24149. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24150. * @param noMipmap defines if the texture will require mip maps or not
  24151. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24152. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24153. * @param onLoad defines a callback triggered when the texture has been loaded
  24154. * @param onError defines a callback triggered when an error occurred during the loading session
  24155. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24156. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24157. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24158. * @param mimeType defines an optional mime type information
  24159. */
  24160. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string);
  24161. /**
  24162. * Update the url (and optional buffer) of this texture if url was null during construction.
  24163. * @param url the url of the texture
  24164. * @param buffer the buffer of the texture (defaults to null)
  24165. * @param onLoad callback called when the texture is loaded (defaults to null)
  24166. */
  24167. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24168. /**
  24169. * Finish the loading sequence of a texture flagged as delayed load.
  24170. * @hidden
  24171. */
  24172. delayLoad(): void;
  24173. private _prepareRowForTextureGeneration;
  24174. /**
  24175. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24176. * @returns the transform matrix of the texture.
  24177. */
  24178. getTextureMatrix(uBase?: number): Matrix;
  24179. /**
  24180. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24181. * @returns The reflection texture transform
  24182. */
  24183. getReflectionTextureMatrix(): Matrix;
  24184. /**
  24185. * Clones the texture.
  24186. * @returns the cloned texture
  24187. */
  24188. clone(): Texture;
  24189. /**
  24190. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24191. * @returns The JSON representation of the texture
  24192. */
  24193. serialize(): any;
  24194. /**
  24195. * Get the current class name of the texture useful for serialization or dynamic coding.
  24196. * @returns "Texture"
  24197. */
  24198. getClassName(): string;
  24199. /**
  24200. * Dispose the texture and release its associated resources.
  24201. */
  24202. dispose(): void;
  24203. /**
  24204. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24205. * @param parsedTexture Define the JSON representation of the texture
  24206. * @param scene Define the scene the parsed texture should be instantiated in
  24207. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24208. * @returns The parsed texture if successful
  24209. */
  24210. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24211. /**
  24212. * Creates a texture from its base 64 representation.
  24213. * @param data Define the base64 payload without the data: prefix
  24214. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24215. * @param scene Define the scene the texture should belong to
  24216. * @param noMipmap Forces the texture to not create mip map information if true
  24217. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24218. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24219. * @param onLoad define a callback triggered when the texture has been loaded
  24220. * @param onError define a callback triggered when an error occurred during the loading session
  24221. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24222. * @returns the created texture
  24223. */
  24224. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24225. /**
  24226. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24227. * @param data Define the base64 payload without the data: prefix
  24228. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24229. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24230. * @param scene Define the scene the texture should belong to
  24231. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24232. * @param noMipmap Forces the texture to not create mip map information if true
  24233. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24234. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24235. * @param onLoad define a callback triggered when the texture has been loaded
  24236. * @param onError define a callback triggered when an error occurred during the loading session
  24237. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24238. * @returns the created texture
  24239. */
  24240. static LoadFromDataString(name: string, buffer: any, scene: Scene, deleteBuffer?: boolean, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number): Texture;
  24241. }
  24242. }
  24243. declare module "babylonjs/PostProcesses/postProcessManager" {
  24244. import { Nullable } from "babylonjs/types";
  24245. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24246. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24247. import { Scene } from "babylonjs/scene";
  24248. /**
  24249. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24250. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24251. */
  24252. export class PostProcessManager {
  24253. private _scene;
  24254. private _indexBuffer;
  24255. private _vertexBuffers;
  24256. /**
  24257. * Creates a new instance PostProcess
  24258. * @param scene The scene that the post process is associated with.
  24259. */
  24260. constructor(scene: Scene);
  24261. private _prepareBuffers;
  24262. private _buildIndexBuffer;
  24263. /**
  24264. * Rebuilds the vertex buffers of the manager.
  24265. * @hidden
  24266. */
  24267. _rebuild(): void;
  24268. /**
  24269. * Prepares a frame to be run through a post process.
  24270. * @param sourceTexture The input texture to the post procesess. (default: null)
  24271. * @param postProcesses An array of post processes to be run. (default: null)
  24272. * @returns True if the post processes were able to be run.
  24273. * @hidden
  24274. */
  24275. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24276. /**
  24277. * Manually render a set of post processes to a texture.
  24278. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24279. * @param postProcesses An array of post processes to be run.
  24280. * @param targetTexture The target texture to render to.
  24281. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24282. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24283. * @param lodLevel defines which lod of the texture to render to
  24284. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24285. */
  24286. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24287. /**
  24288. * Finalize the result of the output of the postprocesses.
  24289. * @param doNotPresent If true the result will not be displayed to the screen.
  24290. * @param targetTexture The target texture to render to.
  24291. * @param faceIndex The index of the face to bind the target texture to.
  24292. * @param postProcesses The array of post processes to render.
  24293. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24294. * @hidden
  24295. */
  24296. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24297. /**
  24298. * Disposes of the post process manager.
  24299. */
  24300. dispose(): void;
  24301. }
  24302. }
  24303. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24304. import { Observable } from "babylonjs/Misc/observable";
  24305. import { SmartArray } from "babylonjs/Misc/smartArray";
  24306. import { Nullable, Immutable } from "babylonjs/types";
  24307. import { Camera } from "babylonjs/Cameras/camera";
  24308. import { Scene } from "babylonjs/scene";
  24309. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24310. import { Color4 } from "babylonjs/Maths/math.color";
  24311. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24312. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24313. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24314. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24315. import { Texture } from "babylonjs/Materials/Textures/texture";
  24316. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24317. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24318. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24319. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24320. import { Engine } from "babylonjs/Engines/engine";
  24321. /**
  24322. * This Helps creating a texture that will be created from a camera in your scene.
  24323. * It is basically a dynamic texture that could be used to create special effects for instance.
  24324. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24325. */
  24326. export class RenderTargetTexture extends Texture {
  24327. /**
  24328. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24329. */
  24330. static readonly REFRESHRATE_RENDER_ONCE: number;
  24331. /**
  24332. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24333. */
  24334. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24335. /**
  24336. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24337. * the central point of your effect and can save a lot of performances.
  24338. */
  24339. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24340. /**
  24341. * Use this predicate to dynamically define the list of mesh you want to render.
  24342. * If set, the renderList property will be overwritten.
  24343. */
  24344. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24345. private _renderList;
  24346. /**
  24347. * Use this list to define the list of mesh you want to render.
  24348. */
  24349. get renderList(): Nullable<Array<AbstractMesh>>;
  24350. set renderList(value: Nullable<Array<AbstractMesh>>);
  24351. /**
  24352. * Use this function to overload the renderList array at rendering time.
  24353. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24354. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24355. * the cube (if the RTT is a cube, else layerOrFace=0).
  24356. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24357. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24358. * hold dummy elements!
  24359. */
  24360. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24361. private _hookArray;
  24362. /**
  24363. * Define if particles should be rendered in your texture.
  24364. */
  24365. renderParticles: boolean;
  24366. /**
  24367. * Define if sprites should be rendered in your texture.
  24368. */
  24369. renderSprites: boolean;
  24370. /**
  24371. * Define the camera used to render the texture.
  24372. */
  24373. activeCamera: Nullable<Camera>;
  24374. /**
  24375. * Override the mesh isReady function with your own one.
  24376. */
  24377. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24378. /**
  24379. * Override the render function of the texture with your own one.
  24380. */
  24381. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24382. /**
  24383. * Define if camera post processes should be use while rendering the texture.
  24384. */
  24385. useCameraPostProcesses: boolean;
  24386. /**
  24387. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24388. */
  24389. ignoreCameraViewport: boolean;
  24390. private _postProcessManager;
  24391. private _postProcesses;
  24392. private _resizeObserver;
  24393. /**
  24394. * An event triggered when the texture is unbind.
  24395. */
  24396. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24397. /**
  24398. * An event triggered when the texture is unbind.
  24399. */
  24400. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24401. private _onAfterUnbindObserver;
  24402. /**
  24403. * Set a after unbind callback in the texture.
  24404. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24405. */
  24406. set onAfterUnbind(callback: () => void);
  24407. /**
  24408. * An event triggered before rendering the texture
  24409. */
  24410. onBeforeRenderObservable: Observable<number>;
  24411. private _onBeforeRenderObserver;
  24412. /**
  24413. * Set a before render callback in the texture.
  24414. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24415. */
  24416. set onBeforeRender(callback: (faceIndex: number) => void);
  24417. /**
  24418. * An event triggered after rendering the texture
  24419. */
  24420. onAfterRenderObservable: Observable<number>;
  24421. private _onAfterRenderObserver;
  24422. /**
  24423. * Set a after render callback in the texture.
  24424. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24425. */
  24426. set onAfterRender(callback: (faceIndex: number) => void);
  24427. /**
  24428. * An event triggered after the texture clear
  24429. */
  24430. onClearObservable: Observable<Engine>;
  24431. private _onClearObserver;
  24432. /**
  24433. * Set a clear callback in the texture.
  24434. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24435. */
  24436. set onClear(callback: (Engine: Engine) => void);
  24437. /**
  24438. * An event triggered when the texture is resized.
  24439. */
  24440. onResizeObservable: Observable<RenderTargetTexture>;
  24441. /**
  24442. * Define the clear color of the Render Target if it should be different from the scene.
  24443. */
  24444. clearColor: Color4;
  24445. protected _size: number | {
  24446. width: number;
  24447. height: number;
  24448. layers?: number;
  24449. };
  24450. protected _initialSizeParameter: number | {
  24451. width: number;
  24452. height: number;
  24453. } | {
  24454. ratio: number;
  24455. };
  24456. protected _sizeRatio: Nullable<number>;
  24457. /** @hidden */
  24458. _generateMipMaps: boolean;
  24459. protected _renderingManager: RenderingManager;
  24460. /** @hidden */
  24461. _waitingRenderList?: string[];
  24462. protected _doNotChangeAspectRatio: boolean;
  24463. protected _currentRefreshId: number;
  24464. protected _refreshRate: number;
  24465. protected _textureMatrix: Matrix;
  24466. protected _samples: number;
  24467. protected _renderTargetOptions: RenderTargetCreationOptions;
  24468. /**
  24469. * Gets render target creation options that were used.
  24470. */
  24471. get renderTargetOptions(): RenderTargetCreationOptions;
  24472. protected _onRatioRescale(): void;
  24473. /**
  24474. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24475. * It must define where the camera used to render the texture is set
  24476. */
  24477. boundingBoxPosition: Vector3;
  24478. private _boundingBoxSize;
  24479. /**
  24480. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24481. * When defined, the cubemap will switch to local mode
  24482. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24483. * @example https://www.babylonjs-playground.com/#RNASML
  24484. */
  24485. set boundingBoxSize(value: Vector3);
  24486. get boundingBoxSize(): Vector3;
  24487. /**
  24488. * In case the RTT has been created with a depth texture, get the associated
  24489. * depth texture.
  24490. * Otherwise, return null.
  24491. */
  24492. get depthStencilTexture(): Nullable<InternalTexture>;
  24493. /**
  24494. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24495. * or used a shadow, depth texture...
  24496. * @param name The friendly name of the texture
  24497. * @param size The size of the RTT (number if square, or {width: number, height:number} or {ratio:} to define a ratio from the main scene)
  24498. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24499. * @param generateMipMaps True if mip maps need to be generated after render.
  24500. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24501. * @param type The type of the buffer in the RTT (int, half float, float...)
  24502. * @param isCube True if a cube texture needs to be created
  24503. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24504. * @param generateDepthBuffer True to generate a depth buffer
  24505. * @param generateStencilBuffer True to generate a stencil buffer
  24506. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24507. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24508. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24509. */
  24510. constructor(name: string, size: number | {
  24511. width: number;
  24512. height: number;
  24513. layers?: number;
  24514. } | {
  24515. ratio: number;
  24516. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24517. /**
  24518. * Creates a depth stencil texture.
  24519. * This is only available in WebGL 2 or with the depth texture extension available.
  24520. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24521. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24522. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24523. */
  24524. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24525. private _processSizeParameter;
  24526. /**
  24527. * Define the number of samples to use in case of MSAA.
  24528. * It defaults to one meaning no MSAA has been enabled.
  24529. */
  24530. get samples(): number;
  24531. set samples(value: number);
  24532. /**
  24533. * Resets the refresh counter of the texture and start bak from scratch.
  24534. * Could be useful to regenerate the texture if it is setup to render only once.
  24535. */
  24536. resetRefreshCounter(): void;
  24537. /**
  24538. * Define the refresh rate of the texture or the rendering frequency.
  24539. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24540. */
  24541. get refreshRate(): number;
  24542. set refreshRate(value: number);
  24543. /**
  24544. * Adds a post process to the render target rendering passes.
  24545. * @param postProcess define the post process to add
  24546. */
  24547. addPostProcess(postProcess: PostProcess): void;
  24548. /**
  24549. * Clear all the post processes attached to the render target
  24550. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24551. */
  24552. clearPostProcesses(dispose?: boolean): void;
  24553. /**
  24554. * Remove one of the post process from the list of attached post processes to the texture
  24555. * @param postProcess define the post process to remove from the list
  24556. */
  24557. removePostProcess(postProcess: PostProcess): void;
  24558. /** @hidden */
  24559. _shouldRender(): boolean;
  24560. /**
  24561. * Gets the actual render size of the texture.
  24562. * @returns the width of the render size
  24563. */
  24564. getRenderSize(): number;
  24565. /**
  24566. * Gets the actual render width of the texture.
  24567. * @returns the width of the render size
  24568. */
  24569. getRenderWidth(): number;
  24570. /**
  24571. * Gets the actual render height of the texture.
  24572. * @returns the height of the render size
  24573. */
  24574. getRenderHeight(): number;
  24575. /**
  24576. * Gets the actual number of layers of the texture.
  24577. * @returns the number of layers
  24578. */
  24579. getRenderLayers(): number;
  24580. /**
  24581. * Get if the texture can be rescaled or not.
  24582. */
  24583. get canRescale(): boolean;
  24584. /**
  24585. * Resize the texture using a ratio.
  24586. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24587. */
  24588. scale(ratio: number): void;
  24589. /**
  24590. * Get the texture reflection matrix used to rotate/transform the reflection.
  24591. * @returns the reflection matrix
  24592. */
  24593. getReflectionTextureMatrix(): Matrix;
  24594. /**
  24595. * Resize the texture to a new desired size.
  24596. * Be carrefull as it will recreate all the data in the new texture.
  24597. * @param size Define the new size. It can be:
  24598. * - a number for squared texture,
  24599. * - an object containing { width: number, height: number }
  24600. * - or an object containing a ratio { ratio: number }
  24601. */
  24602. resize(size: number | {
  24603. width: number;
  24604. height: number;
  24605. } | {
  24606. ratio: number;
  24607. }): void;
  24608. private _defaultRenderListPrepared;
  24609. /**
  24610. * Renders all the objects from the render list into the texture.
  24611. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24612. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24613. */
  24614. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24615. private _bestReflectionRenderTargetDimension;
  24616. private _prepareRenderingManager;
  24617. /**
  24618. * @hidden
  24619. * @param faceIndex face index to bind to if this is a cubetexture
  24620. * @param layer defines the index of the texture to bind in the array
  24621. */
  24622. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24623. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24624. private renderToTarget;
  24625. /**
  24626. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24627. * This allowed control for front to back rendering or reversly depending of the special needs.
  24628. *
  24629. * @param renderingGroupId The rendering group id corresponding to its index
  24630. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24631. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24632. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24633. */
  24634. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  24635. /**
  24636. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24637. *
  24638. * @param renderingGroupId The rendering group id corresponding to its index
  24639. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24640. */
  24641. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24642. /**
  24643. * Clones the texture.
  24644. * @returns the cloned texture
  24645. */
  24646. clone(): RenderTargetTexture;
  24647. /**
  24648. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24649. * @returns The JSON representation of the texture
  24650. */
  24651. serialize(): any;
  24652. /**
  24653. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24654. */
  24655. disposeFramebufferObjects(): void;
  24656. /**
  24657. * Dispose the texture and release its associated resources.
  24658. */
  24659. dispose(): void;
  24660. /** @hidden */
  24661. _rebuild(): void;
  24662. /**
  24663. * Clear the info related to rendering groups preventing retention point in material dispose.
  24664. */
  24665. freeRenderingGroups(): void;
  24666. /**
  24667. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24668. * @returns the view count
  24669. */
  24670. getViewCount(): number;
  24671. }
  24672. }
  24673. declare module "babylonjs/Misc/guid" {
  24674. /**
  24675. * Class used to manipulate GUIDs
  24676. */
  24677. export class GUID {
  24678. /**
  24679. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24680. * Be aware Math.random() could cause collisions, but:
  24681. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  24682. * @returns a pseudo random id
  24683. */
  24684. static RandomId(): string;
  24685. }
  24686. }
  24687. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24688. import { Nullable } from "babylonjs/types";
  24689. import { Scene } from "babylonjs/scene";
  24690. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24691. import { Material } from "babylonjs/Materials/material";
  24692. import { Effect } from "babylonjs/Materials/effect";
  24693. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24694. /**
  24695. * Options to be used when creating a shadow depth material
  24696. */
  24697. export interface IIOptionShadowDepthMaterial {
  24698. /** Variables in the vertex shader code that need to have their names remapped.
  24699. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24700. * "var_name" should be either: worldPos or vNormalW
  24701. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24702. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24703. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24704. */
  24705. remappedVariables?: string[];
  24706. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24707. standalone?: boolean;
  24708. }
  24709. /**
  24710. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24711. */
  24712. export class ShadowDepthWrapper {
  24713. private _scene;
  24714. private _options?;
  24715. private _baseMaterial;
  24716. private _onEffectCreatedObserver;
  24717. private _subMeshToEffect;
  24718. private _subMeshToDepthEffect;
  24719. private _meshes;
  24720. /** @hidden */
  24721. _matriceNames: any;
  24722. /** Gets the standalone status of the wrapper */
  24723. get standalone(): boolean;
  24724. /** Gets the base material the wrapper is built upon */
  24725. get baseMaterial(): Material;
  24726. /**
  24727. * Instantiate a new shadow depth wrapper.
  24728. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24729. * generate the shadow depth map. For more information, please refer to the documentation:
  24730. * https://doc.babylonjs.com/babylon101/shadows
  24731. * @param baseMaterial Material to wrap
  24732. * @param scene Define the scene the material belongs to
  24733. * @param options Options used to create the wrapper
  24734. */
  24735. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24736. /**
  24737. * Gets the effect to use to generate the depth map
  24738. * @param subMesh subMesh to get the effect for
  24739. * @param shadowGenerator shadow generator to get the effect for
  24740. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24741. */
  24742. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24743. /**
  24744. * Specifies that the submesh is ready to be used for depth rendering
  24745. * @param subMesh submesh to check
  24746. * @param defines the list of defines to take into account when checking the effect
  24747. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24748. * @param useInstances specifies that instances should be used
  24749. * @returns a boolean indicating that the submesh is ready or not
  24750. */
  24751. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24752. /**
  24753. * Disposes the resources
  24754. */
  24755. dispose(): void;
  24756. private _makeEffect;
  24757. }
  24758. }
  24759. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24760. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24761. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24762. import { Nullable } from "babylonjs/types";
  24763. module "babylonjs/Engines/thinEngine" {
  24764. interface ThinEngine {
  24765. /**
  24766. * Unbind a list of render target textures from the webGL context
  24767. * This is used only when drawBuffer extension or webGL2 are active
  24768. * @param textures defines the render target textures to unbind
  24769. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24770. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24771. */
  24772. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24773. /**
  24774. * Create a multi render target texture
  24775. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24776. * @param size defines the size of the texture
  24777. * @param options defines the creation options
  24778. * @returns the cube texture as an InternalTexture
  24779. */
  24780. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24781. /**
  24782. * Update the sample count for a given multiple render target texture
  24783. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24784. * @param textures defines the textures to update
  24785. * @param samples defines the sample count to set
  24786. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24787. */
  24788. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24789. /**
  24790. * Select a subsets of attachments to draw to.
  24791. * @param attachments gl attachments
  24792. */
  24793. bindAttachments(attachments: number[]): void;
  24794. }
  24795. }
  24796. }
  24797. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24798. import { Scene } from "babylonjs/scene";
  24799. import { Engine } from "babylonjs/Engines/engine";
  24800. import { Texture } from "babylonjs/Materials/Textures/texture";
  24801. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24802. import "babylonjs/Engines/Extensions/engine.multiRender";
  24803. /**
  24804. * Creation options of the multi render target texture.
  24805. */
  24806. export interface IMultiRenderTargetOptions {
  24807. /**
  24808. * Define if the texture needs to create mip maps after render.
  24809. */
  24810. generateMipMaps?: boolean;
  24811. /**
  24812. * Define the types of all the draw buffers we want to create
  24813. */
  24814. types?: number[];
  24815. /**
  24816. * Define the sampling modes of all the draw buffers we want to create
  24817. */
  24818. samplingModes?: number[];
  24819. /**
  24820. * Define if a depth buffer is required
  24821. */
  24822. generateDepthBuffer?: boolean;
  24823. /**
  24824. * Define if a stencil buffer is required
  24825. */
  24826. generateStencilBuffer?: boolean;
  24827. /**
  24828. * Define if a depth texture is required instead of a depth buffer
  24829. */
  24830. generateDepthTexture?: boolean;
  24831. /**
  24832. * Define the number of desired draw buffers
  24833. */
  24834. textureCount?: number;
  24835. /**
  24836. * Define if aspect ratio should be adapted to the texture or stay the scene one
  24837. */
  24838. doNotChangeAspectRatio?: boolean;
  24839. /**
  24840. * Define the default type of the buffers we are creating
  24841. */
  24842. defaultType?: number;
  24843. }
  24844. /**
  24845. * A multi render target, like a render target provides the ability to render to a texture.
  24846. * Unlike the render target, it can render to several draw buffers in one draw.
  24847. * This is specially interesting in deferred rendering or for any effects requiring more than
  24848. * just one color from a single pass.
  24849. */
  24850. export class MultiRenderTarget extends RenderTargetTexture {
  24851. private _internalTextures;
  24852. private _textures;
  24853. private _multiRenderTargetOptions;
  24854. private _count;
  24855. /**
  24856. * Get if draw buffers are currently supported by the used hardware and browser.
  24857. */
  24858. get isSupported(): boolean;
  24859. /**
  24860. * Get the list of textures generated by the multi render target.
  24861. */
  24862. get textures(): Texture[];
  24863. /**
  24864. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  24865. */
  24866. get count(): number;
  24867. /**
  24868. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  24869. */
  24870. get depthTexture(): Texture;
  24871. /**
  24872. * Set the wrapping mode on U of all the textures we are rendering to.
  24873. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24874. */
  24875. set wrapU(wrap: number);
  24876. /**
  24877. * Set the wrapping mode on V of all the textures we are rendering to.
  24878. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24879. */
  24880. set wrapV(wrap: number);
  24881. /**
  24882. * Instantiate a new multi render target texture.
  24883. * A multi render target, like a render target provides the ability to render to a texture.
  24884. * Unlike the render target, it can render to several draw buffers in one draw.
  24885. * This is specially interesting in deferred rendering or for any effects requiring more than
  24886. * just one color from a single pass.
  24887. * @param name Define the name of the texture
  24888. * @param size Define the size of the buffers to render to
  24889. * @param count Define the number of target we are rendering into
  24890. * @param scene Define the scene the texture belongs to
  24891. * @param options Define the options used to create the multi render target
  24892. */
  24893. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  24894. /** @hidden */
  24895. _rebuild(): void;
  24896. private _createInternalTextures;
  24897. private _createTextures;
  24898. /**
  24899. * Define the number of samples used if MSAA is enabled.
  24900. */
  24901. get samples(): number;
  24902. set samples(value: number);
  24903. /**
  24904. * Resize all the textures in the multi render target.
  24905. * Be carrefull as it will recreate all the data in the new texture.
  24906. * @param size Define the new size
  24907. */
  24908. resize(size: any): void;
  24909. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24910. /**
  24911. * Dispose the render targets and their associated resources
  24912. */
  24913. dispose(): void;
  24914. /**
  24915. * Release all the underlying texture used as draw buffers.
  24916. */
  24917. releaseInternalTextures(): void;
  24918. }
  24919. }
  24920. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  24921. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24922. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24923. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24924. /** @hidden */
  24925. export var imageProcessingPixelShader: {
  24926. name: string;
  24927. shader: string;
  24928. };
  24929. }
  24930. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  24931. import { Nullable } from "babylonjs/types";
  24932. import { Color4 } from "babylonjs/Maths/math.color";
  24933. import { Camera } from "babylonjs/Cameras/camera";
  24934. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24935. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24936. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  24937. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24938. import { Engine } from "babylonjs/Engines/engine";
  24939. import "babylonjs/Shaders/imageProcessing.fragment";
  24940. import "babylonjs/Shaders/postprocess.vertex";
  24941. /**
  24942. * ImageProcessingPostProcess
  24943. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  24944. */
  24945. export class ImageProcessingPostProcess extends PostProcess {
  24946. /**
  24947. * Default configuration related to image processing available in the PBR Material.
  24948. */
  24949. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  24950. /**
  24951. * Gets the image processing configuration used either in this material.
  24952. */
  24953. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  24954. /**
  24955. * Sets the Default image processing configuration used either in the this material.
  24956. *
  24957. * If sets to null, the scene one is in use.
  24958. */
  24959. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  24960. /**
  24961. * Keep track of the image processing observer to allow dispose and replace.
  24962. */
  24963. private _imageProcessingObserver;
  24964. /**
  24965. * Attaches a new image processing configuration to the PBR Material.
  24966. * @param configuration
  24967. */
  24968. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  24969. /**
  24970. * If the post process is supported.
  24971. */
  24972. get isSupported(): boolean;
  24973. /**
  24974. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24975. */
  24976. get colorCurves(): Nullable<ColorCurves>;
  24977. /**
  24978. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24979. */
  24980. set colorCurves(value: Nullable<ColorCurves>);
  24981. /**
  24982. * Gets wether the color curves effect is enabled.
  24983. */
  24984. get colorCurvesEnabled(): boolean;
  24985. /**
  24986. * Sets wether the color curves effect is enabled.
  24987. */
  24988. set colorCurvesEnabled(value: boolean);
  24989. /**
  24990. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24991. */
  24992. get colorGradingTexture(): Nullable<BaseTexture>;
  24993. /**
  24994. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24995. */
  24996. set colorGradingTexture(value: Nullable<BaseTexture>);
  24997. /**
  24998. * Gets wether the color grading effect is enabled.
  24999. */
  25000. get colorGradingEnabled(): boolean;
  25001. /**
  25002. * Gets wether the color grading effect is enabled.
  25003. */
  25004. set colorGradingEnabled(value: boolean);
  25005. /**
  25006. * Gets exposure used in the effect.
  25007. */
  25008. get exposure(): number;
  25009. /**
  25010. * Sets exposure used in the effect.
  25011. */
  25012. set exposure(value: number);
  25013. /**
  25014. * Gets wether tonemapping is enabled or not.
  25015. */
  25016. get toneMappingEnabled(): boolean;
  25017. /**
  25018. * Sets wether tonemapping is enabled or not
  25019. */
  25020. set toneMappingEnabled(value: boolean);
  25021. /**
  25022. * Gets the type of tone mapping effect.
  25023. */
  25024. get toneMappingType(): number;
  25025. /**
  25026. * Sets the type of tone mapping effect.
  25027. */
  25028. set toneMappingType(value: number);
  25029. /**
  25030. * Gets contrast used in the effect.
  25031. */
  25032. get contrast(): number;
  25033. /**
  25034. * Sets contrast used in the effect.
  25035. */
  25036. set contrast(value: number);
  25037. /**
  25038. * Gets Vignette stretch size.
  25039. */
  25040. get vignetteStretch(): number;
  25041. /**
  25042. * Sets Vignette stretch size.
  25043. */
  25044. set vignetteStretch(value: number);
  25045. /**
  25046. * Gets Vignette centre X Offset.
  25047. */
  25048. get vignetteCentreX(): number;
  25049. /**
  25050. * Sets Vignette centre X Offset.
  25051. */
  25052. set vignetteCentreX(value: number);
  25053. /**
  25054. * Gets Vignette centre Y Offset.
  25055. */
  25056. get vignetteCentreY(): number;
  25057. /**
  25058. * Sets Vignette centre Y Offset.
  25059. */
  25060. set vignetteCentreY(value: number);
  25061. /**
  25062. * Gets Vignette weight or intensity of the vignette effect.
  25063. */
  25064. get vignetteWeight(): number;
  25065. /**
  25066. * Sets Vignette weight or intensity of the vignette effect.
  25067. */
  25068. set vignetteWeight(value: number);
  25069. /**
  25070. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25071. * if vignetteEnabled is set to true.
  25072. */
  25073. get vignetteColor(): Color4;
  25074. /**
  25075. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25076. * if vignetteEnabled is set to true.
  25077. */
  25078. set vignetteColor(value: Color4);
  25079. /**
  25080. * Gets Camera field of view used by the Vignette effect.
  25081. */
  25082. get vignetteCameraFov(): number;
  25083. /**
  25084. * Sets Camera field of view used by the Vignette effect.
  25085. */
  25086. set vignetteCameraFov(value: number);
  25087. /**
  25088. * Gets the vignette blend mode allowing different kind of effect.
  25089. */
  25090. get vignetteBlendMode(): number;
  25091. /**
  25092. * Sets the vignette blend mode allowing different kind of effect.
  25093. */
  25094. set vignetteBlendMode(value: number);
  25095. /**
  25096. * Gets wether the vignette effect is enabled.
  25097. */
  25098. get vignetteEnabled(): boolean;
  25099. /**
  25100. * Sets wether the vignette effect is enabled.
  25101. */
  25102. set vignetteEnabled(value: boolean);
  25103. private _fromLinearSpace;
  25104. /**
  25105. * Gets wether the input of the processing is in Gamma or Linear Space.
  25106. */
  25107. get fromLinearSpace(): boolean;
  25108. /**
  25109. * Sets wether the input of the processing is in Gamma or Linear Space.
  25110. */
  25111. set fromLinearSpace(value: boolean);
  25112. /**
  25113. * Defines cache preventing GC.
  25114. */
  25115. private _defines;
  25116. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  25117. /**
  25118. * "ImageProcessingPostProcess"
  25119. * @returns "ImageProcessingPostProcess"
  25120. */
  25121. getClassName(): string;
  25122. /**
  25123. * @hidden
  25124. */
  25125. _updateParameters(): void;
  25126. dispose(camera?: Camera): void;
  25127. }
  25128. }
  25129. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  25130. /** @hidden */
  25131. export var fibonacci: {
  25132. name: string;
  25133. shader: string;
  25134. };
  25135. }
  25136. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  25137. /** @hidden */
  25138. export var subSurfaceScatteringFunctions: {
  25139. name: string;
  25140. shader: string;
  25141. };
  25142. }
  25143. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  25144. /** @hidden */
  25145. export var diffusionProfile: {
  25146. name: string;
  25147. shader: string;
  25148. };
  25149. }
  25150. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  25151. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  25152. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25153. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  25154. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  25155. /** @hidden */
  25156. export var subSurfaceScatteringPixelShader: {
  25157. name: string;
  25158. shader: string;
  25159. };
  25160. }
  25161. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  25162. import { Nullable } from "babylonjs/types";
  25163. import { Camera } from "babylonjs/Cameras/camera";
  25164. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  25165. import { Engine } from "babylonjs/Engines/engine";
  25166. import { Scene } from "babylonjs/scene";
  25167. import "babylonjs/Shaders/imageProcessing.fragment";
  25168. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  25169. import "babylonjs/Shaders/postprocess.vertex";
  25170. /**
  25171. * Sub surface scattering post process
  25172. */
  25173. export class SubSurfaceScatteringPostProcess extends PostProcess {
  25174. /**
  25175. * Gets a string identifying the name of the class
  25176. * @returns "SubSurfaceScatteringPostProcess" string
  25177. */
  25178. getClassName(): string;
  25179. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  25180. }
  25181. }
  25182. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  25183. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25184. /**
  25185. * Interface for defining prepass effects in the prepass post-process pipeline
  25186. */
  25187. export interface PrePassEffectConfiguration {
  25188. /**
  25189. * Post process to attach for this effect
  25190. */
  25191. postProcess: PostProcess;
  25192. /**
  25193. * Is the effect enabled
  25194. */
  25195. enabled: boolean;
  25196. /**
  25197. * Disposes the effect configuration
  25198. */
  25199. dispose(): void;
  25200. /**
  25201. * Disposes the effect configuration
  25202. */
  25203. createPostProcess: () => PostProcess;
  25204. }
  25205. }
  25206. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  25207. import { Scene } from "babylonjs/scene";
  25208. import { Color3 } from "babylonjs/Maths/math.color";
  25209. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  25210. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25211. /**
  25212. * Contains all parameters needed for the prepass to perform
  25213. * screen space subsurface scattering
  25214. */
  25215. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  25216. private _ssDiffusionS;
  25217. private _ssFilterRadii;
  25218. private _ssDiffusionD;
  25219. /**
  25220. * Post process to attach for screen space subsurface scattering
  25221. */
  25222. postProcess: SubSurfaceScatteringPostProcess;
  25223. /**
  25224. * Diffusion profile color for subsurface scattering
  25225. */
  25226. get ssDiffusionS(): number[];
  25227. /**
  25228. * Diffusion profile max color channel value for subsurface scattering
  25229. */
  25230. get ssDiffusionD(): number[];
  25231. /**
  25232. * Diffusion profile filter radius for subsurface scattering
  25233. */
  25234. get ssFilterRadii(): number[];
  25235. /**
  25236. * Is subsurface enabled
  25237. */
  25238. enabled: boolean;
  25239. /**
  25240. * Diffusion profile colors for subsurface scattering
  25241. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  25242. * See ...
  25243. * Note that you can only store up to 5 of them
  25244. */
  25245. ssDiffusionProfileColors: Color3[];
  25246. /**
  25247. * Defines the ratio real world => scene units.
  25248. * Used for subsurface scattering
  25249. */
  25250. metersPerUnit: number;
  25251. private _scene;
  25252. /**
  25253. * Builds a subsurface configuration object
  25254. * @param scene The scene
  25255. */
  25256. constructor(scene: Scene);
  25257. /**
  25258. * Adds a new diffusion profile.
  25259. * Useful for more realistic subsurface scattering on diverse materials.
  25260. * @param color The color of the diffusion profile. Should be the average color of the material.
  25261. * @return The index of the diffusion profile for the material subsurface configuration
  25262. */
  25263. addDiffusionProfile(color: Color3): number;
  25264. /**
  25265. * Creates the sss post process
  25266. * @return The created post process
  25267. */
  25268. createPostProcess(): SubSurfaceScatteringPostProcess;
  25269. /**
  25270. * Deletes all diffusion profiles.
  25271. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  25272. */
  25273. clearAllDiffusionProfiles(): void;
  25274. /**
  25275. * Disposes this object
  25276. */
  25277. dispose(): void;
  25278. /**
  25279. * @hidden
  25280. * https://zero-radiance.github.io/post/sampling-diffusion/
  25281. *
  25282. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  25283. * ------------------------------------------------------------------------------------
  25284. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  25285. * PDF[r, phi, s] = r * R[r, phi, s]
  25286. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  25287. * ------------------------------------------------------------------------------------
  25288. * We importance sample the color channel with the widest scattering distance.
  25289. */
  25290. getDiffusionProfileParameters(color: Color3): number;
  25291. /**
  25292. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  25293. * 'u' is the random number (the value of the CDF): [0, 1).
  25294. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  25295. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  25296. */
  25297. private _sampleBurleyDiffusionProfile;
  25298. }
  25299. }
  25300. declare module "babylonjs/Rendering/prePassRenderer" {
  25301. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25302. import { Scene } from "babylonjs/scene";
  25303. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25304. import { Effect } from "babylonjs/Materials/effect";
  25305. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  25306. /**
  25307. * Renders a pre pass of the scene
  25308. * This means every mesh in the scene will be rendered to a render target texture
  25309. * And then this texture will be composited to the rendering canvas with post processes
  25310. * It is necessary for effects like subsurface scattering or deferred shading
  25311. */
  25312. export class PrePassRenderer {
  25313. /** @hidden */
  25314. static _SceneComponentInitialization: (scene: Scene) => void;
  25315. private _scene;
  25316. private _engine;
  25317. private _isDirty;
  25318. /**
  25319. * Number of textures in the multi render target texture where the scene is directly rendered
  25320. */
  25321. readonly mrtCount: number;
  25322. /**
  25323. * The render target where the scene is directly rendered
  25324. */
  25325. prePassRT: MultiRenderTarget;
  25326. private _mrtTypes;
  25327. private _multiRenderAttachments;
  25328. private _defaultAttachments;
  25329. private _clearAttachments;
  25330. private _postProcesses;
  25331. private readonly _clearColor;
  25332. /**
  25333. * Image processing post process for composition
  25334. */
  25335. imageProcessingPostProcess: ImageProcessingPostProcess;
  25336. /**
  25337. * Configuration for sub surface scattering post process
  25338. */
  25339. subSurfaceConfiguration: SubSurfaceConfiguration;
  25340. /**
  25341. * Should materials render their geometry on the MRT
  25342. */
  25343. materialsShouldRenderGeometry: boolean;
  25344. /**
  25345. * Should materials render the irradiance information on the MRT
  25346. */
  25347. materialsShouldRenderIrradiance: boolean;
  25348. private _enabled;
  25349. /**
  25350. * Indicates if the prepass is enabled
  25351. */
  25352. get enabled(): boolean;
  25353. /**
  25354. * How many samples are used for MSAA of the scene render target
  25355. */
  25356. get samples(): number;
  25357. set samples(n: number);
  25358. /**
  25359. * Instanciates a prepass renderer
  25360. * @param scene The scene
  25361. */
  25362. constructor(scene: Scene);
  25363. private _initializeAttachments;
  25364. private _createCompositionEffect;
  25365. /**
  25366. * Indicates if rendering a prepass is supported
  25367. */
  25368. get isSupported(): boolean;
  25369. /**
  25370. * Sets the proper output textures to draw in the engine.
  25371. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25372. */
  25373. bindAttachmentsForEffect(effect: Effect): void;
  25374. /**
  25375. * @hidden
  25376. */
  25377. _beforeCameraDraw(): void;
  25378. /**
  25379. * @hidden
  25380. */
  25381. _afterCameraDraw(): void;
  25382. private _checkRTSize;
  25383. private _bindFrameBuffer;
  25384. /**
  25385. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25386. */
  25387. clear(): void;
  25388. private _setState;
  25389. private _enable;
  25390. private _disable;
  25391. private _resetPostProcessChain;
  25392. private _bindPostProcessChain;
  25393. /**
  25394. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25395. */
  25396. markAsDirty(): void;
  25397. private _update;
  25398. /**
  25399. * Disposes the prepass renderer.
  25400. */
  25401. dispose(): void;
  25402. }
  25403. }
  25404. declare module "babylonjs/Materials/material" {
  25405. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25406. import { SmartArray } from "babylonjs/Misc/smartArray";
  25407. import { Observable } from "babylonjs/Misc/observable";
  25408. import { Nullable } from "babylonjs/types";
  25409. import { Scene } from "babylonjs/scene";
  25410. import { Matrix } from "babylonjs/Maths/math.vector";
  25411. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25412. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25413. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25414. import { Effect } from "babylonjs/Materials/effect";
  25415. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25416. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25417. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25418. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25419. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25420. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25421. import { Mesh } from "babylonjs/Meshes/mesh";
  25422. import { Animation } from "babylonjs/Animations/animation";
  25423. /**
  25424. * Options for compiling materials.
  25425. */
  25426. export interface IMaterialCompilationOptions {
  25427. /**
  25428. * Defines whether clip planes are enabled.
  25429. */
  25430. clipPlane: boolean;
  25431. /**
  25432. * Defines whether instances are enabled.
  25433. */
  25434. useInstances: boolean;
  25435. }
  25436. /**
  25437. * Options passed when calling customShaderNameResolve
  25438. */
  25439. export interface ICustomShaderNameResolveOptions {
  25440. /**
  25441. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  25442. */
  25443. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25444. }
  25445. /**
  25446. * Base class for the main features of a material in Babylon.js
  25447. */
  25448. export class Material implements IAnimatable {
  25449. /**
  25450. * Returns the triangle fill mode
  25451. */
  25452. static readonly TriangleFillMode: number;
  25453. /**
  25454. * Returns the wireframe mode
  25455. */
  25456. static readonly WireFrameFillMode: number;
  25457. /**
  25458. * Returns the point fill mode
  25459. */
  25460. static readonly PointFillMode: number;
  25461. /**
  25462. * Returns the point list draw mode
  25463. */
  25464. static readonly PointListDrawMode: number;
  25465. /**
  25466. * Returns the line list draw mode
  25467. */
  25468. static readonly LineListDrawMode: number;
  25469. /**
  25470. * Returns the line loop draw mode
  25471. */
  25472. static readonly LineLoopDrawMode: number;
  25473. /**
  25474. * Returns the line strip draw mode
  25475. */
  25476. static readonly LineStripDrawMode: number;
  25477. /**
  25478. * Returns the triangle strip draw mode
  25479. */
  25480. static readonly TriangleStripDrawMode: number;
  25481. /**
  25482. * Returns the triangle fan draw mode
  25483. */
  25484. static readonly TriangleFanDrawMode: number;
  25485. /**
  25486. * Stores the clock-wise side orientation
  25487. */
  25488. static readonly ClockWiseSideOrientation: number;
  25489. /**
  25490. * Stores the counter clock-wise side orientation
  25491. */
  25492. static readonly CounterClockWiseSideOrientation: number;
  25493. /**
  25494. * The dirty texture flag value
  25495. */
  25496. static readonly TextureDirtyFlag: number;
  25497. /**
  25498. * The dirty light flag value
  25499. */
  25500. static readonly LightDirtyFlag: number;
  25501. /**
  25502. * The dirty fresnel flag value
  25503. */
  25504. static readonly FresnelDirtyFlag: number;
  25505. /**
  25506. * The dirty attribute flag value
  25507. */
  25508. static readonly AttributesDirtyFlag: number;
  25509. /**
  25510. * The dirty misc flag value
  25511. */
  25512. static readonly MiscDirtyFlag: number;
  25513. /**
  25514. * The all dirty flag value
  25515. */
  25516. static readonly AllDirtyFlag: number;
  25517. /**
  25518. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25519. */
  25520. static readonly MATERIAL_OPAQUE: number;
  25521. /**
  25522. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25523. */
  25524. static readonly MATERIAL_ALPHATEST: number;
  25525. /**
  25526. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25527. */
  25528. static readonly MATERIAL_ALPHABLEND: number;
  25529. /**
  25530. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25531. * They are also discarded below the alpha cutoff threshold to improve performances.
  25532. */
  25533. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25534. /**
  25535. * The Whiteout method is used to blend normals.
  25536. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25537. */
  25538. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25539. /**
  25540. * The Reoriented Normal Mapping method is used to blend normals.
  25541. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25542. */
  25543. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25544. /**
  25545. * Custom callback helping to override the default shader used in the material.
  25546. */
  25547. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25548. /**
  25549. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25550. */
  25551. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25552. /**
  25553. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25554. * This means that the material can keep using a previous shader while a new one is being compiled.
  25555. * This is mostly used when shader parallel compilation is supported (true by default)
  25556. */
  25557. allowShaderHotSwapping: boolean;
  25558. /**
  25559. * The ID of the material
  25560. */
  25561. id: string;
  25562. /**
  25563. * Gets or sets the unique id of the material
  25564. */
  25565. uniqueId: number;
  25566. /**
  25567. * The name of the material
  25568. */
  25569. name: string;
  25570. /**
  25571. * Gets or sets user defined metadata
  25572. */
  25573. metadata: any;
  25574. /**
  25575. * For internal use only. Please do not use.
  25576. */
  25577. reservedDataStore: any;
  25578. /**
  25579. * Specifies if the ready state should be checked on each call
  25580. */
  25581. checkReadyOnEveryCall: boolean;
  25582. /**
  25583. * Specifies if the ready state should be checked once
  25584. */
  25585. checkReadyOnlyOnce: boolean;
  25586. /**
  25587. * The state of the material
  25588. */
  25589. state: string;
  25590. /**
  25591. * If the material can be rendered to several textures with MRT extension
  25592. */
  25593. get canRenderToMRT(): boolean;
  25594. /**
  25595. * The alpha value of the material
  25596. */
  25597. protected _alpha: number;
  25598. /**
  25599. * List of inspectable custom properties (used by the Inspector)
  25600. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25601. */
  25602. inspectableCustomProperties: IInspectable[];
  25603. /**
  25604. * Sets the alpha value of the material
  25605. */
  25606. set alpha(value: number);
  25607. /**
  25608. * Gets the alpha value of the material
  25609. */
  25610. get alpha(): number;
  25611. /**
  25612. * Specifies if back face culling is enabled
  25613. */
  25614. protected _backFaceCulling: boolean;
  25615. /**
  25616. * Sets the back-face culling state
  25617. */
  25618. set backFaceCulling(value: boolean);
  25619. /**
  25620. * Gets the back-face culling state
  25621. */
  25622. get backFaceCulling(): boolean;
  25623. /**
  25624. * Stores the value for side orientation
  25625. */
  25626. sideOrientation: number;
  25627. /**
  25628. * Callback triggered when the material is compiled
  25629. */
  25630. onCompiled: Nullable<(effect: Effect) => void>;
  25631. /**
  25632. * Callback triggered when an error occurs
  25633. */
  25634. onError: Nullable<(effect: Effect, errors: string) => void>;
  25635. /**
  25636. * Callback triggered to get the render target textures
  25637. */
  25638. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25639. /**
  25640. * Gets a boolean indicating that current material needs to register RTT
  25641. */
  25642. get hasRenderTargetTextures(): boolean;
  25643. /**
  25644. * Specifies if the material should be serialized
  25645. */
  25646. doNotSerialize: boolean;
  25647. /**
  25648. * @hidden
  25649. */
  25650. _storeEffectOnSubMeshes: boolean;
  25651. /**
  25652. * Stores the animations for the material
  25653. */
  25654. animations: Nullable<Array<Animation>>;
  25655. /**
  25656. * An event triggered when the material is disposed
  25657. */
  25658. onDisposeObservable: Observable<Material>;
  25659. /**
  25660. * An observer which watches for dispose events
  25661. */
  25662. private _onDisposeObserver;
  25663. private _onUnBindObservable;
  25664. /**
  25665. * Called during a dispose event
  25666. */
  25667. set onDispose(callback: () => void);
  25668. private _onBindObservable;
  25669. /**
  25670. * An event triggered when the material is bound
  25671. */
  25672. get onBindObservable(): Observable<AbstractMesh>;
  25673. /**
  25674. * An observer which watches for bind events
  25675. */
  25676. private _onBindObserver;
  25677. /**
  25678. * Called during a bind event
  25679. */
  25680. set onBind(callback: (Mesh: AbstractMesh) => void);
  25681. /**
  25682. * An event triggered when the material is unbound
  25683. */
  25684. get onUnBindObservable(): Observable<Material>;
  25685. protected _onEffectCreatedObservable: Nullable<Observable<{
  25686. effect: Effect;
  25687. subMesh: Nullable<SubMesh>;
  25688. }>>;
  25689. /**
  25690. * An event triggered when the effect is (re)created
  25691. */
  25692. get onEffectCreatedObservable(): Observable<{
  25693. effect: Effect;
  25694. subMesh: Nullable<SubMesh>;
  25695. }>;
  25696. /**
  25697. * Stores the value of the alpha mode
  25698. */
  25699. private _alphaMode;
  25700. /**
  25701. * Sets the value of the alpha mode.
  25702. *
  25703. * | Value | Type | Description |
  25704. * | --- | --- | --- |
  25705. * | 0 | ALPHA_DISABLE | |
  25706. * | 1 | ALPHA_ADD | |
  25707. * | 2 | ALPHA_COMBINE | |
  25708. * | 3 | ALPHA_SUBTRACT | |
  25709. * | 4 | ALPHA_MULTIPLY | |
  25710. * | 5 | ALPHA_MAXIMIZED | |
  25711. * | 6 | ALPHA_ONEONE | |
  25712. * | 7 | ALPHA_PREMULTIPLIED | |
  25713. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25714. * | 9 | ALPHA_INTERPOLATE | |
  25715. * | 10 | ALPHA_SCREENMODE | |
  25716. *
  25717. */
  25718. set alphaMode(value: number);
  25719. /**
  25720. * Gets the value of the alpha mode
  25721. */
  25722. get alphaMode(): number;
  25723. /**
  25724. * Stores the state of the need depth pre-pass value
  25725. */
  25726. private _needDepthPrePass;
  25727. /**
  25728. * Sets the need depth pre-pass value
  25729. */
  25730. set needDepthPrePass(value: boolean);
  25731. /**
  25732. * Gets the depth pre-pass value
  25733. */
  25734. get needDepthPrePass(): boolean;
  25735. /**
  25736. * Specifies if depth writing should be disabled
  25737. */
  25738. disableDepthWrite: boolean;
  25739. /**
  25740. * Specifies if color writing should be disabled
  25741. */
  25742. disableColorWrite: boolean;
  25743. /**
  25744. * Specifies if depth writing should be forced
  25745. */
  25746. forceDepthWrite: boolean;
  25747. /**
  25748. * Specifies the depth function that should be used. 0 means the default engine function
  25749. */
  25750. depthFunction: number;
  25751. /**
  25752. * Specifies if there should be a separate pass for culling
  25753. */
  25754. separateCullingPass: boolean;
  25755. /**
  25756. * Stores the state specifing if fog should be enabled
  25757. */
  25758. private _fogEnabled;
  25759. /**
  25760. * Sets the state for enabling fog
  25761. */
  25762. set fogEnabled(value: boolean);
  25763. /**
  25764. * Gets the value of the fog enabled state
  25765. */
  25766. get fogEnabled(): boolean;
  25767. /**
  25768. * Stores the size of points
  25769. */
  25770. pointSize: number;
  25771. /**
  25772. * Stores the z offset value
  25773. */
  25774. zOffset: number;
  25775. get wireframe(): boolean;
  25776. /**
  25777. * Sets the state of wireframe mode
  25778. */
  25779. set wireframe(value: boolean);
  25780. /**
  25781. * Gets the value specifying if point clouds are enabled
  25782. */
  25783. get pointsCloud(): boolean;
  25784. /**
  25785. * Sets the state of point cloud mode
  25786. */
  25787. set pointsCloud(value: boolean);
  25788. /**
  25789. * Gets the material fill mode
  25790. */
  25791. get fillMode(): number;
  25792. /**
  25793. * Sets the material fill mode
  25794. */
  25795. set fillMode(value: number);
  25796. /**
  25797. * @hidden
  25798. * Stores the effects for the material
  25799. */
  25800. _effect: Nullable<Effect>;
  25801. /**
  25802. * Specifies if uniform buffers should be used
  25803. */
  25804. private _useUBO;
  25805. /**
  25806. * Stores a reference to the scene
  25807. */
  25808. private _scene;
  25809. /**
  25810. * Stores the fill mode state
  25811. */
  25812. private _fillMode;
  25813. /**
  25814. * Specifies if the depth write state should be cached
  25815. */
  25816. private _cachedDepthWriteState;
  25817. /**
  25818. * Specifies if the color write state should be cached
  25819. */
  25820. private _cachedColorWriteState;
  25821. /**
  25822. * Specifies if the depth function state should be cached
  25823. */
  25824. private _cachedDepthFunctionState;
  25825. /**
  25826. * Stores the uniform buffer
  25827. */
  25828. protected _uniformBuffer: UniformBuffer;
  25829. /** @hidden */
  25830. _indexInSceneMaterialArray: number;
  25831. /** @hidden */
  25832. meshMap: Nullable<{
  25833. [id: string]: AbstractMesh | undefined;
  25834. }>;
  25835. /**
  25836. * Creates a material instance
  25837. * @param name defines the name of the material
  25838. * @param scene defines the scene to reference
  25839. * @param doNotAdd specifies if the material should be added to the scene
  25840. */
  25841. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25842. /**
  25843. * Returns a string representation of the current material
  25844. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25845. * @returns a string with material information
  25846. */
  25847. toString(fullDetails?: boolean): string;
  25848. /**
  25849. * Gets the class name of the material
  25850. * @returns a string with the class name of the material
  25851. */
  25852. getClassName(): string;
  25853. /**
  25854. * Specifies if updates for the material been locked
  25855. */
  25856. get isFrozen(): boolean;
  25857. /**
  25858. * Locks updates for the material
  25859. */
  25860. freeze(): void;
  25861. /**
  25862. * Unlocks updates for the material
  25863. */
  25864. unfreeze(): void;
  25865. /**
  25866. * Specifies if the material is ready to be used
  25867. * @param mesh defines the mesh to check
  25868. * @param useInstances specifies if instances should be used
  25869. * @returns a boolean indicating if the material is ready to be used
  25870. */
  25871. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25872. /**
  25873. * Specifies that the submesh is ready to be used
  25874. * @param mesh defines the mesh to check
  25875. * @param subMesh defines which submesh to check
  25876. * @param useInstances specifies that instances should be used
  25877. * @returns a boolean indicating that the submesh is ready or not
  25878. */
  25879. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25880. /**
  25881. * Returns the material effect
  25882. * @returns the effect associated with the material
  25883. */
  25884. getEffect(): Nullable<Effect>;
  25885. /**
  25886. * Returns the current scene
  25887. * @returns a Scene
  25888. */
  25889. getScene(): Scene;
  25890. /**
  25891. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25892. */
  25893. protected _forceAlphaTest: boolean;
  25894. /**
  25895. * The transparency mode of the material.
  25896. */
  25897. protected _transparencyMode: Nullable<number>;
  25898. /**
  25899. * Gets the current transparency mode.
  25900. */
  25901. get transparencyMode(): Nullable<number>;
  25902. /**
  25903. * Sets the transparency mode of the material.
  25904. *
  25905. * | Value | Type | Description |
  25906. * | ----- | ----------------------------------- | ----------- |
  25907. * | 0 | OPAQUE | |
  25908. * | 1 | ALPHATEST | |
  25909. * | 2 | ALPHABLEND | |
  25910. * | 3 | ALPHATESTANDBLEND | |
  25911. *
  25912. */
  25913. set transparencyMode(value: Nullable<number>);
  25914. /**
  25915. * Returns true if alpha blending should be disabled.
  25916. */
  25917. protected get _disableAlphaBlending(): boolean;
  25918. /**
  25919. * Specifies whether or not this material should be rendered in alpha blend mode.
  25920. * @returns a boolean specifying if alpha blending is needed
  25921. */
  25922. needAlphaBlending(): boolean;
  25923. /**
  25924. * Specifies if the mesh will require alpha blending
  25925. * @param mesh defines the mesh to check
  25926. * @returns a boolean specifying if alpha blending is needed for the mesh
  25927. */
  25928. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25929. /**
  25930. * Specifies whether or not this material should be rendered in alpha test mode.
  25931. * @returns a boolean specifying if an alpha test is needed.
  25932. */
  25933. needAlphaTesting(): boolean;
  25934. /**
  25935. * Specifies if material alpha testing should be turned on for the mesh
  25936. * @param mesh defines the mesh to check
  25937. */
  25938. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  25939. /**
  25940. * Gets the texture used for the alpha test
  25941. * @returns the texture to use for alpha testing
  25942. */
  25943. getAlphaTestTexture(): Nullable<BaseTexture>;
  25944. /**
  25945. * Marks the material to indicate that it needs to be re-calculated
  25946. */
  25947. markDirty(): void;
  25948. /** @hidden */
  25949. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  25950. /**
  25951. * Binds the material to the mesh
  25952. * @param world defines the world transformation matrix
  25953. * @param mesh defines the mesh to bind the material to
  25954. */
  25955. bind(world: Matrix, mesh?: Mesh): void;
  25956. /**
  25957. * Binds the submesh to the material
  25958. * @param world defines the world transformation matrix
  25959. * @param mesh defines the mesh containing the submesh
  25960. * @param subMesh defines the submesh to bind the material to
  25961. */
  25962. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25963. /**
  25964. * Binds the world matrix to the material
  25965. * @param world defines the world transformation matrix
  25966. */
  25967. bindOnlyWorldMatrix(world: Matrix): void;
  25968. /**
  25969. * Binds the scene's uniform buffer to the effect.
  25970. * @param effect defines the effect to bind to the scene uniform buffer
  25971. * @param sceneUbo defines the uniform buffer storing scene data
  25972. */
  25973. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  25974. /**
  25975. * Binds the view matrix to the effect
  25976. * @param effect defines the effect to bind the view matrix to
  25977. */
  25978. bindView(effect: Effect): void;
  25979. /**
  25980. * Binds the view projection matrix to the effect
  25981. * @param effect defines the effect to bind the view projection matrix to
  25982. */
  25983. bindViewProjection(effect: Effect): void;
  25984. /**
  25985. * Processes to execute after binding the material to a mesh
  25986. * @param mesh defines the rendered mesh
  25987. */
  25988. protected _afterBind(mesh?: Mesh): void;
  25989. /**
  25990. * Unbinds the material from the mesh
  25991. */
  25992. unbind(): void;
  25993. /**
  25994. * Gets the active textures from the material
  25995. * @returns an array of textures
  25996. */
  25997. getActiveTextures(): BaseTexture[];
  25998. /**
  25999. * Specifies if the material uses a texture
  26000. * @param texture defines the texture to check against the material
  26001. * @returns a boolean specifying if the material uses the texture
  26002. */
  26003. hasTexture(texture: BaseTexture): boolean;
  26004. /**
  26005. * Makes a duplicate of the material, and gives it a new name
  26006. * @param name defines the new name for the duplicated material
  26007. * @returns the cloned material
  26008. */
  26009. clone(name: string): Nullable<Material>;
  26010. /**
  26011. * Gets the meshes bound to the material
  26012. * @returns an array of meshes bound to the material
  26013. */
  26014. getBindedMeshes(): AbstractMesh[];
  26015. /**
  26016. * Force shader compilation
  26017. * @param mesh defines the mesh associated with this material
  26018. * @param onCompiled defines a function to execute once the material is compiled
  26019. * @param options defines the options to configure the compilation
  26020. * @param onError defines a function to execute if the material fails compiling
  26021. */
  26022. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  26023. /**
  26024. * Force shader compilation
  26025. * @param mesh defines the mesh that will use this material
  26026. * @param options defines additional options for compiling the shaders
  26027. * @returns a promise that resolves when the compilation completes
  26028. */
  26029. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  26030. private static readonly _AllDirtyCallBack;
  26031. private static readonly _ImageProcessingDirtyCallBack;
  26032. private static readonly _TextureDirtyCallBack;
  26033. private static readonly _FresnelDirtyCallBack;
  26034. private static readonly _MiscDirtyCallBack;
  26035. private static readonly _LightsDirtyCallBack;
  26036. private static readonly _AttributeDirtyCallBack;
  26037. private static _FresnelAndMiscDirtyCallBack;
  26038. private static _TextureAndMiscDirtyCallBack;
  26039. private static readonly _DirtyCallbackArray;
  26040. private static readonly _RunDirtyCallBacks;
  26041. /**
  26042. * Marks a define in the material to indicate that it needs to be re-computed
  26043. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  26044. */
  26045. markAsDirty(flag: number): void;
  26046. /**
  26047. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  26048. * @param func defines a function which checks material defines against the submeshes
  26049. */
  26050. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  26051. /**
  26052. * Indicates that the scene should check if the rendering now needs a prepass
  26053. */
  26054. protected _markScenePrePassDirty(): void;
  26055. /**
  26056. * Indicates that we need to re-calculated for all submeshes
  26057. */
  26058. protected _markAllSubMeshesAsAllDirty(): void;
  26059. /**
  26060. * Indicates that image processing needs to be re-calculated for all submeshes
  26061. */
  26062. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  26063. /**
  26064. * Indicates that textures need to be re-calculated for all submeshes
  26065. */
  26066. protected _markAllSubMeshesAsTexturesDirty(): void;
  26067. /**
  26068. * Indicates that fresnel needs to be re-calculated for all submeshes
  26069. */
  26070. protected _markAllSubMeshesAsFresnelDirty(): void;
  26071. /**
  26072. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  26073. */
  26074. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  26075. /**
  26076. * Indicates that lights need to be re-calculated for all submeshes
  26077. */
  26078. protected _markAllSubMeshesAsLightsDirty(): void;
  26079. /**
  26080. * Indicates that attributes need to be re-calculated for all submeshes
  26081. */
  26082. protected _markAllSubMeshesAsAttributesDirty(): void;
  26083. /**
  26084. * Indicates that misc needs to be re-calculated for all submeshes
  26085. */
  26086. protected _markAllSubMeshesAsMiscDirty(): void;
  26087. /**
  26088. * Indicates that textures and misc need to be re-calculated for all submeshes
  26089. */
  26090. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  26091. /**
  26092. * Sets the required values to the prepass renderer.
  26093. * @param prePassRenderer defines the prepass renderer to setup.
  26094. * @returns true if the pre pass is needed.
  26095. */
  26096. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  26097. /**
  26098. * Disposes the material
  26099. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  26100. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  26101. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  26102. */
  26103. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  26104. /** @hidden */
  26105. private releaseVertexArrayObject;
  26106. /**
  26107. * Serializes this material
  26108. * @returns the serialized material object
  26109. */
  26110. serialize(): any;
  26111. /**
  26112. * Creates a material from parsed material data
  26113. * @param parsedMaterial defines parsed material data
  26114. * @param scene defines the hosting scene
  26115. * @param rootUrl defines the root URL to use to load textures
  26116. * @returns a new material
  26117. */
  26118. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  26119. }
  26120. }
  26121. declare module "babylonjs/Materials/multiMaterial" {
  26122. import { Nullable } from "babylonjs/types";
  26123. import { Scene } from "babylonjs/scene";
  26124. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26125. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26126. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26127. import { Material } from "babylonjs/Materials/material";
  26128. /**
  26129. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26130. * separate meshes. This can be use to improve performances.
  26131. * @see https://doc.babylonjs.com/how_to/multi_materials
  26132. */
  26133. export class MultiMaterial extends Material {
  26134. private _subMaterials;
  26135. /**
  26136. * Gets or Sets the list of Materials used within the multi material.
  26137. * They need to be ordered according to the submeshes order in the associated mesh
  26138. */
  26139. get subMaterials(): Nullable<Material>[];
  26140. set subMaterials(value: Nullable<Material>[]);
  26141. /**
  26142. * Function used to align with Node.getChildren()
  26143. * @returns the list of Materials used within the multi material
  26144. */
  26145. getChildren(): Nullable<Material>[];
  26146. /**
  26147. * Instantiates a new Multi Material
  26148. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26149. * separate meshes. This can be use to improve performances.
  26150. * @see https://doc.babylonjs.com/how_to/multi_materials
  26151. * @param name Define the name in the scene
  26152. * @param scene Define the scene the material belongs to
  26153. */
  26154. constructor(name: string, scene: Scene);
  26155. private _hookArray;
  26156. /**
  26157. * Get one of the submaterial by its index in the submaterials array
  26158. * @param index The index to look the sub material at
  26159. * @returns The Material if the index has been defined
  26160. */
  26161. getSubMaterial(index: number): Nullable<Material>;
  26162. /**
  26163. * Get the list of active textures for the whole sub materials list.
  26164. * @returns All the textures that will be used during the rendering
  26165. */
  26166. getActiveTextures(): BaseTexture[];
  26167. /**
  26168. * Gets the current class name of the material e.g. "MultiMaterial"
  26169. * Mainly use in serialization.
  26170. * @returns the class name
  26171. */
  26172. getClassName(): string;
  26173. /**
  26174. * Checks if the material is ready to render the requested sub mesh
  26175. * @param mesh Define the mesh the submesh belongs to
  26176. * @param subMesh Define the sub mesh to look readyness for
  26177. * @param useInstances Define whether or not the material is used with instances
  26178. * @returns true if ready, otherwise false
  26179. */
  26180. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  26181. /**
  26182. * Clones the current material and its related sub materials
  26183. * @param name Define the name of the newly cloned material
  26184. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  26185. * @returns the cloned material
  26186. */
  26187. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  26188. /**
  26189. * Serializes the materials into a JSON representation.
  26190. * @returns the JSON representation
  26191. */
  26192. serialize(): any;
  26193. /**
  26194. * Dispose the material and release its associated resources
  26195. * @param forceDisposeEffect Define if we want to force disposing the associated effect (if false the shader is not released and could be reuse later on)
  26196. * @param forceDisposeTextures Define if we want to force disposing the associated textures (if false, they will not be disposed and can still be use elsewhere in the app)
  26197. * @param forceDisposeChildren Define if we want to force disposing the associated submaterials (if false, they will not be disposed and can still be use elsewhere in the app)
  26198. */
  26199. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26200. /**
  26201. * Creates a MultiMaterial from parsed MultiMaterial data.
  26202. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26203. * @param scene defines the hosting scene
  26204. * @returns a new MultiMaterial
  26205. */
  26206. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26207. }
  26208. }
  26209. declare module "babylonjs/Meshes/subMesh" {
  26210. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26211. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26212. import { Engine } from "babylonjs/Engines/engine";
  26213. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26214. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26215. import { Effect } from "babylonjs/Materials/effect";
  26216. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26217. import { Plane } from "babylonjs/Maths/math.plane";
  26218. import { Collider } from "babylonjs/Collisions/collider";
  26219. import { Material } from "babylonjs/Materials/material";
  26220. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26221. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26222. import { Mesh } from "babylonjs/Meshes/mesh";
  26223. import { Ray } from "babylonjs/Culling/ray";
  26224. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26225. /**
  26226. * Defines a subdivision inside a mesh
  26227. */
  26228. export class SubMesh implements ICullable {
  26229. /** the material index to use */
  26230. materialIndex: number;
  26231. /** vertex index start */
  26232. verticesStart: number;
  26233. /** vertices count */
  26234. verticesCount: number;
  26235. /** index start */
  26236. indexStart: number;
  26237. /** indices count */
  26238. indexCount: number;
  26239. /** @hidden */
  26240. _materialDefines: Nullable<MaterialDefines>;
  26241. /** @hidden */
  26242. _materialEffect: Nullable<Effect>;
  26243. /** @hidden */
  26244. _effectOverride: Nullable<Effect>;
  26245. /**
  26246. * Gets material defines used by the effect associated to the sub mesh
  26247. */
  26248. get materialDefines(): Nullable<MaterialDefines>;
  26249. /**
  26250. * Sets material defines used by the effect associated to the sub mesh
  26251. */
  26252. set materialDefines(defines: Nullable<MaterialDefines>);
  26253. /**
  26254. * Gets associated effect
  26255. */
  26256. get effect(): Nullable<Effect>;
  26257. /**
  26258. * Sets associated effect (effect used to render this submesh)
  26259. * @param effect defines the effect to associate with
  26260. * @param defines defines the set of defines used to compile this effect
  26261. */
  26262. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26263. /** @hidden */
  26264. _linesIndexCount: number;
  26265. private _mesh;
  26266. private _renderingMesh;
  26267. private _boundingInfo;
  26268. private _linesIndexBuffer;
  26269. /** @hidden */
  26270. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26271. /** @hidden */
  26272. _trianglePlanes: Plane[];
  26273. /** @hidden */
  26274. _lastColliderTransformMatrix: Nullable<Matrix>;
  26275. /** @hidden */
  26276. _renderId: number;
  26277. /** @hidden */
  26278. _alphaIndex: number;
  26279. /** @hidden */
  26280. _distanceToCamera: number;
  26281. /** @hidden */
  26282. _id: number;
  26283. private _currentMaterial;
  26284. /**
  26285. * Add a new submesh to a mesh
  26286. * @param materialIndex defines the material index to use
  26287. * @param verticesStart defines vertex index start
  26288. * @param verticesCount defines vertices count
  26289. * @param indexStart defines index start
  26290. * @param indexCount defines indices count
  26291. * @param mesh defines the parent mesh
  26292. * @param renderingMesh defines an optional rendering mesh
  26293. * @param createBoundingBox defines if bounding box should be created for this submesh
  26294. * @returns the new submesh
  26295. */
  26296. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26297. /**
  26298. * Creates a new submesh
  26299. * @param materialIndex defines the material index to use
  26300. * @param verticesStart defines vertex index start
  26301. * @param verticesCount defines vertices count
  26302. * @param indexStart defines index start
  26303. * @param indexCount defines indices count
  26304. * @param mesh defines the parent mesh
  26305. * @param renderingMesh defines an optional rendering mesh
  26306. * @param createBoundingBox defines if bounding box should be created for this submesh
  26307. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26308. */
  26309. constructor(
  26310. /** the material index to use */
  26311. materialIndex: number,
  26312. /** vertex index start */
  26313. verticesStart: number,
  26314. /** vertices count */
  26315. verticesCount: number,
  26316. /** index start */
  26317. indexStart: number,
  26318. /** indices count */
  26319. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26320. /**
  26321. * Returns true if this submesh covers the entire parent mesh
  26322. * @ignorenaming
  26323. */
  26324. get IsGlobal(): boolean;
  26325. /**
  26326. * Returns the submesh BoudingInfo object
  26327. * @returns current bounding info (or mesh's one if the submesh is global)
  26328. */
  26329. getBoundingInfo(): BoundingInfo;
  26330. /**
  26331. * Sets the submesh BoundingInfo
  26332. * @param boundingInfo defines the new bounding info to use
  26333. * @returns the SubMesh
  26334. */
  26335. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26336. /**
  26337. * Returns the mesh of the current submesh
  26338. * @return the parent mesh
  26339. */
  26340. getMesh(): AbstractMesh;
  26341. /**
  26342. * Returns the rendering mesh of the submesh
  26343. * @returns the rendering mesh (could be different from parent mesh)
  26344. */
  26345. getRenderingMesh(): Mesh;
  26346. /**
  26347. * Returns the replacement mesh of the submesh
  26348. * @returns the replacement mesh (could be different from parent mesh)
  26349. */
  26350. getReplacementMesh(): Nullable<AbstractMesh>;
  26351. /**
  26352. * Returns the effective mesh of the submesh
  26353. * @returns the effective mesh (could be different from parent mesh)
  26354. */
  26355. getEffectiveMesh(): AbstractMesh;
  26356. /**
  26357. * Returns the submesh material
  26358. * @returns null or the current material
  26359. */
  26360. getMaterial(): Nullable<Material>;
  26361. private _IsMultiMaterial;
  26362. /**
  26363. * Sets a new updated BoundingInfo object to the submesh
  26364. * @param data defines an optional position array to use to determine the bounding info
  26365. * @returns the SubMesh
  26366. */
  26367. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26368. /** @hidden */
  26369. _checkCollision(collider: Collider): boolean;
  26370. /**
  26371. * Updates the submesh BoundingInfo
  26372. * @param world defines the world matrix to use to update the bounding info
  26373. * @returns the submesh
  26374. */
  26375. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26376. /**
  26377. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26378. * @param frustumPlanes defines the frustum planes
  26379. * @returns true if the submesh is intersecting with the frustum
  26380. */
  26381. isInFrustum(frustumPlanes: Plane[]): boolean;
  26382. /**
  26383. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26384. * @param frustumPlanes defines the frustum planes
  26385. * @returns true if the submesh is inside the frustum
  26386. */
  26387. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26388. /**
  26389. * Renders the submesh
  26390. * @param enableAlphaMode defines if alpha needs to be used
  26391. * @returns the submesh
  26392. */
  26393. render(enableAlphaMode: boolean): SubMesh;
  26394. /**
  26395. * @hidden
  26396. */
  26397. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26398. /**
  26399. * Checks if the submesh intersects with a ray
  26400. * @param ray defines the ray to test
  26401. * @returns true is the passed ray intersects the submesh bounding box
  26402. */
  26403. canIntersects(ray: Ray): boolean;
  26404. /**
  26405. * Intersects current submesh with a ray
  26406. * @param ray defines the ray to test
  26407. * @param positions defines mesh's positions array
  26408. * @param indices defines mesh's indices array
  26409. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26410. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26411. * @returns intersection info or null if no intersection
  26412. */
  26413. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26414. /** @hidden */
  26415. private _intersectLines;
  26416. /** @hidden */
  26417. private _intersectUnIndexedLines;
  26418. /** @hidden */
  26419. private _intersectTriangles;
  26420. /** @hidden */
  26421. private _intersectUnIndexedTriangles;
  26422. /** @hidden */
  26423. _rebuild(): void;
  26424. /**
  26425. * Creates a new submesh from the passed mesh
  26426. * @param newMesh defines the new hosting mesh
  26427. * @param newRenderingMesh defines an optional rendering mesh
  26428. * @returns the new submesh
  26429. */
  26430. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26431. /**
  26432. * Release associated resources
  26433. */
  26434. dispose(): void;
  26435. /**
  26436. * Gets the class name
  26437. * @returns the string "SubMesh".
  26438. */
  26439. getClassName(): string;
  26440. /**
  26441. * Creates a new submesh from indices data
  26442. * @param materialIndex the index of the main mesh material
  26443. * @param startIndex the index where to start the copy in the mesh indices array
  26444. * @param indexCount the number of indices to copy then from the startIndex
  26445. * @param mesh the main mesh to create the submesh from
  26446. * @param renderingMesh the optional rendering mesh
  26447. * @returns a new submesh
  26448. */
  26449. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26450. }
  26451. }
  26452. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26453. /**
  26454. * Class used to represent data loading progression
  26455. */
  26456. export class SceneLoaderFlags {
  26457. private static _ForceFullSceneLoadingForIncremental;
  26458. private static _ShowLoadingScreen;
  26459. private static _CleanBoneMatrixWeights;
  26460. private static _loggingLevel;
  26461. /**
  26462. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26463. */
  26464. static get ForceFullSceneLoadingForIncremental(): boolean;
  26465. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26466. /**
  26467. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26468. */
  26469. static get ShowLoadingScreen(): boolean;
  26470. static set ShowLoadingScreen(value: boolean);
  26471. /**
  26472. * Defines the current logging level (while loading the scene)
  26473. * @ignorenaming
  26474. */
  26475. static get loggingLevel(): number;
  26476. static set loggingLevel(value: number);
  26477. /**
  26478. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26479. */
  26480. static get CleanBoneMatrixWeights(): boolean;
  26481. static set CleanBoneMatrixWeights(value: boolean);
  26482. }
  26483. }
  26484. declare module "babylonjs/Meshes/geometry" {
  26485. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26486. import { Scene } from "babylonjs/scene";
  26487. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26488. import { Engine } from "babylonjs/Engines/engine";
  26489. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26490. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26491. import { Effect } from "babylonjs/Materials/effect";
  26492. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26493. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26494. import { Mesh } from "babylonjs/Meshes/mesh";
  26495. /**
  26496. * Class used to store geometry data (vertex buffers + index buffer)
  26497. */
  26498. export class Geometry implements IGetSetVerticesData {
  26499. /**
  26500. * Gets or sets the ID of the geometry
  26501. */
  26502. id: string;
  26503. /**
  26504. * Gets or sets the unique ID of the geometry
  26505. */
  26506. uniqueId: number;
  26507. /**
  26508. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26509. */
  26510. delayLoadState: number;
  26511. /**
  26512. * Gets the file containing the data to load when running in delay load state
  26513. */
  26514. delayLoadingFile: Nullable<string>;
  26515. /**
  26516. * Callback called when the geometry is updated
  26517. */
  26518. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26519. private _scene;
  26520. private _engine;
  26521. private _meshes;
  26522. private _totalVertices;
  26523. /** @hidden */
  26524. _indices: IndicesArray;
  26525. /** @hidden */
  26526. _vertexBuffers: {
  26527. [key: string]: VertexBuffer;
  26528. };
  26529. private _isDisposed;
  26530. private _extend;
  26531. private _boundingBias;
  26532. /** @hidden */
  26533. _delayInfo: Array<string>;
  26534. private _indexBuffer;
  26535. private _indexBufferIsUpdatable;
  26536. /** @hidden */
  26537. _boundingInfo: Nullable<BoundingInfo>;
  26538. /** @hidden */
  26539. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26540. /** @hidden */
  26541. _softwareSkinningFrameId: number;
  26542. private _vertexArrayObjects;
  26543. private _updatable;
  26544. /** @hidden */
  26545. _positions: Nullable<Vector3[]>;
  26546. /**
  26547. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  26548. */
  26549. get boundingBias(): Vector2;
  26550. /**
  26551. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  26552. */
  26553. set boundingBias(value: Vector2);
  26554. /**
  26555. * Static function used to attach a new empty geometry to a mesh
  26556. * @param mesh defines the mesh to attach the geometry to
  26557. * @returns the new Geometry
  26558. */
  26559. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26560. /** Get the list of meshes using this geometry */
  26561. get meshes(): Mesh[];
  26562. /**
  26563. * If set to true (false by defaut), the bounding info applied to the meshes sharing this geometry will be the bounding info defined at the class level
  26564. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26565. */
  26566. useBoundingInfoFromGeometry: boolean;
  26567. /**
  26568. * Creates a new geometry
  26569. * @param id defines the unique ID
  26570. * @param scene defines the hosting scene
  26571. * @param vertexData defines the VertexData used to get geometry data
  26572. * @param updatable defines if geometry must be updatable (false by default)
  26573. * @param mesh defines the mesh that will be associated with the geometry
  26574. */
  26575. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26576. /**
  26577. * Gets the current extend of the geometry
  26578. */
  26579. get extend(): {
  26580. minimum: Vector3;
  26581. maximum: Vector3;
  26582. };
  26583. /**
  26584. * Gets the hosting scene
  26585. * @returns the hosting Scene
  26586. */
  26587. getScene(): Scene;
  26588. /**
  26589. * Gets the hosting engine
  26590. * @returns the hosting Engine
  26591. */
  26592. getEngine(): Engine;
  26593. /**
  26594. * Defines if the geometry is ready to use
  26595. * @returns true if the geometry is ready to be used
  26596. */
  26597. isReady(): boolean;
  26598. /**
  26599. * Gets a value indicating that the geometry should not be serialized
  26600. */
  26601. get doNotSerialize(): boolean;
  26602. /** @hidden */
  26603. _rebuild(): void;
  26604. /**
  26605. * Affects all geometry data in one call
  26606. * @param vertexData defines the geometry data
  26607. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26608. */
  26609. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26610. /**
  26611. * Set specific vertex data
  26612. * @param kind defines the data kind (Position, normal, etc...)
  26613. * @param data defines the vertex data to use
  26614. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26615. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26616. */
  26617. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26618. /**
  26619. * Removes a specific vertex data
  26620. * @param kind defines the data kind (Position, normal, etc...)
  26621. */
  26622. removeVerticesData(kind: string): void;
  26623. /**
  26624. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26625. * @param buffer defines the vertex buffer to use
  26626. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26627. */
  26628. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26629. /**
  26630. * Update a specific vertex buffer
  26631. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26632. * It will do nothing if the buffer is not updatable
  26633. * @param kind defines the data kind (Position, normal, etc...)
  26634. * @param data defines the data to use
  26635. * @param offset defines the offset in the target buffer where to store the data
  26636. * @param useBytes set to true if the offset is in bytes
  26637. */
  26638. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26639. /**
  26640. * Update a specific vertex buffer
  26641. * This function will create a new buffer if the current one is not updatable
  26642. * @param kind defines the data kind (Position, normal, etc...)
  26643. * @param data defines the data to use
  26644. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26645. */
  26646. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26647. private _updateBoundingInfo;
  26648. /** @hidden */
  26649. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26650. /**
  26651. * Gets total number of vertices
  26652. * @returns the total number of vertices
  26653. */
  26654. getTotalVertices(): number;
  26655. /**
  26656. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26657. * @param kind defines the data kind (Position, normal, etc...)
  26658. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26659. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26660. * @returns a float array containing vertex data
  26661. */
  26662. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26663. /**
  26664. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26665. * @param kind defines the data kind (Position, normal, etc...)
  26666. * @returns true if the vertex buffer with the specified kind is updatable
  26667. */
  26668. isVertexBufferUpdatable(kind: string): boolean;
  26669. /**
  26670. * Gets a specific vertex buffer
  26671. * @param kind defines the data kind (Position, normal, etc...)
  26672. * @returns a VertexBuffer
  26673. */
  26674. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26675. /**
  26676. * Returns all vertex buffers
  26677. * @return an object holding all vertex buffers indexed by kind
  26678. */
  26679. getVertexBuffers(): Nullable<{
  26680. [key: string]: VertexBuffer;
  26681. }>;
  26682. /**
  26683. * Gets a boolean indicating if specific vertex buffer is present
  26684. * @param kind defines the data kind (Position, normal, etc...)
  26685. * @returns true if data is present
  26686. */
  26687. isVerticesDataPresent(kind: string): boolean;
  26688. /**
  26689. * Gets a list of all attached data kinds (Position, normal, etc...)
  26690. * @returns a list of string containing all kinds
  26691. */
  26692. getVerticesDataKinds(): string[];
  26693. /**
  26694. * Update index buffer
  26695. * @param indices defines the indices to store in the index buffer
  26696. * @param offset defines the offset in the target buffer where to store the data
  26697. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  26698. */
  26699. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26700. /**
  26701. * Creates a new index buffer
  26702. * @param indices defines the indices to store in the index buffer
  26703. * @param totalVertices defines the total number of vertices (could be null)
  26704. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26705. */
  26706. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26707. /**
  26708. * Return the total number of indices
  26709. * @returns the total number of indices
  26710. */
  26711. getTotalIndices(): number;
  26712. /**
  26713. * Gets the index buffer array
  26714. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26715. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26716. * @returns the index buffer array
  26717. */
  26718. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26719. /**
  26720. * Gets the index buffer
  26721. * @return the index buffer
  26722. */
  26723. getIndexBuffer(): Nullable<DataBuffer>;
  26724. /** @hidden */
  26725. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26726. /**
  26727. * Release the associated resources for a specific mesh
  26728. * @param mesh defines the source mesh
  26729. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26730. */
  26731. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26732. /**
  26733. * Apply current geometry to a given mesh
  26734. * @param mesh defines the mesh to apply geometry to
  26735. */
  26736. applyToMesh(mesh: Mesh): void;
  26737. private _updateExtend;
  26738. private _applyToMesh;
  26739. private notifyUpdate;
  26740. /**
  26741. * Load the geometry if it was flagged as delay loaded
  26742. * @param scene defines the hosting scene
  26743. * @param onLoaded defines a callback called when the geometry is loaded
  26744. */
  26745. load(scene: Scene, onLoaded?: () => void): void;
  26746. private _queueLoad;
  26747. /**
  26748. * Invert the geometry to move from a right handed system to a left handed one.
  26749. */
  26750. toLeftHanded(): void;
  26751. /** @hidden */
  26752. _resetPointsArrayCache(): void;
  26753. /** @hidden */
  26754. _generatePointsArray(): boolean;
  26755. /**
  26756. * Gets a value indicating if the geometry is disposed
  26757. * @returns true if the geometry was disposed
  26758. */
  26759. isDisposed(): boolean;
  26760. private _disposeVertexArrayObjects;
  26761. /**
  26762. * Free all associated resources
  26763. */
  26764. dispose(): void;
  26765. /**
  26766. * Clone the current geometry into a new geometry
  26767. * @param id defines the unique ID of the new geometry
  26768. * @returns a new geometry object
  26769. */
  26770. copy(id: string): Geometry;
  26771. /**
  26772. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26773. * @return a JSON representation of the current geometry data (without the vertices data)
  26774. */
  26775. serialize(): any;
  26776. private toNumberArray;
  26777. /**
  26778. * Serialize all vertices data into a JSON oject
  26779. * @returns a JSON representation of the current geometry data
  26780. */
  26781. serializeVerticeData(): any;
  26782. /**
  26783. * Extracts a clone of a mesh geometry
  26784. * @param mesh defines the source mesh
  26785. * @param id defines the unique ID of the new geometry object
  26786. * @returns the new geometry object
  26787. */
  26788. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26789. /**
  26790. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26791. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26792. * Be aware Math.random() could cause collisions, but:
  26793. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  26794. * @returns a string containing a new GUID
  26795. */
  26796. static RandomId(): string;
  26797. /** @hidden */
  26798. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26799. private static _CleanMatricesWeights;
  26800. /**
  26801. * Create a new geometry from persisted data (Using .babylon file format)
  26802. * @param parsedVertexData defines the persisted data
  26803. * @param scene defines the hosting scene
  26804. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26805. * @returns the new geometry object
  26806. */
  26807. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26808. }
  26809. }
  26810. declare module "babylonjs/Meshes/mesh.vertexData" {
  26811. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26812. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26813. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26814. import { Geometry } from "babylonjs/Meshes/geometry";
  26815. import { Mesh } from "babylonjs/Meshes/mesh";
  26816. /**
  26817. * Define an interface for all classes that will get and set the data on vertices
  26818. */
  26819. export interface IGetSetVerticesData {
  26820. /**
  26821. * Gets a boolean indicating if specific vertex data is present
  26822. * @param kind defines the vertex data kind to use
  26823. * @returns true is data kind is present
  26824. */
  26825. isVerticesDataPresent(kind: string): boolean;
  26826. /**
  26827. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26828. * @param kind defines the data kind (Position, normal, etc...)
  26829. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26830. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26831. * @returns a float array containing vertex data
  26832. */
  26833. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26834. /**
  26835. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26836. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  26837. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26838. * @returns the indices array or an empty array if the mesh has no geometry
  26839. */
  26840. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26841. /**
  26842. * Set specific vertex data
  26843. * @param kind defines the data kind (Position, normal, etc...)
  26844. * @param data defines the vertex data to use
  26845. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26846. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26847. */
  26848. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26849. /**
  26850. * Update a specific associated vertex buffer
  26851. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26852. * - VertexBuffer.PositionKind
  26853. * - VertexBuffer.UVKind
  26854. * - VertexBuffer.UV2Kind
  26855. * - VertexBuffer.UV3Kind
  26856. * - VertexBuffer.UV4Kind
  26857. * - VertexBuffer.UV5Kind
  26858. * - VertexBuffer.UV6Kind
  26859. * - VertexBuffer.ColorKind
  26860. * - VertexBuffer.MatricesIndicesKind
  26861. * - VertexBuffer.MatricesIndicesExtraKind
  26862. * - VertexBuffer.MatricesWeightsKind
  26863. * - VertexBuffer.MatricesWeightsExtraKind
  26864. * @param data defines the data source
  26865. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26866. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  26867. */
  26868. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26869. /**
  26870. * Creates a new index buffer
  26871. * @param indices defines the indices to store in the index buffer
  26872. * @param totalVertices defines the total number of vertices (could be null)
  26873. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26874. */
  26875. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26876. }
  26877. /**
  26878. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26879. */
  26880. export class VertexData {
  26881. /**
  26882. * Mesh side orientation : usually the external or front surface
  26883. */
  26884. static readonly FRONTSIDE: number;
  26885. /**
  26886. * Mesh side orientation : usually the internal or back surface
  26887. */
  26888. static readonly BACKSIDE: number;
  26889. /**
  26890. * Mesh side orientation : both internal and external or front and back surfaces
  26891. */
  26892. static readonly DOUBLESIDE: number;
  26893. /**
  26894. * Mesh side orientation : by default, `FRONTSIDE`
  26895. */
  26896. static readonly DEFAULTSIDE: number;
  26897. /**
  26898. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26899. */
  26900. positions: Nullable<FloatArray>;
  26901. /**
  26902. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26903. */
  26904. normals: Nullable<FloatArray>;
  26905. /**
  26906. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26907. */
  26908. tangents: Nullable<FloatArray>;
  26909. /**
  26910. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26911. */
  26912. uvs: Nullable<FloatArray>;
  26913. /**
  26914. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26915. */
  26916. uvs2: Nullable<FloatArray>;
  26917. /**
  26918. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26919. */
  26920. uvs3: Nullable<FloatArray>;
  26921. /**
  26922. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26923. */
  26924. uvs4: Nullable<FloatArray>;
  26925. /**
  26926. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26927. */
  26928. uvs5: Nullable<FloatArray>;
  26929. /**
  26930. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26931. */
  26932. uvs6: Nullable<FloatArray>;
  26933. /**
  26934. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  26935. */
  26936. colors: Nullable<FloatArray>;
  26937. /**
  26938. * An array containing the list of indices to the array of matrices produced by bones, each vertex have up to 4 indices (8 if the matricesIndicesExtra is set).
  26939. */
  26940. matricesIndices: Nullable<FloatArray>;
  26941. /**
  26942. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  26943. */
  26944. matricesWeights: Nullable<FloatArray>;
  26945. /**
  26946. * An array extending the number of possible indices
  26947. */
  26948. matricesIndicesExtra: Nullable<FloatArray>;
  26949. /**
  26950. * An array extending the number of possible weights when the number of indices is extended
  26951. */
  26952. matricesWeightsExtra: Nullable<FloatArray>;
  26953. /**
  26954. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  26955. */
  26956. indices: Nullable<IndicesArray>;
  26957. /**
  26958. * Uses the passed data array to set the set the values for the specified kind of data
  26959. * @param data a linear array of floating numbers
  26960. * @param kind the type of data that is being set, eg positions, colors etc
  26961. */
  26962. set(data: FloatArray, kind: string): void;
  26963. /**
  26964. * Associates the vertexData to the passed Mesh.
  26965. * Sets it as updatable or not (default `false`)
  26966. * @param mesh the mesh the vertexData is applied to
  26967. * @param updatable when used and having the value true allows new data to update the vertexData
  26968. * @returns the VertexData
  26969. */
  26970. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  26971. /**
  26972. * Associates the vertexData to the passed Geometry.
  26973. * Sets it as updatable or not (default `false`)
  26974. * @param geometry the geometry the vertexData is applied to
  26975. * @param updatable when used and having the value true allows new data to update the vertexData
  26976. * @returns VertexData
  26977. */
  26978. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  26979. /**
  26980. * Updates the associated mesh
  26981. * @param mesh the mesh to be updated
  26982. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26983. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  26984. * @returns VertexData
  26985. */
  26986. updateMesh(mesh: Mesh): VertexData;
  26987. /**
  26988. * Updates the associated geometry
  26989. * @param geometry the geometry to be updated
  26990. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26991. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  26992. * @returns VertexData.
  26993. */
  26994. updateGeometry(geometry: Geometry): VertexData;
  26995. private _applyTo;
  26996. private _update;
  26997. /**
  26998. * Transforms each position and each normal of the vertexData according to the passed Matrix
  26999. * @param matrix the transforming matrix
  27000. * @returns the VertexData
  27001. */
  27002. transform(matrix: Matrix): VertexData;
  27003. /**
  27004. * Merges the passed VertexData into the current one
  27005. * @param other the VertexData to be merged into the current one
  27006. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  27007. * @returns the modified VertexData
  27008. */
  27009. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  27010. private _mergeElement;
  27011. private _validate;
  27012. /**
  27013. * Serializes the VertexData
  27014. * @returns a serialized object
  27015. */
  27016. serialize(): any;
  27017. /**
  27018. * Extracts the vertexData from a mesh
  27019. * @param mesh the mesh from which to extract the VertexData
  27020. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  27021. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27022. * @returns the object VertexData associated to the passed mesh
  27023. */
  27024. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27025. /**
  27026. * Extracts the vertexData from the geometry
  27027. * @param geometry the geometry from which to extract the VertexData
  27028. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  27029. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27030. * @returns the object VertexData associated to the passed mesh
  27031. */
  27032. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27033. private static _ExtractFrom;
  27034. /**
  27035. * Creates the VertexData for a Ribbon
  27036. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  27037. * * pathArray array of paths, each of which an array of successive Vector3
  27038. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  27039. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  27040. * * offset a positive integer, only used when pathArray contains a single path (offset = 10 means the point 1 is joined to the point 11), default rounded half size of the pathArray length
  27041. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27042. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27043. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27044. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  27045. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  27046. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  27047. * @returns the VertexData of the ribbon
  27048. */
  27049. static CreateRibbon(options: {
  27050. pathArray: Vector3[][];
  27051. closeArray?: boolean;
  27052. closePath?: boolean;
  27053. offset?: number;
  27054. sideOrientation?: number;
  27055. frontUVs?: Vector4;
  27056. backUVs?: Vector4;
  27057. invertUV?: boolean;
  27058. uvs?: Vector2[];
  27059. colors?: Color4[];
  27060. }): VertexData;
  27061. /**
  27062. * Creates the VertexData for a box
  27063. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27064. * * size sets the width, height and depth of the box to the value of size, optional default 1
  27065. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  27066. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  27067. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  27068. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27069. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27070. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27071. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27072. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27073. * @returns the VertexData of the box
  27074. */
  27075. static CreateBox(options: {
  27076. size?: number;
  27077. width?: number;
  27078. height?: number;
  27079. depth?: number;
  27080. faceUV?: Vector4[];
  27081. faceColors?: Color4[];
  27082. sideOrientation?: number;
  27083. frontUVs?: Vector4;
  27084. backUVs?: Vector4;
  27085. }): VertexData;
  27086. /**
  27087. * Creates the VertexData for a tiled box
  27088. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27089. * * faceTiles sets the pattern, tile size and number of tiles for a face
  27090. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27091. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27092. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27093. * @returns the VertexData of the box
  27094. */
  27095. static CreateTiledBox(options: {
  27096. pattern?: number;
  27097. width?: number;
  27098. height?: number;
  27099. depth?: number;
  27100. tileSize?: number;
  27101. tileWidth?: number;
  27102. tileHeight?: number;
  27103. alignHorizontal?: number;
  27104. alignVertical?: number;
  27105. faceUV?: Vector4[];
  27106. faceColors?: Color4[];
  27107. sideOrientation?: number;
  27108. }): VertexData;
  27109. /**
  27110. * Creates the VertexData for a tiled plane
  27111. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27112. * * pattern a limited pattern arrangement depending on the number
  27113. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  27114. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  27115. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  27116. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27117. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27118. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27119. * @returns the VertexData of the tiled plane
  27120. */
  27121. static CreateTiledPlane(options: {
  27122. pattern?: number;
  27123. tileSize?: number;
  27124. tileWidth?: number;
  27125. tileHeight?: number;
  27126. size?: number;
  27127. width?: number;
  27128. height?: number;
  27129. alignHorizontal?: number;
  27130. alignVertical?: number;
  27131. sideOrientation?: number;
  27132. frontUVs?: Vector4;
  27133. backUVs?: Vector4;
  27134. }): VertexData;
  27135. /**
  27136. * Creates the VertexData for an ellipsoid, defaults to a sphere
  27137. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27138. * * segments sets the number of horizontal strips optional, default 32
  27139. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  27140. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  27141. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  27142. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  27143. * * arc a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the circumference (latitude) given by the arc value, optional, default 1
  27144. * * slice a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the height (latitude) given by the arc value, optional, default 1
  27145. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27146. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27147. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27148. * @returns the VertexData of the ellipsoid
  27149. */
  27150. static CreateSphere(options: {
  27151. segments?: number;
  27152. diameter?: number;
  27153. diameterX?: number;
  27154. diameterY?: number;
  27155. diameterZ?: number;
  27156. arc?: number;
  27157. slice?: number;
  27158. sideOrientation?: number;
  27159. frontUVs?: Vector4;
  27160. backUVs?: Vector4;
  27161. }): VertexData;
  27162. /**
  27163. * Creates the VertexData for a cylinder, cone or prism
  27164. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27165. * * height sets the height (y direction) of the cylinder, optional, default 2
  27166. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  27167. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  27168. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  27169. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27170. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  27171. * * arc a number from 0 to 1, to create an unclosed cylinder based on the fraction of the circumference given by the arc value, optional, default 1
  27172. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27173. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27174. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  27175. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  27176. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27177. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27178. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27179. * @returns the VertexData of the cylinder, cone or prism
  27180. */
  27181. static CreateCylinder(options: {
  27182. height?: number;
  27183. diameterTop?: number;
  27184. diameterBottom?: number;
  27185. diameter?: number;
  27186. tessellation?: number;
  27187. subdivisions?: number;
  27188. arc?: number;
  27189. faceColors?: Color4[];
  27190. faceUV?: Vector4[];
  27191. hasRings?: boolean;
  27192. enclose?: boolean;
  27193. sideOrientation?: number;
  27194. frontUVs?: Vector4;
  27195. backUVs?: Vector4;
  27196. }): VertexData;
  27197. /**
  27198. * Creates the VertexData for a torus
  27199. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27200. * * diameter the diameter of the torus, optional default 1
  27201. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27202. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27203. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27204. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27205. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27206. * @returns the VertexData of the torus
  27207. */
  27208. static CreateTorus(options: {
  27209. diameter?: number;
  27210. thickness?: number;
  27211. tessellation?: number;
  27212. sideOrientation?: number;
  27213. frontUVs?: Vector4;
  27214. backUVs?: Vector4;
  27215. }): VertexData;
  27216. /**
  27217. * Creates the VertexData of the LineSystem
  27218. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27219. * - lines an array of lines, each line being an array of successive Vector3
  27220. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27221. * @returns the VertexData of the LineSystem
  27222. */
  27223. static CreateLineSystem(options: {
  27224. lines: Vector3[][];
  27225. colors?: Nullable<Color4[][]>;
  27226. }): VertexData;
  27227. /**
  27228. * Create the VertexData for a DashedLines
  27229. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27230. * - points an array successive Vector3
  27231. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27232. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27233. * - dashNb the intended total number of dashes, optional, default 200
  27234. * @returns the VertexData for the DashedLines
  27235. */
  27236. static CreateDashedLines(options: {
  27237. points: Vector3[];
  27238. dashSize?: number;
  27239. gapSize?: number;
  27240. dashNb?: number;
  27241. }): VertexData;
  27242. /**
  27243. * Creates the VertexData for a Ground
  27244. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27245. * - width the width (x direction) of the ground, optional, default 1
  27246. * - height the height (z direction) of the ground, optional, default 1
  27247. * - subdivisions the number of subdivisions per side, optional, default 1
  27248. * @returns the VertexData of the Ground
  27249. */
  27250. static CreateGround(options: {
  27251. width?: number;
  27252. height?: number;
  27253. subdivisions?: number;
  27254. subdivisionsX?: number;
  27255. subdivisionsY?: number;
  27256. }): VertexData;
  27257. /**
  27258. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27259. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27260. * * xmin the ground minimum X coordinate, optional, default -1
  27261. * * zmin the ground minimum Z coordinate, optional, default -1
  27262. * * xmax the ground maximum X coordinate, optional, default 1
  27263. * * zmax the ground maximum Z coordinate, optional, default 1
  27264. * * subdivisions a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the ground width and height creating 'tiles', default {w: 6, h: 6}
  27265. * * precision a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the tile width and height, default {w: 2, h: 2}
  27266. * @returns the VertexData of the TiledGround
  27267. */
  27268. static CreateTiledGround(options: {
  27269. xmin: number;
  27270. zmin: number;
  27271. xmax: number;
  27272. zmax: number;
  27273. subdivisions?: {
  27274. w: number;
  27275. h: number;
  27276. };
  27277. precision?: {
  27278. w: number;
  27279. h: number;
  27280. };
  27281. }): VertexData;
  27282. /**
  27283. * Creates the VertexData of the Ground designed from a heightmap
  27284. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27285. * * width the width (x direction) of the ground
  27286. * * height the height (z direction) of the ground
  27287. * * subdivisions the number of subdivisions per side
  27288. * * minHeight the minimum altitude on the ground, optional, default 0
  27289. * * maxHeight the maximum altitude on the ground, optional default 1
  27290. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27291. * * buffer the array holding the image color data
  27292. * * bufferWidth the width of image
  27293. * * bufferHeight the height of image
  27294. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27295. * @returns the VertexData of the Ground designed from a heightmap
  27296. */
  27297. static CreateGroundFromHeightMap(options: {
  27298. width: number;
  27299. height: number;
  27300. subdivisions: number;
  27301. minHeight: number;
  27302. maxHeight: number;
  27303. colorFilter: Color3;
  27304. buffer: Uint8Array;
  27305. bufferWidth: number;
  27306. bufferHeight: number;
  27307. alphaFilter: number;
  27308. }): VertexData;
  27309. /**
  27310. * Creates the VertexData for a Plane
  27311. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27312. * * size sets the width and height of the plane to the value of size, optional default 1
  27313. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27314. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27315. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27316. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27317. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27318. * @returns the VertexData of the box
  27319. */
  27320. static CreatePlane(options: {
  27321. size?: number;
  27322. width?: number;
  27323. height?: number;
  27324. sideOrientation?: number;
  27325. frontUVs?: Vector4;
  27326. backUVs?: Vector4;
  27327. }): VertexData;
  27328. /**
  27329. * Creates the VertexData of the Disc or regular Polygon
  27330. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27331. * * radius the radius of the disc, optional default 0.5
  27332. * * tessellation the number of polygon sides, optional, default 64
  27333. * * arc a number from 0 to 1, to create an unclosed polygon based on the fraction of the circumference given by the arc value, optional, default 1
  27334. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27335. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27336. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27337. * @returns the VertexData of the box
  27338. */
  27339. static CreateDisc(options: {
  27340. radius?: number;
  27341. tessellation?: number;
  27342. arc?: number;
  27343. sideOrientation?: number;
  27344. frontUVs?: Vector4;
  27345. backUVs?: Vector4;
  27346. }): VertexData;
  27347. /**
  27348. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27349. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27350. * @param polygon a mesh built from polygonTriangulation.build()
  27351. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27352. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27353. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27354. * @param frontUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27355. * @param backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27356. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27357. * @returns the VertexData of the Polygon
  27358. */
  27359. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27360. /**
  27361. * Creates the VertexData of the IcoSphere
  27362. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27363. * * radius the radius of the IcoSphere, optional default 1
  27364. * * radiusX allows stretching in the x direction, optional, default radius
  27365. * * radiusY allows stretching in the y direction, optional, default radius
  27366. * * radiusZ allows stretching in the z direction, optional, default radius
  27367. * * flat when true creates a flat shaded mesh, optional, default true
  27368. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27369. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27370. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27371. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27372. * @returns the VertexData of the IcoSphere
  27373. */
  27374. static CreateIcoSphere(options: {
  27375. radius?: number;
  27376. radiusX?: number;
  27377. radiusY?: number;
  27378. radiusZ?: number;
  27379. flat?: boolean;
  27380. subdivisions?: number;
  27381. sideOrientation?: number;
  27382. frontUVs?: Vector4;
  27383. backUVs?: Vector4;
  27384. }): VertexData;
  27385. /**
  27386. * Creates the VertexData for a Polyhedron
  27387. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27388. * * type provided types are:
  27389. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27390. * * 9 : Pentagonal Pyramid (J2), 10 : Triangular Dipyramid (J12), 11 : Pentagonal Dipyramid (J13), 12 : Elongated Square Dipyramid (J15), 13 : Elongated Pentagonal Dipyramid (J16), 14 : Elongated Pentagonal Cupola (J20)
  27391. * * size the size of the IcoSphere, optional default 1
  27392. * * sizeX allows stretching in the x direction, optional, default size
  27393. * * sizeY allows stretching in the y direction, optional, default size
  27394. * * sizeZ allows stretching in the z direction, optional, default size
  27395. * * custom a number that overwrites the type to create from an extended set of polyhedron from https://www.babylonjs-playground.com/#21QRSK#15 with minimised editor
  27396. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27397. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27398. * * flat when true creates a flat shaded mesh, optional, default true
  27399. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27400. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27401. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27402. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27403. * @returns the VertexData of the Polyhedron
  27404. */
  27405. static CreatePolyhedron(options: {
  27406. type?: number;
  27407. size?: number;
  27408. sizeX?: number;
  27409. sizeY?: number;
  27410. sizeZ?: number;
  27411. custom?: any;
  27412. faceUV?: Vector4[];
  27413. faceColors?: Color4[];
  27414. flat?: boolean;
  27415. sideOrientation?: number;
  27416. frontUVs?: Vector4;
  27417. backUVs?: Vector4;
  27418. }): VertexData;
  27419. /**
  27420. * Creates the VertexData for a TorusKnot
  27421. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27422. * * radius the radius of the torus knot, optional, default 2
  27423. * * tube the thickness of the tube, optional, default 0.5
  27424. * * radialSegments the number of sides on each tube segments, optional, default 32
  27425. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27426. * * p the number of windings around the z axis, optional, default 2
  27427. * * q the number of windings around the x axis, optional, default 3
  27428. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27429. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27430. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27431. * @returns the VertexData of the Torus Knot
  27432. */
  27433. static CreateTorusKnot(options: {
  27434. radius?: number;
  27435. tube?: number;
  27436. radialSegments?: number;
  27437. tubularSegments?: number;
  27438. p?: number;
  27439. q?: number;
  27440. sideOrientation?: number;
  27441. frontUVs?: Vector4;
  27442. backUVs?: Vector4;
  27443. }): VertexData;
  27444. /**
  27445. * Compute normals for given positions and indices
  27446. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27447. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27448. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27449. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27450. * * facetNormals : optional array of facet normals (vector3)
  27451. * * facetPositions : optional array of facet positions (vector3)
  27452. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27453. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27454. * * bInfo : optional bounding info, required for facetPartitioning computation
  27455. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27456. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27457. * * useRightHandedSystem: optional boolean to for right handed system computation
  27458. * * depthSort : optional boolean to enable the facet depth sort computation
  27459. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27460. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27461. */
  27462. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27463. facetNormals?: any;
  27464. facetPositions?: any;
  27465. facetPartitioning?: any;
  27466. ratio?: number;
  27467. bInfo?: any;
  27468. bbSize?: Vector3;
  27469. subDiv?: any;
  27470. useRightHandedSystem?: boolean;
  27471. depthSort?: boolean;
  27472. distanceTo?: Vector3;
  27473. depthSortedFacets?: any;
  27474. }): void;
  27475. /** @hidden */
  27476. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27477. /**
  27478. * Applies VertexData created from the imported parameters to the geometry
  27479. * @param parsedVertexData the parsed data from an imported file
  27480. * @param geometry the geometry to apply the VertexData to
  27481. */
  27482. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27483. }
  27484. }
  27485. declare module "babylonjs/Morph/morphTarget" {
  27486. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27487. import { Observable } from "babylonjs/Misc/observable";
  27488. import { Nullable, FloatArray } from "babylonjs/types";
  27489. import { Scene } from "babylonjs/scene";
  27490. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27491. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27492. /**
  27493. * Defines a target to use with MorphTargetManager
  27494. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27495. */
  27496. export class MorphTarget implements IAnimatable {
  27497. /** defines the name of the target */
  27498. name: string;
  27499. /**
  27500. * Gets or sets the list of animations
  27501. */
  27502. animations: import("babylonjs/Animations/animation").Animation[];
  27503. private _scene;
  27504. private _positions;
  27505. private _normals;
  27506. private _tangents;
  27507. private _uvs;
  27508. private _influence;
  27509. private _uniqueId;
  27510. /**
  27511. * Observable raised when the influence changes
  27512. */
  27513. onInfluenceChanged: Observable<boolean>;
  27514. /** @hidden */
  27515. _onDataLayoutChanged: Observable<void>;
  27516. /**
  27517. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27518. */
  27519. get influence(): number;
  27520. set influence(influence: number);
  27521. /**
  27522. * Gets or sets the id of the morph Target
  27523. */
  27524. id: string;
  27525. private _animationPropertiesOverride;
  27526. /**
  27527. * Gets or sets the animation properties override
  27528. */
  27529. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27530. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27531. /**
  27532. * Creates a new MorphTarget
  27533. * @param name defines the name of the target
  27534. * @param influence defines the influence to use
  27535. * @param scene defines the scene the morphtarget belongs to
  27536. */
  27537. constructor(
  27538. /** defines the name of the target */
  27539. name: string, influence?: number, scene?: Nullable<Scene>);
  27540. /**
  27541. * Gets the unique ID of this manager
  27542. */
  27543. get uniqueId(): number;
  27544. /**
  27545. * Gets a boolean defining if the target contains position data
  27546. */
  27547. get hasPositions(): boolean;
  27548. /**
  27549. * Gets a boolean defining if the target contains normal data
  27550. */
  27551. get hasNormals(): boolean;
  27552. /**
  27553. * Gets a boolean defining if the target contains tangent data
  27554. */
  27555. get hasTangents(): boolean;
  27556. /**
  27557. * Gets a boolean defining if the target contains texture coordinates data
  27558. */
  27559. get hasUVs(): boolean;
  27560. /**
  27561. * Affects position data to this target
  27562. * @param data defines the position data to use
  27563. */
  27564. setPositions(data: Nullable<FloatArray>): void;
  27565. /**
  27566. * Gets the position data stored in this target
  27567. * @returns a FloatArray containing the position data (or null if not present)
  27568. */
  27569. getPositions(): Nullable<FloatArray>;
  27570. /**
  27571. * Affects normal data to this target
  27572. * @param data defines the normal data to use
  27573. */
  27574. setNormals(data: Nullable<FloatArray>): void;
  27575. /**
  27576. * Gets the normal data stored in this target
  27577. * @returns a FloatArray containing the normal data (or null if not present)
  27578. */
  27579. getNormals(): Nullable<FloatArray>;
  27580. /**
  27581. * Affects tangent data to this target
  27582. * @param data defines the tangent data to use
  27583. */
  27584. setTangents(data: Nullable<FloatArray>): void;
  27585. /**
  27586. * Gets the tangent data stored in this target
  27587. * @returns a FloatArray containing the tangent data (or null if not present)
  27588. */
  27589. getTangents(): Nullable<FloatArray>;
  27590. /**
  27591. * Affects texture coordinates data to this target
  27592. * @param data defines the texture coordinates data to use
  27593. */
  27594. setUVs(data: Nullable<FloatArray>): void;
  27595. /**
  27596. * Gets the texture coordinates data stored in this target
  27597. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27598. */
  27599. getUVs(): Nullable<FloatArray>;
  27600. /**
  27601. * Clone the current target
  27602. * @returns a new MorphTarget
  27603. */
  27604. clone(): MorphTarget;
  27605. /**
  27606. * Serializes the current target into a Serialization object
  27607. * @returns the serialized object
  27608. */
  27609. serialize(): any;
  27610. /**
  27611. * Returns the string "MorphTarget"
  27612. * @returns "MorphTarget"
  27613. */
  27614. getClassName(): string;
  27615. /**
  27616. * Creates a new target from serialized data
  27617. * @param serializationObject defines the serialized data to use
  27618. * @returns a new MorphTarget
  27619. */
  27620. static Parse(serializationObject: any): MorphTarget;
  27621. /**
  27622. * Creates a MorphTarget from mesh data
  27623. * @param mesh defines the source mesh
  27624. * @param name defines the name to use for the new target
  27625. * @param influence defines the influence to attach to the target
  27626. * @returns a new MorphTarget
  27627. */
  27628. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27629. }
  27630. }
  27631. declare module "babylonjs/Morph/morphTargetManager" {
  27632. import { Nullable } from "babylonjs/types";
  27633. import { Scene } from "babylonjs/scene";
  27634. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27635. /**
  27636. * This class is used to deform meshes using morphing between different targets
  27637. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27638. */
  27639. export class MorphTargetManager {
  27640. private _targets;
  27641. private _targetInfluenceChangedObservers;
  27642. private _targetDataLayoutChangedObservers;
  27643. private _activeTargets;
  27644. private _scene;
  27645. private _influences;
  27646. private _supportsNormals;
  27647. private _supportsTangents;
  27648. private _supportsUVs;
  27649. private _vertexCount;
  27650. private _uniqueId;
  27651. private _tempInfluences;
  27652. /**
  27653. * Gets or sets a boolean indicating if normals must be morphed
  27654. */
  27655. enableNormalMorphing: boolean;
  27656. /**
  27657. * Gets or sets a boolean indicating if tangents must be morphed
  27658. */
  27659. enableTangentMorphing: boolean;
  27660. /**
  27661. * Gets or sets a boolean indicating if UV must be morphed
  27662. */
  27663. enableUVMorphing: boolean;
  27664. /**
  27665. * Creates a new MorphTargetManager
  27666. * @param scene defines the current scene
  27667. */
  27668. constructor(scene?: Nullable<Scene>);
  27669. /**
  27670. * Gets the unique ID of this manager
  27671. */
  27672. get uniqueId(): number;
  27673. /**
  27674. * Gets the number of vertices handled by this manager
  27675. */
  27676. get vertexCount(): number;
  27677. /**
  27678. * Gets a boolean indicating if this manager supports morphing of normals
  27679. */
  27680. get supportsNormals(): boolean;
  27681. /**
  27682. * Gets a boolean indicating if this manager supports morphing of tangents
  27683. */
  27684. get supportsTangents(): boolean;
  27685. /**
  27686. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27687. */
  27688. get supportsUVs(): boolean;
  27689. /**
  27690. * Gets the number of targets stored in this manager
  27691. */
  27692. get numTargets(): number;
  27693. /**
  27694. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27695. */
  27696. get numInfluencers(): number;
  27697. /**
  27698. * Gets the list of influences (one per target)
  27699. */
  27700. get influences(): Float32Array;
  27701. /**
  27702. * Gets the active target at specified index. An active target is a target with an influence > 0
  27703. * @param index defines the index to check
  27704. * @returns the requested target
  27705. */
  27706. getActiveTarget(index: number): MorphTarget;
  27707. /**
  27708. * Gets the target at specified index
  27709. * @param index defines the index to check
  27710. * @returns the requested target
  27711. */
  27712. getTarget(index: number): MorphTarget;
  27713. /**
  27714. * Add a new target to this manager
  27715. * @param target defines the target to add
  27716. */
  27717. addTarget(target: MorphTarget): void;
  27718. /**
  27719. * Removes a target from the manager
  27720. * @param target defines the target to remove
  27721. */
  27722. removeTarget(target: MorphTarget): void;
  27723. /**
  27724. * Clone the current manager
  27725. * @returns a new MorphTargetManager
  27726. */
  27727. clone(): MorphTargetManager;
  27728. /**
  27729. * Serializes the current manager into a Serialization object
  27730. * @returns the serialized object
  27731. */
  27732. serialize(): any;
  27733. private _syncActiveTargets;
  27734. /**
  27735. * Syncrhonize the targets with all the meshes using this morph target manager
  27736. */
  27737. synchronize(): void;
  27738. /**
  27739. * Creates a new MorphTargetManager from serialized data
  27740. * @param serializationObject defines the serialized data
  27741. * @param scene defines the hosting scene
  27742. * @returns the new MorphTargetManager
  27743. */
  27744. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27745. }
  27746. }
  27747. declare module "babylonjs/Meshes/meshLODLevel" {
  27748. import { Mesh } from "babylonjs/Meshes/mesh";
  27749. import { Nullable } from "babylonjs/types";
  27750. /**
  27751. * Class used to represent a specific level of detail of a mesh
  27752. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27753. */
  27754. export class MeshLODLevel {
  27755. /** Defines the distance where this level should start being displayed */
  27756. distance: number;
  27757. /** Defines the mesh to use to render this level */
  27758. mesh: Nullable<Mesh>;
  27759. /**
  27760. * Creates a new LOD level
  27761. * @param distance defines the distance where this level should star being displayed
  27762. * @param mesh defines the mesh to use to render this level
  27763. */
  27764. constructor(
  27765. /** Defines the distance where this level should start being displayed */
  27766. distance: number,
  27767. /** Defines the mesh to use to render this level */
  27768. mesh: Nullable<Mesh>);
  27769. }
  27770. }
  27771. declare module "babylonjs/Misc/canvasGenerator" {
  27772. /**
  27773. * Helper class used to generate a canvas to manipulate images
  27774. */
  27775. export class CanvasGenerator {
  27776. /**
  27777. * Create a new canvas (or offscreen canvas depending on the context)
  27778. * @param width defines the expected width
  27779. * @param height defines the expected height
  27780. * @return a new canvas or offscreen canvas
  27781. */
  27782. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27783. }
  27784. }
  27785. declare module "babylonjs/Meshes/groundMesh" {
  27786. import { Scene } from "babylonjs/scene";
  27787. import { Vector3 } from "babylonjs/Maths/math.vector";
  27788. import { Mesh } from "babylonjs/Meshes/mesh";
  27789. /**
  27790. * Mesh representing the gorund
  27791. */
  27792. export class GroundMesh extends Mesh {
  27793. /** If octree should be generated */
  27794. generateOctree: boolean;
  27795. private _heightQuads;
  27796. /** @hidden */
  27797. _subdivisionsX: number;
  27798. /** @hidden */
  27799. _subdivisionsY: number;
  27800. /** @hidden */
  27801. _width: number;
  27802. /** @hidden */
  27803. _height: number;
  27804. /** @hidden */
  27805. _minX: number;
  27806. /** @hidden */
  27807. _maxX: number;
  27808. /** @hidden */
  27809. _minZ: number;
  27810. /** @hidden */
  27811. _maxZ: number;
  27812. constructor(name: string, scene: Scene);
  27813. /**
  27814. * "GroundMesh"
  27815. * @returns "GroundMesh"
  27816. */
  27817. getClassName(): string;
  27818. /**
  27819. * The minimum of x and y subdivisions
  27820. */
  27821. get subdivisions(): number;
  27822. /**
  27823. * X subdivisions
  27824. */
  27825. get subdivisionsX(): number;
  27826. /**
  27827. * Y subdivisions
  27828. */
  27829. get subdivisionsY(): number;
  27830. /**
  27831. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27832. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27833. * @param chunksCount the number of subdivisions for x and y
  27834. * @param octreeBlocksSize (Default: 32)
  27835. */
  27836. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27837. /**
  27838. * Returns a height (y) value in the Worl system :
  27839. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27840. * @param x x coordinate
  27841. * @param z z coordinate
  27842. * @returns the ground y position if (x, z) are outside the ground surface.
  27843. */
  27844. getHeightAtCoordinates(x: number, z: number): number;
  27845. /**
  27846. * Returns a normalized vector (Vector3) orthogonal to the ground
  27847. * at the ground coordinates (x, z) expressed in the World system.
  27848. * @param x x coordinate
  27849. * @param z z coordinate
  27850. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27851. */
  27852. getNormalAtCoordinates(x: number, z: number): Vector3;
  27853. /**
  27854. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27855. * at the ground coordinates (x, z) expressed in the World system.
  27856. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27857. * @param x x coordinate
  27858. * @param z z coordinate
  27859. * @param ref vector to store the result
  27860. * @returns the GroundMesh.
  27861. */
  27862. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27863. /**
  27864. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27865. * if the ground has been updated.
  27866. * This can be used in the render loop.
  27867. * @returns the GroundMesh.
  27868. */
  27869. updateCoordinateHeights(): GroundMesh;
  27870. private _getFacetAt;
  27871. private _initHeightQuads;
  27872. private _computeHeightQuads;
  27873. /**
  27874. * Serializes this ground mesh
  27875. * @param serializationObject object to write serialization to
  27876. */
  27877. serialize(serializationObject: any): void;
  27878. /**
  27879. * Parses a serialized ground mesh
  27880. * @param parsedMesh the serialized mesh
  27881. * @param scene the scene to create the ground mesh in
  27882. * @returns the created ground mesh
  27883. */
  27884. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27885. }
  27886. }
  27887. declare module "babylonjs/Physics/physicsJoint" {
  27888. import { Vector3 } from "babylonjs/Maths/math.vector";
  27889. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27890. /**
  27891. * Interface for Physics-Joint data
  27892. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27893. */
  27894. export interface PhysicsJointData {
  27895. /**
  27896. * The main pivot of the joint
  27897. */
  27898. mainPivot?: Vector3;
  27899. /**
  27900. * The connected pivot of the joint
  27901. */
  27902. connectedPivot?: Vector3;
  27903. /**
  27904. * The main axis of the joint
  27905. */
  27906. mainAxis?: Vector3;
  27907. /**
  27908. * The connected axis of the joint
  27909. */
  27910. connectedAxis?: Vector3;
  27911. /**
  27912. * The collision of the joint
  27913. */
  27914. collision?: boolean;
  27915. /**
  27916. * Native Oimo/Cannon/Energy data
  27917. */
  27918. nativeParams?: any;
  27919. }
  27920. /**
  27921. * This is a holder class for the physics joint created by the physics plugin
  27922. * It holds a set of functions to control the underlying joint
  27923. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27924. */
  27925. export class PhysicsJoint {
  27926. /**
  27927. * The type of the physics joint
  27928. */
  27929. type: number;
  27930. /**
  27931. * The data for the physics joint
  27932. */
  27933. jointData: PhysicsJointData;
  27934. private _physicsJoint;
  27935. protected _physicsPlugin: IPhysicsEnginePlugin;
  27936. /**
  27937. * Initializes the physics joint
  27938. * @param type The type of the physics joint
  27939. * @param jointData The data for the physics joint
  27940. */
  27941. constructor(
  27942. /**
  27943. * The type of the physics joint
  27944. */
  27945. type: number,
  27946. /**
  27947. * The data for the physics joint
  27948. */
  27949. jointData: PhysicsJointData);
  27950. /**
  27951. * Gets the physics joint
  27952. */
  27953. get physicsJoint(): any;
  27954. /**
  27955. * Sets the physics joint
  27956. */
  27957. set physicsJoint(newJoint: any);
  27958. /**
  27959. * Sets the physics plugin
  27960. */
  27961. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  27962. /**
  27963. * Execute a function that is physics-plugin specific.
  27964. * @param {Function} func the function that will be executed.
  27965. * It accepts two parameters: the physics world and the physics joint
  27966. */
  27967. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  27968. /**
  27969. * Distance-Joint type
  27970. */
  27971. static DistanceJoint: number;
  27972. /**
  27973. * Hinge-Joint type
  27974. */
  27975. static HingeJoint: number;
  27976. /**
  27977. * Ball-and-Socket joint type
  27978. */
  27979. static BallAndSocketJoint: number;
  27980. /**
  27981. * Wheel-Joint type
  27982. */
  27983. static WheelJoint: number;
  27984. /**
  27985. * Slider-Joint type
  27986. */
  27987. static SliderJoint: number;
  27988. /**
  27989. * Prismatic-Joint type
  27990. */
  27991. static PrismaticJoint: number;
  27992. /**
  27993. * Universal-Joint type
  27994. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  27995. */
  27996. static UniversalJoint: number;
  27997. /**
  27998. * Hinge-Joint 2 type
  27999. */
  28000. static Hinge2Joint: number;
  28001. /**
  28002. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  28003. */
  28004. static PointToPointJoint: number;
  28005. /**
  28006. * Spring-Joint type
  28007. */
  28008. static SpringJoint: number;
  28009. /**
  28010. * Lock-Joint type
  28011. */
  28012. static LockJoint: number;
  28013. }
  28014. /**
  28015. * A class representing a physics distance joint
  28016. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28017. */
  28018. export class DistanceJoint extends PhysicsJoint {
  28019. /**
  28020. *
  28021. * @param jointData The data for the Distance-Joint
  28022. */
  28023. constructor(jointData: DistanceJointData);
  28024. /**
  28025. * Update the predefined distance.
  28026. * @param maxDistance The maximum preferred distance
  28027. * @param minDistance The minimum preferred distance
  28028. */
  28029. updateDistance(maxDistance: number, minDistance?: number): void;
  28030. }
  28031. /**
  28032. * Represents a Motor-Enabled Joint
  28033. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28034. */
  28035. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  28036. /**
  28037. * Initializes the Motor-Enabled Joint
  28038. * @param type The type of the joint
  28039. * @param jointData The physica joint data for the joint
  28040. */
  28041. constructor(type: number, jointData: PhysicsJointData);
  28042. /**
  28043. * Set the motor values.
  28044. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28045. * @param force the force to apply
  28046. * @param maxForce max force for this motor.
  28047. */
  28048. setMotor(force?: number, maxForce?: number): void;
  28049. /**
  28050. * Set the motor's limits.
  28051. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28052. * @param upperLimit The upper limit of the motor
  28053. * @param lowerLimit The lower limit of the motor
  28054. */
  28055. setLimit(upperLimit: number, lowerLimit?: number): void;
  28056. }
  28057. /**
  28058. * This class represents a single physics Hinge-Joint
  28059. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28060. */
  28061. export class HingeJoint extends MotorEnabledJoint {
  28062. /**
  28063. * Initializes the Hinge-Joint
  28064. * @param jointData The joint data for the Hinge-Joint
  28065. */
  28066. constructor(jointData: PhysicsJointData);
  28067. /**
  28068. * Set the motor values.
  28069. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28070. * @param {number} force the force to apply
  28071. * @param {number} maxForce max force for this motor.
  28072. */
  28073. setMotor(force?: number, maxForce?: number): void;
  28074. /**
  28075. * Set the motor's limits.
  28076. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28077. * @param upperLimit The upper limit of the motor
  28078. * @param lowerLimit The lower limit of the motor
  28079. */
  28080. setLimit(upperLimit: number, lowerLimit?: number): void;
  28081. }
  28082. /**
  28083. * This class represents a dual hinge physics joint (same as wheel joint)
  28084. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28085. */
  28086. export class Hinge2Joint extends MotorEnabledJoint {
  28087. /**
  28088. * Initializes the Hinge2-Joint
  28089. * @param jointData The joint data for the Hinge2-Joint
  28090. */
  28091. constructor(jointData: PhysicsJointData);
  28092. /**
  28093. * Set the motor values.
  28094. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28095. * @param {number} targetSpeed the speed the motor is to reach
  28096. * @param {number} maxForce max force for this motor.
  28097. * @param {motorIndex} the motor's index, 0 or 1.
  28098. */
  28099. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  28100. /**
  28101. * Set the motor limits.
  28102. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28103. * @param {number} upperLimit the upper limit
  28104. * @param {number} lowerLimit lower limit
  28105. * @param {motorIndex} the motor's index, 0 or 1.
  28106. */
  28107. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28108. }
  28109. /**
  28110. * Interface for a motor enabled joint
  28111. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28112. */
  28113. export interface IMotorEnabledJoint {
  28114. /**
  28115. * Physics joint
  28116. */
  28117. physicsJoint: any;
  28118. /**
  28119. * Sets the motor of the motor-enabled joint
  28120. * @param force The force of the motor
  28121. * @param maxForce The maximum force of the motor
  28122. * @param motorIndex The index of the motor
  28123. */
  28124. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  28125. /**
  28126. * Sets the limit of the motor
  28127. * @param upperLimit The upper limit of the motor
  28128. * @param lowerLimit The lower limit of the motor
  28129. * @param motorIndex The index of the motor
  28130. */
  28131. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28132. }
  28133. /**
  28134. * Joint data for a Distance-Joint
  28135. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28136. */
  28137. export interface DistanceJointData extends PhysicsJointData {
  28138. /**
  28139. * Max distance the 2 joint objects can be apart
  28140. */
  28141. maxDistance: number;
  28142. }
  28143. /**
  28144. * Joint data from a spring joint
  28145. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28146. */
  28147. export interface SpringJointData extends PhysicsJointData {
  28148. /**
  28149. * Length of the spring
  28150. */
  28151. length: number;
  28152. /**
  28153. * Stiffness of the spring
  28154. */
  28155. stiffness: number;
  28156. /**
  28157. * Damping of the spring
  28158. */
  28159. damping: number;
  28160. /** this callback will be called when applying the force to the impostors. */
  28161. forceApplicationCallback: () => void;
  28162. }
  28163. }
  28164. declare module "babylonjs/Physics/physicsRaycastResult" {
  28165. import { Vector3 } from "babylonjs/Maths/math.vector";
  28166. /**
  28167. * Holds the data for the raycast result
  28168. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28169. */
  28170. export class PhysicsRaycastResult {
  28171. private _hasHit;
  28172. private _hitDistance;
  28173. private _hitNormalWorld;
  28174. private _hitPointWorld;
  28175. private _rayFromWorld;
  28176. private _rayToWorld;
  28177. /**
  28178. * Gets if there was a hit
  28179. */
  28180. get hasHit(): boolean;
  28181. /**
  28182. * Gets the distance from the hit
  28183. */
  28184. get hitDistance(): number;
  28185. /**
  28186. * Gets the hit normal/direction in the world
  28187. */
  28188. get hitNormalWorld(): Vector3;
  28189. /**
  28190. * Gets the hit point in the world
  28191. */
  28192. get hitPointWorld(): Vector3;
  28193. /**
  28194. * Gets the ray "start point" of the ray in the world
  28195. */
  28196. get rayFromWorld(): Vector3;
  28197. /**
  28198. * Gets the ray "end point" of the ray in the world
  28199. */
  28200. get rayToWorld(): Vector3;
  28201. /**
  28202. * Sets the hit data (normal & point in world space)
  28203. * @param hitNormalWorld defines the normal in world space
  28204. * @param hitPointWorld defines the point in world space
  28205. */
  28206. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28207. /**
  28208. * Sets the distance from the start point to the hit point
  28209. * @param distance
  28210. */
  28211. setHitDistance(distance: number): void;
  28212. /**
  28213. * Calculates the distance manually
  28214. */
  28215. calculateHitDistance(): void;
  28216. /**
  28217. * Resets all the values to default
  28218. * @param from The from point on world space
  28219. * @param to The to point on world space
  28220. */
  28221. reset(from?: Vector3, to?: Vector3): void;
  28222. }
  28223. /**
  28224. * Interface for the size containing width and height
  28225. */
  28226. interface IXYZ {
  28227. /**
  28228. * X
  28229. */
  28230. x: number;
  28231. /**
  28232. * Y
  28233. */
  28234. y: number;
  28235. /**
  28236. * Z
  28237. */
  28238. z: number;
  28239. }
  28240. }
  28241. declare module "babylonjs/Physics/IPhysicsEngine" {
  28242. import { Nullable } from "babylonjs/types";
  28243. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28244. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28245. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28246. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28247. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28248. /**
  28249. * Interface used to describe a physics joint
  28250. */
  28251. export interface PhysicsImpostorJoint {
  28252. /** Defines the main impostor to which the joint is linked */
  28253. mainImpostor: PhysicsImpostor;
  28254. /** Defines the impostor that is connected to the main impostor using this joint */
  28255. connectedImpostor: PhysicsImpostor;
  28256. /** Defines the joint itself */
  28257. joint: PhysicsJoint;
  28258. }
  28259. /** @hidden */
  28260. export interface IPhysicsEnginePlugin {
  28261. world: any;
  28262. name: string;
  28263. setGravity(gravity: Vector3): void;
  28264. setTimeStep(timeStep: number): void;
  28265. getTimeStep(): number;
  28266. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28267. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28268. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28269. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28270. removePhysicsBody(impostor: PhysicsImpostor): void;
  28271. generateJoint(joint: PhysicsImpostorJoint): void;
  28272. removeJoint(joint: PhysicsImpostorJoint): void;
  28273. isSupported(): boolean;
  28274. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28275. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28276. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28277. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28278. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28279. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28280. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28281. getBodyMass(impostor: PhysicsImpostor): number;
  28282. getBodyFriction(impostor: PhysicsImpostor): number;
  28283. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28284. getBodyRestitution(impostor: PhysicsImpostor): number;
  28285. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28286. getBodyPressure?(impostor: PhysicsImpostor): number;
  28287. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28288. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28289. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28290. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28291. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28292. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28293. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28294. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28295. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28296. sleepBody(impostor: PhysicsImpostor): void;
  28297. wakeUpBody(impostor: PhysicsImpostor): void;
  28298. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28299. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28300. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28301. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28302. getRadius(impostor: PhysicsImpostor): number;
  28303. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28304. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28305. dispose(): void;
  28306. }
  28307. /**
  28308. * Interface used to define a physics engine
  28309. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28310. */
  28311. export interface IPhysicsEngine {
  28312. /**
  28313. * Gets the gravity vector used by the simulation
  28314. */
  28315. gravity: Vector3;
  28316. /**
  28317. * Sets the gravity vector used by the simulation
  28318. * @param gravity defines the gravity vector to use
  28319. */
  28320. setGravity(gravity: Vector3): void;
  28321. /**
  28322. * Set the time step of the physics engine.
  28323. * Default is 1/60.
  28324. * To slow it down, enter 1/600 for example.
  28325. * To speed it up, 1/30
  28326. * @param newTimeStep the new timestep to apply to this world.
  28327. */
  28328. setTimeStep(newTimeStep: number): void;
  28329. /**
  28330. * Get the time step of the physics engine.
  28331. * @returns the current time step
  28332. */
  28333. getTimeStep(): number;
  28334. /**
  28335. * Set the sub time step of the physics engine.
  28336. * Default is 0 meaning there is no sub steps
  28337. * To increase physics resolution precision, set a small value (like 1 ms)
  28338. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28339. */
  28340. setSubTimeStep(subTimeStep: number): void;
  28341. /**
  28342. * Get the sub time step of the physics engine.
  28343. * @returns the current sub time step
  28344. */
  28345. getSubTimeStep(): number;
  28346. /**
  28347. * Release all resources
  28348. */
  28349. dispose(): void;
  28350. /**
  28351. * Gets the name of the current physics plugin
  28352. * @returns the name of the plugin
  28353. */
  28354. getPhysicsPluginName(): string;
  28355. /**
  28356. * Adding a new impostor for the impostor tracking.
  28357. * This will be done by the impostor itself.
  28358. * @param impostor the impostor to add
  28359. */
  28360. addImpostor(impostor: PhysicsImpostor): void;
  28361. /**
  28362. * Remove an impostor from the engine.
  28363. * This impostor and its mesh will not longer be updated by the physics engine.
  28364. * @param impostor the impostor to remove
  28365. */
  28366. removeImpostor(impostor: PhysicsImpostor): void;
  28367. /**
  28368. * Add a joint to the physics engine
  28369. * @param mainImpostor defines the main impostor to which the joint is added.
  28370. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28371. * @param joint defines the joint that will connect both impostors.
  28372. */
  28373. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28374. /**
  28375. * Removes a joint from the simulation
  28376. * @param mainImpostor defines the impostor used with the joint
  28377. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28378. * @param joint defines the joint to remove
  28379. */
  28380. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28381. /**
  28382. * Gets the current plugin used to run the simulation
  28383. * @returns current plugin
  28384. */
  28385. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28386. /**
  28387. * Gets the list of physic impostors
  28388. * @returns an array of PhysicsImpostor
  28389. */
  28390. getImpostors(): Array<PhysicsImpostor>;
  28391. /**
  28392. * Gets the impostor for a physics enabled object
  28393. * @param object defines the object impersonated by the impostor
  28394. * @returns the PhysicsImpostor or null if not found
  28395. */
  28396. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28397. /**
  28398. * Gets the impostor for a physics body object
  28399. * @param body defines physics body used by the impostor
  28400. * @returns the PhysicsImpostor or null if not found
  28401. */
  28402. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28403. /**
  28404. * Does a raycast in the physics world
  28405. * @param from when should the ray start?
  28406. * @param to when should the ray end?
  28407. * @returns PhysicsRaycastResult
  28408. */
  28409. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28410. /**
  28411. * Called by the scene. No need to call it.
  28412. * @param delta defines the timespam between frames
  28413. */
  28414. _step(delta: number): void;
  28415. }
  28416. }
  28417. declare module "babylonjs/Physics/physicsImpostor" {
  28418. import { Nullable, IndicesArray } from "babylonjs/types";
  28419. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28420. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28421. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28422. import { Scene } from "babylonjs/scene";
  28423. import { Bone } from "babylonjs/Bones/bone";
  28424. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28425. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28426. import { Space } from "babylonjs/Maths/math.axis";
  28427. /**
  28428. * The interface for the physics imposter parameters
  28429. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28430. */
  28431. export interface PhysicsImpostorParameters {
  28432. /**
  28433. * The mass of the physics imposter
  28434. */
  28435. mass: number;
  28436. /**
  28437. * The friction of the physics imposter
  28438. */
  28439. friction?: number;
  28440. /**
  28441. * The coefficient of restitution of the physics imposter
  28442. */
  28443. restitution?: number;
  28444. /**
  28445. * The native options of the physics imposter
  28446. */
  28447. nativeOptions?: any;
  28448. /**
  28449. * Specifies if the parent should be ignored
  28450. */
  28451. ignoreParent?: boolean;
  28452. /**
  28453. * Specifies if bi-directional transformations should be disabled
  28454. */
  28455. disableBidirectionalTransformation?: boolean;
  28456. /**
  28457. * The pressure inside the physics imposter, soft object only
  28458. */
  28459. pressure?: number;
  28460. /**
  28461. * The stiffness the physics imposter, soft object only
  28462. */
  28463. stiffness?: number;
  28464. /**
  28465. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28466. */
  28467. velocityIterations?: number;
  28468. /**
  28469. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28470. */
  28471. positionIterations?: number;
  28472. /**
  28473. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28474. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28475. * Add to fix multiple points
  28476. */
  28477. fixedPoints?: number;
  28478. /**
  28479. * The collision margin around a soft object
  28480. */
  28481. margin?: number;
  28482. /**
  28483. * The collision margin around a soft object
  28484. */
  28485. damping?: number;
  28486. /**
  28487. * The path for a rope based on an extrusion
  28488. */
  28489. path?: any;
  28490. /**
  28491. * The shape of an extrusion used for a rope based on an extrusion
  28492. */
  28493. shape?: any;
  28494. }
  28495. /**
  28496. * Interface for a physics-enabled object
  28497. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28498. */
  28499. export interface IPhysicsEnabledObject {
  28500. /**
  28501. * The position of the physics-enabled object
  28502. */
  28503. position: Vector3;
  28504. /**
  28505. * The rotation of the physics-enabled object
  28506. */
  28507. rotationQuaternion: Nullable<Quaternion>;
  28508. /**
  28509. * The scale of the physics-enabled object
  28510. */
  28511. scaling: Vector3;
  28512. /**
  28513. * The rotation of the physics-enabled object
  28514. */
  28515. rotation?: Vector3;
  28516. /**
  28517. * The parent of the physics-enabled object
  28518. */
  28519. parent?: any;
  28520. /**
  28521. * The bounding info of the physics-enabled object
  28522. * @returns The bounding info of the physics-enabled object
  28523. */
  28524. getBoundingInfo(): BoundingInfo;
  28525. /**
  28526. * Computes the world matrix
  28527. * @param force Specifies if the world matrix should be computed by force
  28528. * @returns A world matrix
  28529. */
  28530. computeWorldMatrix(force: boolean): Matrix;
  28531. /**
  28532. * Gets the world matrix
  28533. * @returns A world matrix
  28534. */
  28535. getWorldMatrix?(): Matrix;
  28536. /**
  28537. * Gets the child meshes
  28538. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28539. * @returns An array of abstract meshes
  28540. */
  28541. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28542. /**
  28543. * Gets the vertex data
  28544. * @param kind The type of vertex data
  28545. * @returns A nullable array of numbers, or a float32 array
  28546. */
  28547. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28548. /**
  28549. * Gets the indices from the mesh
  28550. * @returns A nullable array of index arrays
  28551. */
  28552. getIndices?(): Nullable<IndicesArray>;
  28553. /**
  28554. * Gets the scene from the mesh
  28555. * @returns the indices array or null
  28556. */
  28557. getScene?(): Scene;
  28558. /**
  28559. * Gets the absolute position from the mesh
  28560. * @returns the absolute position
  28561. */
  28562. getAbsolutePosition(): Vector3;
  28563. /**
  28564. * Gets the absolute pivot point from the mesh
  28565. * @returns the absolute pivot point
  28566. */
  28567. getAbsolutePivotPoint(): Vector3;
  28568. /**
  28569. * Rotates the mesh
  28570. * @param axis The axis of rotation
  28571. * @param amount The amount of rotation
  28572. * @param space The space of the rotation
  28573. * @returns The rotation transform node
  28574. */
  28575. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28576. /**
  28577. * Translates the mesh
  28578. * @param axis The axis of translation
  28579. * @param distance The distance of translation
  28580. * @param space The space of the translation
  28581. * @returns The transform node
  28582. */
  28583. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28584. /**
  28585. * Sets the absolute position of the mesh
  28586. * @param absolutePosition The absolute position of the mesh
  28587. * @returns The transform node
  28588. */
  28589. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28590. /**
  28591. * Gets the class name of the mesh
  28592. * @returns The class name
  28593. */
  28594. getClassName(): string;
  28595. }
  28596. /**
  28597. * Represents a physics imposter
  28598. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28599. */
  28600. export class PhysicsImpostor {
  28601. /**
  28602. * The physics-enabled object used as the physics imposter
  28603. */
  28604. object: IPhysicsEnabledObject;
  28605. /**
  28606. * The type of the physics imposter
  28607. */
  28608. type: number;
  28609. private _options;
  28610. private _scene?;
  28611. /**
  28612. * The default object size of the imposter
  28613. */
  28614. static DEFAULT_OBJECT_SIZE: Vector3;
  28615. /**
  28616. * The identity quaternion of the imposter
  28617. */
  28618. static IDENTITY_QUATERNION: Quaternion;
  28619. /** @hidden */
  28620. _pluginData: any;
  28621. private _physicsEngine;
  28622. private _physicsBody;
  28623. private _bodyUpdateRequired;
  28624. private _onBeforePhysicsStepCallbacks;
  28625. private _onAfterPhysicsStepCallbacks;
  28626. /** @hidden */
  28627. _onPhysicsCollideCallbacks: Array<{
  28628. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28629. otherImpostors: Array<PhysicsImpostor>;
  28630. }>;
  28631. private _deltaPosition;
  28632. private _deltaRotation;
  28633. private _deltaRotationConjugated;
  28634. /** @hidden */
  28635. _isFromLine: boolean;
  28636. private _parent;
  28637. private _isDisposed;
  28638. private static _tmpVecs;
  28639. private static _tmpQuat;
  28640. /**
  28641. * Specifies if the physics imposter is disposed
  28642. */
  28643. get isDisposed(): boolean;
  28644. /**
  28645. * Gets the mass of the physics imposter
  28646. */
  28647. get mass(): number;
  28648. set mass(value: number);
  28649. /**
  28650. * Gets the coefficient of friction
  28651. */
  28652. get friction(): number;
  28653. /**
  28654. * Sets the coefficient of friction
  28655. */
  28656. set friction(value: number);
  28657. /**
  28658. * Gets the coefficient of restitution
  28659. */
  28660. get restitution(): number;
  28661. /**
  28662. * Sets the coefficient of restitution
  28663. */
  28664. set restitution(value: number);
  28665. /**
  28666. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28667. */
  28668. get pressure(): number;
  28669. /**
  28670. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28671. */
  28672. set pressure(value: number);
  28673. /**
  28674. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28675. */
  28676. get stiffness(): number;
  28677. /**
  28678. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28679. */
  28680. set stiffness(value: number);
  28681. /**
  28682. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28683. */
  28684. get velocityIterations(): number;
  28685. /**
  28686. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28687. */
  28688. set velocityIterations(value: number);
  28689. /**
  28690. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28691. */
  28692. get positionIterations(): number;
  28693. /**
  28694. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28695. */
  28696. set positionIterations(value: number);
  28697. /**
  28698. * The unique id of the physics imposter
  28699. * set by the physics engine when adding this impostor to the array
  28700. */
  28701. uniqueId: number;
  28702. /**
  28703. * @hidden
  28704. */
  28705. soft: boolean;
  28706. /**
  28707. * @hidden
  28708. */
  28709. segments: number;
  28710. private _joints;
  28711. /**
  28712. * Initializes the physics imposter
  28713. * @param object The physics-enabled object used as the physics imposter
  28714. * @param type The type of the physics imposter
  28715. * @param _options The options for the physics imposter
  28716. * @param _scene The Babylon scene
  28717. */
  28718. constructor(
  28719. /**
  28720. * The physics-enabled object used as the physics imposter
  28721. */
  28722. object: IPhysicsEnabledObject,
  28723. /**
  28724. * The type of the physics imposter
  28725. */
  28726. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28727. /**
  28728. * This function will completly initialize this impostor.
  28729. * It will create a new body - but only if this mesh has no parent.
  28730. * If it has, this impostor will not be used other than to define the impostor
  28731. * of the child mesh.
  28732. * @hidden
  28733. */
  28734. _init(): void;
  28735. private _getPhysicsParent;
  28736. /**
  28737. * Should a new body be generated.
  28738. * @returns boolean specifying if body initialization is required
  28739. */
  28740. isBodyInitRequired(): boolean;
  28741. /**
  28742. * Sets the updated scaling
  28743. * @param updated Specifies if the scaling is updated
  28744. */
  28745. setScalingUpdated(): void;
  28746. /**
  28747. * Force a regeneration of this or the parent's impostor's body.
  28748. * Use under cautious - This will remove all joints already implemented.
  28749. */
  28750. forceUpdate(): void;
  28751. /**
  28752. * Gets the body that holds this impostor. Either its own, or its parent.
  28753. */
  28754. get physicsBody(): any;
  28755. /**
  28756. * Get the parent of the physics imposter
  28757. * @returns Physics imposter or null
  28758. */
  28759. get parent(): Nullable<PhysicsImpostor>;
  28760. /**
  28761. * Sets the parent of the physics imposter
  28762. */
  28763. set parent(value: Nullable<PhysicsImpostor>);
  28764. /**
  28765. * Set the physics body. Used mainly by the physics engine/plugin
  28766. */
  28767. set physicsBody(physicsBody: any);
  28768. /**
  28769. * Resets the update flags
  28770. */
  28771. resetUpdateFlags(): void;
  28772. /**
  28773. * Gets the object extend size
  28774. * @returns the object extend size
  28775. */
  28776. getObjectExtendSize(): Vector3;
  28777. /**
  28778. * Gets the object center
  28779. * @returns The object center
  28780. */
  28781. getObjectCenter(): Vector3;
  28782. /**
  28783. * Get a specific parameter from the options parameters
  28784. * @param paramName The object parameter name
  28785. * @returns The object parameter
  28786. */
  28787. getParam(paramName: string): any;
  28788. /**
  28789. * Sets a specific parameter in the options given to the physics plugin
  28790. * @param paramName The parameter name
  28791. * @param value The value of the parameter
  28792. */
  28793. setParam(paramName: string, value: number): void;
  28794. /**
  28795. * Specifically change the body's mass option. Won't recreate the physics body object
  28796. * @param mass The mass of the physics imposter
  28797. */
  28798. setMass(mass: number): void;
  28799. /**
  28800. * Gets the linear velocity
  28801. * @returns linear velocity or null
  28802. */
  28803. getLinearVelocity(): Nullable<Vector3>;
  28804. /**
  28805. * Sets the linear velocity
  28806. * @param velocity linear velocity or null
  28807. */
  28808. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28809. /**
  28810. * Gets the angular velocity
  28811. * @returns angular velocity or null
  28812. */
  28813. getAngularVelocity(): Nullable<Vector3>;
  28814. /**
  28815. * Sets the angular velocity
  28816. * @param velocity The velocity or null
  28817. */
  28818. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28819. /**
  28820. * Execute a function with the physics plugin native code
  28821. * Provide a function the will have two variables - the world object and the physics body object
  28822. * @param func The function to execute with the physics plugin native code
  28823. */
  28824. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28825. /**
  28826. * Register a function that will be executed before the physics world is stepping forward
  28827. * @param func The function to execute before the physics world is stepped forward
  28828. */
  28829. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28830. /**
  28831. * Unregister a function that will be executed before the physics world is stepping forward
  28832. * @param func The function to execute before the physics world is stepped forward
  28833. */
  28834. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28835. /**
  28836. * Register a function that will be executed after the physics step
  28837. * @param func The function to execute after physics step
  28838. */
  28839. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28840. /**
  28841. * Unregisters a function that will be executed after the physics step
  28842. * @param func The function to execute after physics step
  28843. */
  28844. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28845. /**
  28846. * register a function that will be executed when this impostor collides against a different body
  28847. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28848. * @param func Callback that is executed on collision
  28849. */
  28850. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28851. /**
  28852. * Unregisters the physics imposter on contact
  28853. * @param collideAgainst The physics object to collide against
  28854. * @param func Callback to execute on collision
  28855. */
  28856. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28857. private _tmpQuat;
  28858. private _tmpQuat2;
  28859. /**
  28860. * Get the parent rotation
  28861. * @returns The parent rotation
  28862. */
  28863. getParentsRotation(): Quaternion;
  28864. /**
  28865. * this function is executed by the physics engine.
  28866. */
  28867. beforeStep: () => void;
  28868. /**
  28869. * this function is executed by the physics engine
  28870. */
  28871. afterStep: () => void;
  28872. /**
  28873. * Legacy collision detection event support
  28874. */
  28875. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28876. /**
  28877. * event and body object due to cannon's event-based architecture.
  28878. */
  28879. onCollide: (e: {
  28880. body: any;
  28881. }) => void;
  28882. /**
  28883. * Apply a force
  28884. * @param force The force to apply
  28885. * @param contactPoint The contact point for the force
  28886. * @returns The physics imposter
  28887. */
  28888. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28889. /**
  28890. * Apply an impulse
  28891. * @param force The impulse force
  28892. * @param contactPoint The contact point for the impulse force
  28893. * @returns The physics imposter
  28894. */
  28895. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28896. /**
  28897. * A help function to create a joint
  28898. * @param otherImpostor A physics imposter used to create a joint
  28899. * @param jointType The type of joint
  28900. * @param jointData The data for the joint
  28901. * @returns The physics imposter
  28902. */
  28903. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28904. /**
  28905. * Add a joint to this impostor with a different impostor
  28906. * @param otherImpostor A physics imposter used to add a joint
  28907. * @param joint The joint to add
  28908. * @returns The physics imposter
  28909. */
  28910. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28911. /**
  28912. * Add an anchor to a cloth impostor
  28913. * @param otherImpostor rigid impostor to anchor to
  28914. * @param width ratio across width from 0 to 1
  28915. * @param height ratio up height from 0 to 1
  28916. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28917. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28918. * @returns impostor the soft imposter
  28919. */
  28920. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28921. /**
  28922. * Add a hook to a rope impostor
  28923. * @param otherImpostor rigid impostor to anchor to
  28924. * @param length ratio across rope from 0 to 1
  28925. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28926. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28927. * @returns impostor the rope imposter
  28928. */
  28929. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28930. /**
  28931. * Will keep this body still, in a sleep mode.
  28932. * @returns the physics imposter
  28933. */
  28934. sleep(): PhysicsImpostor;
  28935. /**
  28936. * Wake the body up.
  28937. * @returns The physics imposter
  28938. */
  28939. wakeUp(): PhysicsImpostor;
  28940. /**
  28941. * Clones the physics imposter
  28942. * @param newObject The physics imposter clones to this physics-enabled object
  28943. * @returns A nullable physics imposter
  28944. */
  28945. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28946. /**
  28947. * Disposes the physics imposter
  28948. */
  28949. dispose(): void;
  28950. /**
  28951. * Sets the delta position
  28952. * @param position The delta position amount
  28953. */
  28954. setDeltaPosition(position: Vector3): void;
  28955. /**
  28956. * Sets the delta rotation
  28957. * @param rotation The delta rotation amount
  28958. */
  28959. setDeltaRotation(rotation: Quaternion): void;
  28960. /**
  28961. * Gets the box size of the physics imposter and stores the result in the input parameter
  28962. * @param result Stores the box size
  28963. * @returns The physics imposter
  28964. */
  28965. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  28966. /**
  28967. * Gets the radius of the physics imposter
  28968. * @returns Radius of the physics imposter
  28969. */
  28970. getRadius(): number;
  28971. /**
  28972. * Sync a bone with this impostor
  28973. * @param bone The bone to sync to the impostor.
  28974. * @param boneMesh The mesh that the bone is influencing.
  28975. * @param jointPivot The pivot of the joint / bone in local space.
  28976. * @param distToJoint Optional distance from the impostor to the joint.
  28977. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28978. */
  28979. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  28980. /**
  28981. * Sync impostor to a bone
  28982. * @param bone The bone that the impostor will be synced to.
  28983. * @param boneMesh The mesh that the bone is influencing.
  28984. * @param jointPivot The pivot of the joint / bone in local space.
  28985. * @param distToJoint Optional distance from the impostor to the joint.
  28986. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28987. * @param boneAxis Optional vector3 axis the bone is aligned with
  28988. */
  28989. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  28990. /**
  28991. * No-Imposter type
  28992. */
  28993. static NoImpostor: number;
  28994. /**
  28995. * Sphere-Imposter type
  28996. */
  28997. static SphereImpostor: number;
  28998. /**
  28999. * Box-Imposter type
  29000. */
  29001. static BoxImpostor: number;
  29002. /**
  29003. * Plane-Imposter type
  29004. */
  29005. static PlaneImpostor: number;
  29006. /**
  29007. * Mesh-imposter type
  29008. */
  29009. static MeshImpostor: number;
  29010. /**
  29011. * Capsule-Impostor type (Ammo.js plugin only)
  29012. */
  29013. static CapsuleImpostor: number;
  29014. /**
  29015. * Cylinder-Imposter type
  29016. */
  29017. static CylinderImpostor: number;
  29018. /**
  29019. * Particle-Imposter type
  29020. */
  29021. static ParticleImpostor: number;
  29022. /**
  29023. * Heightmap-Imposter type
  29024. */
  29025. static HeightmapImpostor: number;
  29026. /**
  29027. * ConvexHull-Impostor type (Ammo.js plugin only)
  29028. */
  29029. static ConvexHullImpostor: number;
  29030. /**
  29031. * Custom-Imposter type (Ammo.js plugin only)
  29032. */
  29033. static CustomImpostor: number;
  29034. /**
  29035. * Rope-Imposter type
  29036. */
  29037. static RopeImpostor: number;
  29038. /**
  29039. * Cloth-Imposter type
  29040. */
  29041. static ClothImpostor: number;
  29042. /**
  29043. * Softbody-Imposter type
  29044. */
  29045. static SoftbodyImpostor: number;
  29046. }
  29047. }
  29048. declare module "babylonjs/Meshes/mesh" {
  29049. import { Observable } from "babylonjs/Misc/observable";
  29050. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29051. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  29052. import { Camera } from "babylonjs/Cameras/camera";
  29053. import { Scene } from "babylonjs/scene";
  29054. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  29055. import { Color4 } from "babylonjs/Maths/math.color";
  29056. import { Engine } from "babylonjs/Engines/engine";
  29057. import { Node } from "babylonjs/node";
  29058. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29059. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  29060. import { Buffer } from "babylonjs/Meshes/buffer";
  29061. import { Geometry } from "babylonjs/Meshes/geometry";
  29062. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29063. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29064. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  29065. import { Effect } from "babylonjs/Materials/effect";
  29066. import { Material } from "babylonjs/Materials/material";
  29067. import { Skeleton } from "babylonjs/Bones/skeleton";
  29068. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  29069. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  29070. import { Path3D } from "babylonjs/Maths/math.path";
  29071. import { Plane } from "babylonjs/Maths/math.plane";
  29072. import { TransformNode } from "babylonjs/Meshes/transformNode";
  29073. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  29074. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  29075. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  29076. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  29077. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  29078. /**
  29079. * @hidden
  29080. **/
  29081. export class _CreationDataStorage {
  29082. closePath?: boolean;
  29083. closeArray?: boolean;
  29084. idx: number[];
  29085. dashSize: number;
  29086. gapSize: number;
  29087. path3D: Path3D;
  29088. pathArray: Vector3[][];
  29089. arc: number;
  29090. radius: number;
  29091. cap: number;
  29092. tessellation: number;
  29093. }
  29094. /**
  29095. * @hidden
  29096. **/
  29097. class _InstanceDataStorage {
  29098. visibleInstances: any;
  29099. batchCache: _InstancesBatch;
  29100. instancesBufferSize: number;
  29101. instancesBuffer: Nullable<Buffer>;
  29102. instancesData: Float32Array;
  29103. overridenInstanceCount: number;
  29104. isFrozen: boolean;
  29105. previousBatch: Nullable<_InstancesBatch>;
  29106. hardwareInstancedRendering: boolean;
  29107. sideOrientation: number;
  29108. manualUpdate: boolean;
  29109. }
  29110. /**
  29111. * @hidden
  29112. **/
  29113. export class _InstancesBatch {
  29114. mustReturn: boolean;
  29115. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  29116. renderSelf: boolean[];
  29117. hardwareInstancedRendering: boolean[];
  29118. }
  29119. /**
  29120. * @hidden
  29121. **/
  29122. class _ThinInstanceDataStorage {
  29123. instancesCount: number;
  29124. matrixBuffer: Nullable<Buffer>;
  29125. matrixBufferSize: number;
  29126. matrixData: Nullable<Float32Array>;
  29127. boundingVectors: Array<Vector3>;
  29128. worldMatrices: Nullable<Matrix[]>;
  29129. }
  29130. /**
  29131. * Class used to represent renderable models
  29132. */
  29133. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  29134. /**
  29135. * Mesh side orientation : usually the external or front surface
  29136. */
  29137. static readonly FRONTSIDE: number;
  29138. /**
  29139. * Mesh side orientation : usually the internal or back surface
  29140. */
  29141. static readonly BACKSIDE: number;
  29142. /**
  29143. * Mesh side orientation : both internal and external or front and back surfaces
  29144. */
  29145. static readonly DOUBLESIDE: number;
  29146. /**
  29147. * Mesh side orientation : by default, `FRONTSIDE`
  29148. */
  29149. static readonly DEFAULTSIDE: number;
  29150. /**
  29151. * Mesh cap setting : no cap
  29152. */
  29153. static readonly NO_CAP: number;
  29154. /**
  29155. * Mesh cap setting : one cap at the beginning of the mesh
  29156. */
  29157. static readonly CAP_START: number;
  29158. /**
  29159. * Mesh cap setting : one cap at the end of the mesh
  29160. */
  29161. static readonly CAP_END: number;
  29162. /**
  29163. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  29164. */
  29165. static readonly CAP_ALL: number;
  29166. /**
  29167. * Mesh pattern setting : no flip or rotate
  29168. */
  29169. static readonly NO_FLIP: number;
  29170. /**
  29171. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  29172. */
  29173. static readonly FLIP_TILE: number;
  29174. /**
  29175. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  29176. */
  29177. static readonly ROTATE_TILE: number;
  29178. /**
  29179. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  29180. */
  29181. static readonly FLIP_ROW: number;
  29182. /**
  29183. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  29184. */
  29185. static readonly ROTATE_ROW: number;
  29186. /**
  29187. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  29188. */
  29189. static readonly FLIP_N_ROTATE_TILE: number;
  29190. /**
  29191. * Mesh pattern setting : rotate pattern and rotate
  29192. */
  29193. static readonly FLIP_N_ROTATE_ROW: number;
  29194. /**
  29195. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29196. */
  29197. static readonly CENTER: number;
  29198. /**
  29199. * Mesh tile positioning : part tiles on left
  29200. */
  29201. static readonly LEFT: number;
  29202. /**
  29203. * Mesh tile positioning : part tiles on right
  29204. */
  29205. static readonly RIGHT: number;
  29206. /**
  29207. * Mesh tile positioning : part tiles on top
  29208. */
  29209. static readonly TOP: number;
  29210. /**
  29211. * Mesh tile positioning : part tiles on bottom
  29212. */
  29213. static readonly BOTTOM: number;
  29214. /**
  29215. * Gets the default side orientation.
  29216. * @param orientation the orientation to value to attempt to get
  29217. * @returns the default orientation
  29218. * @hidden
  29219. */
  29220. static _GetDefaultSideOrientation(orientation?: number): number;
  29221. private _internalMeshDataInfo;
  29222. get computeBonesUsingShaders(): boolean;
  29223. set computeBonesUsingShaders(value: boolean);
  29224. /**
  29225. * An event triggered before rendering the mesh
  29226. */
  29227. get onBeforeRenderObservable(): Observable<Mesh>;
  29228. /**
  29229. * An event triggered before binding the mesh
  29230. */
  29231. get onBeforeBindObservable(): Observable<Mesh>;
  29232. /**
  29233. * An event triggered after rendering the mesh
  29234. */
  29235. get onAfterRenderObservable(): Observable<Mesh>;
  29236. /**
  29237. * An event triggered before drawing the mesh
  29238. */
  29239. get onBeforeDrawObservable(): Observable<Mesh>;
  29240. private _onBeforeDrawObserver;
  29241. /**
  29242. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29243. */
  29244. set onBeforeDraw(callback: () => void);
  29245. get hasInstances(): boolean;
  29246. get hasThinInstances(): boolean;
  29247. /**
  29248. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29249. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29250. */
  29251. delayLoadState: number;
  29252. /**
  29253. * Gets the list of instances created from this mesh
  29254. * it is not supposed to be modified manually.
  29255. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29256. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29257. */
  29258. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29259. /**
  29260. * Gets the file containing delay loading data for this mesh
  29261. */
  29262. delayLoadingFile: string;
  29263. /** @hidden */
  29264. _binaryInfo: any;
  29265. /**
  29266. * User defined function used to change how LOD level selection is done
  29267. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29268. */
  29269. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29270. /**
  29271. * Gets or sets the morph target manager
  29272. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29273. */
  29274. get morphTargetManager(): Nullable<MorphTargetManager>;
  29275. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29276. /** @hidden */
  29277. _creationDataStorage: Nullable<_CreationDataStorage>;
  29278. /** @hidden */
  29279. _geometry: Nullable<Geometry>;
  29280. /** @hidden */
  29281. _delayInfo: Array<string>;
  29282. /** @hidden */
  29283. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29284. /** @hidden */
  29285. _instanceDataStorage: _InstanceDataStorage;
  29286. /** @hidden */
  29287. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29288. private _effectiveMaterial;
  29289. /** @hidden */
  29290. _shouldGenerateFlatShading: boolean;
  29291. /** @hidden */
  29292. _originalBuilderSideOrientation: number;
  29293. /**
  29294. * Use this property to change the original side orientation defined at construction time
  29295. */
  29296. overrideMaterialSideOrientation: Nullable<number>;
  29297. /**
  29298. * Gets the source mesh (the one used to clone this one from)
  29299. */
  29300. get source(): Nullable<Mesh>;
  29301. /**
  29302. * Gets the list of clones of this mesh
  29303. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  29304. * Note that useClonedMeshMap=true is the default setting
  29305. */
  29306. get cloneMeshMap(): Nullable<{
  29307. [id: string]: Mesh | undefined;
  29308. }>;
  29309. /**
  29310. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29311. */
  29312. get isUnIndexed(): boolean;
  29313. set isUnIndexed(value: boolean);
  29314. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29315. get worldMatrixInstancedBuffer(): Float32Array;
  29316. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29317. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29318. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29319. /**
  29320. * @constructor
  29321. * @param name The value used by scene.getMeshByName() to do a lookup.
  29322. * @param scene The scene to add this mesh to.
  29323. * @param parent The parent of this mesh, if it has one
  29324. * @param source An optional Mesh from which geometry is shared, cloned.
  29325. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29326. * When false, achieved by calling a clone(), also passing False.
  29327. * This will make creation of children, recursive.
  29328. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29329. */
  29330. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29331. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29332. doNotInstantiate: boolean;
  29333. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29334. /**
  29335. * Gets the class name
  29336. * @returns the string "Mesh".
  29337. */
  29338. getClassName(): string;
  29339. /** @hidden */
  29340. get _isMesh(): boolean;
  29341. /**
  29342. * Returns a description of this mesh
  29343. * @param fullDetails define if full details about this mesh must be used
  29344. * @returns a descriptive string representing this mesh
  29345. */
  29346. toString(fullDetails?: boolean): string;
  29347. /** @hidden */
  29348. _unBindEffect(): void;
  29349. /**
  29350. * Gets a boolean indicating if this mesh has LOD
  29351. */
  29352. get hasLODLevels(): boolean;
  29353. /**
  29354. * Gets the list of MeshLODLevel associated with the current mesh
  29355. * @returns an array of MeshLODLevel
  29356. */
  29357. getLODLevels(): MeshLODLevel[];
  29358. private _sortLODLevels;
  29359. /**
  29360. * Add a mesh as LOD level triggered at the given distance.
  29361. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29362. * @param distance The distance from the center of the object to show this level
  29363. * @param mesh The mesh to be added as LOD level (can be null)
  29364. * @return This mesh (for chaining)
  29365. */
  29366. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29367. /**
  29368. * Returns the LOD level mesh at the passed distance or null if not found.
  29369. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29370. * @param distance The distance from the center of the object to show this level
  29371. * @returns a Mesh or `null`
  29372. */
  29373. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29374. /**
  29375. * Remove a mesh from the LOD array
  29376. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29377. * @param mesh defines the mesh to be removed
  29378. * @return This mesh (for chaining)
  29379. */
  29380. removeLODLevel(mesh: Mesh): Mesh;
  29381. /**
  29382. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29383. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29384. * @param camera defines the camera to use to compute distance
  29385. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29386. * @return This mesh (for chaining)
  29387. */
  29388. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29389. /**
  29390. * Gets the mesh internal Geometry object
  29391. */
  29392. get geometry(): Nullable<Geometry>;
  29393. /**
  29394. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29395. * @returns the total number of vertices
  29396. */
  29397. getTotalVertices(): number;
  29398. /**
  29399. * Returns the content of an associated vertex buffer
  29400. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29401. * - VertexBuffer.PositionKind
  29402. * - VertexBuffer.UVKind
  29403. * - VertexBuffer.UV2Kind
  29404. * - VertexBuffer.UV3Kind
  29405. * - VertexBuffer.UV4Kind
  29406. * - VertexBuffer.UV5Kind
  29407. * - VertexBuffer.UV6Kind
  29408. * - VertexBuffer.ColorKind
  29409. * - VertexBuffer.MatricesIndicesKind
  29410. * - VertexBuffer.MatricesIndicesExtraKind
  29411. * - VertexBuffer.MatricesWeightsKind
  29412. * - VertexBuffer.MatricesWeightsExtraKind
  29413. * @param copyWhenShared defines a boolean indicating that if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one
  29414. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29415. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29416. */
  29417. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29418. /**
  29419. * Returns the mesh VertexBuffer object from the requested `kind`
  29420. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29421. * - VertexBuffer.PositionKind
  29422. * - VertexBuffer.NormalKind
  29423. * - VertexBuffer.UVKind
  29424. * - VertexBuffer.UV2Kind
  29425. * - VertexBuffer.UV3Kind
  29426. * - VertexBuffer.UV4Kind
  29427. * - VertexBuffer.UV5Kind
  29428. * - VertexBuffer.UV6Kind
  29429. * - VertexBuffer.ColorKind
  29430. * - VertexBuffer.MatricesIndicesKind
  29431. * - VertexBuffer.MatricesIndicesExtraKind
  29432. * - VertexBuffer.MatricesWeightsKind
  29433. * - VertexBuffer.MatricesWeightsExtraKind
  29434. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29435. */
  29436. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29437. /**
  29438. * Tests if a specific vertex buffer is associated with this mesh
  29439. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29440. * - VertexBuffer.PositionKind
  29441. * - VertexBuffer.NormalKind
  29442. * - VertexBuffer.UVKind
  29443. * - VertexBuffer.UV2Kind
  29444. * - VertexBuffer.UV3Kind
  29445. * - VertexBuffer.UV4Kind
  29446. * - VertexBuffer.UV5Kind
  29447. * - VertexBuffer.UV6Kind
  29448. * - VertexBuffer.ColorKind
  29449. * - VertexBuffer.MatricesIndicesKind
  29450. * - VertexBuffer.MatricesIndicesExtraKind
  29451. * - VertexBuffer.MatricesWeightsKind
  29452. * - VertexBuffer.MatricesWeightsExtraKind
  29453. * @returns a boolean
  29454. */
  29455. isVerticesDataPresent(kind: string): boolean;
  29456. /**
  29457. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29458. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29459. * - VertexBuffer.PositionKind
  29460. * - VertexBuffer.UVKind
  29461. * - VertexBuffer.UV2Kind
  29462. * - VertexBuffer.UV3Kind
  29463. * - VertexBuffer.UV4Kind
  29464. * - VertexBuffer.UV5Kind
  29465. * - VertexBuffer.UV6Kind
  29466. * - VertexBuffer.ColorKind
  29467. * - VertexBuffer.MatricesIndicesKind
  29468. * - VertexBuffer.MatricesIndicesExtraKind
  29469. * - VertexBuffer.MatricesWeightsKind
  29470. * - VertexBuffer.MatricesWeightsExtraKind
  29471. * @returns a boolean
  29472. */
  29473. isVertexBufferUpdatable(kind: string): boolean;
  29474. /**
  29475. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29476. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29477. * - VertexBuffer.PositionKind
  29478. * - VertexBuffer.NormalKind
  29479. * - VertexBuffer.UVKind
  29480. * - VertexBuffer.UV2Kind
  29481. * - VertexBuffer.UV3Kind
  29482. * - VertexBuffer.UV4Kind
  29483. * - VertexBuffer.UV5Kind
  29484. * - VertexBuffer.UV6Kind
  29485. * - VertexBuffer.ColorKind
  29486. * - VertexBuffer.MatricesIndicesKind
  29487. * - VertexBuffer.MatricesIndicesExtraKind
  29488. * - VertexBuffer.MatricesWeightsKind
  29489. * - VertexBuffer.MatricesWeightsExtraKind
  29490. * @returns an array of strings
  29491. */
  29492. getVerticesDataKinds(): string[];
  29493. /**
  29494. * Returns a positive integer : the total number of indices in this mesh geometry.
  29495. * @returns the numner of indices or zero if the mesh has no geometry.
  29496. */
  29497. getTotalIndices(): number;
  29498. /**
  29499. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29500. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  29501. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29502. * @returns the indices array or an empty array if the mesh has no geometry
  29503. */
  29504. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29505. get isBlocked(): boolean;
  29506. /**
  29507. * Determine if the current mesh is ready to be rendered
  29508. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29509. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29510. * @returns true if all associated assets are ready (material, textures, shaders)
  29511. */
  29512. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29513. /**
  29514. * Gets a boolean indicating if the normals aren't to be recomputed on next mesh `positions` array update. This property is pertinent only for updatable parametric shapes.
  29515. */
  29516. get areNormalsFrozen(): boolean;
  29517. /**
  29518. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It prevents the mesh normals from being recomputed on next `positions` array update.
  29519. * @returns the current mesh
  29520. */
  29521. freezeNormals(): Mesh;
  29522. /**
  29523. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It reactivates the mesh normals computation if it was previously frozen
  29524. * @returns the current mesh
  29525. */
  29526. unfreezeNormals(): Mesh;
  29527. /**
  29528. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29529. */
  29530. set overridenInstanceCount(count: number);
  29531. /** @hidden */
  29532. _preActivate(): Mesh;
  29533. /** @hidden */
  29534. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29535. /** @hidden */
  29536. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29537. protected _afterComputeWorldMatrix(): void;
  29538. /** @hidden */
  29539. _postActivate(): void;
  29540. /**
  29541. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29542. * This means the mesh underlying bounding box and sphere are recomputed.
  29543. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29544. * @returns the current mesh
  29545. */
  29546. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29547. /** @hidden */
  29548. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29549. /**
  29550. * This function will subdivide the mesh into multiple submeshes
  29551. * @param count defines the expected number of submeshes
  29552. */
  29553. subdivide(count: number): void;
  29554. /**
  29555. * Copy a FloatArray into a specific associated vertex buffer
  29556. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29557. * - VertexBuffer.PositionKind
  29558. * - VertexBuffer.UVKind
  29559. * - VertexBuffer.UV2Kind
  29560. * - VertexBuffer.UV3Kind
  29561. * - VertexBuffer.UV4Kind
  29562. * - VertexBuffer.UV5Kind
  29563. * - VertexBuffer.UV6Kind
  29564. * - VertexBuffer.ColorKind
  29565. * - VertexBuffer.MatricesIndicesKind
  29566. * - VertexBuffer.MatricesIndicesExtraKind
  29567. * - VertexBuffer.MatricesWeightsKind
  29568. * - VertexBuffer.MatricesWeightsExtraKind
  29569. * @param data defines the data source
  29570. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29571. * @param stride defines the data stride size (can be null)
  29572. * @returns the current mesh
  29573. */
  29574. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29575. /**
  29576. * Delete a vertex buffer associated with this mesh
  29577. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29578. * - VertexBuffer.PositionKind
  29579. * - VertexBuffer.UVKind
  29580. * - VertexBuffer.UV2Kind
  29581. * - VertexBuffer.UV3Kind
  29582. * - VertexBuffer.UV4Kind
  29583. * - VertexBuffer.UV5Kind
  29584. * - VertexBuffer.UV6Kind
  29585. * - VertexBuffer.ColorKind
  29586. * - VertexBuffer.MatricesIndicesKind
  29587. * - VertexBuffer.MatricesIndicesExtraKind
  29588. * - VertexBuffer.MatricesWeightsKind
  29589. * - VertexBuffer.MatricesWeightsExtraKind
  29590. */
  29591. removeVerticesData(kind: string): void;
  29592. /**
  29593. * Flags an associated vertex buffer as updatable
  29594. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29595. * - VertexBuffer.PositionKind
  29596. * - VertexBuffer.UVKind
  29597. * - VertexBuffer.UV2Kind
  29598. * - VertexBuffer.UV3Kind
  29599. * - VertexBuffer.UV4Kind
  29600. * - VertexBuffer.UV5Kind
  29601. * - VertexBuffer.UV6Kind
  29602. * - VertexBuffer.ColorKind
  29603. * - VertexBuffer.MatricesIndicesKind
  29604. * - VertexBuffer.MatricesIndicesExtraKind
  29605. * - VertexBuffer.MatricesWeightsKind
  29606. * - VertexBuffer.MatricesWeightsExtraKind
  29607. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29608. */
  29609. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29610. /**
  29611. * Sets the mesh global Vertex Buffer
  29612. * @param buffer defines the buffer to use
  29613. * @returns the current mesh
  29614. */
  29615. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29616. /**
  29617. * Update a specific associated vertex buffer
  29618. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29619. * - VertexBuffer.PositionKind
  29620. * - VertexBuffer.UVKind
  29621. * - VertexBuffer.UV2Kind
  29622. * - VertexBuffer.UV3Kind
  29623. * - VertexBuffer.UV4Kind
  29624. * - VertexBuffer.UV5Kind
  29625. * - VertexBuffer.UV6Kind
  29626. * - VertexBuffer.ColorKind
  29627. * - VertexBuffer.MatricesIndicesKind
  29628. * - VertexBuffer.MatricesIndicesExtraKind
  29629. * - VertexBuffer.MatricesWeightsKind
  29630. * - VertexBuffer.MatricesWeightsExtraKind
  29631. * @param data defines the data source
  29632. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29633. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  29634. * @returns the current mesh
  29635. */
  29636. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29637. /**
  29638. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29639. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29640. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29641. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29642. * @returns the current mesh
  29643. */
  29644. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29645. /**
  29646. * Creates a un-shared specific occurence of the geometry for the mesh.
  29647. * @returns the current mesh
  29648. */
  29649. makeGeometryUnique(): Mesh;
  29650. /**
  29651. * Set the index buffer of this mesh
  29652. * @param indices defines the source data
  29653. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29654. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29655. * @returns the current mesh
  29656. */
  29657. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29658. /**
  29659. * Update the current index buffer
  29660. * @param indices defines the source data
  29661. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29662. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  29663. * @returns the current mesh
  29664. */
  29665. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29666. /**
  29667. * Invert the geometry to move from a right handed system to a left handed one.
  29668. * @returns the current mesh
  29669. */
  29670. toLeftHanded(): Mesh;
  29671. /** @hidden */
  29672. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29673. /** @hidden */
  29674. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29675. /**
  29676. * Registers for this mesh a javascript function called just before the rendering process
  29677. * @param func defines the function to call before rendering this mesh
  29678. * @returns the current mesh
  29679. */
  29680. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29681. /**
  29682. * Disposes a previously registered javascript function called before the rendering
  29683. * @param func defines the function to remove
  29684. * @returns the current mesh
  29685. */
  29686. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29687. /**
  29688. * Registers for this mesh a javascript function called just after the rendering is complete
  29689. * @param func defines the function to call after rendering this mesh
  29690. * @returns the current mesh
  29691. */
  29692. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29693. /**
  29694. * Disposes a previously registered javascript function called after the rendering.
  29695. * @param func defines the function to remove
  29696. * @returns the current mesh
  29697. */
  29698. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29699. /** @hidden */
  29700. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29701. /** @hidden */
  29702. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29703. /** @hidden */
  29704. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29705. /** @hidden */
  29706. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29707. /** @hidden */
  29708. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29709. /** @hidden */
  29710. _rebuild(): void;
  29711. /** @hidden */
  29712. _freeze(): void;
  29713. /** @hidden */
  29714. _unFreeze(): void;
  29715. /**
  29716. * Triggers the draw call for the mesh. Usually, you don't need to call this method by your own because the mesh rendering is handled by the scene rendering manager
  29717. * @param subMesh defines the subMesh to render
  29718. * @param enableAlphaMode defines if alpha mode can be changed
  29719. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29720. * @returns the current mesh
  29721. */
  29722. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29723. private _onBeforeDraw;
  29724. /**
  29725. * Renormalize the mesh and patch it up if there are no weights
  29726. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29727. * However in the case of zero weights then we set just a single influence to 1.
  29728. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29729. */
  29730. cleanMatrixWeights(): void;
  29731. private normalizeSkinFourWeights;
  29732. private normalizeSkinWeightsAndExtra;
  29733. /**
  29734. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29735. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29736. * the user know there was an issue with importing the mesh
  29737. * @returns a validation object with skinned, valid and report string
  29738. */
  29739. validateSkinning(): {
  29740. skinned: boolean;
  29741. valid: boolean;
  29742. report: string;
  29743. };
  29744. /** @hidden */
  29745. _checkDelayState(): Mesh;
  29746. private _queueLoad;
  29747. /**
  29748. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29749. * A mesh is in the frustum if its bounding box intersects the frustum
  29750. * @param frustumPlanes defines the frustum to test
  29751. * @returns true if the mesh is in the frustum planes
  29752. */
  29753. isInFrustum(frustumPlanes: Plane[]): boolean;
  29754. /**
  29755. * Sets the mesh material by the material or multiMaterial `id` property
  29756. * @param id is a string identifying the material or the multiMaterial
  29757. * @returns the current mesh
  29758. */
  29759. setMaterialByID(id: string): Mesh;
  29760. /**
  29761. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29762. * @returns an array of IAnimatable
  29763. */
  29764. getAnimatables(): IAnimatable[];
  29765. /**
  29766. * Modifies the mesh geometry according to the passed transformation matrix.
  29767. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29768. * The mesh normals are modified using the same transformation.
  29769. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29770. * @param transform defines the transform matrix to use
  29771. * @see https://doc.babylonjs.com/resources/baking_transformations
  29772. * @returns the current mesh
  29773. */
  29774. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29775. /**
  29776. * Modifies the mesh geometry according to its own current World Matrix.
  29777. * The mesh World Matrix is then reset.
  29778. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29779. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29780. * @see https://doc.babylonjs.com/resources/baking_transformations
  29781. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29782. * @returns the current mesh
  29783. */
  29784. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29785. /** @hidden */
  29786. get _positions(): Nullable<Vector3[]>;
  29787. /** @hidden */
  29788. _resetPointsArrayCache(): Mesh;
  29789. /** @hidden */
  29790. _generatePointsArray(): boolean;
  29791. /**
  29792. * Returns a new Mesh object generated from the current mesh properties.
  29793. * This method must not get confused with createInstance()
  29794. * @param name is a string, the name given to the new mesh
  29795. * @param newParent can be any Node object (default `null`)
  29796. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29797. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29798. * @returns a new mesh
  29799. */
  29800. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29801. /**
  29802. * Releases resources associated with this mesh.
  29803. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29804. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29805. */
  29806. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29807. /** @hidden */
  29808. _disposeInstanceSpecificData(): void;
  29809. /** @hidden */
  29810. _disposeThinInstanceSpecificData(): void;
  29811. /**
  29812. * Modifies the mesh geometry according to a displacement map.
  29813. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  29814. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29815. * @param url is a string, the URL from the image file is to be downloaded.
  29816. * @param minHeight is the lower limit of the displacement.
  29817. * @param maxHeight is the upper limit of the displacement.
  29818. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  29819. * @param uvOffset is an optional vector2 used to offset UV.
  29820. * @param uvScale is an optional vector2 used to scale UV.
  29821. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  29822. * @returns the Mesh.
  29823. */
  29824. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29825. /**
  29826. * Modifies the mesh geometry according to a displacementMap buffer.
  29827. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  29828. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29829. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29830. * @param heightMapWidth is the width of the buffer image.
  29831. * @param heightMapHeight is the height of the buffer image.
  29832. * @param minHeight is the lower limit of the displacement.
  29833. * @param maxHeight is the upper limit of the displacement.
  29834. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  29835. * @param uvOffset is an optional vector2 used to offset UV.
  29836. * @param uvScale is an optional vector2 used to scale UV.
  29837. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  29838. * @returns the Mesh.
  29839. */
  29840. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29841. /**
  29842. * Modify the mesh to get a flat shading rendering.
  29843. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29844. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29845. * @returns current mesh
  29846. */
  29847. convertToFlatShadedMesh(): Mesh;
  29848. /**
  29849. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29850. * In other words, more vertices, no more indices and a single bigger VBO.
  29851. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29852. * @returns current mesh
  29853. */
  29854. convertToUnIndexedMesh(): Mesh;
  29855. /**
  29856. * Inverses facet orientations.
  29857. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29858. * @param flipNormals will also inverts the normals
  29859. * @returns current mesh
  29860. */
  29861. flipFaces(flipNormals?: boolean): Mesh;
  29862. /**
  29863. * Increase the number of facets and hence vertices in a mesh
  29864. * Vertex normals are interpolated from existing vertex normals
  29865. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29866. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29867. */
  29868. increaseVertices(numberPerEdge: number): void;
  29869. /**
  29870. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29871. * This will undo any application of covertToFlatShadedMesh
  29872. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29873. */
  29874. forceSharedVertices(): void;
  29875. /** @hidden */
  29876. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29877. /** @hidden */
  29878. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29879. /**
  29880. * Creates a new InstancedMesh object from the mesh model.
  29881. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29882. * @param name defines the name of the new instance
  29883. * @returns a new InstancedMesh
  29884. */
  29885. createInstance(name: string): InstancedMesh;
  29886. /**
  29887. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29888. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29889. * @returns the current mesh
  29890. */
  29891. synchronizeInstances(): Mesh;
  29892. /**
  29893. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29894. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29895. * This should be used together with the simplification to avoid disappearing triangles.
  29896. * @param successCallback an optional success callback to be called after the optimization finished.
  29897. * @returns the current mesh
  29898. */
  29899. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29900. /**
  29901. * Serialize current mesh
  29902. * @param serializationObject defines the object which will receive the serialization data
  29903. */
  29904. serialize(serializationObject: any): void;
  29905. /** @hidden */
  29906. _syncGeometryWithMorphTargetManager(): void;
  29907. /** @hidden */
  29908. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29909. /**
  29910. * Returns a new Mesh object parsed from the source provided.
  29911. * @param parsedMesh is the source
  29912. * @param scene defines the hosting scene
  29913. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29914. * @returns a new Mesh
  29915. */
  29916. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29917. /**
  29918. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29919. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29920. * @param name defines the name of the mesh to create
  29921. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29922. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29923. * @param closePath creates a seam between the first and the last points of each path of the path array
  29924. * @param offset is taken in account only if the `pathArray` is containing a single path
  29925. * @param scene defines the hosting scene
  29926. * @param updatable defines if the mesh must be flagged as updatable
  29927. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29928. * @param instance defines an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#ribbon)
  29929. * @returns a new Mesh
  29930. */
  29931. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29932. /**
  29933. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29934. * @param name defines the name of the mesh to create
  29935. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29936. * @param tessellation sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  29937. * @param scene defines the hosting scene
  29938. * @param updatable defines if the mesh must be flagged as updatable
  29939. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29940. * @returns a new Mesh
  29941. */
  29942. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29943. /**
  29944. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  29945. * @param name defines the name of the mesh to create
  29946. * @param size sets the size (float) of each box side (default 1)
  29947. * @param scene defines the hosting scene
  29948. * @param updatable defines if the mesh must be flagged as updatable
  29949. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29950. * @returns a new Mesh
  29951. */
  29952. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29953. /**
  29954. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29955. * @param name defines the name of the mesh to create
  29956. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29957. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29958. * @param scene defines the hosting scene
  29959. * @param updatable defines if the mesh must be flagged as updatable
  29960. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29961. * @returns a new Mesh
  29962. */
  29963. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29964. /**
  29965. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  29966. * @param name defines the name of the mesh to create
  29967. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29968. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29969. * @param scene defines the hosting scene
  29970. * @returns a new Mesh
  29971. */
  29972. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29973. /**
  29974. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29975. * @param name defines the name of the mesh to create
  29976. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29977. * @param diameterTop set the top cap diameter (floats, default 1)
  29978. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29979. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29980. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29981. * @param scene defines the hosting scene
  29982. * @param updatable defines if the mesh must be flagged as updatable
  29983. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29984. * @returns a new Mesh
  29985. */
  29986. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29987. /**
  29988. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29989. * @param name defines the name of the mesh to create
  29990. * @param diameter sets the diameter size (float) of the torus (default 1)
  29991. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29992. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29993. * @param scene defines the hosting scene
  29994. * @param updatable defines if the mesh must be flagged as updatable
  29995. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29996. * @returns a new Mesh
  29997. */
  29998. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29999. /**
  30000. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  30001. * @param name defines the name of the mesh to create
  30002. * @param radius sets the global radius size (float) of the torus knot (default 2)
  30003. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  30004. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  30005. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  30006. * @param p the number of windings on X axis (positive integers, default 2)
  30007. * @param q the number of windings on Y axis (positive integers, default 3)
  30008. * @param scene defines the hosting scene
  30009. * @param updatable defines if the mesh must be flagged as updatable
  30010. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30011. * @returns a new Mesh
  30012. */
  30013. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30014. /**
  30015. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  30016. * @param name defines the name of the mesh to create
  30017. * @param points is an array successive Vector3
  30018. * @param scene defines the hosting scene
  30019. * @param updatable defines if the mesh must be flagged as updatable
  30020. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines).
  30021. * @returns a new Mesh
  30022. */
  30023. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30024. /**
  30025. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30026. * @param name defines the name of the mesh to create
  30027. * @param points is an array successive Vector3
  30028. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30029. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30030. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30031. * @param scene defines the hosting scene
  30032. * @param updatable defines if the mesh must be flagged as updatable
  30033. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines)
  30034. * @returns a new Mesh
  30035. */
  30036. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30037. /**
  30038. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30039. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30040. * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors.
  30041. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30042. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30043. * Remember you can only change the shape positions, not their number when updating a polygon.
  30044. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30045. * @param name defines the name of the mesh to create
  30046. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  30047. * @param scene defines the hosting scene
  30048. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30049. * @param updatable defines if the mesh must be flagged as updatable
  30050. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30051. * @param earcutInjection can be used to inject your own earcut reference
  30052. * @returns a new Mesh
  30053. */
  30054. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30055. /**
  30056. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30057. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30058. * @param name defines the name of the mesh to create
  30059. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  30060. * @param depth defines the height of extrusion
  30061. * @param scene defines the hosting scene
  30062. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30063. * @param updatable defines if the mesh must be flagged as updatable
  30064. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30065. * @param earcutInjection can be used to inject your own earcut reference
  30066. * @returns a new Mesh
  30067. */
  30068. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30069. /**
  30070. * Creates an extruded shape mesh.
  30071. * The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters. Please consider using the same method from the MeshBuilder class instead
  30072. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30073. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30074. * @param name defines the name of the mesh to create
  30075. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  30076. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30077. * @param scale is the value to scale the shape
  30078. * @param rotation is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve
  30079. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30080. * @param scene defines the hosting scene
  30081. * @param updatable defines if the mesh must be flagged as updatable
  30082. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30083. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#extruded-shape)
  30084. * @returns a new Mesh
  30085. */
  30086. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30087. /**
  30088. * Creates an custom extruded shape mesh.
  30089. * The custom extrusion is a parametric shape.
  30090. * It has no predefined shape. Its final shape will depend on the input parameters.
  30091. * Please consider using the same method from the MeshBuilder class instead
  30092. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30093. * @param name defines the name of the mesh to create
  30094. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  30095. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30096. * @param scaleFunction is a custom Javascript function called on each path point
  30097. * @param rotationFunction is a custom Javascript function called on each path point
  30098. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30099. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30100. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30101. * @param scene defines the hosting scene
  30102. * @param updatable defines if the mesh must be flagged as updatable
  30103. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30104. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape)
  30105. * @returns a new Mesh
  30106. */
  30107. static ExtrudeShapeCustom(name: string, shape: Vector3[], path: Vector3[], scaleFunction: Function, rotationFunction: Function, ribbonCloseArray: boolean, ribbonClosePath: boolean, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30108. /**
  30109. * Creates lathe mesh.
  30110. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30111. * Please consider using the same method from the MeshBuilder class instead
  30112. * @param name defines the name of the mesh to create
  30113. * @param shape is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  30114. * @param radius is the radius value of the lathe
  30115. * @param tessellation is the side number of the lathe.
  30116. * @param scene defines the hosting scene
  30117. * @param updatable defines if the mesh must be flagged as updatable
  30118. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30119. * @returns a new Mesh
  30120. */
  30121. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30122. /**
  30123. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30124. * @param name defines the name of the mesh to create
  30125. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30126. * @param scene defines the hosting scene
  30127. * @param updatable defines if the mesh must be flagged as updatable
  30128. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30129. * @returns a new Mesh
  30130. */
  30131. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30132. /**
  30133. * Creates a ground mesh.
  30134. * Please consider using the same method from the MeshBuilder class instead
  30135. * @param name defines the name of the mesh to create
  30136. * @param width set the width of the ground
  30137. * @param height set the height of the ground
  30138. * @param subdivisions sets the number of subdivisions per side
  30139. * @param scene defines the hosting scene
  30140. * @param updatable defines if the mesh must be flagged as updatable
  30141. * @returns a new Mesh
  30142. */
  30143. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30144. /**
  30145. * Creates a tiled ground mesh.
  30146. * Please consider using the same method from the MeshBuilder class instead
  30147. * @param name defines the name of the mesh to create
  30148. * @param xmin set the ground minimum X coordinate
  30149. * @param zmin set the ground minimum Y coordinate
  30150. * @param xmax set the ground maximum X coordinate
  30151. * @param zmax set the ground maximum Z coordinate
  30152. * @param subdivisions is an object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  30153. * @param precision is an object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  30154. * @param scene defines the hosting scene
  30155. * @param updatable defines if the mesh must be flagged as updatable
  30156. * @returns a new Mesh
  30157. */
  30158. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30159. w: number;
  30160. h: number;
  30161. }, precision: {
  30162. w: number;
  30163. h: number;
  30164. }, scene: Scene, updatable?: boolean): Mesh;
  30165. /**
  30166. * Creates a ground mesh from a height map.
  30167. * Please consider using the same method from the MeshBuilder class instead
  30168. * @see https://doc.babylonjs.com/babylon101/height_map
  30169. * @param name defines the name of the mesh to create
  30170. * @param url sets the URL of the height map image resource
  30171. * @param width set the ground width size
  30172. * @param height set the ground height size
  30173. * @param subdivisions sets the number of subdivision per side
  30174. * @param minHeight is the minimum altitude on the ground
  30175. * @param maxHeight is the maximum altitude on the ground
  30176. * @param scene defines the hosting scene
  30177. * @param updatable defines if the mesh must be flagged as updatable
  30178. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30179. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30180. * @returns a new Mesh
  30181. */
  30182. static CreateGroundFromHeightMap(name: string, url: string, width: number, height: number, subdivisions: number, minHeight: number, maxHeight: number, scene: Scene, updatable?: boolean, onReady?: (mesh: GroundMesh) => void, alphaFilter?: number): GroundMesh;
  30183. /**
  30184. * Creates a tube mesh.
  30185. * The tube is a parametric shape.
  30186. * It has no predefined shape. Its final shape will depend on the input parameters.
  30187. * Please consider using the same method from the MeshBuilder class instead
  30188. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30189. * @param name defines the name of the mesh to create
  30190. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30191. * @param radius sets the tube radius size
  30192. * @param tessellation is the number of sides on the tubular surface
  30193. * @param radiusFunction is a custom function. If it is not null, it overwrittes the parameter `radius`. This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path
  30194. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30195. * @param scene defines the hosting scene
  30196. * @param updatable defines if the mesh must be flagged as updatable
  30197. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30198. * @param instance is an instance of an existing Tube object to be updated with the passed `pathArray` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#tube)
  30199. * @returns a new Mesh
  30200. */
  30201. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30202. (i: number, distance: number): number;
  30203. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30204. /**
  30205. * Creates a polyhedron mesh.
  30206. * Please consider using the same method from the MeshBuilder class instead.
  30207. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  30208. * * The parameter `size` (positive float, default 1) sets the polygon size
  30209. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30210. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  30211. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  30212. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  30213. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  30214. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  30215. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30216. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30217. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30218. * @param name defines the name of the mesh to create
  30219. * @param options defines the options used to create the mesh
  30220. * @param scene defines the hosting scene
  30221. * @returns a new Mesh
  30222. */
  30223. static CreatePolyhedron(name: string, options: {
  30224. type?: number;
  30225. size?: number;
  30226. sizeX?: number;
  30227. sizeY?: number;
  30228. sizeZ?: number;
  30229. custom?: any;
  30230. faceUV?: Vector4[];
  30231. faceColors?: Color4[];
  30232. updatable?: boolean;
  30233. sideOrientation?: number;
  30234. }, scene: Scene): Mesh;
  30235. /**
  30236. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30237. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30238. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value than `radius`)
  30239. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30240. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  30241. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30242. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30243. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30244. * @param name defines the name of the mesh
  30245. * @param options defines the options used to create the mesh
  30246. * @param scene defines the hosting scene
  30247. * @returns a new Mesh
  30248. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30249. */
  30250. static CreateIcoSphere(name: string, options: {
  30251. radius?: number;
  30252. flat?: boolean;
  30253. subdivisions?: number;
  30254. sideOrientation?: number;
  30255. updatable?: boolean;
  30256. }, scene: Scene): Mesh;
  30257. /**
  30258. * Creates a decal mesh.
  30259. * Please consider using the same method from the MeshBuilder class instead.
  30260. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30261. * @param name defines the name of the mesh
  30262. * @param sourceMesh defines the mesh receiving the decal
  30263. * @param position sets the position of the decal in world coordinates
  30264. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30265. * @param size sets the decal scaling
  30266. * @param angle sets the angle to rotate the decal
  30267. * @returns a new Mesh
  30268. */
  30269. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30270. /**
  30271. * Prepare internal position array for software CPU skinning
  30272. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30273. */
  30274. setPositionsForCPUSkinning(): Float32Array;
  30275. /**
  30276. * Prepare internal normal array for software CPU skinning
  30277. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30278. */
  30279. setNormalsForCPUSkinning(): Float32Array;
  30280. /**
  30281. * Updates the vertex buffer by applying transformation from the bones
  30282. * @param skeleton defines the skeleton to apply to current mesh
  30283. * @returns the current mesh
  30284. */
  30285. applySkeleton(skeleton: Skeleton): Mesh;
  30286. /**
  30287. * Returns an object containing a min and max Vector3 which are the minimum and maximum vectors of each mesh bounding box from the passed array, in the world coordinates
  30288. * @param meshes defines the list of meshes to scan
  30289. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30290. */
  30291. static MinMax(meshes: AbstractMesh[]): {
  30292. min: Vector3;
  30293. max: Vector3;
  30294. };
  30295. /**
  30296. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30297. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30298. * @returns a vector3
  30299. */
  30300. static Center(meshesOrMinMaxVector: {
  30301. min: Vector3;
  30302. max: Vector3;
  30303. } | AbstractMesh[]): Vector3;
  30304. /**
  30305. * Merge the array of meshes into a single mesh for performance reasons.
  30306. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30307. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30308. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30309. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30310. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30311. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30312. * @returns a new mesh
  30313. */
  30314. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30315. /** @hidden */
  30316. addInstance(instance: InstancedMesh): void;
  30317. /** @hidden */
  30318. removeInstance(instance: InstancedMesh): void;
  30319. }
  30320. }
  30321. declare module "babylonjs/Cameras/camera" {
  30322. import { SmartArray } from "babylonjs/Misc/smartArray";
  30323. import { Observable } from "babylonjs/Misc/observable";
  30324. import { Nullable } from "babylonjs/types";
  30325. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30326. import { Scene } from "babylonjs/scene";
  30327. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30328. import { Node } from "babylonjs/node";
  30329. import { Mesh } from "babylonjs/Meshes/mesh";
  30330. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30331. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30332. import { Viewport } from "babylonjs/Maths/math.viewport";
  30333. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30334. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30335. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30336. import { Ray } from "babylonjs/Culling/ray";
  30337. /**
  30338. * This is the base class of all the camera used in the application.
  30339. * @see https://doc.babylonjs.com/features/cameras
  30340. */
  30341. export class Camera extends Node {
  30342. /** @hidden */
  30343. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30344. /**
  30345. * This is the default projection mode used by the cameras.
  30346. * It helps recreating a feeling of perspective and better appreciate depth.
  30347. * This is the best way to simulate real life cameras.
  30348. */
  30349. static readonly PERSPECTIVE_CAMERA: number;
  30350. /**
  30351. * This helps creating camera with an orthographic mode.
  30352. * Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.
  30353. */
  30354. static readonly ORTHOGRAPHIC_CAMERA: number;
  30355. /**
  30356. * This is the default FOV mode for perspective cameras.
  30357. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30358. */
  30359. static readonly FOVMODE_VERTICAL_FIXED: number;
  30360. /**
  30361. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30362. */
  30363. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30364. /**
  30365. * This specifies ther is no need for a camera rig.
  30366. * Basically only one eye is rendered corresponding to the camera.
  30367. */
  30368. static readonly RIG_MODE_NONE: number;
  30369. /**
  30370. * Simulates a camera Rig with one blue eye and one red eye.
  30371. * This can be use with 3d blue and red glasses.
  30372. */
  30373. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30374. /**
  30375. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30376. */
  30377. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30378. /**
  30379. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30380. */
  30381. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30382. /**
  30383. * Defines that both eyes of the camera will be rendered over under each other.
  30384. */
  30385. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30386. /**
  30387. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30388. */
  30389. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30390. /**
  30391. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30392. */
  30393. static readonly RIG_MODE_VR: number;
  30394. /**
  30395. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30396. */
  30397. static readonly RIG_MODE_WEBVR: number;
  30398. /**
  30399. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30400. */
  30401. static readonly RIG_MODE_CUSTOM: number;
  30402. /**
  30403. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30404. */
  30405. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30406. /**
  30407. * Define the input manager associated with the camera.
  30408. */
  30409. inputs: CameraInputsManager<Camera>;
  30410. /** @hidden */
  30411. _position: Vector3;
  30412. /**
  30413. * Define the current local position of the camera in the scene
  30414. */
  30415. get position(): Vector3;
  30416. set position(newPosition: Vector3);
  30417. protected _upVector: Vector3;
  30418. /**
  30419. * The vector the camera should consider as up.
  30420. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30421. */
  30422. set upVector(vec: Vector3);
  30423. get upVector(): Vector3;
  30424. /**
  30425. * Define the current limit on the left side for an orthographic camera
  30426. * In scene unit
  30427. */
  30428. orthoLeft: Nullable<number>;
  30429. /**
  30430. * Define the current limit on the right side for an orthographic camera
  30431. * In scene unit
  30432. */
  30433. orthoRight: Nullable<number>;
  30434. /**
  30435. * Define the current limit on the bottom side for an orthographic camera
  30436. * In scene unit
  30437. */
  30438. orthoBottom: Nullable<number>;
  30439. /**
  30440. * Define the current limit on the top side for an orthographic camera
  30441. * In scene unit
  30442. */
  30443. orthoTop: Nullable<number>;
  30444. /**
  30445. * Field Of View is set in Radians. (default is 0.8)
  30446. */
  30447. fov: number;
  30448. /**
  30449. * Define the minimum distance the camera can see from.
  30450. * This is important to note that the depth buffer are not infinite and the closer it starts
  30451. * the more your scene might encounter depth fighting issue.
  30452. */
  30453. minZ: number;
  30454. /**
  30455. * Define the maximum distance the camera can see to.
  30456. * This is important to note that the depth buffer are not infinite and the further it end
  30457. * the more your scene might encounter depth fighting issue.
  30458. */
  30459. maxZ: number;
  30460. /**
  30461. * Define the default inertia of the camera.
  30462. * This helps giving a smooth feeling to the camera movement.
  30463. */
  30464. inertia: number;
  30465. /**
  30466. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30467. */
  30468. mode: number;
  30469. /**
  30470. * Define whether the camera is intermediate.
  30471. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30472. */
  30473. isIntermediate: boolean;
  30474. /**
  30475. * Define the viewport of the camera.
  30476. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30477. */
  30478. viewport: Viewport;
  30479. /**
  30480. * Restricts the camera to viewing objects with the same layerMask.
  30481. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30482. */
  30483. layerMask: number;
  30484. /**
  30485. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30486. */
  30487. fovMode: number;
  30488. /**
  30489. * Rig mode of the camera.
  30490. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30491. * This is normally controlled byt the camera themselves as internal use.
  30492. */
  30493. cameraRigMode: number;
  30494. /**
  30495. * Defines the distance between both "eyes" in case of a RIG
  30496. */
  30497. interaxialDistance: number;
  30498. /**
  30499. * Defines if stereoscopic rendering is done side by side or over under.
  30500. */
  30501. isStereoscopicSideBySide: boolean;
  30502. /**
  30503. * Defines the list of custom render target which are rendered to and then used as the input to this camera's render. Eg. display another camera view on a TV in the main scene
  30504. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30505. * else in the scene. (Eg. security camera)
  30506. *
  30507. * To change the final output target of the camera, camera.outputRenderTarget should be used instead (eg. webXR renders to a render target corrisponding to an HMD)
  30508. */
  30509. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30510. /**
  30511. * When set, the camera will render to this render target instead of the default canvas
  30512. *
  30513. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30514. */
  30515. outputRenderTarget: Nullable<RenderTargetTexture>;
  30516. /**
  30517. * Observable triggered when the camera view matrix has changed.
  30518. */
  30519. onViewMatrixChangedObservable: Observable<Camera>;
  30520. /**
  30521. * Observable triggered when the camera Projection matrix has changed.
  30522. */
  30523. onProjectionMatrixChangedObservable: Observable<Camera>;
  30524. /**
  30525. * Observable triggered when the inputs have been processed.
  30526. */
  30527. onAfterCheckInputsObservable: Observable<Camera>;
  30528. /**
  30529. * Observable triggered when reset has been called and applied to the camera.
  30530. */
  30531. onRestoreStateObservable: Observable<Camera>;
  30532. /**
  30533. * Is this camera a part of a rig system?
  30534. */
  30535. isRigCamera: boolean;
  30536. /**
  30537. * If isRigCamera set to true this will be set with the parent camera.
  30538. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30539. */
  30540. rigParent?: Camera;
  30541. /** @hidden */
  30542. _cameraRigParams: any;
  30543. /** @hidden */
  30544. _rigCameras: Camera[];
  30545. /** @hidden */
  30546. _rigPostProcess: Nullable<PostProcess>;
  30547. protected _webvrViewMatrix: Matrix;
  30548. /** @hidden */
  30549. _skipRendering: boolean;
  30550. /** @hidden */
  30551. _projectionMatrix: Matrix;
  30552. /** @hidden */
  30553. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30554. /** @hidden */
  30555. _activeMeshes: SmartArray<AbstractMesh>;
  30556. protected _globalPosition: Vector3;
  30557. /** @hidden */
  30558. _computedViewMatrix: Matrix;
  30559. private _doNotComputeProjectionMatrix;
  30560. private _transformMatrix;
  30561. private _frustumPlanes;
  30562. private _refreshFrustumPlanes;
  30563. private _storedFov;
  30564. private _stateStored;
  30565. /**
  30566. * Instantiates a new camera object.
  30567. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30568. * @see https://doc.babylonjs.com/features/cameras
  30569. * @param name Defines the name of the camera in the scene
  30570. * @param position Defines the position of the camera
  30571. * @param scene Defines the scene the camera belongs too
  30572. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30573. */
  30574. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30575. /**
  30576. * Store current camera state (fov, position, etc..)
  30577. * @returns the camera
  30578. */
  30579. storeState(): Camera;
  30580. /**
  30581. * Restores the camera state values if it has been stored. You must call storeState() first
  30582. */
  30583. protected _restoreStateValues(): boolean;
  30584. /**
  30585. * Restored camera state. You must call storeState() first.
  30586. * @returns true if restored and false otherwise
  30587. */
  30588. restoreState(): boolean;
  30589. /**
  30590. * Gets the class name of the camera.
  30591. * @returns the class name
  30592. */
  30593. getClassName(): string;
  30594. /** @hidden */
  30595. readonly _isCamera: boolean;
  30596. /**
  30597. * Gets a string representation of the camera useful for debug purpose.
  30598. * @param fullDetails Defines that a more verboe level of logging is required
  30599. * @returns the string representation
  30600. */
  30601. toString(fullDetails?: boolean): string;
  30602. /**
  30603. * Gets the current world space position of the camera.
  30604. */
  30605. get globalPosition(): Vector3;
  30606. /**
  30607. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30608. * @returns the active meshe list
  30609. */
  30610. getActiveMeshes(): SmartArray<AbstractMesh>;
  30611. /**
  30612. * Check whether a mesh is part of the current active mesh list of the camera
  30613. * @param mesh Defines the mesh to check
  30614. * @returns true if active, false otherwise
  30615. */
  30616. isActiveMesh(mesh: Mesh): boolean;
  30617. /**
  30618. * Is this camera ready to be used/rendered
  30619. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30620. * @return true if the camera is ready
  30621. */
  30622. isReady(completeCheck?: boolean): boolean;
  30623. /** @hidden */
  30624. _initCache(): void;
  30625. /** @hidden */
  30626. _updateCache(ignoreParentClass?: boolean): void;
  30627. /** @hidden */
  30628. _isSynchronized(): boolean;
  30629. /** @hidden */
  30630. _isSynchronizedViewMatrix(): boolean;
  30631. /** @hidden */
  30632. _isSynchronizedProjectionMatrix(): boolean;
  30633. /**
  30634. * Attach the input controls to a specific dom element to get the input from.
  30635. * @param element Defines the element the controls should be listened from
  30636. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30637. */
  30638. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30639. /**
  30640. * Detach the current controls from the specified dom element.
  30641. * @param element Defines the element to stop listening the inputs from
  30642. */
  30643. detachControl(element: HTMLElement): void;
  30644. /**
  30645. * Update the camera state according to the different inputs gathered during the frame.
  30646. */
  30647. update(): void;
  30648. /** @hidden */
  30649. _checkInputs(): void;
  30650. /** @hidden */
  30651. get rigCameras(): Camera[];
  30652. /**
  30653. * Gets the post process used by the rig cameras
  30654. */
  30655. get rigPostProcess(): Nullable<PostProcess>;
  30656. /**
  30657. * Internal, gets the first post proces.
  30658. * @returns the first post process to be run on this camera.
  30659. */
  30660. _getFirstPostProcess(): Nullable<PostProcess>;
  30661. private _cascadePostProcessesToRigCams;
  30662. /**
  30663. * Attach a post process to the camera.
  30664. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30665. * @param postProcess The post process to attach to the camera
  30666. * @param insertAt The position of the post process in case several of them are in use in the scene
  30667. * @returns the position the post process has been inserted at
  30668. */
  30669. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30670. /**
  30671. * Detach a post process to the camera.
  30672. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30673. * @param postProcess The post process to detach from the camera
  30674. */
  30675. detachPostProcess(postProcess: PostProcess): void;
  30676. /**
  30677. * Gets the current world matrix of the camera
  30678. */
  30679. getWorldMatrix(): Matrix;
  30680. /** @hidden */
  30681. _getViewMatrix(): Matrix;
  30682. /**
  30683. * Gets the current view matrix of the camera.
  30684. * @param force forces the camera to recompute the matrix without looking at the cached state
  30685. * @returns the view matrix
  30686. */
  30687. getViewMatrix(force?: boolean): Matrix;
  30688. /**
  30689. * Freeze the projection matrix.
  30690. * It will prevent the cache check of the camera projection compute and can speed up perf
  30691. * if no parameter of the camera are meant to change
  30692. * @param projection Defines manually a projection if necessary
  30693. */
  30694. freezeProjectionMatrix(projection?: Matrix): void;
  30695. /**
  30696. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30697. */
  30698. unfreezeProjectionMatrix(): void;
  30699. /**
  30700. * Gets the current projection matrix of the camera.
  30701. * @param force forces the camera to recompute the matrix without looking at the cached state
  30702. * @returns the projection matrix
  30703. */
  30704. getProjectionMatrix(force?: boolean): Matrix;
  30705. /**
  30706. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30707. * @returns a Matrix
  30708. */
  30709. getTransformationMatrix(): Matrix;
  30710. private _updateFrustumPlanes;
  30711. /**
  30712. * Checks if a cullable object (mesh...) is in the camera frustum
  30713. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30714. * @param target The object to check
  30715. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30716. * @returns true if the object is in frustum otherwise false
  30717. */
  30718. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30719. /**
  30720. * Checks if a cullable object (mesh...) is in the camera frustum
  30721. * Unlike isInFrustum this cheks the full bounding box
  30722. * @param target The object to check
  30723. * @returns true if the object is in frustum otherwise false
  30724. */
  30725. isCompletelyInFrustum(target: ICullable): boolean;
  30726. /**
  30727. * Gets a ray in the forward direction from the camera.
  30728. * @param length Defines the length of the ray to create
  30729. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30730. * @param origin Defines the start point of the ray which defaults to the camera position
  30731. * @returns the forward ray
  30732. */
  30733. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30734. /**
  30735. * Gets a ray in the forward direction from the camera.
  30736. * @param refRay the ray to (re)use when setting the values
  30737. * @param length Defines the length of the ray to create
  30738. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30739. * @param origin Defines the start point of the ray which defaults to the camera position
  30740. * @returns the forward ray
  30741. */
  30742. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30743. /**
  30744. * Releases resources associated with this node.
  30745. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30746. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30747. */
  30748. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30749. /** @hidden */
  30750. _isLeftCamera: boolean;
  30751. /**
  30752. * Gets the left camera of a rig setup in case of Rigged Camera
  30753. */
  30754. get isLeftCamera(): boolean;
  30755. /** @hidden */
  30756. _isRightCamera: boolean;
  30757. /**
  30758. * Gets the right camera of a rig setup in case of Rigged Camera
  30759. */
  30760. get isRightCamera(): boolean;
  30761. /**
  30762. * Gets the left camera of a rig setup in case of Rigged Camera
  30763. */
  30764. get leftCamera(): Nullable<FreeCamera>;
  30765. /**
  30766. * Gets the right camera of a rig setup in case of Rigged Camera
  30767. */
  30768. get rightCamera(): Nullable<FreeCamera>;
  30769. /**
  30770. * Gets the left camera target of a rig setup in case of Rigged Camera
  30771. * @returns the target position
  30772. */
  30773. getLeftTarget(): Nullable<Vector3>;
  30774. /**
  30775. * Gets the right camera target of a rig setup in case of Rigged Camera
  30776. * @returns the target position
  30777. */
  30778. getRightTarget(): Nullable<Vector3>;
  30779. /**
  30780. * @hidden
  30781. */
  30782. setCameraRigMode(mode: number, rigParams: any): void;
  30783. /** @hidden */
  30784. static _setStereoscopicRigMode(camera: Camera): void;
  30785. /** @hidden */
  30786. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30787. /** @hidden */
  30788. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30789. /** @hidden */
  30790. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30791. /** @hidden */
  30792. _getVRProjectionMatrix(): Matrix;
  30793. protected _updateCameraRotationMatrix(): void;
  30794. protected _updateWebVRCameraRotationMatrix(): void;
  30795. /**
  30796. * This function MUST be overwritten by the different WebVR cameras available.
  30797. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30798. * @hidden
  30799. */
  30800. _getWebVRProjectionMatrix(): Matrix;
  30801. /**
  30802. * This function MUST be overwritten by the different WebVR cameras available.
  30803. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30804. * @hidden
  30805. */
  30806. _getWebVRViewMatrix(): Matrix;
  30807. /** @hidden */
  30808. setCameraRigParameter(name: string, value: any): void;
  30809. /**
  30810. * needs to be overridden by children so sub has required properties to be copied
  30811. * @hidden
  30812. */
  30813. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30814. /**
  30815. * May need to be overridden by children
  30816. * @hidden
  30817. */
  30818. _updateRigCameras(): void;
  30819. /** @hidden */
  30820. _setupInputs(): void;
  30821. /**
  30822. * Serialiaze the camera setup to a json represention
  30823. * @returns the JSON representation
  30824. */
  30825. serialize(): any;
  30826. /**
  30827. * Clones the current camera.
  30828. * @param name The cloned camera name
  30829. * @returns the cloned camera
  30830. */
  30831. clone(name: string): Camera;
  30832. /**
  30833. * Gets the direction of the camera relative to a given local axis.
  30834. * @param localAxis Defines the reference axis to provide a relative direction.
  30835. * @return the direction
  30836. */
  30837. getDirection(localAxis: Vector3): Vector3;
  30838. /**
  30839. * Returns the current camera absolute rotation
  30840. */
  30841. get absoluteRotation(): Quaternion;
  30842. /**
  30843. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30844. * @param localAxis Defines the reference axis to provide a relative direction.
  30845. * @param result Defines the vector to store the result in
  30846. */
  30847. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30848. /**
  30849. * Gets a camera constructor for a given camera type
  30850. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30851. * @param name The name of the camera the result will be able to instantiate
  30852. * @param scene The scene the result will construct the camera in
  30853. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30854. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30855. * @returns a factory method to construc the camera
  30856. */
  30857. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30858. /**
  30859. * Compute the world matrix of the camera.
  30860. * @returns the camera world matrix
  30861. */
  30862. computeWorldMatrix(): Matrix;
  30863. /**
  30864. * Parse a JSON and creates the camera from the parsed information
  30865. * @param parsedCamera The JSON to parse
  30866. * @param scene The scene to instantiate the camera in
  30867. * @returns the newly constructed camera
  30868. */
  30869. static Parse(parsedCamera: any, scene: Scene): Camera;
  30870. }
  30871. }
  30872. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30873. import { Nullable } from "babylonjs/types";
  30874. import { Scene } from "babylonjs/scene";
  30875. import { Vector4 } from "babylonjs/Maths/math.vector";
  30876. import { Mesh } from "babylonjs/Meshes/mesh";
  30877. /**
  30878. * Class containing static functions to help procedurally build meshes
  30879. */
  30880. export class DiscBuilder {
  30881. /**
  30882. * Creates a plane polygonal mesh. By default, this is a disc
  30883. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30884. * * The parameter `tessellation` sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  30885. * * You can create an unclosed polygon with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference : 2 x PI x ratio
  30886. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30887. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30888. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30889. * @param name defines the name of the mesh
  30890. * @param options defines the options used to create the mesh
  30891. * @param scene defines the hosting scene
  30892. * @returns the plane polygonal mesh
  30893. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30894. */
  30895. static CreateDisc(name: string, options: {
  30896. radius?: number;
  30897. tessellation?: number;
  30898. arc?: number;
  30899. updatable?: boolean;
  30900. sideOrientation?: number;
  30901. frontUVs?: Vector4;
  30902. backUVs?: Vector4;
  30903. }, scene?: Nullable<Scene>): Mesh;
  30904. }
  30905. }
  30906. declare module "babylonjs/Materials/fresnelParameters" {
  30907. import { DeepImmutable } from "babylonjs/types";
  30908. import { Color3 } from "babylonjs/Maths/math.color";
  30909. /**
  30910. * Options to be used when creating a FresnelParameters.
  30911. */
  30912. export type IFresnelParametersCreationOptions = {
  30913. /**
  30914. * Define the color used on edges (grazing angle)
  30915. */
  30916. leftColor?: Color3;
  30917. /**
  30918. * Define the color used on center
  30919. */
  30920. rightColor?: Color3;
  30921. /**
  30922. * Define bias applied to computed fresnel term
  30923. */
  30924. bias?: number;
  30925. /**
  30926. * Defined the power exponent applied to fresnel term
  30927. */
  30928. power?: number;
  30929. /**
  30930. * Define if the fresnel effect is enable or not.
  30931. */
  30932. isEnabled?: boolean;
  30933. };
  30934. /**
  30935. * Serialized format for FresnelParameters.
  30936. */
  30937. export type IFresnelParametersSerialized = {
  30938. /**
  30939. * Define the color used on edges (grazing angle) [as an array]
  30940. */
  30941. leftColor: number[];
  30942. /**
  30943. * Define the color used on center [as an array]
  30944. */
  30945. rightColor: number[];
  30946. /**
  30947. * Define bias applied to computed fresnel term
  30948. */
  30949. bias: number;
  30950. /**
  30951. * Defined the power exponent applied to fresnel term
  30952. */
  30953. power?: number;
  30954. /**
  30955. * Define if the fresnel effect is enable or not.
  30956. */
  30957. isEnabled: boolean;
  30958. };
  30959. /**
  30960. * This represents all the required information to add a fresnel effect on a material:
  30961. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30962. */
  30963. export class FresnelParameters {
  30964. private _isEnabled;
  30965. /**
  30966. * Define if the fresnel effect is enable or not.
  30967. */
  30968. get isEnabled(): boolean;
  30969. set isEnabled(value: boolean);
  30970. /**
  30971. * Define the color used on edges (grazing angle)
  30972. */
  30973. leftColor: Color3;
  30974. /**
  30975. * Define the color used on center
  30976. */
  30977. rightColor: Color3;
  30978. /**
  30979. * Define bias applied to computed fresnel term
  30980. */
  30981. bias: number;
  30982. /**
  30983. * Defined the power exponent applied to fresnel term
  30984. */
  30985. power: number;
  30986. /**
  30987. * Creates a new FresnelParameters object.
  30988. *
  30989. * @param options provide your own settings to optionally to override defaults
  30990. */
  30991. constructor(options?: IFresnelParametersCreationOptions);
  30992. /**
  30993. * Clones the current fresnel and its valuues
  30994. * @returns a clone fresnel configuration
  30995. */
  30996. clone(): FresnelParameters;
  30997. /**
  30998. * Determines equality between FresnelParameters objects
  30999. * @param otherFresnelParameters defines the second operand
  31000. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  31001. */
  31002. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  31003. /**
  31004. * Serializes the current fresnel parameters to a JSON representation.
  31005. * @return the JSON serialization
  31006. */
  31007. serialize(): IFresnelParametersSerialized;
  31008. /**
  31009. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31010. * @param parsedFresnelParameters Define the JSON representation
  31011. * @returns the parsed parameters
  31012. */
  31013. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31014. }
  31015. }
  31016. declare module "babylonjs/Materials/materialFlags" {
  31017. /**
  31018. * This groups all the flags used to control the materials channel.
  31019. */
  31020. export class MaterialFlags {
  31021. private static _DiffuseTextureEnabled;
  31022. /**
  31023. * Are diffuse textures enabled in the application.
  31024. */
  31025. static get DiffuseTextureEnabled(): boolean;
  31026. static set DiffuseTextureEnabled(value: boolean);
  31027. private static _DetailTextureEnabled;
  31028. /**
  31029. * Are detail textures enabled in the application.
  31030. */
  31031. static get DetailTextureEnabled(): boolean;
  31032. static set DetailTextureEnabled(value: boolean);
  31033. private static _AmbientTextureEnabled;
  31034. /**
  31035. * Are ambient textures enabled in the application.
  31036. */
  31037. static get AmbientTextureEnabled(): boolean;
  31038. static set AmbientTextureEnabled(value: boolean);
  31039. private static _OpacityTextureEnabled;
  31040. /**
  31041. * Are opacity textures enabled in the application.
  31042. */
  31043. static get OpacityTextureEnabled(): boolean;
  31044. static set OpacityTextureEnabled(value: boolean);
  31045. private static _ReflectionTextureEnabled;
  31046. /**
  31047. * Are reflection textures enabled in the application.
  31048. */
  31049. static get ReflectionTextureEnabled(): boolean;
  31050. static set ReflectionTextureEnabled(value: boolean);
  31051. private static _EmissiveTextureEnabled;
  31052. /**
  31053. * Are emissive textures enabled in the application.
  31054. */
  31055. static get EmissiveTextureEnabled(): boolean;
  31056. static set EmissiveTextureEnabled(value: boolean);
  31057. private static _SpecularTextureEnabled;
  31058. /**
  31059. * Are specular textures enabled in the application.
  31060. */
  31061. static get SpecularTextureEnabled(): boolean;
  31062. static set SpecularTextureEnabled(value: boolean);
  31063. private static _BumpTextureEnabled;
  31064. /**
  31065. * Are bump textures enabled in the application.
  31066. */
  31067. static get BumpTextureEnabled(): boolean;
  31068. static set BumpTextureEnabled(value: boolean);
  31069. private static _LightmapTextureEnabled;
  31070. /**
  31071. * Are lightmap textures enabled in the application.
  31072. */
  31073. static get LightmapTextureEnabled(): boolean;
  31074. static set LightmapTextureEnabled(value: boolean);
  31075. private static _RefractionTextureEnabled;
  31076. /**
  31077. * Are refraction textures enabled in the application.
  31078. */
  31079. static get RefractionTextureEnabled(): boolean;
  31080. static set RefractionTextureEnabled(value: boolean);
  31081. private static _ColorGradingTextureEnabled;
  31082. /**
  31083. * Are color grading textures enabled in the application.
  31084. */
  31085. static get ColorGradingTextureEnabled(): boolean;
  31086. static set ColorGradingTextureEnabled(value: boolean);
  31087. private static _FresnelEnabled;
  31088. /**
  31089. * Are fresnels enabled in the application.
  31090. */
  31091. static get FresnelEnabled(): boolean;
  31092. static set FresnelEnabled(value: boolean);
  31093. private static _ClearCoatTextureEnabled;
  31094. /**
  31095. * Are clear coat textures enabled in the application.
  31096. */
  31097. static get ClearCoatTextureEnabled(): boolean;
  31098. static set ClearCoatTextureEnabled(value: boolean);
  31099. private static _ClearCoatBumpTextureEnabled;
  31100. /**
  31101. * Are clear coat bump textures enabled in the application.
  31102. */
  31103. static get ClearCoatBumpTextureEnabled(): boolean;
  31104. static set ClearCoatBumpTextureEnabled(value: boolean);
  31105. private static _ClearCoatTintTextureEnabled;
  31106. /**
  31107. * Are clear coat tint textures enabled in the application.
  31108. */
  31109. static get ClearCoatTintTextureEnabled(): boolean;
  31110. static set ClearCoatTintTextureEnabled(value: boolean);
  31111. private static _SheenTextureEnabled;
  31112. /**
  31113. * Are sheen textures enabled in the application.
  31114. */
  31115. static get SheenTextureEnabled(): boolean;
  31116. static set SheenTextureEnabled(value: boolean);
  31117. private static _AnisotropicTextureEnabled;
  31118. /**
  31119. * Are anisotropic textures enabled in the application.
  31120. */
  31121. static get AnisotropicTextureEnabled(): boolean;
  31122. static set AnisotropicTextureEnabled(value: boolean);
  31123. private static _ThicknessTextureEnabled;
  31124. /**
  31125. * Are thickness textures enabled in the application.
  31126. */
  31127. static get ThicknessTextureEnabled(): boolean;
  31128. static set ThicknessTextureEnabled(value: boolean);
  31129. }
  31130. }
  31131. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31132. /** @hidden */
  31133. export var defaultFragmentDeclaration: {
  31134. name: string;
  31135. shader: string;
  31136. };
  31137. }
  31138. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31139. /** @hidden */
  31140. export var defaultUboDeclaration: {
  31141. name: string;
  31142. shader: string;
  31143. };
  31144. }
  31145. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31146. /** @hidden */
  31147. export var prePassDeclaration: {
  31148. name: string;
  31149. shader: string;
  31150. };
  31151. }
  31152. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31153. /** @hidden */
  31154. export var lightFragmentDeclaration: {
  31155. name: string;
  31156. shader: string;
  31157. };
  31158. }
  31159. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31160. /** @hidden */
  31161. export var lightUboDeclaration: {
  31162. name: string;
  31163. shader: string;
  31164. };
  31165. }
  31166. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31167. /** @hidden */
  31168. export var lightsFragmentFunctions: {
  31169. name: string;
  31170. shader: string;
  31171. };
  31172. }
  31173. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31174. /** @hidden */
  31175. export var shadowsFragmentFunctions: {
  31176. name: string;
  31177. shader: string;
  31178. };
  31179. }
  31180. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31181. /** @hidden */
  31182. export var fresnelFunction: {
  31183. name: string;
  31184. shader: string;
  31185. };
  31186. }
  31187. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31188. /** @hidden */
  31189. export var bumpFragmentMainFunctions: {
  31190. name: string;
  31191. shader: string;
  31192. };
  31193. }
  31194. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31195. /** @hidden */
  31196. export var bumpFragmentFunctions: {
  31197. name: string;
  31198. shader: string;
  31199. };
  31200. }
  31201. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31202. /** @hidden */
  31203. export var logDepthDeclaration: {
  31204. name: string;
  31205. shader: string;
  31206. };
  31207. }
  31208. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31209. /** @hidden */
  31210. export var bumpFragment: {
  31211. name: string;
  31212. shader: string;
  31213. };
  31214. }
  31215. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31216. /** @hidden */
  31217. export var depthPrePass: {
  31218. name: string;
  31219. shader: string;
  31220. };
  31221. }
  31222. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31223. /** @hidden */
  31224. export var lightFragment: {
  31225. name: string;
  31226. shader: string;
  31227. };
  31228. }
  31229. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31230. /** @hidden */
  31231. export var logDepthFragment: {
  31232. name: string;
  31233. shader: string;
  31234. };
  31235. }
  31236. declare module "babylonjs/Shaders/default.fragment" {
  31237. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31238. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31239. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31240. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31241. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31242. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31243. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31244. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31245. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31246. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31247. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31248. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31249. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31250. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31251. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31252. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31253. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31254. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31255. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31256. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31257. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31258. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31259. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31260. /** @hidden */
  31261. export var defaultPixelShader: {
  31262. name: string;
  31263. shader: string;
  31264. };
  31265. }
  31266. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31267. /** @hidden */
  31268. export var defaultVertexDeclaration: {
  31269. name: string;
  31270. shader: string;
  31271. };
  31272. }
  31273. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31274. /** @hidden */
  31275. export var bumpVertexDeclaration: {
  31276. name: string;
  31277. shader: string;
  31278. };
  31279. }
  31280. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31281. /** @hidden */
  31282. export var bumpVertex: {
  31283. name: string;
  31284. shader: string;
  31285. };
  31286. }
  31287. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31288. /** @hidden */
  31289. export var fogVertex: {
  31290. name: string;
  31291. shader: string;
  31292. };
  31293. }
  31294. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31295. /** @hidden */
  31296. export var shadowsVertex: {
  31297. name: string;
  31298. shader: string;
  31299. };
  31300. }
  31301. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31302. /** @hidden */
  31303. export var pointCloudVertex: {
  31304. name: string;
  31305. shader: string;
  31306. };
  31307. }
  31308. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31309. /** @hidden */
  31310. export var logDepthVertex: {
  31311. name: string;
  31312. shader: string;
  31313. };
  31314. }
  31315. declare module "babylonjs/Shaders/default.vertex" {
  31316. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31317. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31318. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31319. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31320. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31321. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31322. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31323. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31324. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31325. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31326. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31327. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31328. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31329. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31330. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31331. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31332. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31333. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31334. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31335. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31336. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31337. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31338. /** @hidden */
  31339. export var defaultVertexShader: {
  31340. name: string;
  31341. shader: string;
  31342. };
  31343. }
  31344. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31345. import { Nullable } from "babylonjs/types";
  31346. import { Scene } from "babylonjs/scene";
  31347. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31348. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31349. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31350. /**
  31351. * @hidden
  31352. */
  31353. export interface IMaterialDetailMapDefines {
  31354. DETAIL: boolean;
  31355. DETAILDIRECTUV: number;
  31356. DETAIL_NORMALBLENDMETHOD: number;
  31357. /** @hidden */
  31358. _areTexturesDirty: boolean;
  31359. }
  31360. /**
  31361. * Define the code related to the detail map parameters of a material
  31362. *
  31363. * Inspired from:
  31364. * Unity: https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@9.0/manual/Mask-Map-and-Detail-Map.html and https://docs.unity3d.com/Manual/StandardShaderMaterialParameterDetail.html
  31365. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31366. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31367. */
  31368. export class DetailMapConfiguration {
  31369. private _texture;
  31370. /**
  31371. * The detail texture of the material.
  31372. */
  31373. texture: Nullable<BaseTexture>;
  31374. /**
  31375. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31376. * Bigger values mean stronger blending
  31377. */
  31378. diffuseBlendLevel: number;
  31379. /**
  31380. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31381. * Bigger values mean stronger blending. Only used with PBR materials
  31382. */
  31383. roughnessBlendLevel: number;
  31384. /**
  31385. * Defines how strong the bump effect from the detail map is
  31386. * Bigger values mean stronger effect
  31387. */
  31388. bumpLevel: number;
  31389. private _normalBlendMethod;
  31390. /**
  31391. * The method used to blend the bump and detail normals together
  31392. */
  31393. normalBlendMethod: number;
  31394. private _isEnabled;
  31395. /**
  31396. * Enable or disable the detail map on this material
  31397. */
  31398. isEnabled: boolean;
  31399. /** @hidden */
  31400. private _internalMarkAllSubMeshesAsTexturesDirty;
  31401. /** @hidden */
  31402. _markAllSubMeshesAsTexturesDirty(): void;
  31403. /**
  31404. * Instantiate a new detail map
  31405. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31406. */
  31407. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31408. /**
  31409. * Gets whether the submesh is ready to be used or not.
  31410. * @param defines the list of "defines" to update.
  31411. * @param scene defines the scene the material belongs to.
  31412. * @returns - boolean indicating that the submesh is ready or not.
  31413. */
  31414. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31415. /**
  31416. * Update the defines for detail map usage
  31417. * @param defines the list of "defines" to update.
  31418. * @param scene defines the scene the material belongs to.
  31419. */
  31420. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31421. /**
  31422. * Binds the material data.
  31423. * @param uniformBuffer defines the Uniform buffer to fill in.
  31424. * @param scene defines the scene the material belongs to.
  31425. * @param isFrozen defines whether the material is frozen or not.
  31426. */
  31427. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31428. /**
  31429. * Checks to see if a texture is used in the material.
  31430. * @param texture - Base texture to use.
  31431. * @returns - Boolean specifying if a texture is used in the material.
  31432. */
  31433. hasTexture(texture: BaseTexture): boolean;
  31434. /**
  31435. * Returns an array of the actively used textures.
  31436. * @param activeTextures Array of BaseTextures
  31437. */
  31438. getActiveTextures(activeTextures: BaseTexture[]): void;
  31439. /**
  31440. * Returns the animatable textures.
  31441. * @param animatables Array of animatable textures.
  31442. */
  31443. getAnimatables(animatables: IAnimatable[]): void;
  31444. /**
  31445. * Disposes the resources of the material.
  31446. * @param forceDisposeTextures - Forces the disposal of all textures.
  31447. */
  31448. dispose(forceDisposeTextures?: boolean): void;
  31449. /**
  31450. * Get the current class name useful for serialization or dynamic coding.
  31451. * @returns "DetailMap"
  31452. */
  31453. getClassName(): string;
  31454. /**
  31455. * Add the required uniforms to the current list.
  31456. * @param uniforms defines the current uniform list.
  31457. */
  31458. static AddUniforms(uniforms: string[]): void;
  31459. /**
  31460. * Add the required samplers to the current list.
  31461. * @param samplers defines the current sampler list.
  31462. */
  31463. static AddSamplers(samplers: string[]): void;
  31464. /**
  31465. * Add the required uniforms to the current buffer.
  31466. * @param uniformBuffer defines the current uniform buffer.
  31467. */
  31468. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31469. /**
  31470. * Makes a duplicate of the current instance into another one.
  31471. * @param detailMap define the instance where to copy the info
  31472. */
  31473. copyTo(detailMap: DetailMapConfiguration): void;
  31474. /**
  31475. * Serializes this detail map instance
  31476. * @returns - An object with the serialized instance.
  31477. */
  31478. serialize(): any;
  31479. /**
  31480. * Parses a detail map setting from a serialized object.
  31481. * @param source - Serialized object.
  31482. * @param scene Defines the scene we are parsing for
  31483. * @param rootUrl Defines the rootUrl to load from
  31484. */
  31485. parse(source: any, scene: Scene, rootUrl: string): void;
  31486. }
  31487. }
  31488. declare module "babylonjs/Materials/standardMaterial" {
  31489. import { SmartArray } from "babylonjs/Misc/smartArray";
  31490. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31491. import { Nullable } from "babylonjs/types";
  31492. import { Scene } from "babylonjs/scene";
  31493. import { Matrix } from "babylonjs/Maths/math.vector";
  31494. import { Color3 } from "babylonjs/Maths/math.color";
  31495. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31496. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31497. import { Mesh } from "babylonjs/Meshes/mesh";
  31498. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31499. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31500. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31501. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31502. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31503. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31504. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31505. import "babylonjs/Shaders/default.fragment";
  31506. import "babylonjs/Shaders/default.vertex";
  31507. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31508. /** @hidden */
  31509. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31510. MAINUV1: boolean;
  31511. MAINUV2: boolean;
  31512. DIFFUSE: boolean;
  31513. DIFFUSEDIRECTUV: number;
  31514. DETAIL: boolean;
  31515. DETAILDIRECTUV: number;
  31516. DETAIL_NORMALBLENDMETHOD: number;
  31517. AMBIENT: boolean;
  31518. AMBIENTDIRECTUV: number;
  31519. OPACITY: boolean;
  31520. OPACITYDIRECTUV: number;
  31521. OPACITYRGB: boolean;
  31522. REFLECTION: boolean;
  31523. EMISSIVE: boolean;
  31524. EMISSIVEDIRECTUV: number;
  31525. SPECULAR: boolean;
  31526. SPECULARDIRECTUV: number;
  31527. BUMP: boolean;
  31528. BUMPDIRECTUV: number;
  31529. PARALLAX: boolean;
  31530. PARALLAXOCCLUSION: boolean;
  31531. SPECULAROVERALPHA: boolean;
  31532. CLIPPLANE: boolean;
  31533. CLIPPLANE2: boolean;
  31534. CLIPPLANE3: boolean;
  31535. CLIPPLANE4: boolean;
  31536. CLIPPLANE5: boolean;
  31537. CLIPPLANE6: boolean;
  31538. ALPHATEST: boolean;
  31539. DEPTHPREPASS: boolean;
  31540. ALPHAFROMDIFFUSE: boolean;
  31541. POINTSIZE: boolean;
  31542. FOG: boolean;
  31543. SPECULARTERM: boolean;
  31544. DIFFUSEFRESNEL: boolean;
  31545. OPACITYFRESNEL: boolean;
  31546. REFLECTIONFRESNEL: boolean;
  31547. REFRACTIONFRESNEL: boolean;
  31548. EMISSIVEFRESNEL: boolean;
  31549. FRESNEL: boolean;
  31550. NORMAL: boolean;
  31551. UV1: boolean;
  31552. UV2: boolean;
  31553. VERTEXCOLOR: boolean;
  31554. VERTEXALPHA: boolean;
  31555. NUM_BONE_INFLUENCERS: number;
  31556. BonesPerMesh: number;
  31557. BONETEXTURE: boolean;
  31558. INSTANCES: boolean;
  31559. THIN_INSTANCES: boolean;
  31560. GLOSSINESS: boolean;
  31561. ROUGHNESS: boolean;
  31562. EMISSIVEASILLUMINATION: boolean;
  31563. LINKEMISSIVEWITHDIFFUSE: boolean;
  31564. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31565. LIGHTMAP: boolean;
  31566. LIGHTMAPDIRECTUV: number;
  31567. OBJECTSPACE_NORMALMAP: boolean;
  31568. USELIGHTMAPASSHADOWMAP: boolean;
  31569. REFLECTIONMAP_3D: boolean;
  31570. REFLECTIONMAP_SPHERICAL: boolean;
  31571. REFLECTIONMAP_PLANAR: boolean;
  31572. REFLECTIONMAP_CUBIC: boolean;
  31573. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31574. REFLECTIONMAP_PROJECTION: boolean;
  31575. REFLECTIONMAP_SKYBOX: boolean;
  31576. REFLECTIONMAP_EXPLICIT: boolean;
  31577. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31578. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31579. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31580. INVERTCUBICMAP: boolean;
  31581. LOGARITHMICDEPTH: boolean;
  31582. REFRACTION: boolean;
  31583. REFRACTIONMAP_3D: boolean;
  31584. REFLECTIONOVERALPHA: boolean;
  31585. TWOSIDEDLIGHTING: boolean;
  31586. SHADOWFLOAT: boolean;
  31587. MORPHTARGETS: boolean;
  31588. MORPHTARGETS_NORMAL: boolean;
  31589. MORPHTARGETS_TANGENT: boolean;
  31590. MORPHTARGETS_UV: boolean;
  31591. NUM_MORPH_INFLUENCERS: number;
  31592. NONUNIFORMSCALING: boolean;
  31593. PREMULTIPLYALPHA: boolean;
  31594. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31595. ALPHABLEND: boolean;
  31596. PREPASS: boolean;
  31597. SCENE_MRT_COUNT: number;
  31598. RGBDLIGHTMAP: boolean;
  31599. RGBDREFLECTION: boolean;
  31600. RGBDREFRACTION: boolean;
  31601. IMAGEPROCESSING: boolean;
  31602. VIGNETTE: boolean;
  31603. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31604. VIGNETTEBLENDMODEOPAQUE: boolean;
  31605. TONEMAPPING: boolean;
  31606. TONEMAPPING_ACES: boolean;
  31607. CONTRAST: boolean;
  31608. COLORCURVES: boolean;
  31609. COLORGRADING: boolean;
  31610. COLORGRADING3D: boolean;
  31611. SAMPLER3DGREENDEPTH: boolean;
  31612. SAMPLER3DBGRMAP: boolean;
  31613. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31614. MULTIVIEW: boolean;
  31615. /**
  31616. * If the reflection texture on this material is in linear color space
  31617. * @hidden
  31618. */
  31619. IS_REFLECTION_LINEAR: boolean;
  31620. /**
  31621. * If the refraction texture on this material is in linear color space
  31622. * @hidden
  31623. */
  31624. IS_REFRACTION_LINEAR: boolean;
  31625. EXPOSURE: boolean;
  31626. constructor();
  31627. setReflectionMode(modeToEnable: string): void;
  31628. }
  31629. /**
  31630. * This is the default material used in Babylon. It is the best trade off between quality
  31631. * and performances.
  31632. * @see https://doc.babylonjs.com/babylon101/materials
  31633. */
  31634. export class StandardMaterial extends PushMaterial {
  31635. private _diffuseTexture;
  31636. /**
  31637. * The basic texture of the material as viewed under a light.
  31638. */
  31639. diffuseTexture: Nullable<BaseTexture>;
  31640. private _ambientTexture;
  31641. /**
  31642. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31643. */
  31644. ambientTexture: Nullable<BaseTexture>;
  31645. private _opacityTexture;
  31646. /**
  31647. * Define the transparency of the material from a texture.
  31648. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31649. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31650. */
  31651. opacityTexture: Nullable<BaseTexture>;
  31652. private _reflectionTexture;
  31653. /**
  31654. * Define the texture used to display the reflection.
  31655. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31656. */
  31657. reflectionTexture: Nullable<BaseTexture>;
  31658. private _emissiveTexture;
  31659. /**
  31660. * Define texture of the material as if self lit.
  31661. * This will be mixed in the final result even in the absence of light.
  31662. */
  31663. emissiveTexture: Nullable<BaseTexture>;
  31664. private _specularTexture;
  31665. /**
  31666. * Define how the color and intensity of the highlight given by the light in the material.
  31667. */
  31668. specularTexture: Nullable<BaseTexture>;
  31669. private _bumpTexture;
  31670. /**
  31671. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31672. * These are made by creating a normal map from an image. The means to do this can be found on the web, a search for 'normal map generator' will bring up free and paid for methods of doing this.
  31673. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31674. */
  31675. bumpTexture: Nullable<BaseTexture>;
  31676. private _lightmapTexture;
  31677. /**
  31678. * Complex lighting can be computationally expensive to compute at runtime.
  31679. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31680. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31681. */
  31682. lightmapTexture: Nullable<BaseTexture>;
  31683. private _refractionTexture;
  31684. /**
  31685. * Define the texture used to display the refraction.
  31686. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31687. */
  31688. refractionTexture: Nullable<BaseTexture>;
  31689. /**
  31690. * The color of the material lit by the environmental background lighting.
  31691. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31692. */
  31693. ambientColor: Color3;
  31694. /**
  31695. * The basic color of the material as viewed under a light.
  31696. */
  31697. diffuseColor: Color3;
  31698. /**
  31699. * Define how the color and intensity of the highlight given by the light in the material.
  31700. */
  31701. specularColor: Color3;
  31702. /**
  31703. * Define the color of the material as if self lit.
  31704. * This will be mixed in the final result even in the absence of light.
  31705. */
  31706. emissiveColor: Color3;
  31707. /**
  31708. * Defines how sharp are the highlights in the material.
  31709. * The bigger the value the sharper giving a more glossy feeling to the result.
  31710. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31711. */
  31712. specularPower: number;
  31713. private _useAlphaFromDiffuseTexture;
  31714. /**
  31715. * Does the transparency come from the diffuse texture alpha channel.
  31716. */
  31717. useAlphaFromDiffuseTexture: boolean;
  31718. private _useEmissiveAsIllumination;
  31719. /**
  31720. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31721. */
  31722. useEmissiveAsIllumination: boolean;
  31723. private _linkEmissiveWithDiffuse;
  31724. /**
  31725. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31726. * the emissive level when the final color is close to one.
  31727. */
  31728. linkEmissiveWithDiffuse: boolean;
  31729. private _useSpecularOverAlpha;
  31730. /**
  31731. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31732. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31733. */
  31734. useSpecularOverAlpha: boolean;
  31735. private _useReflectionOverAlpha;
  31736. /**
  31737. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31738. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31739. */
  31740. useReflectionOverAlpha: boolean;
  31741. private _disableLighting;
  31742. /**
  31743. * Does lights from the scene impacts this material.
  31744. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31745. */
  31746. disableLighting: boolean;
  31747. private _useObjectSpaceNormalMap;
  31748. /**
  31749. * Allows using an object space normal map (instead of tangent space).
  31750. */
  31751. useObjectSpaceNormalMap: boolean;
  31752. private _useParallax;
  31753. /**
  31754. * Is parallax enabled or not.
  31755. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31756. */
  31757. useParallax: boolean;
  31758. private _useParallaxOcclusion;
  31759. /**
  31760. * Is parallax occlusion enabled or not.
  31761. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31762. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31763. */
  31764. useParallaxOcclusion: boolean;
  31765. /**
  31766. * Apply a scaling factor that determine which "depth" the height map should reprensent. A value between 0.05 and 0.1 is reasonnable in Parallax, you can reach 0.2 using Parallax Occlusion.
  31767. */
  31768. parallaxScaleBias: number;
  31769. private _roughness;
  31770. /**
  31771. * Helps to define how blurry the reflections should appears in the material.
  31772. */
  31773. roughness: number;
  31774. /**
  31775. * In case of refraction, define the value of the index of refraction.
  31776. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31777. */
  31778. indexOfRefraction: number;
  31779. /**
  31780. * Invert the refraction texture alongside the y axis.
  31781. * It can be useful with procedural textures or probe for instance.
  31782. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31783. */
  31784. invertRefractionY: boolean;
  31785. /**
  31786. * Defines the alpha limits in alpha test mode.
  31787. */
  31788. alphaCutOff: number;
  31789. private _useLightmapAsShadowmap;
  31790. /**
  31791. * In case of light mapping, define whether the map contains light or shadow informations.
  31792. */
  31793. useLightmapAsShadowmap: boolean;
  31794. private _diffuseFresnelParameters;
  31795. /**
  31796. * Define the diffuse fresnel parameters of the material.
  31797. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31798. */
  31799. diffuseFresnelParameters: FresnelParameters;
  31800. private _opacityFresnelParameters;
  31801. /**
  31802. * Define the opacity fresnel parameters of the material.
  31803. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31804. */
  31805. opacityFresnelParameters: FresnelParameters;
  31806. private _reflectionFresnelParameters;
  31807. /**
  31808. * Define the reflection fresnel parameters of the material.
  31809. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31810. */
  31811. reflectionFresnelParameters: FresnelParameters;
  31812. private _refractionFresnelParameters;
  31813. /**
  31814. * Define the refraction fresnel parameters of the material.
  31815. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31816. */
  31817. refractionFresnelParameters: FresnelParameters;
  31818. private _emissiveFresnelParameters;
  31819. /**
  31820. * Define the emissive fresnel parameters of the material.
  31821. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31822. */
  31823. emissiveFresnelParameters: FresnelParameters;
  31824. private _useReflectionFresnelFromSpecular;
  31825. /**
  31826. * If true automatically deducts the fresnels values from the material specularity.
  31827. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31828. */
  31829. useReflectionFresnelFromSpecular: boolean;
  31830. private _useGlossinessFromSpecularMapAlpha;
  31831. /**
  31832. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31833. */
  31834. useGlossinessFromSpecularMapAlpha: boolean;
  31835. private _maxSimultaneousLights;
  31836. /**
  31837. * Defines the maximum number of lights that can be used in the material
  31838. */
  31839. maxSimultaneousLights: number;
  31840. private _invertNormalMapX;
  31841. /**
  31842. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31843. */
  31844. invertNormalMapX: boolean;
  31845. private _invertNormalMapY;
  31846. /**
  31847. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31848. */
  31849. invertNormalMapY: boolean;
  31850. private _twoSidedLighting;
  31851. /**
  31852. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31853. */
  31854. twoSidedLighting: boolean;
  31855. /**
  31856. * Default configuration related to image processing available in the standard Material.
  31857. */
  31858. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31859. /**
  31860. * Gets the image processing configuration used either in this material.
  31861. */
  31862. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31863. /**
  31864. * Sets the Default image processing configuration used either in the this material.
  31865. *
  31866. * If sets to null, the scene one is in use.
  31867. */
  31868. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31869. /**
  31870. * Keep track of the image processing observer to allow dispose and replace.
  31871. */
  31872. private _imageProcessingObserver;
  31873. /**
  31874. * Attaches a new image processing configuration to the Standard Material.
  31875. * @param configuration
  31876. */
  31877. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31878. /**
  31879. * Gets wether the color curves effect is enabled.
  31880. */
  31881. get cameraColorCurvesEnabled(): boolean;
  31882. /**
  31883. * Sets wether the color curves effect is enabled.
  31884. */
  31885. set cameraColorCurvesEnabled(value: boolean);
  31886. /**
  31887. * Gets wether the color grading effect is enabled.
  31888. */
  31889. get cameraColorGradingEnabled(): boolean;
  31890. /**
  31891. * Gets wether the color grading effect is enabled.
  31892. */
  31893. set cameraColorGradingEnabled(value: boolean);
  31894. /**
  31895. * Gets wether tonemapping is enabled or not.
  31896. */
  31897. get cameraToneMappingEnabled(): boolean;
  31898. /**
  31899. * Sets wether tonemapping is enabled or not
  31900. */
  31901. set cameraToneMappingEnabled(value: boolean);
  31902. /**
  31903. * The camera exposure used on this material.
  31904. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31905. * This corresponds to a photographic exposure.
  31906. */
  31907. get cameraExposure(): number;
  31908. /**
  31909. * The camera exposure used on this material.
  31910. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31911. * This corresponds to a photographic exposure.
  31912. */
  31913. set cameraExposure(value: number);
  31914. /**
  31915. * Gets The camera contrast used on this material.
  31916. */
  31917. get cameraContrast(): number;
  31918. /**
  31919. * Sets The camera contrast used on this material.
  31920. */
  31921. set cameraContrast(value: number);
  31922. /**
  31923. * Gets the Color Grading 2D Lookup Texture.
  31924. */
  31925. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31926. /**
  31927. * Sets the Color Grading 2D Lookup Texture.
  31928. */
  31929. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31930. /**
  31931. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31932. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31933. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  31934. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31935. */
  31936. get cameraColorCurves(): Nullable<ColorCurves>;
  31937. /**
  31938. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31939. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31940. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  31941. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31942. */
  31943. set cameraColorCurves(value: Nullable<ColorCurves>);
  31944. /**
  31945. * Can this material render to several textures at once
  31946. */
  31947. get canRenderToMRT(): boolean;
  31948. /**
  31949. * Defines the detail map parameters for the material.
  31950. */
  31951. readonly detailMap: DetailMapConfiguration;
  31952. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31953. protected _worldViewProjectionMatrix: Matrix;
  31954. protected _globalAmbientColor: Color3;
  31955. protected _useLogarithmicDepth: boolean;
  31956. protected _rebuildInParallel: boolean;
  31957. /**
  31958. * Instantiates a new standard material.
  31959. * This is the default material used in Babylon. It is the best trade off between quality
  31960. * and performances.
  31961. * @see https://doc.babylonjs.com/babylon101/materials
  31962. * @param name Define the name of the material in the scene
  31963. * @param scene Define the scene the material belong to
  31964. */
  31965. constructor(name: string, scene: Scene);
  31966. /**
  31967. * Gets a boolean indicating that current material needs to register RTT
  31968. */
  31969. get hasRenderTargetTextures(): boolean;
  31970. /**
  31971. * Gets the current class name of the material e.g. "StandardMaterial"
  31972. * Mainly use in serialization.
  31973. * @returns the class name
  31974. */
  31975. getClassName(): string;
  31976. /**
  31977. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31978. * You can try switching to logarithmic depth.
  31979. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31980. */
  31981. get useLogarithmicDepth(): boolean;
  31982. set useLogarithmicDepth(value: boolean);
  31983. /**
  31984. * Specifies if the material will require alpha blending
  31985. * @returns a boolean specifying if alpha blending is needed
  31986. */
  31987. needAlphaBlending(): boolean;
  31988. /**
  31989. * Specifies if this material should be rendered in alpha test mode
  31990. * @returns a boolean specifying if an alpha test is needed.
  31991. */
  31992. needAlphaTesting(): boolean;
  31993. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31994. /**
  31995. * Get the texture used for alpha test purpose.
  31996. * @returns the diffuse texture in case of the standard material.
  31997. */
  31998. getAlphaTestTexture(): Nullable<BaseTexture>;
  31999. /**
  32000. * Get if the submesh is ready to be used and all its information available.
  32001. * Child classes can use it to update shaders
  32002. * @param mesh defines the mesh to check
  32003. * @param subMesh defines which submesh to check
  32004. * @param useInstances specifies that instances should be used
  32005. * @returns a boolean indicating that the submesh is ready or not
  32006. */
  32007. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  32008. /**
  32009. * Builds the material UBO layouts.
  32010. * Used internally during the effect preparation.
  32011. */
  32012. buildUniformLayout(): void;
  32013. /**
  32014. * Unbinds the material from the mesh
  32015. */
  32016. unbind(): void;
  32017. /**
  32018. * Binds the submesh to this material by preparing the effect and shader to draw
  32019. * @param world defines the world transformation matrix
  32020. * @param mesh defines the mesh containing the submesh
  32021. * @param subMesh defines the submesh to bind the material to
  32022. */
  32023. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32024. /**
  32025. * Get the list of animatables in the material.
  32026. * @returns the list of animatables object used in the material
  32027. */
  32028. getAnimatables(): IAnimatable[];
  32029. /**
  32030. * Gets the active textures from the material
  32031. * @returns an array of textures
  32032. */
  32033. getActiveTextures(): BaseTexture[];
  32034. /**
  32035. * Specifies if the material uses a texture
  32036. * @param texture defines the texture to check against the material
  32037. * @returns a boolean specifying if the material uses the texture
  32038. */
  32039. hasTexture(texture: BaseTexture): boolean;
  32040. /**
  32041. * Disposes the material
  32042. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32043. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32044. */
  32045. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32046. /**
  32047. * Makes a duplicate of the material, and gives it a new name
  32048. * @param name defines the new name for the duplicated material
  32049. * @returns the cloned material
  32050. */
  32051. clone(name: string): StandardMaterial;
  32052. /**
  32053. * Serializes this material in a JSON representation
  32054. * @returns the serialized material object
  32055. */
  32056. serialize(): any;
  32057. /**
  32058. * Creates a standard material from parsed material data
  32059. * @param source defines the JSON representation of the material
  32060. * @param scene defines the hosting scene
  32061. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32062. * @returns a new standard material
  32063. */
  32064. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32065. /**
  32066. * Are diffuse textures enabled in the application.
  32067. */
  32068. static get DiffuseTextureEnabled(): boolean;
  32069. static set DiffuseTextureEnabled(value: boolean);
  32070. /**
  32071. * Are detail textures enabled in the application.
  32072. */
  32073. static get DetailTextureEnabled(): boolean;
  32074. static set DetailTextureEnabled(value: boolean);
  32075. /**
  32076. * Are ambient textures enabled in the application.
  32077. */
  32078. static get AmbientTextureEnabled(): boolean;
  32079. static set AmbientTextureEnabled(value: boolean);
  32080. /**
  32081. * Are opacity textures enabled in the application.
  32082. */
  32083. static get OpacityTextureEnabled(): boolean;
  32084. static set OpacityTextureEnabled(value: boolean);
  32085. /**
  32086. * Are reflection textures enabled in the application.
  32087. */
  32088. static get ReflectionTextureEnabled(): boolean;
  32089. static set ReflectionTextureEnabled(value: boolean);
  32090. /**
  32091. * Are emissive textures enabled in the application.
  32092. */
  32093. static get EmissiveTextureEnabled(): boolean;
  32094. static set EmissiveTextureEnabled(value: boolean);
  32095. /**
  32096. * Are specular textures enabled in the application.
  32097. */
  32098. static get SpecularTextureEnabled(): boolean;
  32099. static set SpecularTextureEnabled(value: boolean);
  32100. /**
  32101. * Are bump textures enabled in the application.
  32102. */
  32103. static get BumpTextureEnabled(): boolean;
  32104. static set BumpTextureEnabled(value: boolean);
  32105. /**
  32106. * Are lightmap textures enabled in the application.
  32107. */
  32108. static get LightmapTextureEnabled(): boolean;
  32109. static set LightmapTextureEnabled(value: boolean);
  32110. /**
  32111. * Are refraction textures enabled in the application.
  32112. */
  32113. static get RefractionTextureEnabled(): boolean;
  32114. static set RefractionTextureEnabled(value: boolean);
  32115. /**
  32116. * Are color grading textures enabled in the application.
  32117. */
  32118. static get ColorGradingTextureEnabled(): boolean;
  32119. static set ColorGradingTextureEnabled(value: boolean);
  32120. /**
  32121. * Are fresnels enabled in the application.
  32122. */
  32123. static get FresnelEnabled(): boolean;
  32124. static set FresnelEnabled(value: boolean);
  32125. }
  32126. }
  32127. declare module "babylonjs/Particles/solidParticleSystem" {
  32128. import { Nullable } from "babylonjs/types";
  32129. import { Mesh } from "babylonjs/Meshes/mesh";
  32130. import { Scene, IDisposable } from "babylonjs/scene";
  32131. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32132. import { Material } from "babylonjs/Materials/material";
  32133. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32134. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32135. /**
  32136. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32137. *As it is just a mesh, the SPS has all the same properties than any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  32138. * The SPS is also a particle system. It provides some methods to manage the particles.
  32139. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32140. *
  32141. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32142. */
  32143. export class SolidParticleSystem implements IDisposable {
  32144. /**
  32145. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32146. * Example : var p = SPS.particles[i];
  32147. */
  32148. particles: SolidParticle[];
  32149. /**
  32150. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32151. */
  32152. nbParticles: number;
  32153. /**
  32154. * If the particles must ever face the camera (default false). Useful for planar particles.
  32155. */
  32156. billboard: boolean;
  32157. /**
  32158. * Recompute normals when adding a shape
  32159. */
  32160. recomputeNormals: boolean;
  32161. /**
  32162. * This a counter ofr your own usage. It's not set by any SPS functions.
  32163. */
  32164. counter: number;
  32165. /**
  32166. * The SPS name. This name is also given to the underlying mesh.
  32167. */
  32168. name: string;
  32169. /**
  32170. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32171. */
  32172. mesh: Mesh;
  32173. /**
  32174. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32175. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32176. */
  32177. vars: any;
  32178. /**
  32179. * This array is populated when the SPS is set as 'pickable'.
  32180. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32181. * Each element of this array is an object `{idx: int, faceId: int}`.
  32182. * `idx` is the picked particle index in the `SPS.particles` array
  32183. * `faceId` is the picked face index counted within this particle.
  32184. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32185. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32186. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32187. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32188. */
  32189. pickedParticles: {
  32190. idx: number;
  32191. faceId: number;
  32192. }[];
  32193. /**
  32194. * This array is populated when the SPS is set as 'pickable'
  32195. * Each key of this array is a submesh index.
  32196. * Each element of this array is a second array defined like this :
  32197. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32198. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32199. * `idx` is the picked particle index in the `SPS.particles` array
  32200. * `faceId` is the picked face index counted within this particle.
  32201. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32202. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32203. */
  32204. pickedBySubMesh: {
  32205. idx: number;
  32206. faceId: number;
  32207. }[][];
  32208. /**
  32209. * This array is populated when `enableDepthSort` is set to true.
  32210. * Each element of this array is an instance of the class DepthSortedParticle.
  32211. */
  32212. depthSortedParticles: DepthSortedParticle[];
  32213. /**
  32214. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32215. * @hidden
  32216. */
  32217. _bSphereOnly: boolean;
  32218. /**
  32219. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32220. * @hidden
  32221. */
  32222. _bSphereRadiusFactor: number;
  32223. private _scene;
  32224. private _positions;
  32225. private _indices;
  32226. private _normals;
  32227. private _colors;
  32228. private _uvs;
  32229. private _indices32;
  32230. private _positions32;
  32231. private _normals32;
  32232. private _fixedNormal32;
  32233. private _colors32;
  32234. private _uvs32;
  32235. private _index;
  32236. private _updatable;
  32237. private _pickable;
  32238. private _isVisibilityBoxLocked;
  32239. private _alwaysVisible;
  32240. private _depthSort;
  32241. private _expandable;
  32242. private _shapeCounter;
  32243. private _copy;
  32244. private _color;
  32245. private _computeParticleColor;
  32246. private _computeParticleTexture;
  32247. private _computeParticleRotation;
  32248. private _computeParticleVertex;
  32249. private _computeBoundingBox;
  32250. private _depthSortParticles;
  32251. private _camera;
  32252. private _mustUnrotateFixedNormals;
  32253. private _particlesIntersect;
  32254. private _needs32Bits;
  32255. private _isNotBuilt;
  32256. private _lastParticleId;
  32257. private _idxOfId;
  32258. private _multimaterialEnabled;
  32259. private _useModelMaterial;
  32260. private _indicesByMaterial;
  32261. private _materialIndexes;
  32262. private _depthSortFunction;
  32263. private _materialSortFunction;
  32264. private _materials;
  32265. private _multimaterial;
  32266. private _materialIndexesById;
  32267. private _defaultMaterial;
  32268. private _autoUpdateSubMeshes;
  32269. private _tmpVertex;
  32270. /**
  32271. * Creates a SPS (Solid Particle System) object.
  32272. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32273. * @param scene (Scene) is the scene in which the SPS is added.
  32274. * @param options defines the options of the sps e.g.
  32275. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32276. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32277. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32278. * * useModelMaterial (optional boolean, defaut false) : if the model materials must be used to create the SPS multimaterial. This enables the multimaterial supports of the SPS.
  32279. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32280. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32281. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32282. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32283. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32284. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32285. */
  32286. constructor(name: string, scene: Scene, options?: {
  32287. updatable?: boolean;
  32288. isPickable?: boolean;
  32289. enableDepthSort?: boolean;
  32290. particleIntersection?: boolean;
  32291. boundingSphereOnly?: boolean;
  32292. bSphereRadiusFactor?: number;
  32293. expandable?: boolean;
  32294. useModelMaterial?: boolean;
  32295. enableMultiMaterial?: boolean;
  32296. });
  32297. /**
  32298. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32299. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32300. * @returns the created mesh
  32301. */
  32302. buildMesh(): Mesh;
  32303. /**
  32304. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32305. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32306. * Thus the particles generated from `digest()` have their property `position` set yet.
  32307. * @param mesh ( Mesh ) is the mesh to be digested
  32308. * @param options {facetNb} (optional integer, default 1) is the number of mesh facets per particle, this parameter is overriden by the parameter `number` if any
  32309. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32310. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32311. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32312. * @returns the current SPS
  32313. */
  32314. digest(mesh: Mesh, options?: {
  32315. facetNb?: number;
  32316. number?: number;
  32317. delta?: number;
  32318. storage?: [];
  32319. }): SolidParticleSystem;
  32320. /**
  32321. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32322. * @hidden
  32323. */
  32324. private _unrotateFixedNormals;
  32325. /**
  32326. * Resets the temporary working copy particle
  32327. * @hidden
  32328. */
  32329. private _resetCopy;
  32330. /**
  32331. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32332. * @param p the current index in the positions array to be updated
  32333. * @param ind the current index in the indices array
  32334. * @param shape a Vector3 array, the shape geometry
  32335. * @param positions the positions array to be updated
  32336. * @param meshInd the shape indices array
  32337. * @param indices the indices array to be updated
  32338. * @param meshUV the shape uv array
  32339. * @param uvs the uv array to be updated
  32340. * @param meshCol the shape color array
  32341. * @param colors the color array to be updated
  32342. * @param meshNor the shape normals array
  32343. * @param normals the normals array to be updated
  32344. * @param idx the particle index
  32345. * @param idxInShape the particle index in its shape
  32346. * @param options the addShape() method passed options
  32347. * @model the particle model
  32348. * @hidden
  32349. */
  32350. private _meshBuilder;
  32351. /**
  32352. * Returns a shape Vector3 array from positions float array
  32353. * @param positions float array
  32354. * @returns a vector3 array
  32355. * @hidden
  32356. */
  32357. private _posToShape;
  32358. /**
  32359. * Returns a shapeUV array from a float uvs (array deep copy)
  32360. * @param uvs as a float array
  32361. * @returns a shapeUV array
  32362. * @hidden
  32363. */
  32364. private _uvsToShapeUV;
  32365. /**
  32366. * Adds a new particle object in the particles array
  32367. * @param idx particle index in particles array
  32368. * @param id particle id
  32369. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32370. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32371. * @param model particle ModelShape object
  32372. * @param shapeId model shape identifier
  32373. * @param idxInShape index of the particle in the current model
  32374. * @param bInfo model bounding info object
  32375. * @param storage target storage array, if any
  32376. * @hidden
  32377. */
  32378. private _addParticle;
  32379. /**
  32380. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32381. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32382. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32383. * @param nb (positive integer) the number of particles to be created from this model
  32384. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32385. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32386. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32387. * @returns the number of shapes in the system
  32388. */
  32389. addShape(mesh: Mesh, nb: number, options?: {
  32390. positionFunction?: any;
  32391. vertexFunction?: any;
  32392. storage?: [];
  32393. }): number;
  32394. /**
  32395. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32396. * @hidden
  32397. */
  32398. private _rebuildParticle;
  32399. /**
  32400. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32401. * @param reset boolean, default false : if the particles must be reset at position and rotation zero, scaling 1, color white, initial UVs and not parented.
  32402. * @returns the SPS.
  32403. */
  32404. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32405. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32406. * Returns an array with the removed particles.
  32407. * If the number of particles to remove is lower than zero or greater than the global remaining particle number, then an empty array is returned.
  32408. * The SPS can't be empty so at least one particle needs to remain in place.
  32409. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32410. * @param start index of the first particle to remove
  32411. * @param end index of the last particle to remove (included)
  32412. * @returns an array populated with the removed particles
  32413. */
  32414. removeParticles(start: number, end: number): SolidParticle[];
  32415. /**
  32416. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32417. * @param solidParticleArray an array populated with Solid Particles objects
  32418. * @returns the SPS
  32419. */
  32420. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32421. /**
  32422. * Creates a new particle and modifies the SPS mesh geometry :
  32423. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32424. * - calls _addParticle() to populate the particle array
  32425. * factorized code from addShape() and insertParticlesFromArray()
  32426. * @param idx particle index in the particles array
  32427. * @param i particle index in its shape
  32428. * @param modelShape particle ModelShape object
  32429. * @param shape shape vertex array
  32430. * @param meshInd shape indices array
  32431. * @param meshUV shape uv array
  32432. * @param meshCol shape color array
  32433. * @param meshNor shape normals array
  32434. * @param bbInfo shape bounding info
  32435. * @param storage target particle storage
  32436. * @options addShape() passed options
  32437. * @hidden
  32438. */
  32439. private _insertNewParticle;
  32440. /**
  32441. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32442. * This method calls `updateParticle()` for each particle of the SPS.
  32443. * For an animated SPS, it is usually called within the render loop.
  32444. * This methods does nothing if called on a non updatable or not yet built SPS. Example : buildMesh() not called after having added or removed particles from an expandable SPS.
  32445. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32446. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32447. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32448. * @returns the SPS.
  32449. */
  32450. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32451. /**
  32452. * Disposes the SPS.
  32453. */
  32454. dispose(): void;
  32455. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32456. * idx is the particle index in the SPS
  32457. * faceId is the picked face index counted within this particle.
  32458. * Returns null if the pickInfo can't identify a picked particle.
  32459. * @param pickingInfo (PickingInfo object)
  32460. * @returns {idx: number, faceId: number} or null
  32461. */
  32462. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32463. idx: number;
  32464. faceId: number;
  32465. }>;
  32466. /**
  32467. * Returns a SolidParticle object from its identifier : particle.id
  32468. * @param id (integer) the particle Id
  32469. * @returns the searched particle or null if not found in the SPS.
  32470. */
  32471. getParticleById(id: number): Nullable<SolidParticle>;
  32472. /**
  32473. * Returns a new array populated with the particles having the passed shapeId.
  32474. * @param shapeId (integer) the shape identifier
  32475. * @returns a new solid particle array
  32476. */
  32477. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32478. /**
  32479. * Populates the passed array "ref" with the particles having the passed shapeId.
  32480. * @param shapeId the shape identifier
  32481. * @returns the SPS
  32482. * @param ref
  32483. */
  32484. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32485. /**
  32486. * Computes the required SubMeshes according the materials assigned to the particles.
  32487. * @returns the solid particle system.
  32488. * Does nothing if called before the SPS mesh is built.
  32489. */
  32490. computeSubMeshes(): SolidParticleSystem;
  32491. /**
  32492. * Sorts the solid particles by material when MultiMaterial is enabled.
  32493. * Updates the indices32 array.
  32494. * Updates the indicesByMaterial array.
  32495. * Updates the mesh indices array.
  32496. * @returns the SPS
  32497. * @hidden
  32498. */
  32499. private _sortParticlesByMaterial;
  32500. /**
  32501. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32502. * @hidden
  32503. */
  32504. private _setMaterialIndexesById;
  32505. /**
  32506. * Returns an array with unique values of Materials from the passed array
  32507. * @param array the material array to be checked and filtered
  32508. * @hidden
  32509. */
  32510. private _filterUniqueMaterialId;
  32511. /**
  32512. * Sets a new Standard Material as _defaultMaterial if not already set.
  32513. * @hidden
  32514. */
  32515. private _setDefaultMaterial;
  32516. /**
  32517. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32518. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32519. * @returns the SPS.
  32520. */
  32521. refreshVisibleSize(): SolidParticleSystem;
  32522. /**
  32523. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32524. * @param size the size (float) of the visibility box
  32525. * note : this doesn't lock the SPS mesh bounding box.
  32526. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32527. */
  32528. setVisibilityBox(size: number): void;
  32529. /**
  32530. * Gets whether the SPS as always visible or not
  32531. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32532. */
  32533. get isAlwaysVisible(): boolean;
  32534. /**
  32535. * Sets the SPS as always visible or not
  32536. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32537. */
  32538. set isAlwaysVisible(val: boolean);
  32539. /**
  32540. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32541. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32542. */
  32543. set isVisibilityBoxLocked(val: boolean);
  32544. /**
  32545. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32546. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32547. */
  32548. get isVisibilityBoxLocked(): boolean;
  32549. /**
  32550. * Tells to `setParticles()` to compute the particle rotations or not.
  32551. * Default value : true. The SPS is faster when it's set to false.
  32552. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32553. */
  32554. set computeParticleRotation(val: boolean);
  32555. /**
  32556. * Tells to `setParticles()` to compute the particle colors or not.
  32557. * Default value : true. The SPS is faster when it's set to false.
  32558. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32559. */
  32560. set computeParticleColor(val: boolean);
  32561. set computeParticleTexture(val: boolean);
  32562. /**
  32563. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32564. * Default value : false. The SPS is faster when it's set to false.
  32565. * Note : the particle custom vertex positions aren't stored values.
  32566. */
  32567. set computeParticleVertex(val: boolean);
  32568. /**
  32569. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32570. */
  32571. set computeBoundingBox(val: boolean);
  32572. /**
  32573. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32574. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32575. * Default : `true`
  32576. */
  32577. set depthSortParticles(val: boolean);
  32578. /**
  32579. * Gets if `setParticles()` computes the particle rotations or not.
  32580. * Default value : true. The SPS is faster when it's set to false.
  32581. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32582. */
  32583. get computeParticleRotation(): boolean;
  32584. /**
  32585. * Gets if `setParticles()` computes the particle colors or not.
  32586. * Default value : true. The SPS is faster when it's set to false.
  32587. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32588. */
  32589. get computeParticleColor(): boolean;
  32590. /**
  32591. * Gets if `setParticles()` computes the particle textures or not.
  32592. * Default value : true. The SPS is faster when it's set to false.
  32593. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32594. */
  32595. get computeParticleTexture(): boolean;
  32596. /**
  32597. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32598. * Default value : false. The SPS is faster when it's set to false.
  32599. * Note : the particle custom vertex positions aren't stored values.
  32600. */
  32601. get computeParticleVertex(): boolean;
  32602. /**
  32603. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32604. */
  32605. get computeBoundingBox(): boolean;
  32606. /**
  32607. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32608. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32609. * Default : `true`
  32610. */
  32611. get depthSortParticles(): boolean;
  32612. /**
  32613. * Gets if the SPS is created as expandable at construction time.
  32614. * Default : `false`
  32615. */
  32616. get expandable(): boolean;
  32617. /**
  32618. * Gets if the SPS supports the Multi Materials
  32619. */
  32620. get multimaterialEnabled(): boolean;
  32621. /**
  32622. * Gets if the SPS uses the model materials for its own multimaterial.
  32623. */
  32624. get useModelMaterial(): boolean;
  32625. /**
  32626. * The SPS used material array.
  32627. */
  32628. get materials(): Material[];
  32629. /**
  32630. * Sets the SPS MultiMaterial from the passed materials.
  32631. * Note : the passed array is internally copied and not used then by reference.
  32632. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32633. */
  32634. setMultiMaterial(materials: Material[]): void;
  32635. /**
  32636. * The SPS computed multimaterial object
  32637. */
  32638. get multimaterial(): MultiMaterial;
  32639. set multimaterial(mm: MultiMaterial);
  32640. /**
  32641. * If the subMeshes must be updated on the next call to setParticles()
  32642. */
  32643. get autoUpdateSubMeshes(): boolean;
  32644. set autoUpdateSubMeshes(val: boolean);
  32645. /**
  32646. * This function does nothing. It may be overwritten to set all the particle first values.
  32647. * The SPS doesn't call this function, you may have to call it by your own.
  32648. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32649. */
  32650. initParticles(): void;
  32651. /**
  32652. * This function does nothing. It may be overwritten to recycle a particle.
  32653. * The SPS doesn't call this function, you may have to call it by your own.
  32654. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32655. * @param particle The particle to recycle
  32656. * @returns the recycled particle
  32657. */
  32658. recycleParticle(particle: SolidParticle): SolidParticle;
  32659. /**
  32660. * Updates a particle : this function should be overwritten by the user.
  32661. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32662. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32663. * @example : just set a particle position or velocity and recycle conditions
  32664. * @param particle The particle to update
  32665. * @returns the updated particle
  32666. */
  32667. updateParticle(particle: SolidParticle): SolidParticle;
  32668. /**
  32669. * Updates a vertex of a particle : it can be overwritten by the user.
  32670. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32671. * @param particle the current particle
  32672. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32673. * @param pt the index of the current vertex in the particle shape
  32674. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32675. * @example : just set a vertex particle position or color
  32676. * @returns the sps
  32677. */
  32678. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32679. /**
  32680. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32681. * This does nothing and may be overwritten by the user.
  32682. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32683. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32684. * @param update the boolean update value actually passed to setParticles()
  32685. */
  32686. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32687. /**
  32688. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32689. * This will be passed three parameters.
  32690. * This does nothing and may be overwritten by the user.
  32691. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32692. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32693. * @param update the boolean update value actually passed to setParticles()
  32694. */
  32695. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32696. }
  32697. }
  32698. declare module "babylonjs/Particles/solidParticle" {
  32699. import { Nullable } from "babylonjs/types";
  32700. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32701. import { Color4 } from "babylonjs/Maths/math.color";
  32702. import { Mesh } from "babylonjs/Meshes/mesh";
  32703. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32704. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32705. import { Plane } from "babylonjs/Maths/math.plane";
  32706. import { Material } from "babylonjs/Materials/material";
  32707. /**
  32708. * Represents one particle of a solid particle system.
  32709. */
  32710. export class SolidParticle {
  32711. /**
  32712. * particle global index
  32713. */
  32714. idx: number;
  32715. /**
  32716. * particle identifier
  32717. */
  32718. id: number;
  32719. /**
  32720. * The color of the particle
  32721. */
  32722. color: Nullable<Color4>;
  32723. /**
  32724. * The world space position of the particle.
  32725. */
  32726. position: Vector3;
  32727. /**
  32728. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32729. */
  32730. rotation: Vector3;
  32731. /**
  32732. * The world space rotation quaternion of the particle.
  32733. */
  32734. rotationQuaternion: Nullable<Quaternion>;
  32735. /**
  32736. * The scaling of the particle.
  32737. */
  32738. scaling: Vector3;
  32739. /**
  32740. * The uvs of the particle.
  32741. */
  32742. uvs: Vector4;
  32743. /**
  32744. * The current speed of the particle.
  32745. */
  32746. velocity: Vector3;
  32747. /**
  32748. * The pivot point in the particle local space.
  32749. */
  32750. pivot: Vector3;
  32751. /**
  32752. * Must the particle be translated from its pivot point in its local space ?
  32753. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32754. * Default : false
  32755. */
  32756. translateFromPivot: boolean;
  32757. /**
  32758. * Is the particle active or not ?
  32759. */
  32760. alive: boolean;
  32761. /**
  32762. * Is the particle visible or not ?
  32763. */
  32764. isVisible: boolean;
  32765. /**
  32766. * Index of this particle in the global "positions" array (Internal use)
  32767. * @hidden
  32768. */
  32769. _pos: number;
  32770. /**
  32771. * @hidden Index of this particle in the global "indices" array (Internal use)
  32772. */
  32773. _ind: number;
  32774. /**
  32775. * @hidden ModelShape of this particle (Internal use)
  32776. */
  32777. _model: ModelShape;
  32778. /**
  32779. * ModelShape id of this particle
  32780. */
  32781. shapeId: number;
  32782. /**
  32783. * Index of the particle in its shape id
  32784. */
  32785. idxInShape: number;
  32786. /**
  32787. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32788. */
  32789. _modelBoundingInfo: BoundingInfo;
  32790. /**
  32791. * @hidden Particle BoundingInfo object (Internal use)
  32792. */
  32793. _boundingInfo: BoundingInfo;
  32794. /**
  32795. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32796. */
  32797. _sps: SolidParticleSystem;
  32798. /**
  32799. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32800. */
  32801. _stillInvisible: boolean;
  32802. /**
  32803. * @hidden Last computed particle rotation matrix
  32804. */
  32805. _rotationMatrix: number[];
  32806. /**
  32807. * Parent particle Id, if any.
  32808. * Default null.
  32809. */
  32810. parentId: Nullable<number>;
  32811. /**
  32812. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32813. */
  32814. materialIndex: Nullable<number>;
  32815. /**
  32816. * Custom object or properties.
  32817. */
  32818. props: Nullable<any>;
  32819. /**
  32820. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32821. * The possible values are :
  32822. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32823. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32824. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32825. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32826. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32827. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32828. * */
  32829. cullingStrategy: number;
  32830. /**
  32831. * @hidden Internal global position in the SPS.
  32832. */
  32833. _globalPosition: Vector3;
  32834. /**
  32835. * Creates a Solid Particle object.
  32836. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32837. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32838. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32839. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32840. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32841. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32842. * @param shapeId (integer) is the model shape identifier in the SPS.
  32843. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32844. * @param sps defines the sps it is associated to
  32845. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32846. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32847. */
  32848. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32849. /**
  32850. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32851. * @param target the particle target
  32852. * @returns the current particle
  32853. */
  32854. copyToRef(target: SolidParticle): SolidParticle;
  32855. /**
  32856. * Legacy support, changed scale to scaling
  32857. */
  32858. get scale(): Vector3;
  32859. /**
  32860. * Legacy support, changed scale to scaling
  32861. */
  32862. set scale(scale: Vector3);
  32863. /**
  32864. * Legacy support, changed quaternion to rotationQuaternion
  32865. */
  32866. get quaternion(): Nullable<Quaternion>;
  32867. /**
  32868. * Legacy support, changed quaternion to rotationQuaternion
  32869. */
  32870. set quaternion(q: Nullable<Quaternion>);
  32871. /**
  32872. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32873. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32874. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32875. * @returns true if it intersects
  32876. */
  32877. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32878. /**
  32879. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32880. * A particle is in the frustum if its bounding box intersects the frustum
  32881. * @param frustumPlanes defines the frustum to test
  32882. * @returns true if the particle is in the frustum planes
  32883. */
  32884. isInFrustum(frustumPlanes: Plane[]): boolean;
  32885. /**
  32886. * get the rotation matrix of the particle
  32887. * @hidden
  32888. */
  32889. getRotationMatrix(m: Matrix): void;
  32890. }
  32891. /**
  32892. * Represents the shape of the model used by one particle of a solid particle system.
  32893. * SPS internal tool, don't use it manually.
  32894. */
  32895. export class ModelShape {
  32896. /**
  32897. * The shape id
  32898. * @hidden
  32899. */
  32900. shapeID: number;
  32901. /**
  32902. * flat array of model positions (internal use)
  32903. * @hidden
  32904. */
  32905. _shape: Vector3[];
  32906. /**
  32907. * flat array of model UVs (internal use)
  32908. * @hidden
  32909. */
  32910. _shapeUV: number[];
  32911. /**
  32912. * color array of the model
  32913. * @hidden
  32914. */
  32915. _shapeColors: number[];
  32916. /**
  32917. * indices array of the model
  32918. * @hidden
  32919. */
  32920. _indices: number[];
  32921. /**
  32922. * normals array of the model
  32923. * @hidden
  32924. */
  32925. _normals: number[];
  32926. /**
  32927. * length of the shape in the model indices array (internal use)
  32928. * @hidden
  32929. */
  32930. _indicesLength: number;
  32931. /**
  32932. * Custom position function (internal use)
  32933. * @hidden
  32934. */
  32935. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32936. /**
  32937. * Custom vertex function (internal use)
  32938. * @hidden
  32939. */
  32940. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32941. /**
  32942. * Model material (internal use)
  32943. * @hidden
  32944. */
  32945. _material: Nullable<Material>;
  32946. /**
  32947. * Creates a ModelShape object. This is an internal simplified reference to a mesh used as for a model to replicate particles from by the SPS.
  32948. * SPS internal tool, don't use it manually.
  32949. * @hidden
  32950. */
  32951. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>, material: Nullable<Material>);
  32952. }
  32953. /**
  32954. * Represents a Depth Sorted Particle in the solid particle system.
  32955. * @hidden
  32956. */
  32957. export class DepthSortedParticle {
  32958. /**
  32959. * Particle index
  32960. */
  32961. idx: number;
  32962. /**
  32963. * Index of the particle in the "indices" array
  32964. */
  32965. ind: number;
  32966. /**
  32967. * Length of the particle shape in the "indices" array
  32968. */
  32969. indicesLength: number;
  32970. /**
  32971. * Squared distance from the particle to the camera
  32972. */
  32973. sqDistance: number;
  32974. /**
  32975. * Material index when used with MultiMaterials
  32976. */
  32977. materialIndex: number;
  32978. /**
  32979. * Creates a new sorted particle
  32980. * @param materialIndex
  32981. */
  32982. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32983. }
  32984. /**
  32985. * Represents a solid particle vertex
  32986. */
  32987. export class SolidParticleVertex {
  32988. /**
  32989. * Vertex position
  32990. */
  32991. position: Vector3;
  32992. /**
  32993. * Vertex color
  32994. */
  32995. color: Color4;
  32996. /**
  32997. * Vertex UV
  32998. */
  32999. uv: Vector2;
  33000. /**
  33001. * Creates a new solid particle vertex
  33002. */
  33003. constructor();
  33004. /** Vertex x coordinate */
  33005. get x(): number;
  33006. set x(val: number);
  33007. /** Vertex y coordinate */
  33008. get y(): number;
  33009. set y(val: number);
  33010. /** Vertex z coordinate */
  33011. get z(): number;
  33012. set z(val: number);
  33013. }
  33014. }
  33015. declare module "babylonjs/Collisions/meshCollisionData" {
  33016. import { Collider } from "babylonjs/Collisions/collider";
  33017. import { Vector3 } from "babylonjs/Maths/math.vector";
  33018. import { Nullable } from "babylonjs/types";
  33019. import { Observer } from "babylonjs/Misc/observable";
  33020. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33021. /**
  33022. * @hidden
  33023. */
  33024. export class _MeshCollisionData {
  33025. _checkCollisions: boolean;
  33026. _collisionMask: number;
  33027. _collisionGroup: number;
  33028. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33029. _collider: Nullable<Collider>;
  33030. _oldPositionForCollisions: Vector3;
  33031. _diffPositionForCollisions: Vector3;
  33032. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33033. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33034. }
  33035. }
  33036. declare module "babylonjs/Meshes/abstractMesh" {
  33037. import { Observable } from "babylonjs/Misc/observable";
  33038. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33039. import { Camera } from "babylonjs/Cameras/camera";
  33040. import { Scene, IDisposable } from "babylonjs/scene";
  33041. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33042. import { Node } from "babylonjs/node";
  33043. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33044. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33045. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33046. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33047. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33048. import { Material } from "babylonjs/Materials/material";
  33049. import { Light } from "babylonjs/Lights/light";
  33050. import { Skeleton } from "babylonjs/Bones/skeleton";
  33051. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33052. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33053. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33054. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33055. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33056. import { Plane } from "babylonjs/Maths/math.plane";
  33057. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33058. import { Ray } from "babylonjs/Culling/ray";
  33059. import { Collider } from "babylonjs/Collisions/collider";
  33060. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33061. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33062. /** @hidden */
  33063. class _FacetDataStorage {
  33064. facetPositions: Vector3[];
  33065. facetNormals: Vector3[];
  33066. facetPartitioning: number[][];
  33067. facetNb: number;
  33068. partitioningSubdivisions: number;
  33069. partitioningBBoxRatio: number;
  33070. facetDataEnabled: boolean;
  33071. facetParameters: any;
  33072. bbSize: Vector3;
  33073. subDiv: {
  33074. max: number;
  33075. X: number;
  33076. Y: number;
  33077. Z: number;
  33078. };
  33079. facetDepthSort: boolean;
  33080. facetDepthSortEnabled: boolean;
  33081. depthSortedIndices: IndicesArray;
  33082. depthSortedFacets: {
  33083. ind: number;
  33084. sqDistance: number;
  33085. }[];
  33086. facetDepthSortFunction: (f1: {
  33087. ind: number;
  33088. sqDistance: number;
  33089. }, f2: {
  33090. ind: number;
  33091. sqDistance: number;
  33092. }) => number;
  33093. facetDepthSortFrom: Vector3;
  33094. facetDepthSortOrigin: Vector3;
  33095. invertedMatrix: Matrix;
  33096. }
  33097. /**
  33098. * @hidden
  33099. **/
  33100. class _InternalAbstractMeshDataInfo {
  33101. _hasVertexAlpha: boolean;
  33102. _useVertexColors: boolean;
  33103. _numBoneInfluencers: number;
  33104. _applyFog: boolean;
  33105. _receiveShadows: boolean;
  33106. _facetData: _FacetDataStorage;
  33107. _visibility: number;
  33108. _skeleton: Nullable<Skeleton>;
  33109. _layerMask: number;
  33110. _computeBonesUsingShaders: boolean;
  33111. _isActive: boolean;
  33112. _onlyForInstances: boolean;
  33113. _isActiveIntermediate: boolean;
  33114. _onlyForInstancesIntermediate: boolean;
  33115. _actAsRegularMesh: boolean;
  33116. }
  33117. /**
  33118. * Class used to store all common mesh properties
  33119. */
  33120. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33121. /** No occlusion */
  33122. static OCCLUSION_TYPE_NONE: number;
  33123. /** Occlusion set to optimisitic */
  33124. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33125. /** Occlusion set to strict */
  33126. static OCCLUSION_TYPE_STRICT: number;
  33127. /** Use an accurante occlusion algorithm */
  33128. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33129. /** Use a conservative occlusion algorithm */
  33130. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33131. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33132. * Test order :
  33133. * Is the bounding sphere outside the frustum ?
  33134. * If not, are the bounding box vertices outside the frustum ?
  33135. * It not, then the cullable object is in the frustum.
  33136. */
  33137. static readonly CULLINGSTRATEGY_STANDARD: number;
  33138. /** Culling strategy : Bounding Sphere Only.
  33139. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33140. * It's also less accurate than the standard because some not visible objects can still be selected.
  33141. * Test : is the bounding sphere outside the frustum ?
  33142. * If not, then the cullable object is in the frustum.
  33143. */
  33144. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33145. /** Culling strategy : Optimistic Inclusion.
  33146. * This in an inclusion test first, then the standard exclusion test.
  33147. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33148. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  33149. * Anyway, it's as accurate as the standard strategy.
  33150. * Test :
  33151. * Is the cullable object bounding sphere center in the frustum ?
  33152. * If not, apply the default culling strategy.
  33153. */
  33154. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33155. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33156. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33157. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33158. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  33159. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33160. * Test :
  33161. * Is the cullable object bounding sphere center in the frustum ?
  33162. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33163. */
  33164. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33165. /**
  33166. * No billboard
  33167. */
  33168. static get BILLBOARDMODE_NONE(): number;
  33169. /** Billboard on X axis */
  33170. static get BILLBOARDMODE_X(): number;
  33171. /** Billboard on Y axis */
  33172. static get BILLBOARDMODE_Y(): number;
  33173. /** Billboard on Z axis */
  33174. static get BILLBOARDMODE_Z(): number;
  33175. /** Billboard on all axes */
  33176. static get BILLBOARDMODE_ALL(): number;
  33177. /** Billboard on using position instead of orientation */
  33178. static get BILLBOARDMODE_USE_POSITION(): number;
  33179. /** @hidden */
  33180. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33181. /**
  33182. * The culling strategy to use to check whether the mesh must be rendered or not.
  33183. * This value can be changed at any time and will be used on the next render mesh selection.
  33184. * The possible values are :
  33185. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33186. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33187. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33188. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33189. * Please read each static variable documentation to get details about the culling process.
  33190. * */
  33191. cullingStrategy: number;
  33192. /**
  33193. * Gets the number of facets in the mesh
  33194. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33195. */
  33196. get facetNb(): number;
  33197. /**
  33198. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33199. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33200. */
  33201. get partitioningSubdivisions(): number;
  33202. set partitioningSubdivisions(nb: number);
  33203. /**
  33204. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33205. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33206. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33207. */
  33208. get partitioningBBoxRatio(): number;
  33209. set partitioningBBoxRatio(ratio: number);
  33210. /**
  33211. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33212. * Works only for updatable meshes.
  33213. * Doesn't work with multi-materials
  33214. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33215. */
  33216. get mustDepthSortFacets(): boolean;
  33217. set mustDepthSortFacets(sort: boolean);
  33218. /**
  33219. * The location (Vector3) where the facet depth sort must be computed from.
  33220. * By default, the active camera position.
  33221. * Used only when facet depth sort is enabled
  33222. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33223. */
  33224. get facetDepthSortFrom(): Vector3;
  33225. set facetDepthSortFrom(location: Vector3);
  33226. /**
  33227. * gets a boolean indicating if facetData is enabled
  33228. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33229. */
  33230. get isFacetDataEnabled(): boolean;
  33231. /** @hidden */
  33232. _updateNonUniformScalingState(value: boolean): boolean;
  33233. /**
  33234. * An event triggered when this mesh collides with another one
  33235. */
  33236. onCollideObservable: Observable<AbstractMesh>;
  33237. /** Set a function to call when this mesh collides with another one */
  33238. set onCollide(callback: () => void);
  33239. /**
  33240. * An event triggered when the collision's position changes
  33241. */
  33242. onCollisionPositionChangeObservable: Observable<Vector3>;
  33243. /** Set a function to call when the collision's position changes */
  33244. set onCollisionPositionChange(callback: () => void);
  33245. /**
  33246. * An event triggered when material is changed
  33247. */
  33248. onMaterialChangedObservable: Observable<AbstractMesh>;
  33249. /**
  33250. * Gets or sets the orientation for POV movement & rotation
  33251. */
  33252. definedFacingForward: boolean;
  33253. /** @hidden */
  33254. _occlusionQuery: Nullable<WebGLQuery>;
  33255. /** @hidden */
  33256. _renderingGroup: Nullable<RenderingGroup>;
  33257. /**
  33258. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33259. */
  33260. get visibility(): number;
  33261. /**
  33262. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33263. */
  33264. set visibility(value: number);
  33265. /** Gets or sets the alpha index used to sort transparent meshes
  33266. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33267. */
  33268. alphaIndex: number;
  33269. /**
  33270. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33271. */
  33272. isVisible: boolean;
  33273. /**
  33274. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33275. */
  33276. isPickable: boolean;
  33277. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33278. showSubMeshesBoundingBox: boolean;
  33279. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33280. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33281. */
  33282. isBlocker: boolean;
  33283. /**
  33284. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33285. */
  33286. enablePointerMoveEvents: boolean;
  33287. private _renderingGroupId;
  33288. /**
  33289. * Specifies the rendering group id for this mesh (0 by default)
  33290. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33291. */
  33292. get renderingGroupId(): number;
  33293. set renderingGroupId(value: number);
  33294. private _material;
  33295. /** Gets or sets current material */
  33296. get material(): Nullable<Material>;
  33297. set material(value: Nullable<Material>);
  33298. /**
  33299. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33300. * @see https://doc.babylonjs.com/babylon101/shadows
  33301. */
  33302. get receiveShadows(): boolean;
  33303. set receiveShadows(value: boolean);
  33304. /** Defines color to use when rendering outline */
  33305. outlineColor: Color3;
  33306. /** Define width to use when rendering outline */
  33307. outlineWidth: number;
  33308. /** Defines color to use when rendering overlay */
  33309. overlayColor: Color3;
  33310. /** Defines alpha to use when rendering overlay */
  33311. overlayAlpha: number;
  33312. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33313. get hasVertexAlpha(): boolean;
  33314. set hasVertexAlpha(value: boolean);
  33315. /** Gets or sets a boolean indicating that this mesh needs to use vertex color data to render (if this kind of vertex data is available in the geometry) */
  33316. get useVertexColors(): boolean;
  33317. set useVertexColors(value: boolean);
  33318. /**
  33319. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33320. */
  33321. get computeBonesUsingShaders(): boolean;
  33322. set computeBonesUsingShaders(value: boolean);
  33323. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33324. get numBoneInfluencers(): number;
  33325. set numBoneInfluencers(value: number);
  33326. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33327. get applyFog(): boolean;
  33328. set applyFog(value: boolean);
  33329. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33330. useOctreeForRenderingSelection: boolean;
  33331. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33332. useOctreeForPicking: boolean;
  33333. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33334. useOctreeForCollisions: boolean;
  33335. /**
  33336. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33337. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33338. */
  33339. get layerMask(): number;
  33340. set layerMask(value: number);
  33341. /**
  33342. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33343. */
  33344. alwaysSelectAsActiveMesh: boolean;
  33345. /**
  33346. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33347. */
  33348. doNotSyncBoundingInfo: boolean;
  33349. /**
  33350. * Gets or sets the current action manager
  33351. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33352. */
  33353. actionManager: Nullable<AbstractActionManager>;
  33354. private _meshCollisionData;
  33355. /**
  33356. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33357. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33358. */
  33359. ellipsoid: Vector3;
  33360. /**
  33361. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33362. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33363. */
  33364. ellipsoidOffset: Vector3;
  33365. /**
  33366. * Gets or sets a collision mask used to mask collisions (default is -1).
  33367. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33368. */
  33369. get collisionMask(): number;
  33370. set collisionMask(mask: number);
  33371. /**
  33372. * Gets or sets the current collision group mask (-1 by default).
  33373. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33374. */
  33375. get collisionGroup(): number;
  33376. set collisionGroup(mask: number);
  33377. /**
  33378. * Gets or sets current surrounding meshes (null by default).
  33379. *
  33380. * By default collision detection is tested against every mesh in the scene.
  33381. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33382. * meshes will be tested for the collision.
  33383. *
  33384. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33385. */
  33386. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33387. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33388. /**
  33389. * Defines edge width used when edgesRenderer is enabled
  33390. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33391. */
  33392. edgesWidth: number;
  33393. /**
  33394. * Defines edge color used when edgesRenderer is enabled
  33395. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33396. */
  33397. edgesColor: Color4;
  33398. /** @hidden */
  33399. _edgesRenderer: Nullable<IEdgesRenderer>;
  33400. /** @hidden */
  33401. _masterMesh: Nullable<AbstractMesh>;
  33402. /** @hidden */
  33403. _boundingInfo: Nullable<BoundingInfo>;
  33404. /** @hidden */
  33405. _renderId: number;
  33406. /**
  33407. * Gets or sets the list of subMeshes
  33408. * @see https://doc.babylonjs.com/how_to/multi_materials
  33409. */
  33410. subMeshes: SubMesh[];
  33411. /** @hidden */
  33412. _intersectionsInProgress: AbstractMesh[];
  33413. /** @hidden */
  33414. _unIndexed: boolean;
  33415. /** @hidden */
  33416. _lightSources: Light[];
  33417. /** Gets the list of lights affecting that mesh */
  33418. get lightSources(): Light[];
  33419. /** @hidden */
  33420. get _positions(): Nullable<Vector3[]>;
  33421. /** @hidden */
  33422. _waitingData: {
  33423. lods: Nullable<any>;
  33424. actions: Nullable<any>;
  33425. freezeWorldMatrix: Nullable<boolean>;
  33426. };
  33427. /** @hidden */
  33428. _bonesTransformMatrices: Nullable<Float32Array>;
  33429. /** @hidden */
  33430. _transformMatrixTexture: Nullable<RawTexture>;
  33431. /**
  33432. * Gets or sets a skeleton to apply skining transformations
  33433. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33434. */
  33435. set skeleton(value: Nullable<Skeleton>);
  33436. get skeleton(): Nullable<Skeleton>;
  33437. /**
  33438. * An event triggered when the mesh is rebuilt.
  33439. */
  33440. onRebuildObservable: Observable<AbstractMesh>;
  33441. /**
  33442. * Creates a new AbstractMesh
  33443. * @param name defines the name of the mesh
  33444. * @param scene defines the hosting scene
  33445. */
  33446. constructor(name: string, scene?: Nullable<Scene>);
  33447. /**
  33448. * Returns the string "AbstractMesh"
  33449. * @returns "AbstractMesh"
  33450. */
  33451. getClassName(): string;
  33452. /**
  33453. * Gets a string representation of the current mesh
  33454. * @param fullDetails defines a boolean indicating if full details must be included
  33455. * @returns a string representation of the current mesh
  33456. */
  33457. toString(fullDetails?: boolean): string;
  33458. /**
  33459. * @hidden
  33460. */
  33461. protected _getEffectiveParent(): Nullable<Node>;
  33462. /** @hidden */
  33463. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33464. /** @hidden */
  33465. _rebuild(): void;
  33466. /** @hidden */
  33467. _resyncLightSources(): void;
  33468. /** @hidden */
  33469. _resyncLightSource(light: Light): void;
  33470. /** @hidden */
  33471. _unBindEffect(): void;
  33472. /** @hidden */
  33473. _removeLightSource(light: Light, dispose: boolean): void;
  33474. private _markSubMeshesAsDirty;
  33475. /** @hidden */
  33476. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33477. /** @hidden */
  33478. _markSubMeshesAsAttributesDirty(): void;
  33479. /** @hidden */
  33480. _markSubMeshesAsMiscDirty(): void;
  33481. /**
  33482. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33483. */
  33484. get scaling(): Vector3;
  33485. set scaling(newScaling: Vector3);
  33486. /**
  33487. * Returns true if the mesh is blocked. Implemented by child classes
  33488. */
  33489. get isBlocked(): boolean;
  33490. /**
  33491. * Returns the mesh itself by default. Implemented by child classes
  33492. * @param camera defines the camera to use to pick the right LOD level
  33493. * @returns the currentAbstractMesh
  33494. */
  33495. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33496. /**
  33497. * Returns 0 by default. Implemented by child classes
  33498. * @returns an integer
  33499. */
  33500. getTotalVertices(): number;
  33501. /**
  33502. * Returns a positive integer : the total number of indices in this mesh geometry.
  33503. * @returns the numner of indices or zero if the mesh has no geometry.
  33504. */
  33505. getTotalIndices(): number;
  33506. /**
  33507. * Returns null by default. Implemented by child classes
  33508. * @returns null
  33509. */
  33510. getIndices(): Nullable<IndicesArray>;
  33511. /**
  33512. * Returns the array of the requested vertex data kind. Implemented by child classes
  33513. * @param kind defines the vertex data kind to use
  33514. * @returns null
  33515. */
  33516. getVerticesData(kind: string): Nullable<FloatArray>;
  33517. /**
  33518. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33519. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33520. * Note that a new underlying VertexBuffer object is created each call.
  33521. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33522. * @param kind defines vertex data kind:
  33523. * * VertexBuffer.PositionKind
  33524. * * VertexBuffer.UVKind
  33525. * * VertexBuffer.UV2Kind
  33526. * * VertexBuffer.UV3Kind
  33527. * * VertexBuffer.UV4Kind
  33528. * * VertexBuffer.UV5Kind
  33529. * * VertexBuffer.UV6Kind
  33530. * * VertexBuffer.ColorKind
  33531. * * VertexBuffer.MatricesIndicesKind
  33532. * * VertexBuffer.MatricesIndicesExtraKind
  33533. * * VertexBuffer.MatricesWeightsKind
  33534. * * VertexBuffer.MatricesWeightsExtraKind
  33535. * @param data defines the data source
  33536. * @param updatable defines if the data must be flagged as updatable (or static)
  33537. * @param stride defines the vertex stride (size of an entire vertex). Can be null and in this case will be deduced from vertex data kind
  33538. * @returns the current mesh
  33539. */
  33540. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33541. /**
  33542. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33543. * If the mesh has no geometry, it is simply returned as it is.
  33544. * @param kind defines vertex data kind:
  33545. * * VertexBuffer.PositionKind
  33546. * * VertexBuffer.UVKind
  33547. * * VertexBuffer.UV2Kind
  33548. * * VertexBuffer.UV3Kind
  33549. * * VertexBuffer.UV4Kind
  33550. * * VertexBuffer.UV5Kind
  33551. * * VertexBuffer.UV6Kind
  33552. * * VertexBuffer.ColorKind
  33553. * * VertexBuffer.MatricesIndicesKind
  33554. * * VertexBuffer.MatricesIndicesExtraKind
  33555. * * VertexBuffer.MatricesWeightsKind
  33556. * * VertexBuffer.MatricesWeightsExtraKind
  33557. * @param data defines the data source
  33558. * @param updateExtends If `kind` is `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed
  33559. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33560. * @returns the current mesh
  33561. */
  33562. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33563. /**
  33564. * Sets the mesh indices,
  33565. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33566. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33567. * @param totalVertices Defines the total number of vertices
  33568. * @returns the current mesh
  33569. */
  33570. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33571. /**
  33572. * Gets a boolean indicating if specific vertex data is present
  33573. * @param kind defines the vertex data kind to use
  33574. * @returns true is data kind is present
  33575. */
  33576. isVerticesDataPresent(kind: string): boolean;
  33577. /**
  33578. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33579. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33580. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33581. * @returns a BoundingInfo
  33582. */
  33583. getBoundingInfo(): BoundingInfo;
  33584. /**
  33585. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33586. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33587. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33588. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33589. * @returns the current mesh
  33590. */
  33591. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33592. /**
  33593. * Overwrite the current bounding info
  33594. * @param boundingInfo defines the new bounding info
  33595. * @returns the current mesh
  33596. */
  33597. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33598. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33599. get useBones(): boolean;
  33600. /** @hidden */
  33601. _preActivate(): void;
  33602. /** @hidden */
  33603. _preActivateForIntermediateRendering(renderId: number): void;
  33604. /** @hidden */
  33605. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33606. /** @hidden */
  33607. _postActivate(): void;
  33608. /** @hidden */
  33609. _freeze(): void;
  33610. /** @hidden */
  33611. _unFreeze(): void;
  33612. /**
  33613. * Gets the current world matrix
  33614. * @returns a Matrix
  33615. */
  33616. getWorldMatrix(): Matrix;
  33617. /** @hidden */
  33618. _getWorldMatrixDeterminant(): number;
  33619. /**
  33620. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33621. */
  33622. get isAnInstance(): boolean;
  33623. /**
  33624. * Gets a boolean indicating if this mesh has instances
  33625. */
  33626. get hasInstances(): boolean;
  33627. /**
  33628. * Gets a boolean indicating if this mesh has thin instances
  33629. */
  33630. get hasThinInstances(): boolean;
  33631. /**
  33632. * Perform relative position change from the point of view of behind the front of the mesh.
  33633. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33634. * Supports definition of mesh facing forward or backward
  33635. * @param amountRight defines the distance on the right axis
  33636. * @param amountUp defines the distance on the up axis
  33637. * @param amountForward defines the distance on the forward axis
  33638. * @returns the current mesh
  33639. */
  33640. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33641. /**
  33642. * Calculate relative position change from the point of view of behind the front of the mesh.
  33643. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33644. * Supports definition of mesh facing forward or backward
  33645. * @param amountRight defines the distance on the right axis
  33646. * @param amountUp defines the distance on the up axis
  33647. * @param amountForward defines the distance on the forward axis
  33648. * @returns the new displacement vector
  33649. */
  33650. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33651. /**
  33652. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33653. * Supports definition of mesh facing forward or backward
  33654. * @param flipBack defines the flip
  33655. * @param twirlClockwise defines the twirl
  33656. * @param tiltRight defines the tilt
  33657. * @returns the current mesh
  33658. */
  33659. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33660. /**
  33661. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33662. * Supports definition of mesh facing forward or backward.
  33663. * @param flipBack defines the flip
  33664. * @param twirlClockwise defines the twirl
  33665. * @param tiltRight defines the tilt
  33666. * @returns the new rotation vector
  33667. */
  33668. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33669. /**
  33670. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33671. * This means the mesh underlying bounding box and sphere are recomputed.
  33672. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33673. * @returns the current mesh
  33674. */
  33675. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33676. /** @hidden */
  33677. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33678. /** @hidden */
  33679. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33680. /** @hidden */
  33681. _updateBoundingInfo(): AbstractMesh;
  33682. /** @hidden */
  33683. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33684. /** @hidden */
  33685. protected _afterComputeWorldMatrix(): void;
  33686. /** @hidden */
  33687. get _effectiveMesh(): AbstractMesh;
  33688. /**
  33689. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33690. * A mesh is in the frustum if its bounding box intersects the frustum
  33691. * @param frustumPlanes defines the frustum to test
  33692. * @returns true if the mesh is in the frustum planes
  33693. */
  33694. isInFrustum(frustumPlanes: Plane[]): boolean;
  33695. /**
  33696. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33697. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33698. * @param frustumPlanes defines the frustum to test
  33699. * @returns true if the mesh is completely in the frustum planes
  33700. */
  33701. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33702. /**
  33703. * True if the mesh intersects another mesh or a SolidParticle object
  33704. * @param mesh defines a target mesh or SolidParticle to test
  33705. * @param precise Unless the parameter `precise` is set to `true` the intersection is computed according to Axis Aligned Bounding Boxes (AABB), else according to OBB (Oriented BBoxes)
  33706. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33707. * @returns true if there is an intersection
  33708. */
  33709. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33710. /**
  33711. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33712. * @param point defines the point to test
  33713. * @returns true if there is an intersection
  33714. */
  33715. intersectsPoint(point: Vector3): boolean;
  33716. /**
  33717. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33718. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33719. */
  33720. get checkCollisions(): boolean;
  33721. set checkCollisions(collisionEnabled: boolean);
  33722. /**
  33723. * Gets Collider object used to compute collisions (not physics)
  33724. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33725. */
  33726. get collider(): Nullable<Collider>;
  33727. /**
  33728. * Move the mesh using collision engine
  33729. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33730. * @param displacement defines the requested displacement vector
  33731. * @returns the current mesh
  33732. */
  33733. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33734. private _onCollisionPositionChange;
  33735. /** @hidden */
  33736. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33737. /** @hidden */
  33738. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33739. /** @hidden */
  33740. _checkCollision(collider: Collider): AbstractMesh;
  33741. /** @hidden */
  33742. _generatePointsArray(): boolean;
  33743. /**
  33744. * Checks if the passed Ray intersects with the mesh
  33745. * @param ray defines the ray to use
  33746. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33747. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33748. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33749. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33750. * @returns the picking info
  33751. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33752. */
  33753. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33754. /**
  33755. * Clones the current mesh
  33756. * @param name defines the mesh name
  33757. * @param newParent defines the new mesh parent
  33758. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33759. * @returns the new mesh
  33760. */
  33761. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33762. /**
  33763. * Disposes all the submeshes of the current meshnp
  33764. * @returns the current mesh
  33765. */
  33766. releaseSubMeshes(): AbstractMesh;
  33767. /**
  33768. * Releases resources associated with this abstract mesh.
  33769. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33770. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33771. */
  33772. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33773. /**
  33774. * Adds the passed mesh as a child to the current mesh
  33775. * @param mesh defines the child mesh
  33776. * @returns the current mesh
  33777. */
  33778. addChild(mesh: AbstractMesh): AbstractMesh;
  33779. /**
  33780. * Removes the passed mesh from the current mesh children list
  33781. * @param mesh defines the child mesh
  33782. * @returns the current mesh
  33783. */
  33784. removeChild(mesh: AbstractMesh): AbstractMesh;
  33785. /** @hidden */
  33786. private _initFacetData;
  33787. /**
  33788. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33789. * This method can be called within the render loop.
  33790. * You don't need to call this method by yourself in the render loop when you update/morph a mesh with the methods CreateXXX() as they automatically manage this computation
  33791. * @returns the current mesh
  33792. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33793. */
  33794. updateFacetData(): AbstractMesh;
  33795. /**
  33796. * Returns the facetLocalNormals array.
  33797. * The normals are expressed in the mesh local spac
  33798. * @returns an array of Vector3
  33799. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33800. */
  33801. getFacetLocalNormals(): Vector3[];
  33802. /**
  33803. * Returns the facetLocalPositions array.
  33804. * The facet positions are expressed in the mesh local space
  33805. * @returns an array of Vector3
  33806. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33807. */
  33808. getFacetLocalPositions(): Vector3[];
  33809. /**
  33810. * Returns the facetLocalPartioning array
  33811. * @returns an array of array of numbers
  33812. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33813. */
  33814. getFacetLocalPartitioning(): number[][];
  33815. /**
  33816. * Returns the i-th facet position in the world system.
  33817. * This method allocates a new Vector3 per call
  33818. * @param i defines the facet index
  33819. * @returns a new Vector3
  33820. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33821. */
  33822. getFacetPosition(i: number): Vector3;
  33823. /**
  33824. * Sets the reference Vector3 with the i-th facet position in the world system
  33825. * @param i defines the facet index
  33826. * @param ref defines the target vector
  33827. * @returns the current mesh
  33828. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33829. */
  33830. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33831. /**
  33832. * Returns the i-th facet normal in the world system.
  33833. * This method allocates a new Vector3 per call
  33834. * @param i defines the facet index
  33835. * @returns a new Vector3
  33836. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33837. */
  33838. getFacetNormal(i: number): Vector3;
  33839. /**
  33840. * Sets the reference Vector3 with the i-th facet normal in the world system
  33841. * @param i defines the facet index
  33842. * @param ref defines the target vector
  33843. * @returns the current mesh
  33844. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33845. */
  33846. getFacetNormalToRef(i: number, ref: Vector3): this;
  33847. /**
  33848. * Returns the facets (in an array) in the same partitioning block than the one the passed coordinates are located (expressed in the mesh local system)
  33849. * @param x defines x coordinate
  33850. * @param y defines y coordinate
  33851. * @param z defines z coordinate
  33852. * @returns the array of facet indexes
  33853. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33854. */
  33855. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33856. /**
  33857. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33858. * @param projected sets as the (x,y,z) world projection on the facet
  33859. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  33860. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  33861. * @param x defines x coordinate
  33862. * @param y defines y coordinate
  33863. * @param z defines z coordinate
  33864. * @returns the face index if found (or null instead)
  33865. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33866. */
  33867. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33868. /**
  33869. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33870. * @param projected sets as the (x,y,z) local projection on the facet
  33871. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  33872. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  33873. * @param x defines x coordinate
  33874. * @param y defines y coordinate
  33875. * @param z defines z coordinate
  33876. * @returns the face index if found (or null instead)
  33877. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33878. */
  33879. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33880. /**
  33881. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33882. * @returns the parameters
  33883. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33884. */
  33885. getFacetDataParameters(): any;
  33886. /**
  33887. * Disables the feature FacetData and frees the related memory
  33888. * @returns the current mesh
  33889. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33890. */
  33891. disableFacetData(): AbstractMesh;
  33892. /**
  33893. * Updates the AbstractMesh indices array
  33894. * @param indices defines the data source
  33895. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33896. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  33897. * @returns the current mesh
  33898. */
  33899. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33900. /**
  33901. * Creates new normals data for the mesh
  33902. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33903. * @returns the current mesh
  33904. */
  33905. createNormals(updatable: boolean): AbstractMesh;
  33906. /**
  33907. * Align the mesh with a normal
  33908. * @param normal defines the normal to use
  33909. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33910. * @returns the current mesh
  33911. */
  33912. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33913. /** @hidden */
  33914. _checkOcclusionQuery(): boolean;
  33915. /**
  33916. * Disables the mesh edge rendering mode
  33917. * @returns the currentAbstractMesh
  33918. */
  33919. disableEdgesRendering(): AbstractMesh;
  33920. /**
  33921. * Enables the edge rendering mode on the mesh.
  33922. * This mode makes the mesh edges visible
  33923. * @param epsilon defines the maximal distance between two angles to detect a face
  33924. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33925. * @returns the currentAbstractMesh
  33926. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33927. */
  33928. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33929. /**
  33930. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33931. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33932. */
  33933. getConnectedParticleSystems(): IParticleSystem[];
  33934. }
  33935. }
  33936. declare module "babylonjs/Actions/actionEvent" {
  33937. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33938. import { Nullable } from "babylonjs/types";
  33939. import { Sprite } from "babylonjs/Sprites/sprite";
  33940. import { Scene } from "babylonjs/scene";
  33941. import { Vector2 } from "babylonjs/Maths/math.vector";
  33942. /**
  33943. * Interface used to define ActionEvent
  33944. */
  33945. export interface IActionEvent {
  33946. /** The mesh or sprite that triggered the action */
  33947. source: any;
  33948. /** The X mouse cursor position at the time of the event */
  33949. pointerX: number;
  33950. /** The Y mouse cursor position at the time of the event */
  33951. pointerY: number;
  33952. /** The mesh that is currently pointed at (can be null) */
  33953. meshUnderPointer: Nullable<AbstractMesh>;
  33954. /** the original (browser) event that triggered the ActionEvent */
  33955. sourceEvent?: any;
  33956. /** additional data for the event */
  33957. additionalData?: any;
  33958. }
  33959. /**
  33960. * ActionEvent is the event being sent when an action is triggered.
  33961. */
  33962. export class ActionEvent implements IActionEvent {
  33963. /** The mesh or sprite that triggered the action */
  33964. source: any;
  33965. /** The X mouse cursor position at the time of the event */
  33966. pointerX: number;
  33967. /** The Y mouse cursor position at the time of the event */
  33968. pointerY: number;
  33969. /** The mesh that is currently pointed at (can be null) */
  33970. meshUnderPointer: Nullable<AbstractMesh>;
  33971. /** the original (browser) event that triggered the ActionEvent */
  33972. sourceEvent?: any;
  33973. /** additional data for the event */
  33974. additionalData?: any;
  33975. /**
  33976. * Creates a new ActionEvent
  33977. * @param source The mesh or sprite that triggered the action
  33978. * @param pointerX The X mouse cursor position at the time of the event
  33979. * @param pointerY The Y mouse cursor position at the time of the event
  33980. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33981. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33982. * @param additionalData additional data for the event
  33983. */
  33984. constructor(
  33985. /** The mesh or sprite that triggered the action */
  33986. source: any,
  33987. /** The X mouse cursor position at the time of the event */
  33988. pointerX: number,
  33989. /** The Y mouse cursor position at the time of the event */
  33990. pointerY: number,
  33991. /** The mesh that is currently pointed at (can be null) */
  33992. meshUnderPointer: Nullable<AbstractMesh>,
  33993. /** the original (browser) event that triggered the ActionEvent */
  33994. sourceEvent?: any,
  33995. /** additional data for the event */
  33996. additionalData?: any);
  33997. /**
  33998. * Helper function to auto-create an ActionEvent from a source mesh.
  33999. * @param source The source mesh that triggered the event
  34000. * @param evt The original (browser) event
  34001. * @param additionalData additional data for the event
  34002. * @returns the new ActionEvent
  34003. */
  34004. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  34005. /**
  34006. * Helper function to auto-create an ActionEvent from a source sprite
  34007. * @param source The source sprite that triggered the event
  34008. * @param scene Scene associated with the sprite
  34009. * @param evt The original (browser) event
  34010. * @param additionalData additional data for the event
  34011. * @returns the new ActionEvent
  34012. */
  34013. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34014. /**
  34015. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34016. * @param scene the scene where the event occurred
  34017. * @param evt The original (browser) event
  34018. * @returns the new ActionEvent
  34019. */
  34020. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34021. /**
  34022. * Helper function to auto-create an ActionEvent from a primitive
  34023. * @param prim defines the target primitive
  34024. * @param pointerPos defines the pointer position
  34025. * @param evt The original (browser) event
  34026. * @param additionalData additional data for the event
  34027. * @returns the new ActionEvent
  34028. */
  34029. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34030. }
  34031. }
  34032. declare module "babylonjs/Actions/abstractActionManager" {
  34033. import { IDisposable } from "babylonjs/scene";
  34034. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34035. import { IAction } from "babylonjs/Actions/action";
  34036. import { Nullable } from "babylonjs/types";
  34037. /**
  34038. * Abstract class used to decouple action Manager from scene and meshes.
  34039. * Do not instantiate.
  34040. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34041. */
  34042. export abstract class AbstractActionManager implements IDisposable {
  34043. /** Gets the list of active triggers */
  34044. static Triggers: {
  34045. [key: string]: number;
  34046. };
  34047. /** Gets the cursor to use when hovering items */
  34048. hoverCursor: string;
  34049. /** Gets the list of actions */
  34050. actions: IAction[];
  34051. /**
  34052. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34053. */
  34054. isRecursive: boolean;
  34055. /**
  34056. * Releases all associated resources
  34057. */
  34058. abstract dispose(): void;
  34059. /**
  34060. * Does this action manager has pointer triggers
  34061. */
  34062. abstract get hasPointerTriggers(): boolean;
  34063. /**
  34064. * Does this action manager has pick triggers
  34065. */
  34066. abstract get hasPickTriggers(): boolean;
  34067. /**
  34068. * Process a specific trigger
  34069. * @param trigger defines the trigger to process
  34070. * @param evt defines the event details to be processed
  34071. */
  34072. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34073. /**
  34074. * Does this action manager handles actions of any of the given triggers
  34075. * @param triggers defines the triggers to be tested
  34076. * @return a boolean indicating whether one (or more) of the triggers is handled
  34077. */
  34078. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34079. /**
  34080. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34081. * speed.
  34082. * @param triggerA defines the trigger to be tested
  34083. * @param triggerB defines the trigger to be tested
  34084. * @return a boolean indicating whether one (or more) of the triggers is handled
  34085. */
  34086. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34087. /**
  34088. * Does this action manager handles actions of a given trigger
  34089. * @param trigger defines the trigger to be tested
  34090. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34091. * @return whether the trigger is handled
  34092. */
  34093. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34094. /**
  34095. * Serialize this manager to a JSON object
  34096. * @param name defines the property name to store this manager
  34097. * @returns a JSON representation of this manager
  34098. */
  34099. abstract serialize(name: string): any;
  34100. /**
  34101. * Registers an action to this action manager
  34102. * @param action defines the action to be registered
  34103. * @return the action amended (prepared) after registration
  34104. */
  34105. abstract registerAction(action: IAction): Nullable<IAction>;
  34106. /**
  34107. * Unregisters an action to this action manager
  34108. * @param action defines the action to be unregistered
  34109. * @return a boolean indicating whether the action has been unregistered
  34110. */
  34111. abstract unregisterAction(action: IAction): Boolean;
  34112. /**
  34113. * Does exist one action manager with at least one trigger
  34114. **/
  34115. static get HasTriggers(): boolean;
  34116. /**
  34117. * Does exist one action manager with at least one pick trigger
  34118. **/
  34119. static get HasPickTriggers(): boolean;
  34120. /**
  34121. * Does exist one action manager that handles actions of a given trigger
  34122. * @param trigger defines the trigger to be tested
  34123. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34124. **/
  34125. static HasSpecificTrigger(trigger: number): boolean;
  34126. }
  34127. }
  34128. declare module "babylonjs/node" {
  34129. import { Scene } from "babylonjs/scene";
  34130. import { Nullable } from "babylonjs/types";
  34131. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34132. import { Engine } from "babylonjs/Engines/engine";
  34133. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34134. import { Observable } from "babylonjs/Misc/observable";
  34135. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34136. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34137. import { Animatable } from "babylonjs/Animations/animatable";
  34138. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34139. import { Animation } from "babylonjs/Animations/animation";
  34140. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34141. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34142. /**
  34143. * Defines how a node can be built from a string name.
  34144. */
  34145. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34146. /**
  34147. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34148. */
  34149. export class Node implements IBehaviorAware<Node> {
  34150. /** @hidden */
  34151. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34152. private static _NodeConstructors;
  34153. /**
  34154. * Add a new node constructor
  34155. * @param type defines the type name of the node to construct
  34156. * @param constructorFunc defines the constructor function
  34157. */
  34158. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34159. /**
  34160. * Returns a node constructor based on type name
  34161. * @param type defines the type name
  34162. * @param name defines the new node name
  34163. * @param scene defines the hosting scene
  34164. * @param options defines optional options to transmit to constructors
  34165. * @returns the new constructor or null
  34166. */
  34167. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34168. /**
  34169. * Gets or sets the name of the node
  34170. */
  34171. name: string;
  34172. /**
  34173. * Gets or sets the id of the node
  34174. */
  34175. id: string;
  34176. /**
  34177. * Gets or sets the unique id of the node
  34178. */
  34179. uniqueId: number;
  34180. /**
  34181. * Gets or sets a string used to store user defined state for the node
  34182. */
  34183. state: string;
  34184. /**
  34185. * Gets or sets an object used to store user defined information for the node
  34186. */
  34187. metadata: any;
  34188. /**
  34189. * For internal use only. Please do not use.
  34190. */
  34191. reservedDataStore: any;
  34192. /**
  34193. * List of inspectable custom properties (used by the Inspector)
  34194. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34195. */
  34196. inspectableCustomProperties: IInspectable[];
  34197. private _doNotSerialize;
  34198. /**
  34199. * Gets or sets a boolean used to define if the node must be serialized
  34200. */
  34201. get doNotSerialize(): boolean;
  34202. set doNotSerialize(value: boolean);
  34203. /** @hidden */
  34204. _isDisposed: boolean;
  34205. /**
  34206. * Gets a list of Animations associated with the node
  34207. */
  34208. animations: import("babylonjs/Animations/animation").Animation[];
  34209. protected _ranges: {
  34210. [name: string]: Nullable<AnimationRange>;
  34211. };
  34212. /**
  34213. * Callback raised when the node is ready to be used
  34214. */
  34215. onReady: Nullable<(node: Node) => void>;
  34216. private _isEnabled;
  34217. private _isParentEnabled;
  34218. private _isReady;
  34219. /** @hidden */
  34220. _currentRenderId: number;
  34221. private _parentUpdateId;
  34222. /** @hidden */
  34223. _childUpdateId: number;
  34224. /** @hidden */
  34225. _waitingParentId: Nullable<string>;
  34226. /** @hidden */
  34227. _scene: Scene;
  34228. /** @hidden */
  34229. _cache: any;
  34230. private _parentNode;
  34231. private _children;
  34232. /** @hidden */
  34233. _worldMatrix: Matrix;
  34234. /** @hidden */
  34235. _worldMatrixDeterminant: number;
  34236. /** @hidden */
  34237. _worldMatrixDeterminantIsDirty: boolean;
  34238. /** @hidden */
  34239. private _sceneRootNodesIndex;
  34240. /**
  34241. * Gets a boolean indicating if the node has been disposed
  34242. * @returns true if the node was disposed
  34243. */
  34244. isDisposed(): boolean;
  34245. /**
  34246. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34247. * @see https://doc.babylonjs.com/how_to/parenting
  34248. */
  34249. set parent(parent: Nullable<Node>);
  34250. get parent(): Nullable<Node>;
  34251. /** @hidden */
  34252. _addToSceneRootNodes(): void;
  34253. /** @hidden */
  34254. _removeFromSceneRootNodes(): void;
  34255. private _animationPropertiesOverride;
  34256. /**
  34257. * Gets or sets the animation properties override
  34258. */
  34259. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34260. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34261. /**
  34262. * Gets a string identifying the name of the class
  34263. * @returns "Node" string
  34264. */
  34265. getClassName(): string;
  34266. /** @hidden */
  34267. readonly _isNode: boolean;
  34268. /**
  34269. * An event triggered when the mesh is disposed
  34270. */
  34271. onDisposeObservable: Observable<Node>;
  34272. private _onDisposeObserver;
  34273. /**
  34274. * Sets a callback that will be raised when the node will be disposed
  34275. */
  34276. set onDispose(callback: () => void);
  34277. /**
  34278. * Creates a new Node
  34279. * @param name the name and id to be given to this node
  34280. * @param scene the scene this node will be added to
  34281. */
  34282. constructor(name: string, scene?: Nullable<Scene>);
  34283. /**
  34284. * Gets the scene of the node
  34285. * @returns a scene
  34286. */
  34287. getScene(): Scene;
  34288. /**
  34289. * Gets the engine of the node
  34290. * @returns a Engine
  34291. */
  34292. getEngine(): Engine;
  34293. private _behaviors;
  34294. /**
  34295. * Attach a behavior to the node
  34296. * @see https://doc.babylonjs.com/features/behaviour
  34297. * @param behavior defines the behavior to attach
  34298. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34299. * @returns the current Node
  34300. */
  34301. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34302. /**
  34303. * Remove an attached behavior
  34304. * @see https://doc.babylonjs.com/features/behaviour
  34305. * @param behavior defines the behavior to attach
  34306. * @returns the current Node
  34307. */
  34308. removeBehavior(behavior: Behavior<Node>): Node;
  34309. /**
  34310. * Gets the list of attached behaviors
  34311. * @see https://doc.babylonjs.com/features/behaviour
  34312. */
  34313. get behaviors(): Behavior<Node>[];
  34314. /**
  34315. * Gets an attached behavior by name
  34316. * @param name defines the name of the behavior to look for
  34317. * @see https://doc.babylonjs.com/features/behaviour
  34318. * @returns null if behavior was not found else the requested behavior
  34319. */
  34320. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34321. /**
  34322. * Returns the latest update of the World matrix
  34323. * @returns a Matrix
  34324. */
  34325. getWorldMatrix(): Matrix;
  34326. /** @hidden */
  34327. _getWorldMatrixDeterminant(): number;
  34328. /**
  34329. * Returns directly the latest state of the mesh World matrix.
  34330. * A Matrix is returned.
  34331. */
  34332. get worldMatrixFromCache(): Matrix;
  34333. /** @hidden */
  34334. _initCache(): void;
  34335. /** @hidden */
  34336. updateCache(force?: boolean): void;
  34337. /** @hidden */
  34338. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34339. /** @hidden */
  34340. _updateCache(ignoreParentClass?: boolean): void;
  34341. /** @hidden */
  34342. _isSynchronized(): boolean;
  34343. /** @hidden */
  34344. _markSyncedWithParent(): void;
  34345. /** @hidden */
  34346. isSynchronizedWithParent(): boolean;
  34347. /** @hidden */
  34348. isSynchronized(): boolean;
  34349. /**
  34350. * Is this node ready to be used/rendered
  34351. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34352. * @return true if the node is ready
  34353. */
  34354. isReady(completeCheck?: boolean): boolean;
  34355. /**
  34356. * Is this node enabled?
  34357. * If the node has a parent, all ancestors will be checked and false will be returned if any are false (not enabled), otherwise will return true
  34358. * @param checkAncestors indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
  34359. * @return whether this node (and its parent) is enabled
  34360. */
  34361. isEnabled(checkAncestors?: boolean): boolean;
  34362. /** @hidden */
  34363. protected _syncParentEnabledState(): void;
  34364. /**
  34365. * Set the enabled state of this node
  34366. * @param value defines the new enabled state
  34367. */
  34368. setEnabled(value: boolean): void;
  34369. /**
  34370. * Is this node a descendant of the given node?
  34371. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34372. * @param ancestor defines the parent node to inspect
  34373. * @returns a boolean indicating if this node is a descendant of the given node
  34374. */
  34375. isDescendantOf(ancestor: Node): boolean;
  34376. /** @hidden */
  34377. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34378. /**
  34379. * Will return all nodes that have this node as ascendant
  34380. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  34381. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34382. * @return all children nodes of all types
  34383. */
  34384. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34385. /**
  34386. * Get all child-meshes of this node
  34387. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
  34388. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34389. * @returns an array of AbstractMesh
  34390. */
  34391. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34392. /**
  34393. * Get all direct children of this node
  34394. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34395. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
  34396. * @returns an array of Node
  34397. */
  34398. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34399. /** @hidden */
  34400. _setReady(state: boolean): void;
  34401. /**
  34402. * Get an animation by name
  34403. * @param name defines the name of the animation to look for
  34404. * @returns null if not found else the requested animation
  34405. */
  34406. getAnimationByName(name: string): Nullable<Animation>;
  34407. /**
  34408. * Creates an animation range for this node
  34409. * @param name defines the name of the range
  34410. * @param from defines the starting key
  34411. * @param to defines the end key
  34412. */
  34413. createAnimationRange(name: string, from: number, to: number): void;
  34414. /**
  34415. * Delete a specific animation range
  34416. * @param name defines the name of the range to delete
  34417. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34418. */
  34419. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34420. /**
  34421. * Get an animation range by name
  34422. * @param name defines the name of the animation range to look for
  34423. * @returns null if not found else the requested animation range
  34424. */
  34425. getAnimationRange(name: string): Nullable<AnimationRange>;
  34426. /**
  34427. * Gets the list of all animation ranges defined on this node
  34428. * @returns an array
  34429. */
  34430. getAnimationRanges(): Nullable<AnimationRange>[];
  34431. /**
  34432. * Will start the animation sequence
  34433. * @param name defines the range frames for animation sequence
  34434. * @param loop defines if the animation should loop (false by default)
  34435. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34436. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34437. * @returns the object created for this animation. If range does not exist, it will return null
  34438. */
  34439. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34440. /**
  34441. * Serialize animation ranges into a JSON compatible object
  34442. * @returns serialization object
  34443. */
  34444. serializeAnimationRanges(): any;
  34445. /**
  34446. * Computes the world matrix of the node
  34447. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34448. * @returns the world matrix
  34449. */
  34450. computeWorldMatrix(force?: boolean): Matrix;
  34451. /**
  34452. * Releases resources associated with this node.
  34453. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34454. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34455. */
  34456. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34457. /**
  34458. * Parse animation range data from a serialization object and store them into a given node
  34459. * @param node defines where to store the animation ranges
  34460. * @param parsedNode defines the serialization object to read data from
  34461. * @param scene defines the hosting scene
  34462. */
  34463. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34464. /**
  34465. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34466. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34467. * @param predicate defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
  34468. * @returns the new bounding vectors
  34469. */
  34470. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34471. min: Vector3;
  34472. max: Vector3;
  34473. };
  34474. }
  34475. }
  34476. declare module "babylonjs/Animations/animation" {
  34477. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34478. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34479. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34480. import { Nullable } from "babylonjs/types";
  34481. import { Scene } from "babylonjs/scene";
  34482. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34483. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34484. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34485. import { Node } from "babylonjs/node";
  34486. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34487. import { Size } from "babylonjs/Maths/math.size";
  34488. import { Animatable } from "babylonjs/Animations/animatable";
  34489. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34490. /**
  34491. * @hidden
  34492. */
  34493. export class _IAnimationState {
  34494. key: number;
  34495. repeatCount: number;
  34496. workValue?: any;
  34497. loopMode?: number;
  34498. offsetValue?: any;
  34499. highLimitValue?: any;
  34500. }
  34501. /**
  34502. * Class used to store any kind of animation
  34503. */
  34504. export class Animation {
  34505. /**Name of the animation */
  34506. name: string;
  34507. /**Property to animate */
  34508. targetProperty: string;
  34509. /**The frames per second of the animation */
  34510. framePerSecond: number;
  34511. /**The data type of the animation */
  34512. dataType: number;
  34513. /**The loop mode of the animation */
  34514. loopMode?: number | undefined;
  34515. /**Specifies if blending should be enabled */
  34516. enableBlending?: boolean | undefined;
  34517. /**
  34518. * Use matrix interpolation instead of using direct key value when animating matrices
  34519. */
  34520. static AllowMatricesInterpolation: boolean;
  34521. /**
  34522. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34523. */
  34524. static AllowMatrixDecomposeForInterpolation: boolean;
  34525. /** Define the Url to load snippets */
  34526. static SnippetUrl: string;
  34527. /** Snippet ID if the animation was created from the snippet server */
  34528. snippetId: string;
  34529. /**
  34530. * Stores the key frames of the animation
  34531. */
  34532. private _keys;
  34533. /**
  34534. * Stores the easing function of the animation
  34535. */
  34536. private _easingFunction;
  34537. /**
  34538. * @hidden Internal use only
  34539. */
  34540. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34541. /**
  34542. * The set of event that will be linked to this animation
  34543. */
  34544. private _events;
  34545. /**
  34546. * Stores an array of target property paths
  34547. */
  34548. targetPropertyPath: string[];
  34549. /**
  34550. * Stores the blending speed of the animation
  34551. */
  34552. blendingSpeed: number;
  34553. /**
  34554. * Stores the animation ranges for the animation
  34555. */
  34556. private _ranges;
  34557. /**
  34558. * @hidden Internal use
  34559. */
  34560. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34561. /**
  34562. * Sets up an animation
  34563. * @param property The property to animate
  34564. * @param animationType The animation type to apply
  34565. * @param framePerSecond The frames per second of the animation
  34566. * @param easingFunction The easing function used in the animation
  34567. * @returns The created animation
  34568. */
  34569. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34570. /**
  34571. * Create and start an animation on a node
  34572. * @param name defines the name of the global animation that will be run on all nodes
  34573. * @param node defines the root node where the animation will take place
  34574. * @param targetProperty defines property to animate
  34575. * @param framePerSecond defines the number of frame per second yo use
  34576. * @param totalFrame defines the number of frames in total
  34577. * @param from defines the initial value
  34578. * @param to defines the final value
  34579. * @param loopMode defines which loop mode you want to use (off by default)
  34580. * @param easingFunction defines the easing function to use (linear by default)
  34581. * @param onAnimationEnd defines the callback to call when animation end
  34582. * @returns the animatable created for this animation
  34583. */
  34584. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34585. /**
  34586. * Create and start an animation on a node and its descendants
  34587. * @param name defines the name of the global animation that will be run on all nodes
  34588. * @param node defines the root node where the animation will take place
  34589. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used
  34590. * @param targetProperty defines property to animate
  34591. * @param framePerSecond defines the number of frame per second to use
  34592. * @param totalFrame defines the number of frames in total
  34593. * @param from defines the initial value
  34594. * @param to defines the final value
  34595. * @param loopMode defines which loop mode you want to use (off by default)
  34596. * @param easingFunction defines the easing function to use (linear by default)
  34597. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34598. * @returns the list of animatables created for all nodes
  34599. * @example https://www.babylonjs-playground.com/#MH0VLI
  34600. */
  34601. static CreateAndStartHierarchyAnimation(name: string, node: Node, directDescendantsOnly: boolean, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable[]>;
  34602. /**
  34603. * Creates a new animation, merges it with the existing animations and starts it
  34604. * @param name Name of the animation
  34605. * @param node Node which contains the scene that begins the animations
  34606. * @param targetProperty Specifies which property to animate
  34607. * @param framePerSecond The frames per second of the animation
  34608. * @param totalFrame The total number of frames
  34609. * @param from The frame at the beginning of the animation
  34610. * @param to The frame at the end of the animation
  34611. * @param loopMode Specifies the loop mode of the animation
  34612. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34613. * @param onAnimationEnd Callback to run once the animation is complete
  34614. * @returns Nullable animation
  34615. */
  34616. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34617. /**
  34618. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34619. * @param sourceAnimation defines the Animation containing keyframes to convert
  34620. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34621. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34622. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34623. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34624. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34625. */
  34626. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34627. /**
  34628. * Transition property of an host to the target Value
  34629. * @param property The property to transition
  34630. * @param targetValue The target Value of the property
  34631. * @param host The object where the property to animate belongs
  34632. * @param scene Scene used to run the animation
  34633. * @param frameRate Framerate (in frame/s) to use
  34634. * @param transition The transition type we want to use
  34635. * @param duration The duration of the animation, in milliseconds
  34636. * @param onAnimationEnd Callback trigger at the end of the animation
  34637. * @returns Nullable animation
  34638. */
  34639. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34640. /**
  34641. * Return the array of runtime animations currently using this animation
  34642. */
  34643. get runtimeAnimations(): RuntimeAnimation[];
  34644. /**
  34645. * Specifies if any of the runtime animations are currently running
  34646. */
  34647. get hasRunningRuntimeAnimations(): boolean;
  34648. /**
  34649. * Initializes the animation
  34650. * @param name Name of the animation
  34651. * @param targetProperty Property to animate
  34652. * @param framePerSecond The frames per second of the animation
  34653. * @param dataType The data type of the animation
  34654. * @param loopMode The loop mode of the animation
  34655. * @param enableBlending Specifies if blending should be enabled
  34656. */
  34657. constructor(
  34658. /**Name of the animation */
  34659. name: string,
  34660. /**Property to animate */
  34661. targetProperty: string,
  34662. /**The frames per second of the animation */
  34663. framePerSecond: number,
  34664. /**The data type of the animation */
  34665. dataType: number,
  34666. /**The loop mode of the animation */
  34667. loopMode?: number | undefined,
  34668. /**Specifies if blending should be enabled */
  34669. enableBlending?: boolean | undefined);
  34670. /**
  34671. * Converts the animation to a string
  34672. * @param fullDetails support for multiple levels of logging within scene loading
  34673. * @returns String form of the animation
  34674. */
  34675. toString(fullDetails?: boolean): string;
  34676. /**
  34677. * Add an event to this animation
  34678. * @param event Event to add
  34679. */
  34680. addEvent(event: AnimationEvent): void;
  34681. /**
  34682. * Remove all events found at the given frame
  34683. * @param frame The frame to remove events from
  34684. */
  34685. removeEvents(frame: number): void;
  34686. /**
  34687. * Retrieves all the events from the animation
  34688. * @returns Events from the animation
  34689. */
  34690. getEvents(): AnimationEvent[];
  34691. /**
  34692. * Creates an animation range
  34693. * @param name Name of the animation range
  34694. * @param from Starting frame of the animation range
  34695. * @param to Ending frame of the animation
  34696. */
  34697. createRange(name: string, from: number, to: number): void;
  34698. /**
  34699. * Deletes an animation range by name
  34700. * @param name Name of the animation range to delete
  34701. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34702. */
  34703. deleteRange(name: string, deleteFrames?: boolean): void;
  34704. /**
  34705. * Gets the animation range by name, or null if not defined
  34706. * @param name Name of the animation range
  34707. * @returns Nullable animation range
  34708. */
  34709. getRange(name: string): Nullable<AnimationRange>;
  34710. /**
  34711. * Gets the key frames from the animation
  34712. * @returns The key frames of the animation
  34713. */
  34714. getKeys(): Array<IAnimationKey>;
  34715. /**
  34716. * Gets the highest frame rate of the animation
  34717. * @returns Highest frame rate of the animation
  34718. */
  34719. getHighestFrame(): number;
  34720. /**
  34721. * Gets the easing function of the animation
  34722. * @returns Easing function of the animation
  34723. */
  34724. getEasingFunction(): IEasingFunction;
  34725. /**
  34726. * Sets the easing function of the animation
  34727. * @param easingFunction A custom mathematical formula for animation
  34728. */
  34729. setEasingFunction(easingFunction: EasingFunction): void;
  34730. /**
  34731. * Interpolates a scalar linearly
  34732. * @param startValue Start value of the animation curve
  34733. * @param endValue End value of the animation curve
  34734. * @param gradient Scalar amount to interpolate
  34735. * @returns Interpolated scalar value
  34736. */
  34737. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34738. /**
  34739. * Interpolates a scalar cubically
  34740. * @param startValue Start value of the animation curve
  34741. * @param outTangent End tangent of the animation
  34742. * @param endValue End value of the animation curve
  34743. * @param inTangent Start tangent of the animation curve
  34744. * @param gradient Scalar amount to interpolate
  34745. * @returns Interpolated scalar value
  34746. */
  34747. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34748. /**
  34749. * Interpolates a quaternion using a spherical linear interpolation
  34750. * @param startValue Start value of the animation curve
  34751. * @param endValue End value of the animation curve
  34752. * @param gradient Scalar amount to interpolate
  34753. * @returns Interpolated quaternion value
  34754. */
  34755. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34756. /**
  34757. * Interpolates a quaternion cubically
  34758. * @param startValue Start value of the animation curve
  34759. * @param outTangent End tangent of the animation curve
  34760. * @param endValue End value of the animation curve
  34761. * @param inTangent Start tangent of the animation curve
  34762. * @param gradient Scalar amount to interpolate
  34763. * @returns Interpolated quaternion value
  34764. */
  34765. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34766. /**
  34767. * Interpolates a Vector3 linearl
  34768. * @param startValue Start value of the animation curve
  34769. * @param endValue End value of the animation curve
  34770. * @param gradient Scalar amount to interpolate
  34771. * @returns Interpolated scalar value
  34772. */
  34773. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34774. /**
  34775. * Interpolates a Vector3 cubically
  34776. * @param startValue Start value of the animation curve
  34777. * @param outTangent End tangent of the animation
  34778. * @param endValue End value of the animation curve
  34779. * @param inTangent Start tangent of the animation curve
  34780. * @param gradient Scalar amount to interpolate
  34781. * @returns InterpolatedVector3 value
  34782. */
  34783. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34784. /**
  34785. * Interpolates a Vector2 linearly
  34786. * @param startValue Start value of the animation curve
  34787. * @param endValue End value of the animation curve
  34788. * @param gradient Scalar amount to interpolate
  34789. * @returns Interpolated Vector2 value
  34790. */
  34791. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34792. /**
  34793. * Interpolates a Vector2 cubically
  34794. * @param startValue Start value of the animation curve
  34795. * @param outTangent End tangent of the animation
  34796. * @param endValue End value of the animation curve
  34797. * @param inTangent Start tangent of the animation curve
  34798. * @param gradient Scalar amount to interpolate
  34799. * @returns Interpolated Vector2 value
  34800. */
  34801. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34802. /**
  34803. * Interpolates a size linearly
  34804. * @param startValue Start value of the animation curve
  34805. * @param endValue End value of the animation curve
  34806. * @param gradient Scalar amount to interpolate
  34807. * @returns Interpolated Size value
  34808. */
  34809. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34810. /**
  34811. * Interpolates a Color3 linearly
  34812. * @param startValue Start value of the animation curve
  34813. * @param endValue End value of the animation curve
  34814. * @param gradient Scalar amount to interpolate
  34815. * @returns Interpolated Color3 value
  34816. */
  34817. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34818. /**
  34819. * Interpolates a Color4 linearly
  34820. * @param startValue Start value of the animation curve
  34821. * @param endValue End value of the animation curve
  34822. * @param gradient Scalar amount to interpolate
  34823. * @returns Interpolated Color3 value
  34824. */
  34825. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34826. /**
  34827. * @hidden Internal use only
  34828. */
  34829. _getKeyValue(value: any): any;
  34830. /**
  34831. * @hidden Internal use only
  34832. */
  34833. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34834. /**
  34835. * Defines the function to use to interpolate matrices
  34836. * @param startValue defines the start matrix
  34837. * @param endValue defines the end matrix
  34838. * @param gradient defines the gradient between both matrices
  34839. * @param result defines an optional target matrix where to store the interpolation
  34840. * @returns the interpolated matrix
  34841. */
  34842. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34843. /**
  34844. * Makes a copy of the animation
  34845. * @returns Cloned animation
  34846. */
  34847. clone(): Animation;
  34848. /**
  34849. * Sets the key frames of the animation
  34850. * @param values The animation key frames to set
  34851. */
  34852. setKeys(values: Array<IAnimationKey>): void;
  34853. /**
  34854. * Serializes the animation to an object
  34855. * @returns Serialized object
  34856. */
  34857. serialize(): any;
  34858. /**
  34859. * Float animation type
  34860. */
  34861. static readonly ANIMATIONTYPE_FLOAT: number;
  34862. /**
  34863. * Vector3 animation type
  34864. */
  34865. static readonly ANIMATIONTYPE_VECTOR3: number;
  34866. /**
  34867. * Quaternion animation type
  34868. */
  34869. static readonly ANIMATIONTYPE_QUATERNION: number;
  34870. /**
  34871. * Matrix animation type
  34872. */
  34873. static readonly ANIMATIONTYPE_MATRIX: number;
  34874. /**
  34875. * Color3 animation type
  34876. */
  34877. static readonly ANIMATIONTYPE_COLOR3: number;
  34878. /**
  34879. * Color3 animation type
  34880. */
  34881. static readonly ANIMATIONTYPE_COLOR4: number;
  34882. /**
  34883. * Vector2 animation type
  34884. */
  34885. static readonly ANIMATIONTYPE_VECTOR2: number;
  34886. /**
  34887. * Size animation type
  34888. */
  34889. static readonly ANIMATIONTYPE_SIZE: number;
  34890. /**
  34891. * Relative Loop Mode
  34892. */
  34893. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34894. /**
  34895. * Cycle Loop Mode
  34896. */
  34897. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34898. /**
  34899. * Constant Loop Mode
  34900. */
  34901. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34902. /** @hidden */
  34903. static _UniversalLerp(left: any, right: any, amount: number): any;
  34904. /**
  34905. * Parses an animation object and creates an animation
  34906. * @param parsedAnimation Parsed animation object
  34907. * @returns Animation object
  34908. */
  34909. static Parse(parsedAnimation: any): Animation;
  34910. /**
  34911. * Appends the serialized animations from the source animations
  34912. * @param source Source containing the animations
  34913. * @param destination Target to store the animations
  34914. */
  34915. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34916. /**
  34917. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34918. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34919. * @param url defines the url to load from
  34920. * @returns a promise that will resolve to the new animation or an array of animations
  34921. */
  34922. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34923. /**
  34924. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34925. * @param snippetId defines the snippet to load
  34926. * @returns a promise that will resolve to the new animation or a new array of animations
  34927. */
  34928. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34929. }
  34930. }
  34931. declare module "babylonjs/Animations/animatable.interface" {
  34932. import { Nullable } from "babylonjs/types";
  34933. import { Animation } from "babylonjs/Animations/animation";
  34934. /**
  34935. * Interface containing an array of animations
  34936. */
  34937. export interface IAnimatable {
  34938. /**
  34939. * Array of animations
  34940. */
  34941. animations: Nullable<Array<Animation>>;
  34942. }
  34943. }
  34944. declare module "babylonjs/Misc/decorators" {
  34945. import { Nullable } from "babylonjs/types";
  34946. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34947. import { Scene } from "babylonjs/scene";
  34948. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34949. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34950. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34951. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34952. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34953. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34954. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34955. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34956. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34957. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34958. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34959. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34960. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34961. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34962. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34963. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34964. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34965. /**
  34966. * Decorator used to define property that can be serialized as reference to a camera
  34967. * @param sourceName defines the name of the property to decorate
  34968. */
  34969. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34970. /**
  34971. * Class used to help serialization objects
  34972. */
  34973. export class SerializationHelper {
  34974. /** @hidden */
  34975. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34976. /** @hidden */
  34977. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34978. /** @hidden */
  34979. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34980. /** @hidden */
  34981. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34982. /**
  34983. * Appends the serialized animations from the source animations
  34984. * @param source Source containing the animations
  34985. * @param destination Target to store the animations
  34986. */
  34987. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34988. /**
  34989. * Static function used to serialized a specific entity
  34990. * @param entity defines the entity to serialize
  34991. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34992. * @returns a JSON compatible object representing the serialization of the entity
  34993. */
  34994. static Serialize<T>(entity: T, serializationObject?: any): any;
  34995. /**
  34996. * Creates a new entity from a serialization data object
  34997. * @param creationFunction defines a function used to instanciated the new entity
  34998. * @param source defines the source serialization data
  34999. * @param scene defines the hosting scene
  35000. * @param rootUrl defines the root url for resources
  35001. * @returns a new entity
  35002. */
  35003. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  35004. /**
  35005. * Clones an object
  35006. * @param creationFunction defines the function used to instanciate the new object
  35007. * @param source defines the source object
  35008. * @returns the cloned object
  35009. */
  35010. static Clone<T>(creationFunction: () => T, source: T): T;
  35011. /**
  35012. * Instanciates a new object based on a source one (some data will be shared between both object)
  35013. * @param creationFunction defines the function used to instanciate the new object
  35014. * @param source defines the source object
  35015. * @returns the new object
  35016. */
  35017. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35018. }
  35019. }
  35020. declare module "babylonjs/Materials/Textures/baseTexture" {
  35021. import { Observable } from "babylonjs/Misc/observable";
  35022. import { Nullable } from "babylonjs/types";
  35023. import { Scene } from "babylonjs/scene";
  35024. import { Matrix } from "babylonjs/Maths/math.vector";
  35025. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35026. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35027. import { ISize } from "babylonjs/Maths/math.size";
  35028. import "babylonjs/Misc/fileTools";
  35029. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35030. /**
  35031. * Base class of all the textures in babylon.
  35032. * It groups all the common properties the materials, post process, lights... might need
  35033. * in order to make a correct use of the texture.
  35034. */
  35035. export class BaseTexture implements IAnimatable {
  35036. /**
  35037. * Default anisotropic filtering level for the application.
  35038. * It is set to 4 as a good tradeoff between perf and quality.
  35039. */
  35040. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35041. /**
  35042. * Gets or sets the unique id of the texture
  35043. */
  35044. uniqueId: number;
  35045. /**
  35046. * Define the name of the texture.
  35047. */
  35048. name: string;
  35049. /**
  35050. * Gets or sets an object used to store user defined information.
  35051. */
  35052. metadata: any;
  35053. /**
  35054. * For internal use only. Please do not use.
  35055. */
  35056. reservedDataStore: any;
  35057. private _hasAlpha;
  35058. /**
  35059. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35060. */
  35061. set hasAlpha(value: boolean);
  35062. get hasAlpha(): boolean;
  35063. /**
  35064. * Defines if the alpha value should be determined via the rgb values.
  35065. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35066. */
  35067. getAlphaFromRGB: boolean;
  35068. /**
  35069. * Intensity or strength of the texture.
  35070. * It is commonly used by materials to fine tune the intensity of the texture
  35071. */
  35072. level: number;
  35073. /**
  35074. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35075. * This is part of the texture as textures usually maps to one uv set.
  35076. */
  35077. coordinatesIndex: number;
  35078. protected _coordinatesMode: number;
  35079. /**
  35080. * How a texture is mapped.
  35081. *
  35082. * | Value | Type | Description |
  35083. * | ----- | ----------------------------------- | ----------- |
  35084. * | 0 | EXPLICIT_MODE | |
  35085. * | 1 | SPHERICAL_MODE | |
  35086. * | 2 | PLANAR_MODE | |
  35087. * | 3 | CUBIC_MODE | |
  35088. * | 4 | PROJECTION_MODE | |
  35089. * | 5 | SKYBOX_MODE | |
  35090. * | 6 | INVCUBIC_MODE | |
  35091. * | 7 | EQUIRECTANGULAR_MODE | |
  35092. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35093. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35094. */
  35095. set coordinatesMode(value: number);
  35096. get coordinatesMode(): number;
  35097. private _wrapU;
  35098. /**
  35099. * | Value | Type | Description |
  35100. * | ----- | ------------------ | ----------- |
  35101. * | 0 | CLAMP_ADDRESSMODE | |
  35102. * | 1 | WRAP_ADDRESSMODE | |
  35103. * | 2 | MIRROR_ADDRESSMODE | |
  35104. */
  35105. get wrapU(): number;
  35106. set wrapU(value: number);
  35107. private _wrapV;
  35108. /**
  35109. * | Value | Type | Description |
  35110. * | ----- | ------------------ | ----------- |
  35111. * | 0 | CLAMP_ADDRESSMODE | |
  35112. * | 1 | WRAP_ADDRESSMODE | |
  35113. * | 2 | MIRROR_ADDRESSMODE | |
  35114. */
  35115. get wrapV(): number;
  35116. set wrapV(value: number);
  35117. /**
  35118. * | Value | Type | Description |
  35119. * | ----- | ------------------ | ----------- |
  35120. * | 0 | CLAMP_ADDRESSMODE | |
  35121. * | 1 | WRAP_ADDRESSMODE | |
  35122. * | 2 | MIRROR_ADDRESSMODE | |
  35123. */
  35124. wrapR: number;
  35125. /**
  35126. * With compliant hardware and browser (supporting anisotropic filtering)
  35127. * this defines the level of anisotropic filtering in the texture.
  35128. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35129. */
  35130. anisotropicFilteringLevel: number;
  35131. /**
  35132. * Define if the texture is a cube texture or if false a 2d texture.
  35133. */
  35134. get isCube(): boolean;
  35135. set isCube(value: boolean);
  35136. /**
  35137. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35138. */
  35139. get is3D(): boolean;
  35140. set is3D(value: boolean);
  35141. /**
  35142. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35143. */
  35144. get is2DArray(): boolean;
  35145. set is2DArray(value: boolean);
  35146. /**
  35147. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35148. * HDR texture are usually stored in linear space.
  35149. * This only impacts the PBR and Background materials
  35150. */
  35151. gammaSpace: boolean;
  35152. /**
  35153. * Gets or sets whether or not the texture contains RGBD data.
  35154. */
  35155. get isRGBD(): boolean;
  35156. set isRGBD(value: boolean);
  35157. /**
  35158. * Is Z inverted in the texture (useful in a cube texture).
  35159. */
  35160. invertZ: boolean;
  35161. /**
  35162. * Are mip maps generated for this texture or not.
  35163. */
  35164. get noMipmap(): boolean;
  35165. /**
  35166. * @hidden
  35167. */
  35168. lodLevelInAlpha: boolean;
  35169. /**
  35170. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35171. */
  35172. get lodGenerationOffset(): number;
  35173. set lodGenerationOffset(value: number);
  35174. /**
  35175. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35176. */
  35177. get lodGenerationScale(): number;
  35178. set lodGenerationScale(value: number);
  35179. /**
  35180. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35181. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35182. * average roughness values.
  35183. */
  35184. get linearSpecularLOD(): boolean;
  35185. set linearSpecularLOD(value: boolean);
  35186. /**
  35187. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35188. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35189. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35190. */
  35191. get irradianceTexture(): Nullable<BaseTexture>;
  35192. set irradianceTexture(value: Nullable<BaseTexture>);
  35193. /**
  35194. * Define if the texture is a render target.
  35195. */
  35196. isRenderTarget: boolean;
  35197. /**
  35198. * Define the unique id of the texture in the scene.
  35199. */
  35200. get uid(): string;
  35201. /** @hidden */
  35202. _prefiltered: boolean;
  35203. /**
  35204. * Return a string representation of the texture.
  35205. * @returns the texture as a string
  35206. */
  35207. toString(): string;
  35208. /**
  35209. * Get the class name of the texture.
  35210. * @returns "BaseTexture"
  35211. */
  35212. getClassName(): string;
  35213. /**
  35214. * Define the list of animation attached to the texture.
  35215. */
  35216. animations: import("babylonjs/Animations/animation").Animation[];
  35217. /**
  35218. * An event triggered when the texture is disposed.
  35219. */
  35220. onDisposeObservable: Observable<BaseTexture>;
  35221. private _onDisposeObserver;
  35222. /**
  35223. * Callback triggered when the texture has been disposed.
  35224. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35225. */
  35226. set onDispose(callback: () => void);
  35227. /**
  35228. * Define the current state of the loading sequence when in delayed load mode.
  35229. */
  35230. delayLoadState: number;
  35231. protected _scene: Nullable<Scene>;
  35232. protected _engine: Nullable<ThinEngine>;
  35233. /** @hidden */
  35234. _texture: Nullable<InternalTexture>;
  35235. private _uid;
  35236. /**
  35237. * Define if the texture is preventinga material to render or not.
  35238. * If not and the texture is not ready, the engine will use a default black texture instead.
  35239. */
  35240. get isBlocking(): boolean;
  35241. /**
  35242. * Instantiates a new BaseTexture.
  35243. * Base class of all the textures in babylon.
  35244. * It groups all the common properties the materials, post process, lights... might need
  35245. * in order to make a correct use of the texture.
  35246. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35247. */
  35248. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35249. /**
  35250. * Get the scene the texture belongs to.
  35251. * @returns the scene or null if undefined
  35252. */
  35253. getScene(): Nullable<Scene>;
  35254. /** @hidden */
  35255. protected _getEngine(): Nullable<ThinEngine>;
  35256. /**
  35257. * Get the texture transform matrix used to offset tile the texture for istance.
  35258. * @returns the transformation matrix
  35259. */
  35260. getTextureMatrix(): Matrix;
  35261. /**
  35262. * Get the texture reflection matrix used to rotate/transform the reflection.
  35263. * @returns the reflection matrix
  35264. */
  35265. getReflectionTextureMatrix(): Matrix;
  35266. /**
  35267. * Get the underlying lower level texture from Babylon.
  35268. * @returns the insternal texture
  35269. */
  35270. getInternalTexture(): Nullable<InternalTexture>;
  35271. /**
  35272. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35273. * @returns true if ready or not blocking
  35274. */
  35275. isReadyOrNotBlocking(): boolean;
  35276. /**
  35277. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35278. * @returns true if fully ready
  35279. */
  35280. isReady(): boolean;
  35281. private _cachedSize;
  35282. /**
  35283. * Get the size of the texture.
  35284. * @returns the texture size.
  35285. */
  35286. getSize(): ISize;
  35287. /**
  35288. * Get the base size of the texture.
  35289. * It can be different from the size if the texture has been resized for POT for instance
  35290. * @returns the base size
  35291. */
  35292. getBaseSize(): ISize;
  35293. /**
  35294. * Update the sampling mode of the texture.
  35295. * Default is Trilinear mode.
  35296. *
  35297. * | Value | Type | Description |
  35298. * | ----- | ------------------ | ----------- |
  35299. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35300. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35301. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35302. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35303. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35304. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35305. * | 7 | NEAREST_LINEAR | |
  35306. * | 8 | NEAREST_NEAREST | |
  35307. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35308. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35309. * | 11 | LINEAR_LINEAR | |
  35310. * | 12 | LINEAR_NEAREST | |
  35311. *
  35312. * > _mag_: magnification filter (close to the viewer)
  35313. * > _min_: minification filter (far from the viewer)
  35314. * > _mip_: filter used between mip map levels
  35315. *@param samplingMode Define the new sampling mode of the texture
  35316. */
  35317. updateSamplingMode(samplingMode: number): void;
  35318. /**
  35319. * Scales the texture if is `canRescale()`
  35320. * @param ratio the resize factor we want to use to rescale
  35321. */
  35322. scale(ratio: number): void;
  35323. /**
  35324. * Get if the texture can rescale.
  35325. */
  35326. get canRescale(): boolean;
  35327. /** @hidden */
  35328. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35329. /** @hidden */
  35330. _rebuild(): void;
  35331. /**
  35332. * Triggers the load sequence in delayed load mode.
  35333. */
  35334. delayLoad(): void;
  35335. /**
  35336. * Clones the texture.
  35337. * @returns the cloned texture
  35338. */
  35339. clone(): Nullable<BaseTexture>;
  35340. /**
  35341. * Get the texture underlying type (INT, FLOAT...)
  35342. */
  35343. get textureType(): number;
  35344. /**
  35345. * Get the texture underlying format (RGB, RGBA...)
  35346. */
  35347. get textureFormat(): number;
  35348. /**
  35349. * Indicates that textures need to be re-calculated for all materials
  35350. */
  35351. protected _markAllSubMeshesAsTexturesDirty(): void;
  35352. /**
  35353. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35354. * This will returns an RGBA array buffer containing either in values (0-255) or
  35355. * float values (0-1) depending of the underlying buffer type.
  35356. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35357. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35358. * @param buffer defines a user defined buffer to fill with data (can be null)
  35359. * @returns The Array buffer containing the pixels data.
  35360. */
  35361. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35362. /**
  35363. * Release and destroy the underlying lower level texture aka internalTexture.
  35364. */
  35365. releaseInternalTexture(): void;
  35366. /** @hidden */
  35367. get _lodTextureHigh(): Nullable<BaseTexture>;
  35368. /** @hidden */
  35369. get _lodTextureMid(): Nullable<BaseTexture>;
  35370. /** @hidden */
  35371. get _lodTextureLow(): Nullable<BaseTexture>;
  35372. /**
  35373. * Dispose the texture and release its associated resources.
  35374. */
  35375. dispose(): void;
  35376. /**
  35377. * Serialize the texture into a JSON representation that can be parsed later on.
  35378. * @returns the JSON representation of the texture
  35379. */
  35380. serialize(): any;
  35381. /**
  35382. * Helper function to be called back once a list of texture contains only ready textures.
  35383. * @param textures Define the list of textures to wait for
  35384. * @param callback Define the callback triggered once the entire list will be ready
  35385. */
  35386. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35387. private static _isScene;
  35388. }
  35389. }
  35390. declare module "babylonjs/Materials/effect" {
  35391. import { Observable } from "babylonjs/Misc/observable";
  35392. import { Nullable } from "babylonjs/types";
  35393. import { IDisposable } from "babylonjs/scene";
  35394. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35395. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35396. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35397. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35398. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35399. import { Engine } from "babylonjs/Engines/engine";
  35400. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35401. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35402. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35403. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35404. /**
  35405. * Options to be used when creating an effect.
  35406. */
  35407. export interface IEffectCreationOptions {
  35408. /**
  35409. * Atrributes that will be used in the shader.
  35410. */
  35411. attributes: string[];
  35412. /**
  35413. * Uniform varible names that will be set in the shader.
  35414. */
  35415. uniformsNames: string[];
  35416. /**
  35417. * Uniform buffer variable names that will be set in the shader.
  35418. */
  35419. uniformBuffersNames: string[];
  35420. /**
  35421. * Sampler texture variable names that will be set in the shader.
  35422. */
  35423. samplers: string[];
  35424. /**
  35425. * Define statements that will be set in the shader.
  35426. */
  35427. defines: any;
  35428. /**
  35429. * Possible fallbacks for this effect to improve performance when needed.
  35430. */
  35431. fallbacks: Nullable<IEffectFallbacks>;
  35432. /**
  35433. * Callback that will be called when the shader is compiled.
  35434. */
  35435. onCompiled: Nullable<(effect: Effect) => void>;
  35436. /**
  35437. * Callback that will be called if an error occurs during shader compilation.
  35438. */
  35439. onError: Nullable<(effect: Effect, errors: string) => void>;
  35440. /**
  35441. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35442. */
  35443. indexParameters?: any;
  35444. /**
  35445. * Max number of lights that can be used in the shader.
  35446. */
  35447. maxSimultaneousLights?: number;
  35448. /**
  35449. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35450. */
  35451. transformFeedbackVaryings?: Nullable<string[]>;
  35452. /**
  35453. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  35454. */
  35455. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35456. /**
  35457. * Is this effect rendering to several color attachments ?
  35458. */
  35459. multiTarget?: boolean;
  35460. }
  35461. /**
  35462. * Effect containing vertex and fragment shader that can be executed on an object.
  35463. */
  35464. export class Effect implements IDisposable {
  35465. /**
  35466. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35467. */
  35468. static ShadersRepository: string;
  35469. /**
  35470. * Enable logging of the shader code when a compilation error occurs
  35471. */
  35472. static LogShaderCodeOnCompilationError: boolean;
  35473. /**
  35474. * Name of the effect.
  35475. */
  35476. name: any;
  35477. /**
  35478. * String container all the define statements that should be set on the shader.
  35479. */
  35480. defines: string;
  35481. /**
  35482. * Callback that will be called when the shader is compiled.
  35483. */
  35484. onCompiled: Nullable<(effect: Effect) => void>;
  35485. /**
  35486. * Callback that will be called if an error occurs during shader compilation.
  35487. */
  35488. onError: Nullable<(effect: Effect, errors: string) => void>;
  35489. /**
  35490. * Callback that will be called when effect is bound.
  35491. */
  35492. onBind: Nullable<(effect: Effect) => void>;
  35493. /**
  35494. * Unique ID of the effect.
  35495. */
  35496. uniqueId: number;
  35497. /**
  35498. * Observable that will be called when the shader is compiled.
  35499. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35500. */
  35501. onCompileObservable: Observable<Effect>;
  35502. /**
  35503. * Observable that will be called if an error occurs during shader compilation.
  35504. */
  35505. onErrorObservable: Observable<Effect>;
  35506. /** @hidden */
  35507. _onBindObservable: Nullable<Observable<Effect>>;
  35508. /**
  35509. * @hidden
  35510. * Specifies if the effect was previously ready
  35511. */
  35512. _wasPreviouslyReady: boolean;
  35513. /**
  35514. * Observable that will be called when effect is bound.
  35515. */
  35516. get onBindObservable(): Observable<Effect>;
  35517. /** @hidden */
  35518. _bonesComputationForcedToCPU: boolean;
  35519. /** @hidden */
  35520. _multiTarget: boolean;
  35521. private static _uniqueIdSeed;
  35522. private _engine;
  35523. private _uniformBuffersNames;
  35524. private _uniformBuffersNamesList;
  35525. private _uniformsNames;
  35526. private _samplerList;
  35527. private _samplers;
  35528. private _isReady;
  35529. private _compilationError;
  35530. private _allFallbacksProcessed;
  35531. private _attributesNames;
  35532. private _attributes;
  35533. private _attributeLocationByName;
  35534. private _uniforms;
  35535. /**
  35536. * Key for the effect.
  35537. * @hidden
  35538. */
  35539. _key: string;
  35540. private _indexParameters;
  35541. private _fallbacks;
  35542. private _vertexSourceCode;
  35543. private _fragmentSourceCode;
  35544. private _vertexSourceCodeOverride;
  35545. private _fragmentSourceCodeOverride;
  35546. private _transformFeedbackVaryings;
  35547. /**
  35548. * Compiled shader to webGL program.
  35549. * @hidden
  35550. */
  35551. _pipelineContext: Nullable<IPipelineContext>;
  35552. private _valueCache;
  35553. private static _baseCache;
  35554. /**
  35555. * Instantiates an effect.
  35556. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35557. * @param baseName Name of the effect.
  35558. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35559. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35560. * @param samplers List of sampler variables that will be passed to the shader.
  35561. * @param engine Engine to be used to render the effect
  35562. * @param defines Define statements to be added to the shader.
  35563. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35564. * @param onCompiled Callback that will be called when the shader is compiled.
  35565. * @param onError Callback that will be called if an error occurs during shader compilation.
  35566. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35567. */
  35568. constructor(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: Nullable<string[]>, engine?: ThinEngine, defines?: Nullable<string>, fallbacks?: Nullable<IEffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  35569. private _useFinalCode;
  35570. /**
  35571. * Unique key for this effect
  35572. */
  35573. get key(): string;
  35574. /**
  35575. * If the effect has been compiled and prepared.
  35576. * @returns if the effect is compiled and prepared.
  35577. */
  35578. isReady(): boolean;
  35579. private _isReadyInternal;
  35580. /**
  35581. * The engine the effect was initialized with.
  35582. * @returns the engine.
  35583. */
  35584. getEngine(): Engine;
  35585. /**
  35586. * The pipeline context for this effect
  35587. * @returns the associated pipeline context
  35588. */
  35589. getPipelineContext(): Nullable<IPipelineContext>;
  35590. /**
  35591. * The set of names of attribute variables for the shader.
  35592. * @returns An array of attribute names.
  35593. */
  35594. getAttributesNames(): string[];
  35595. /**
  35596. * Returns the attribute at the given index.
  35597. * @param index The index of the attribute.
  35598. * @returns The location of the attribute.
  35599. */
  35600. getAttributeLocation(index: number): number;
  35601. /**
  35602. * Returns the attribute based on the name of the variable.
  35603. * @param name of the attribute to look up.
  35604. * @returns the attribute location.
  35605. */
  35606. getAttributeLocationByName(name: string): number;
  35607. /**
  35608. * The number of attributes.
  35609. * @returns the numnber of attributes.
  35610. */
  35611. getAttributesCount(): number;
  35612. /**
  35613. * Gets the index of a uniform variable.
  35614. * @param uniformName of the uniform to look up.
  35615. * @returns the index.
  35616. */
  35617. getUniformIndex(uniformName: string): number;
  35618. /**
  35619. * Returns the attribute based on the name of the variable.
  35620. * @param uniformName of the uniform to look up.
  35621. * @returns the location of the uniform.
  35622. */
  35623. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35624. /**
  35625. * Returns an array of sampler variable names
  35626. * @returns The array of sampler variable names.
  35627. */
  35628. getSamplers(): string[];
  35629. /**
  35630. * Returns an array of uniform variable names
  35631. * @returns The array of uniform variable names.
  35632. */
  35633. getUniformNames(): string[];
  35634. /**
  35635. * Returns an array of uniform buffer variable names
  35636. * @returns The array of uniform buffer variable names.
  35637. */
  35638. getUniformBuffersNames(): string[];
  35639. /**
  35640. * Returns the index parameters used to create the effect
  35641. * @returns The index parameters object
  35642. */
  35643. getIndexParameters(): any;
  35644. /**
  35645. * The error from the last compilation.
  35646. * @returns the error string.
  35647. */
  35648. getCompilationError(): string;
  35649. /**
  35650. * Gets a boolean indicating that all fallbacks were used during compilation
  35651. * @returns true if all fallbacks were used
  35652. */
  35653. allFallbacksProcessed(): boolean;
  35654. /**
  35655. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35656. * @param func The callback to be used.
  35657. */
  35658. executeWhenCompiled(func: (effect: Effect) => void): void;
  35659. private _checkIsReady;
  35660. private _loadShader;
  35661. /**
  35662. * Gets the vertex shader source code of this effect
  35663. */
  35664. get vertexSourceCode(): string;
  35665. /**
  35666. * Gets the fragment shader source code of this effect
  35667. */
  35668. get fragmentSourceCode(): string;
  35669. /**
  35670. * Recompiles the webGL program
  35671. * @param vertexSourceCode The source code for the vertex shader.
  35672. * @param fragmentSourceCode The source code for the fragment shader.
  35673. * @param onCompiled Callback called when completed.
  35674. * @param onError Callback called on error.
  35675. * @hidden
  35676. */
  35677. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35678. /**
  35679. * Prepares the effect
  35680. * @hidden
  35681. */
  35682. _prepareEffect(): void;
  35683. private _getShaderCodeAndErrorLine;
  35684. private _processCompilationErrors;
  35685. /**
  35686. * Checks if the effect is supported. (Must be called after compilation)
  35687. */
  35688. get isSupported(): boolean;
  35689. /**
  35690. * Binds a texture to the engine to be used as output of the shader.
  35691. * @param channel Name of the output variable.
  35692. * @param texture Texture to bind.
  35693. * @hidden
  35694. */
  35695. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35696. /**
  35697. * Sets a texture on the engine to be used in the shader.
  35698. * @param channel Name of the sampler variable.
  35699. * @param texture Texture to set.
  35700. */
  35701. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35702. /**
  35703. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35704. * @param channel Name of the sampler variable.
  35705. * @param texture Texture to set.
  35706. */
  35707. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35708. /**
  35709. * Sets an array of textures on the engine to be used in the shader.
  35710. * @param channel Name of the variable.
  35711. * @param textures Textures to set.
  35712. */
  35713. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35714. /**
  35715. * Sets a texture to be the input of the specified post process. (To use the output, pass in the next post process in the pipeline)
  35716. * @param channel Name of the sampler variable.
  35717. * @param postProcess Post process to get the input texture from.
  35718. */
  35719. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35720. /**
  35721. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35722. * Sets the input texture of the passed in post process to be input of this effect. (To use the output of the passed in post process use setTextureFromPostProcessOutput)
  35723. * @param channel Name of the sampler variable.
  35724. * @param postProcess Post process to get the output texture from.
  35725. */
  35726. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35727. /** @hidden */
  35728. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35729. /** @hidden */
  35730. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35731. /** @hidden */
  35732. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35733. /** @hidden */
  35734. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35735. /**
  35736. * Binds a buffer to a uniform.
  35737. * @param buffer Buffer to bind.
  35738. * @param name Name of the uniform variable to bind to.
  35739. */
  35740. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35741. /**
  35742. * Binds block to a uniform.
  35743. * @param blockName Name of the block to bind.
  35744. * @param index Index to bind.
  35745. */
  35746. bindUniformBlock(blockName: string, index: number): void;
  35747. /**
  35748. * Sets an interger value on a uniform variable.
  35749. * @param uniformName Name of the variable.
  35750. * @param value Value to be set.
  35751. * @returns this effect.
  35752. */
  35753. setInt(uniformName: string, value: number): Effect;
  35754. /**
  35755. * Sets an int array on a uniform variable.
  35756. * @param uniformName Name of the variable.
  35757. * @param array array to be set.
  35758. * @returns this effect.
  35759. */
  35760. setIntArray(uniformName: string, array: Int32Array): Effect;
  35761. /**
  35762. * Sets an int array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  35763. * @param uniformName Name of the variable.
  35764. * @param array array to be set.
  35765. * @returns this effect.
  35766. */
  35767. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35768. /**
  35769. * Sets an int array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  35770. * @param uniformName Name of the variable.
  35771. * @param array array to be set.
  35772. * @returns this effect.
  35773. */
  35774. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35775. /**
  35776. * Sets an int array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  35777. * @param uniformName Name of the variable.
  35778. * @param array array to be set.
  35779. * @returns this effect.
  35780. */
  35781. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35782. /**
  35783. * Sets an float array on a uniform variable.
  35784. * @param uniformName Name of the variable.
  35785. * @param array array to be set.
  35786. * @returns this effect.
  35787. */
  35788. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35789. /**
  35790. * Sets an float array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  35791. * @param uniformName Name of the variable.
  35792. * @param array array to be set.
  35793. * @returns this effect.
  35794. */
  35795. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35796. /**
  35797. * Sets an float array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  35798. * @param uniformName Name of the variable.
  35799. * @param array array to be set.
  35800. * @returns this effect.
  35801. */
  35802. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35803. /**
  35804. * Sets an float array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  35805. * @param uniformName Name of the variable.
  35806. * @param array array to be set.
  35807. * @returns this effect.
  35808. */
  35809. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35810. /**
  35811. * Sets an array on a uniform variable.
  35812. * @param uniformName Name of the variable.
  35813. * @param array array to be set.
  35814. * @returns this effect.
  35815. */
  35816. setArray(uniformName: string, array: number[]): Effect;
  35817. /**
  35818. * Sets an array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  35819. * @param uniformName Name of the variable.
  35820. * @param array array to be set.
  35821. * @returns this effect.
  35822. */
  35823. setArray2(uniformName: string, array: number[]): Effect;
  35824. /**
  35825. * Sets an array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  35826. * @param uniformName Name of the variable.
  35827. * @param array array to be set.
  35828. * @returns this effect.
  35829. */
  35830. setArray3(uniformName: string, array: number[]): Effect;
  35831. /**
  35832. * Sets an array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  35833. * @param uniformName Name of the variable.
  35834. * @param array array to be set.
  35835. * @returns this effect.
  35836. */
  35837. setArray4(uniformName: string, array: number[]): Effect;
  35838. /**
  35839. * Sets matrices on a uniform variable.
  35840. * @param uniformName Name of the variable.
  35841. * @param matrices matrices to be set.
  35842. * @returns this effect.
  35843. */
  35844. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35845. /**
  35846. * Sets matrix on a uniform variable.
  35847. * @param uniformName Name of the variable.
  35848. * @param matrix matrix to be set.
  35849. * @returns this effect.
  35850. */
  35851. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35852. /**
  35853. * Sets a 3x3 matrix on a uniform variable. (Speicified as [1,2,3,4,5,6,7,8,9] will result in [1,2,3][4,5,6][7,8,9] matrix)
  35854. * @param uniformName Name of the variable.
  35855. * @param matrix matrix to be set.
  35856. * @returns this effect.
  35857. */
  35858. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35859. /**
  35860. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35861. * @param uniformName Name of the variable.
  35862. * @param matrix matrix to be set.
  35863. * @returns this effect.
  35864. */
  35865. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35866. /**
  35867. * Sets a float on a uniform variable.
  35868. * @param uniformName Name of the variable.
  35869. * @param value value to be set.
  35870. * @returns this effect.
  35871. */
  35872. setFloat(uniformName: string, value: number): Effect;
  35873. /**
  35874. * Sets a boolean on a uniform variable.
  35875. * @param uniformName Name of the variable.
  35876. * @param bool value to be set.
  35877. * @returns this effect.
  35878. */
  35879. setBool(uniformName: string, bool: boolean): Effect;
  35880. /**
  35881. * Sets a Vector2 on a uniform variable.
  35882. * @param uniformName Name of the variable.
  35883. * @param vector2 vector2 to be set.
  35884. * @returns this effect.
  35885. */
  35886. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35887. /**
  35888. * Sets a float2 on a uniform variable.
  35889. * @param uniformName Name of the variable.
  35890. * @param x First float in float2.
  35891. * @param y Second float in float2.
  35892. * @returns this effect.
  35893. */
  35894. setFloat2(uniformName: string, x: number, y: number): Effect;
  35895. /**
  35896. * Sets a Vector3 on a uniform variable.
  35897. * @param uniformName Name of the variable.
  35898. * @param vector3 Value to be set.
  35899. * @returns this effect.
  35900. */
  35901. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35902. /**
  35903. * Sets a float3 on a uniform variable.
  35904. * @param uniformName Name of the variable.
  35905. * @param x First float in float3.
  35906. * @param y Second float in float3.
  35907. * @param z Third float in float3.
  35908. * @returns this effect.
  35909. */
  35910. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35911. /**
  35912. * Sets a Vector4 on a uniform variable.
  35913. * @param uniformName Name of the variable.
  35914. * @param vector4 Value to be set.
  35915. * @returns this effect.
  35916. */
  35917. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35918. /**
  35919. * Sets a float4 on a uniform variable.
  35920. * @param uniformName Name of the variable.
  35921. * @param x First float in float4.
  35922. * @param y Second float in float4.
  35923. * @param z Third float in float4.
  35924. * @param w Fourth float in float4.
  35925. * @returns this effect.
  35926. */
  35927. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35928. /**
  35929. * Sets a Color3 on a uniform variable.
  35930. * @param uniformName Name of the variable.
  35931. * @param color3 Value to be set.
  35932. * @returns this effect.
  35933. */
  35934. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35935. /**
  35936. * Sets a Color4 on a uniform variable.
  35937. * @param uniformName Name of the variable.
  35938. * @param color3 Value to be set.
  35939. * @param alpha Alpha value to be set.
  35940. * @returns this effect.
  35941. */
  35942. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35943. /**
  35944. * Sets a Color4 on a uniform variable
  35945. * @param uniformName defines the name of the variable
  35946. * @param color4 defines the value to be set
  35947. * @returns this effect.
  35948. */
  35949. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35950. /** Release all associated resources */
  35951. dispose(): void;
  35952. /**
  35953. * This function will add a new shader to the shader store
  35954. * @param name the name of the shader
  35955. * @param pixelShader optional pixel shader content
  35956. * @param vertexShader optional vertex shader content
  35957. */
  35958. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35959. /**
  35960. * Store of each shader (The can be looked up using effect.key)
  35961. */
  35962. static ShadersStore: {
  35963. [key: string]: string;
  35964. };
  35965. /**
  35966. * Store of each included file for a shader (The can be looked up using effect.key)
  35967. */
  35968. static IncludesShadersStore: {
  35969. [key: string]: string;
  35970. };
  35971. /**
  35972. * Resets the cache of effects.
  35973. */
  35974. static ResetCache(): void;
  35975. }
  35976. }
  35977. declare module "babylonjs/Engines/engineCapabilities" {
  35978. /**
  35979. * Interface used to describe the capabilities of the engine relatively to the current browser
  35980. */
  35981. export interface EngineCapabilities {
  35982. /** Maximum textures units per fragment shader */
  35983. maxTexturesImageUnits: number;
  35984. /** Maximum texture units per vertex shader */
  35985. maxVertexTextureImageUnits: number;
  35986. /** Maximum textures units in the entire pipeline */
  35987. maxCombinedTexturesImageUnits: number;
  35988. /** Maximum texture size */
  35989. maxTextureSize: number;
  35990. /** Maximum texture samples */
  35991. maxSamples?: number;
  35992. /** Maximum cube texture size */
  35993. maxCubemapTextureSize: number;
  35994. /** Maximum render texture size */
  35995. maxRenderTextureSize: number;
  35996. /** Maximum number of vertex attributes */
  35997. maxVertexAttribs: number;
  35998. /** Maximum number of varyings */
  35999. maxVaryingVectors: number;
  36000. /** Maximum number of uniforms per vertex shader */
  36001. maxVertexUniformVectors: number;
  36002. /** Maximum number of uniforms per fragment shader */
  36003. maxFragmentUniformVectors: number;
  36004. /** Defines if standard derivates (dx/dy) are supported */
  36005. standardDerivatives: boolean;
  36006. /** Defines if s3tc texture compression is supported */
  36007. s3tc?: WEBGL_compressed_texture_s3tc;
  36008. /** Defines if pvrtc texture compression is supported */
  36009. pvrtc: any;
  36010. /** Defines if etc1 texture compression is supported */
  36011. etc1: any;
  36012. /** Defines if etc2 texture compression is supported */
  36013. etc2: any;
  36014. /** Defines if astc texture compression is supported */
  36015. astc: any;
  36016. /** Defines if float textures are supported */
  36017. textureFloat: boolean;
  36018. /** Defines if vertex array objects are supported */
  36019. vertexArrayObject: boolean;
  36020. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36021. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36022. /** Gets the maximum level of anisotropy supported */
  36023. maxAnisotropy: number;
  36024. /** Defines if instancing is supported */
  36025. instancedArrays: boolean;
  36026. /** Defines if 32 bits indices are supported */
  36027. uintIndices: boolean;
  36028. /** Defines if high precision shaders are supported */
  36029. highPrecisionShaderSupported: boolean;
  36030. /** Defines if depth reading in the fragment shader is supported */
  36031. fragmentDepthSupported: boolean;
  36032. /** Defines if float texture linear filtering is supported*/
  36033. textureFloatLinearFiltering: boolean;
  36034. /** Defines if rendering to float textures is supported */
  36035. textureFloatRender: boolean;
  36036. /** Defines if half float textures are supported*/
  36037. textureHalfFloat: boolean;
  36038. /** Defines if half float texture linear filtering is supported*/
  36039. textureHalfFloatLinearFiltering: boolean;
  36040. /** Defines if rendering to half float textures is supported */
  36041. textureHalfFloatRender: boolean;
  36042. /** Defines if textureLOD shader command is supported */
  36043. textureLOD: boolean;
  36044. /** Defines if draw buffers extension is supported */
  36045. drawBuffersExtension: boolean;
  36046. /** Defines if depth textures are supported */
  36047. depthTextureExtension: boolean;
  36048. /** Defines if float color buffer are supported */
  36049. colorBufferFloat: boolean;
  36050. /** Gets disjoint timer query extension (null if not supported) */
  36051. timerQuery?: EXT_disjoint_timer_query;
  36052. /** Defines if timestamp can be used with timer query */
  36053. canUseTimestampForTimerQuery: boolean;
  36054. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36055. multiview?: any;
  36056. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36057. oculusMultiview?: any;
  36058. /** Function used to let the system compiles shaders in background */
  36059. parallelShaderCompile?: {
  36060. COMPLETION_STATUS_KHR: number;
  36061. };
  36062. /** Max number of texture samples for MSAA */
  36063. maxMSAASamples: number;
  36064. /** Defines if the blend min max extension is supported */
  36065. blendMinMax: boolean;
  36066. }
  36067. }
  36068. declare module "babylonjs/States/depthCullingState" {
  36069. import { Nullable } from "babylonjs/types";
  36070. /**
  36071. * @hidden
  36072. **/
  36073. export class DepthCullingState {
  36074. private _isDepthTestDirty;
  36075. private _isDepthMaskDirty;
  36076. private _isDepthFuncDirty;
  36077. private _isCullFaceDirty;
  36078. private _isCullDirty;
  36079. private _isZOffsetDirty;
  36080. private _isFrontFaceDirty;
  36081. private _depthTest;
  36082. private _depthMask;
  36083. private _depthFunc;
  36084. private _cull;
  36085. private _cullFace;
  36086. private _zOffset;
  36087. private _frontFace;
  36088. /**
  36089. * Initializes the state.
  36090. */
  36091. constructor();
  36092. get isDirty(): boolean;
  36093. get zOffset(): number;
  36094. set zOffset(value: number);
  36095. get cullFace(): Nullable<number>;
  36096. set cullFace(value: Nullable<number>);
  36097. get cull(): Nullable<boolean>;
  36098. set cull(value: Nullable<boolean>);
  36099. get depthFunc(): Nullable<number>;
  36100. set depthFunc(value: Nullable<number>);
  36101. get depthMask(): boolean;
  36102. set depthMask(value: boolean);
  36103. get depthTest(): boolean;
  36104. set depthTest(value: boolean);
  36105. get frontFace(): Nullable<number>;
  36106. set frontFace(value: Nullable<number>);
  36107. reset(): void;
  36108. apply(gl: WebGLRenderingContext): void;
  36109. }
  36110. }
  36111. declare module "babylonjs/States/stencilState" {
  36112. /**
  36113. * @hidden
  36114. **/
  36115. export class StencilState {
  36116. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  36117. static readonly ALWAYS: number;
  36118. /** Passed to stencilOperation to specify that stencil value must be kept */
  36119. static readonly KEEP: number;
  36120. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36121. static readonly REPLACE: number;
  36122. private _isStencilTestDirty;
  36123. private _isStencilMaskDirty;
  36124. private _isStencilFuncDirty;
  36125. private _isStencilOpDirty;
  36126. private _stencilTest;
  36127. private _stencilMask;
  36128. private _stencilFunc;
  36129. private _stencilFuncRef;
  36130. private _stencilFuncMask;
  36131. private _stencilOpStencilFail;
  36132. private _stencilOpDepthFail;
  36133. private _stencilOpStencilDepthPass;
  36134. get isDirty(): boolean;
  36135. get stencilFunc(): number;
  36136. set stencilFunc(value: number);
  36137. get stencilFuncRef(): number;
  36138. set stencilFuncRef(value: number);
  36139. get stencilFuncMask(): number;
  36140. set stencilFuncMask(value: number);
  36141. get stencilOpStencilFail(): number;
  36142. set stencilOpStencilFail(value: number);
  36143. get stencilOpDepthFail(): number;
  36144. set stencilOpDepthFail(value: number);
  36145. get stencilOpStencilDepthPass(): number;
  36146. set stencilOpStencilDepthPass(value: number);
  36147. get stencilMask(): number;
  36148. set stencilMask(value: number);
  36149. get stencilTest(): boolean;
  36150. set stencilTest(value: boolean);
  36151. constructor();
  36152. reset(): void;
  36153. apply(gl: WebGLRenderingContext): void;
  36154. }
  36155. }
  36156. declare module "babylonjs/States/alphaCullingState" {
  36157. /**
  36158. * @hidden
  36159. **/
  36160. export class AlphaState {
  36161. private _isAlphaBlendDirty;
  36162. private _isBlendFunctionParametersDirty;
  36163. private _isBlendEquationParametersDirty;
  36164. private _isBlendConstantsDirty;
  36165. private _alphaBlend;
  36166. private _blendFunctionParameters;
  36167. private _blendEquationParameters;
  36168. private _blendConstants;
  36169. /**
  36170. * Initializes the state.
  36171. */
  36172. constructor();
  36173. get isDirty(): boolean;
  36174. get alphaBlend(): boolean;
  36175. set alphaBlend(value: boolean);
  36176. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36177. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36178. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36179. reset(): void;
  36180. apply(gl: WebGLRenderingContext): void;
  36181. }
  36182. }
  36183. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36184. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36185. /** @hidden */
  36186. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36187. attributeProcessor(attribute: string): string;
  36188. varyingProcessor(varying: string, isFragment: boolean): string;
  36189. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36190. }
  36191. }
  36192. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36193. /**
  36194. * Interface for attribute information associated with buffer instanciation
  36195. */
  36196. export interface InstancingAttributeInfo {
  36197. /**
  36198. * Name of the GLSL attribute
  36199. * if attribute index is not specified, this is used to retrieve the index from the effect
  36200. */
  36201. attributeName: string;
  36202. /**
  36203. * Index/offset of the attribute in the vertex shader
  36204. * if not specified, this will be computes from the name.
  36205. */
  36206. index?: number;
  36207. /**
  36208. * size of the attribute, 1, 2, 3 or 4
  36209. */
  36210. attributeSize: number;
  36211. /**
  36212. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36213. */
  36214. offset: number;
  36215. /**
  36216. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36217. * default to 1
  36218. */
  36219. divisor?: number;
  36220. /**
  36221. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36222. * default is FLOAT
  36223. */
  36224. attributeType?: number;
  36225. /**
  36226. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36227. */
  36228. normalized?: boolean;
  36229. }
  36230. }
  36231. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36232. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36233. import { Nullable } from "babylonjs/types";
  36234. module "babylonjs/Engines/thinEngine" {
  36235. interface ThinEngine {
  36236. /**
  36237. * Update a video texture
  36238. * @param texture defines the texture to update
  36239. * @param video defines the video element to use
  36240. * @param invertY defines if data must be stored with Y axis inverted
  36241. */
  36242. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36243. }
  36244. }
  36245. }
  36246. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36247. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36248. import { Nullable } from "babylonjs/types";
  36249. module "babylonjs/Engines/thinEngine" {
  36250. interface ThinEngine {
  36251. /**
  36252. * Creates a dynamic texture
  36253. * @param width defines the width of the texture
  36254. * @param height defines the height of the texture
  36255. * @param generateMipMaps defines if the engine should generate the mip levels
  36256. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36257. * @returns the dynamic texture inside an InternalTexture
  36258. */
  36259. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36260. /**
  36261. * Update the content of a dynamic texture
  36262. * @param texture defines the texture to update
  36263. * @param canvas defines the canvas containing the source
  36264. * @param invertY defines if data must be stored with Y axis inverted
  36265. * @param premulAlpha defines if alpha is stored as premultiplied
  36266. * @param format defines the format of the data
  36267. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36268. */
  36269. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36270. }
  36271. }
  36272. }
  36273. declare module "babylonjs/Materials/Textures/videoTexture" {
  36274. import { Observable } from "babylonjs/Misc/observable";
  36275. import { Nullable } from "babylonjs/types";
  36276. import { Scene } from "babylonjs/scene";
  36277. import { Texture } from "babylonjs/Materials/Textures/texture";
  36278. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36279. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36280. /**
  36281. * Settings for finer control over video usage
  36282. */
  36283. export interface VideoTextureSettings {
  36284. /**
  36285. * Applies `autoplay` to video, if specified
  36286. */
  36287. autoPlay?: boolean;
  36288. /**
  36289. * Applies `loop` to video, if specified
  36290. */
  36291. loop?: boolean;
  36292. /**
  36293. * Automatically updates internal texture from video at every frame in the render loop
  36294. */
  36295. autoUpdateTexture: boolean;
  36296. /**
  36297. * Image src displayed during the video loading or until the user interacts with the video.
  36298. */
  36299. poster?: string;
  36300. }
  36301. /**
  36302. * If you want to display a video in your scene, this is the special texture for that.
  36303. * This special texture works similar to other textures, with the exception of a few parameters.
  36304. * @see https://doc.babylonjs.com/how_to/video_texture
  36305. */
  36306. export class VideoTexture extends Texture {
  36307. /**
  36308. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36309. */
  36310. readonly autoUpdateTexture: boolean;
  36311. /**
  36312. * The video instance used by the texture internally
  36313. */
  36314. readonly video: HTMLVideoElement;
  36315. private _onUserActionRequestedObservable;
  36316. /**
  36317. * Event triggerd when a dom action is required by the user to play the video.
  36318. * This happens due to recent changes in browser policies preventing video to auto start.
  36319. */
  36320. get onUserActionRequestedObservable(): Observable<Texture>;
  36321. private _generateMipMaps;
  36322. private _stillImageCaptured;
  36323. private _displayingPosterTexture;
  36324. private _settings;
  36325. private _createInternalTextureOnEvent;
  36326. private _frameId;
  36327. private _currentSrc;
  36328. /**
  36329. * Creates a video texture.
  36330. * If you want to display a video in your scene, this is the special texture for that.
  36331. * This special texture works similar to other textures, with the exception of a few parameters.
  36332. * @see https://doc.babylonjs.com/how_to/video_texture
  36333. * @param name optional name, will detect from video source, if not defined
  36334. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36335. * @param scene is obviously the current scene.
  36336. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36337. * @param invertY is false by default but can be used to invert video on Y axis
  36338. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36339. * @param settings allows finer control over video usage
  36340. */
  36341. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36342. private _getName;
  36343. private _getVideo;
  36344. private _createInternalTexture;
  36345. private reset;
  36346. /**
  36347. * @hidden Internal method to initiate `update`.
  36348. */
  36349. _rebuild(): void;
  36350. /**
  36351. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36352. */
  36353. update(): void;
  36354. /**
  36355. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36356. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36357. */
  36358. updateTexture(isVisible: boolean): void;
  36359. protected _updateInternalTexture: () => void;
  36360. /**
  36361. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36362. * @param url New url.
  36363. */
  36364. updateURL(url: string): void;
  36365. /**
  36366. * Clones the texture.
  36367. * @returns the cloned texture
  36368. */
  36369. clone(): VideoTexture;
  36370. /**
  36371. * Dispose the texture and release its associated resources.
  36372. */
  36373. dispose(): void;
  36374. /**
  36375. * Creates a video texture straight from a stream.
  36376. * @param scene Define the scene the texture should be created in
  36377. * @param stream Define the stream the texture should be created from
  36378. * @returns The created video texture as a promise
  36379. */
  36380. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36381. /**
  36382. * Creates a video texture straight from your WebCam video feed.
  36383. * @param scene Define the scene the texture should be created in
  36384. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36385. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36386. * @returns The created video texture as a promise
  36387. */
  36388. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36389. minWidth: number;
  36390. maxWidth: number;
  36391. minHeight: number;
  36392. maxHeight: number;
  36393. deviceId: string;
  36394. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36395. /**
  36396. * Creates a video texture straight from your WebCam video feed.
  36397. * @param scene Define the scene the texture should be created in
  36398. * @param onReady Define a callback to triggered once the texture will be ready
  36399. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36400. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36401. */
  36402. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36403. minWidth: number;
  36404. maxWidth: number;
  36405. minHeight: number;
  36406. maxHeight: number;
  36407. deviceId: string;
  36408. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36409. }
  36410. }
  36411. declare module "babylonjs/Engines/thinEngine" {
  36412. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36413. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36414. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36415. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36416. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36417. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36418. import { Observable } from "babylonjs/Misc/observable";
  36419. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36420. import { StencilState } from "babylonjs/States/stencilState";
  36421. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36422. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36423. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36424. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36425. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36426. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36427. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36428. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36429. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36430. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36431. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36432. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36433. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36434. import { WebRequest } from "babylonjs/Misc/webRequest";
  36435. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36436. /**
  36437. * Defines the interface used by objects working like Scene
  36438. * @hidden
  36439. */
  36440. export interface ISceneLike {
  36441. _addPendingData(data: any): void;
  36442. _removePendingData(data: any): void;
  36443. offlineProvider: IOfflineProvider;
  36444. }
  36445. /**
  36446. * Information about the current host
  36447. */
  36448. export interface HostInformation {
  36449. /**
  36450. * Defines if the current host is a mobile
  36451. */
  36452. isMobile: boolean;
  36453. }
  36454. /** Interface defining initialization parameters for Engine class */
  36455. export interface EngineOptions extends WebGLContextAttributes {
  36456. /**
  36457. * Defines if the engine should no exceed a specified device ratio
  36458. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36459. */
  36460. limitDeviceRatio?: number;
  36461. /**
  36462. * Defines if webvr should be enabled automatically
  36463. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36464. */
  36465. autoEnableWebVR?: boolean;
  36466. /**
  36467. * Defines if webgl2 should be turned off even if supported
  36468. * @see https://doc.babylonjs.com/features/webgl2
  36469. */
  36470. disableWebGL2Support?: boolean;
  36471. /**
  36472. * Defines if webaudio should be initialized as well
  36473. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36474. */
  36475. audioEngine?: boolean;
  36476. /**
  36477. * Defines if animations should run using a deterministic lock step
  36478. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36479. */
  36480. deterministicLockstep?: boolean;
  36481. /** Defines the maximum steps to use with deterministic lock step mode */
  36482. lockstepMaxSteps?: number;
  36483. /** Defines the seconds between each deterministic lock step */
  36484. timeStep?: number;
  36485. /**
  36486. * Defines that engine should ignore context lost events
  36487. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36488. */
  36489. doNotHandleContextLost?: boolean;
  36490. /**
  36491. * Defines that engine should ignore modifying touch action attribute and style
  36492. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36493. */
  36494. doNotHandleTouchAction?: boolean;
  36495. /**
  36496. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36497. */
  36498. useHighPrecisionFloats?: boolean;
  36499. /**
  36500. * Make the canvas XR Compatible for XR sessions
  36501. */
  36502. xrCompatible?: boolean;
  36503. /**
  36504. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36505. */
  36506. useHighPrecisionMatrix?: boolean;
  36507. }
  36508. /**
  36509. * The base engine class (root of all engines)
  36510. */
  36511. export class ThinEngine {
  36512. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36513. static ExceptionList: ({
  36514. key: string;
  36515. capture: string;
  36516. captureConstraint: number;
  36517. targets: string[];
  36518. } | {
  36519. key: string;
  36520. capture: null;
  36521. captureConstraint: null;
  36522. targets: string[];
  36523. })[];
  36524. /** @hidden */
  36525. static _TextureLoaders: IInternalTextureLoader[];
  36526. /**
  36527. * Returns the current npm package of the sdk
  36528. */
  36529. static get NpmPackage(): string;
  36530. /**
  36531. * Returns the current version of the framework
  36532. */
  36533. static get Version(): string;
  36534. /**
  36535. * Returns a string describing the current engine
  36536. */
  36537. get description(): string;
  36538. /**
  36539. * Gets or sets the epsilon value used by collision engine
  36540. */
  36541. static CollisionsEpsilon: number;
  36542. /**
  36543. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36544. */
  36545. static get ShadersRepository(): string;
  36546. static set ShadersRepository(value: string);
  36547. /** @hidden */
  36548. _shaderProcessor: IShaderProcessor;
  36549. /**
  36550. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36551. */
  36552. forcePOTTextures: boolean;
  36553. /**
  36554. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36555. */
  36556. isFullscreen: boolean;
  36557. /**
  36558. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36559. */
  36560. cullBackFaces: boolean;
  36561. /**
  36562. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36563. */
  36564. renderEvenInBackground: boolean;
  36565. /**
  36566. * Gets or sets a boolean indicating that cache can be kept between frames
  36567. */
  36568. preventCacheWipeBetweenFrames: boolean;
  36569. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36570. validateShaderPrograms: boolean;
  36571. /**
  36572. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36573. * This can provide greater z depth for distant objects.
  36574. */
  36575. useReverseDepthBuffer: boolean;
  36576. /**
  36577. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36578. */
  36579. disableUniformBuffers: boolean;
  36580. /** @hidden */
  36581. _uniformBuffers: UniformBuffer[];
  36582. /**
  36583. * Gets a boolean indicating that the engine supports uniform buffers
  36584. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36585. */
  36586. get supportsUniformBuffers(): boolean;
  36587. /** @hidden */
  36588. _gl: WebGLRenderingContext;
  36589. /** @hidden */
  36590. _webGLVersion: number;
  36591. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36592. protected _windowIsBackground: boolean;
  36593. protected _creationOptions: EngineOptions;
  36594. protected _highPrecisionShadersAllowed: boolean;
  36595. /** @hidden */
  36596. get _shouldUseHighPrecisionShader(): boolean;
  36597. /**
  36598. * Gets a boolean indicating that only power of 2 textures are supported
  36599. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36600. */
  36601. get needPOTTextures(): boolean;
  36602. /** @hidden */
  36603. _badOS: boolean;
  36604. /** @hidden */
  36605. _badDesktopOS: boolean;
  36606. private _hardwareScalingLevel;
  36607. /** @hidden */
  36608. _caps: EngineCapabilities;
  36609. private _isStencilEnable;
  36610. private _glVersion;
  36611. private _glRenderer;
  36612. private _glVendor;
  36613. /** @hidden */
  36614. _videoTextureSupported: boolean;
  36615. protected _renderingQueueLaunched: boolean;
  36616. protected _activeRenderLoops: (() => void)[];
  36617. /**
  36618. * Observable signaled when a context lost event is raised
  36619. */
  36620. onContextLostObservable: Observable<ThinEngine>;
  36621. /**
  36622. * Observable signaled when a context restored event is raised
  36623. */
  36624. onContextRestoredObservable: Observable<ThinEngine>;
  36625. private _onContextLost;
  36626. private _onContextRestored;
  36627. protected _contextWasLost: boolean;
  36628. /** @hidden */
  36629. _doNotHandleContextLost: boolean;
  36630. /**
  36631. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36632. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36633. */
  36634. get doNotHandleContextLost(): boolean;
  36635. set doNotHandleContextLost(value: boolean);
  36636. /**
  36637. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36638. */
  36639. disableVertexArrayObjects: boolean;
  36640. /** @hidden */
  36641. protected _colorWrite: boolean;
  36642. /** @hidden */
  36643. protected _colorWriteChanged: boolean;
  36644. /** @hidden */
  36645. protected _depthCullingState: DepthCullingState;
  36646. /** @hidden */
  36647. protected _stencilState: StencilState;
  36648. /** @hidden */
  36649. _alphaState: AlphaState;
  36650. /** @hidden */
  36651. _alphaMode: number;
  36652. /** @hidden */
  36653. _alphaEquation: number;
  36654. /** @hidden */
  36655. _internalTexturesCache: InternalTexture[];
  36656. /** @hidden */
  36657. protected _activeChannel: number;
  36658. private _currentTextureChannel;
  36659. /** @hidden */
  36660. protected _boundTexturesCache: {
  36661. [key: string]: Nullable<InternalTexture>;
  36662. };
  36663. /** @hidden */
  36664. protected _currentEffect: Nullable<Effect>;
  36665. /** @hidden */
  36666. protected _currentProgram: Nullable<WebGLProgram>;
  36667. private _compiledEffects;
  36668. private _vertexAttribArraysEnabled;
  36669. /** @hidden */
  36670. protected _cachedViewport: Nullable<IViewportLike>;
  36671. private _cachedVertexArrayObject;
  36672. /** @hidden */
  36673. protected _cachedVertexBuffers: any;
  36674. /** @hidden */
  36675. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36676. /** @hidden */
  36677. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36678. /** @hidden */
  36679. _currentRenderTarget: Nullable<InternalTexture>;
  36680. private _uintIndicesCurrentlySet;
  36681. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36682. /** @hidden */
  36683. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36684. /** @hidden */
  36685. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36686. private _currentBufferPointers;
  36687. private _currentInstanceLocations;
  36688. private _currentInstanceBuffers;
  36689. private _textureUnits;
  36690. /** @hidden */
  36691. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36692. /** @hidden */
  36693. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36694. /** @hidden */
  36695. _boundRenderFunction: any;
  36696. private _vaoRecordInProgress;
  36697. private _mustWipeVertexAttributes;
  36698. private _emptyTexture;
  36699. private _emptyCubeTexture;
  36700. private _emptyTexture3D;
  36701. private _emptyTexture2DArray;
  36702. /** @hidden */
  36703. _frameHandler: number;
  36704. private _nextFreeTextureSlots;
  36705. private _maxSimultaneousTextures;
  36706. private _activeRequests;
  36707. /** @hidden */
  36708. _transformTextureUrl: Nullable<(url: string) => string>;
  36709. /**
  36710. * Gets information about the current host
  36711. */
  36712. hostInformation: HostInformation;
  36713. protected get _supportsHardwareTextureRescaling(): boolean;
  36714. private _framebufferDimensionsObject;
  36715. /**
  36716. * sets the object from which width and height will be taken from when getting render width and height
  36717. * Will fallback to the gl object
  36718. * @param dimensions the framebuffer width and height that will be used.
  36719. */
  36720. set framebufferDimensionsObject(dimensions: Nullable<{
  36721. framebufferWidth: number;
  36722. framebufferHeight: number;
  36723. }>);
  36724. /**
  36725. * Gets the current viewport
  36726. */
  36727. get currentViewport(): Nullable<IViewportLike>;
  36728. /**
  36729. * Gets the default empty texture
  36730. */
  36731. get emptyTexture(): InternalTexture;
  36732. /**
  36733. * Gets the default empty 3D texture
  36734. */
  36735. get emptyTexture3D(): InternalTexture;
  36736. /**
  36737. * Gets the default empty 2D array texture
  36738. */
  36739. get emptyTexture2DArray(): InternalTexture;
  36740. /**
  36741. * Gets the default empty cube texture
  36742. */
  36743. get emptyCubeTexture(): InternalTexture;
  36744. /**
  36745. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36746. */
  36747. readonly premultipliedAlpha: boolean;
  36748. /**
  36749. * Observable event triggered before each texture is initialized
  36750. */
  36751. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36752. /**
  36753. * Creates a new engine
  36754. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  36755. * @param antialias defines enable antialiasing (default: false)
  36756. * @param options defines further options to be sent to the getContext() function
  36757. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36758. */
  36759. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36760. private _rebuildInternalTextures;
  36761. private _rebuildEffects;
  36762. /**
  36763. * Gets a boolean indicating if all created effects are ready
  36764. * @returns true if all effects are ready
  36765. */
  36766. areAllEffectsReady(): boolean;
  36767. protected _rebuildBuffers(): void;
  36768. protected _initGLContext(): void;
  36769. /**
  36770. * Gets version of the current webGL context
  36771. */
  36772. get webGLVersion(): number;
  36773. /**
  36774. * Gets a string identifying the name of the class
  36775. * @returns "Engine" string
  36776. */
  36777. getClassName(): string;
  36778. /**
  36779. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36780. */
  36781. get isStencilEnable(): boolean;
  36782. /** @hidden */
  36783. _prepareWorkingCanvas(): void;
  36784. /**
  36785. * Reset the texture cache to empty state
  36786. */
  36787. resetTextureCache(): void;
  36788. /**
  36789. * Gets an object containing information about the current webGL context
  36790. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36791. */
  36792. getGlInfo(): {
  36793. vendor: string;
  36794. renderer: string;
  36795. version: string;
  36796. };
  36797. /**
  36798. * Defines the hardware scaling level.
  36799. * By default the hardware scaling level is computed from the window device ratio.
  36800. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  36801. * @param level defines the level to use
  36802. */
  36803. setHardwareScalingLevel(level: number): void;
  36804. /**
  36805. * Gets the current hardware scaling level.
  36806. * By default the hardware scaling level is computed from the window device ratio.
  36807. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  36808. * @returns a number indicating the current hardware scaling level
  36809. */
  36810. getHardwareScalingLevel(): number;
  36811. /**
  36812. * Gets the list of loaded textures
  36813. * @returns an array containing all loaded textures
  36814. */
  36815. getLoadedTexturesCache(): InternalTexture[];
  36816. /**
  36817. * Gets the object containing all engine capabilities
  36818. * @returns the EngineCapabilities object
  36819. */
  36820. getCaps(): EngineCapabilities;
  36821. /**
  36822. * stop executing a render loop function and remove it from the execution array
  36823. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36824. */
  36825. stopRenderLoop(renderFunction?: () => void): void;
  36826. /** @hidden */
  36827. _renderLoop(): void;
  36828. /**
  36829. * Gets the HTML canvas attached with the current webGL context
  36830. * @returns a HTML canvas
  36831. */
  36832. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36833. /**
  36834. * Gets host window
  36835. * @returns the host window object
  36836. */
  36837. getHostWindow(): Nullable<Window>;
  36838. /**
  36839. * Gets the current render width
  36840. * @param useScreen defines if screen size must be used (or the current render target if any)
  36841. * @returns a number defining the current render width
  36842. */
  36843. getRenderWidth(useScreen?: boolean): number;
  36844. /**
  36845. * Gets the current render height
  36846. * @param useScreen defines if screen size must be used (or the current render target if any)
  36847. * @returns a number defining the current render height
  36848. */
  36849. getRenderHeight(useScreen?: boolean): number;
  36850. /**
  36851. * Can be used to override the current requestAnimationFrame requester.
  36852. * @hidden
  36853. */
  36854. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36855. /**
  36856. * Register and execute a render loop. The engine can have more than one render function
  36857. * @param renderFunction defines the function to continuously execute
  36858. */
  36859. runRenderLoop(renderFunction: () => void): void;
  36860. /**
  36861. * Clear the current render buffer or the current render target (if any is set up)
  36862. * @param color defines the color to use
  36863. * @param backBuffer defines if the back buffer must be cleared
  36864. * @param depth defines if the depth buffer must be cleared
  36865. * @param stencil defines if the stencil buffer must be cleared
  36866. */
  36867. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36868. private _viewportCached;
  36869. /** @hidden */
  36870. _viewport(x: number, y: number, width: number, height: number): void;
  36871. /**
  36872. * Set the WebGL's viewport
  36873. * @param viewport defines the viewport element to be used
  36874. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36875. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36876. */
  36877. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36878. /**
  36879. * Begin a new frame
  36880. */
  36881. beginFrame(): void;
  36882. /**
  36883. * Enf the current frame
  36884. */
  36885. endFrame(): void;
  36886. /**
  36887. * Resize the view according to the canvas' size
  36888. */
  36889. resize(): void;
  36890. /**
  36891. * Force a specific size of the canvas
  36892. * @param width defines the new canvas' width
  36893. * @param height defines the new canvas' height
  36894. * @returns true if the size was changed
  36895. */
  36896. setSize(width: number, height: number): boolean;
  36897. /**
  36898. * Binds the frame buffer to the specified texture.
  36899. * @param texture The texture to render to or null for the default canvas
  36900. * @param faceIndex The face of the texture to render to in case of cube texture
  36901. * @param requiredWidth The width of the target to render to
  36902. * @param requiredHeight The height of the target to render to
  36903. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36904. * @param lodLevel defines the lod level to bind to the frame buffer
  36905. * @param layer defines the 2d array index to bind to frame buffer to
  36906. */
  36907. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36908. /** @hidden */
  36909. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36910. /**
  36911. * Unbind the current render target texture from the webGL context
  36912. * @param texture defines the render target texture to unbind
  36913. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36914. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36915. */
  36916. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36917. /**
  36918. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36919. */
  36920. flushFramebuffer(): void;
  36921. /**
  36922. * Unbind the current render target and bind the default framebuffer
  36923. */
  36924. restoreDefaultFramebuffer(): void;
  36925. /** @hidden */
  36926. protected _resetVertexBufferBinding(): void;
  36927. /**
  36928. * Creates a vertex buffer
  36929. * @param data the data for the vertex buffer
  36930. * @returns the new WebGL static buffer
  36931. */
  36932. createVertexBuffer(data: DataArray): DataBuffer;
  36933. private _createVertexBuffer;
  36934. /**
  36935. * Creates a dynamic vertex buffer
  36936. * @param data the data for the dynamic vertex buffer
  36937. * @returns the new WebGL dynamic buffer
  36938. */
  36939. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36940. protected _resetIndexBufferBinding(): void;
  36941. /**
  36942. * Creates a new index buffer
  36943. * @param indices defines the content of the index buffer
  36944. * @param updatable defines if the index buffer must be updatable
  36945. * @returns a new webGL buffer
  36946. */
  36947. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36948. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36949. /**
  36950. * Bind a webGL buffer to the webGL context
  36951. * @param buffer defines the buffer to bind
  36952. */
  36953. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36954. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36955. private bindBuffer;
  36956. /**
  36957. * update the bound buffer with the given data
  36958. * @param data defines the data to update
  36959. */
  36960. updateArrayBuffer(data: Float32Array): void;
  36961. private _vertexAttribPointer;
  36962. /** @hidden */
  36963. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36964. private _bindVertexBuffersAttributes;
  36965. /**
  36966. * Records a vertex array object
  36967. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36968. * @param vertexBuffers defines the list of vertex buffers to store
  36969. * @param indexBuffer defines the index buffer to store
  36970. * @param effect defines the effect to store
  36971. * @returns the new vertex array object
  36972. */
  36973. recordVertexArrayObject(vertexBuffers: {
  36974. [key: string]: VertexBuffer;
  36975. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36976. /**
  36977. * Bind a specific vertex array object
  36978. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36979. * @param vertexArrayObject defines the vertex array object to bind
  36980. * @param indexBuffer defines the index buffer to bind
  36981. */
  36982. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36983. /**
  36984. * Bind webGl buffers directly to the webGL context
  36985. * @param vertexBuffer defines the vertex buffer to bind
  36986. * @param indexBuffer defines the index buffer to bind
  36987. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36988. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36989. * @param effect defines the effect associated with the vertex buffer
  36990. */
  36991. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36992. private _unbindVertexArrayObject;
  36993. /**
  36994. * Bind a list of vertex buffers to the webGL context
  36995. * @param vertexBuffers defines the list of vertex buffers to bind
  36996. * @param indexBuffer defines the index buffer to bind
  36997. * @param effect defines the effect associated with the vertex buffers
  36998. */
  36999. bindBuffers(vertexBuffers: {
  37000. [key: string]: Nullable<VertexBuffer>;
  37001. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  37002. /**
  37003. * Unbind all instance attributes
  37004. */
  37005. unbindInstanceAttributes(): void;
  37006. /**
  37007. * Release and free the memory of a vertex array object
  37008. * @param vao defines the vertex array object to delete
  37009. */
  37010. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  37011. /** @hidden */
  37012. _releaseBuffer(buffer: DataBuffer): boolean;
  37013. protected _deleteBuffer(buffer: DataBuffer): void;
  37014. /**
  37015. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37016. * @param instancesBuffer defines the webGL buffer to update and bind
  37017. * @param data defines the data to store in the buffer
  37018. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37019. */
  37020. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37021. /**
  37022. * Bind the content of a webGL buffer used with instantiation
  37023. * @param instancesBuffer defines the webGL buffer to bind
  37024. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37025. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37026. */
  37027. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37028. /**
  37029. * Disable the instance attribute corresponding to the name in parameter
  37030. * @param name defines the name of the attribute to disable
  37031. */
  37032. disableInstanceAttributeByName(name: string): void;
  37033. /**
  37034. * Disable the instance attribute corresponding to the location in parameter
  37035. * @param attributeLocation defines the attribute location of the attribute to disable
  37036. */
  37037. disableInstanceAttribute(attributeLocation: number): void;
  37038. /**
  37039. * Disable the attribute corresponding to the location in parameter
  37040. * @param attributeLocation defines the attribute location of the attribute to disable
  37041. */
  37042. disableAttributeByIndex(attributeLocation: number): void;
  37043. /**
  37044. * Send a draw order
  37045. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37046. * @param indexStart defines the starting index
  37047. * @param indexCount defines the number of index to draw
  37048. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37049. */
  37050. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37051. /**
  37052. * Draw a list of points
  37053. * @param verticesStart defines the index of first vertex to draw
  37054. * @param verticesCount defines the count of vertices to draw
  37055. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37056. */
  37057. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37058. /**
  37059. * Draw a list of unindexed primitives
  37060. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37061. * @param verticesStart defines the index of first vertex to draw
  37062. * @param verticesCount defines the count of vertices to draw
  37063. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37064. */
  37065. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37066. /**
  37067. * Draw a list of indexed primitives
  37068. * @param fillMode defines the primitive to use
  37069. * @param indexStart defines the starting index
  37070. * @param indexCount defines the number of index to draw
  37071. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37072. */
  37073. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37074. /**
  37075. * Draw a list of unindexed primitives
  37076. * @param fillMode defines the primitive to use
  37077. * @param verticesStart defines the index of first vertex to draw
  37078. * @param verticesCount defines the count of vertices to draw
  37079. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37080. */
  37081. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37082. private _drawMode;
  37083. /** @hidden */
  37084. protected _reportDrawCall(): void;
  37085. /** @hidden */
  37086. _releaseEffect(effect: Effect): void;
  37087. /** @hidden */
  37088. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37089. /**
  37090. * Create a new effect (used to store vertex/fragment shaders)
  37091. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37092. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37093. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37094. * @param samplers defines an array of string used to represent textures
  37095. * @param defines defines the string containing the defines to use to compile the shaders
  37096. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37097. * @param onCompiled defines a function to call when the effect creation is successful
  37098. * @param onError defines a function to call when the effect creation has failed
  37099. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37100. * @returns the new Effect
  37101. */
  37102. createEffect(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: string[], defines?: string, fallbacks?: IEffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  37103. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37104. private _compileShader;
  37105. private _compileRawShader;
  37106. /** @hidden */
  37107. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37108. /**
  37109. * Directly creates a webGL program
  37110. * @param pipelineContext defines the pipeline context to attach to
  37111. * @param vertexCode defines the vertex shader code to use
  37112. * @param fragmentCode defines the fragment shader code to use
  37113. * @param context defines the webGL context to use (if not set, the current one will be used)
  37114. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37115. * @returns the new webGL program
  37116. */
  37117. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37118. /**
  37119. * Creates a webGL program
  37120. * @param pipelineContext defines the pipeline context to attach to
  37121. * @param vertexCode defines the vertex shader code to use
  37122. * @param fragmentCode defines the fragment shader code to use
  37123. * @param defines defines the string containing the defines to use to compile the shaders
  37124. * @param context defines the webGL context to use (if not set, the current one will be used)
  37125. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37126. * @returns the new webGL program
  37127. */
  37128. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37129. /**
  37130. * Creates a new pipeline context
  37131. * @returns the new pipeline
  37132. */
  37133. createPipelineContext(): IPipelineContext;
  37134. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37135. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37136. /** @hidden */
  37137. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37138. /** @hidden */
  37139. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37140. /** @hidden */
  37141. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37142. /**
  37143. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37144. * @param pipelineContext defines the pipeline context to use
  37145. * @param uniformsNames defines the list of uniform names
  37146. * @returns an array of webGL uniform locations
  37147. */
  37148. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37149. /**
  37150. * Gets the lsit of active attributes for a given webGL program
  37151. * @param pipelineContext defines the pipeline context to use
  37152. * @param attributesNames defines the list of attribute names to get
  37153. * @returns an array of indices indicating the offset of each attribute
  37154. */
  37155. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37156. /**
  37157. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37158. * @param effect defines the effect to activate
  37159. */
  37160. enableEffect(effect: Nullable<Effect>): void;
  37161. /**
  37162. * Set the value of an uniform to a number (int)
  37163. * @param uniform defines the webGL uniform location where to store the value
  37164. * @param value defines the int number to store
  37165. */
  37166. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37167. /**
  37168. * Set the value of an uniform to an array of int32
  37169. * @param uniform defines the webGL uniform location where to store the value
  37170. * @param array defines the array of int32 to store
  37171. */
  37172. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37173. /**
  37174. * Set the value of an uniform to an array of int32 (stored as vec2)
  37175. * @param uniform defines the webGL uniform location where to store the value
  37176. * @param array defines the array of int32 to store
  37177. */
  37178. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37179. /**
  37180. * Set the value of an uniform to an array of int32 (stored as vec3)
  37181. * @param uniform defines the webGL uniform location where to store the value
  37182. * @param array defines the array of int32 to store
  37183. */
  37184. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37185. /**
  37186. * Set the value of an uniform to an array of int32 (stored as vec4)
  37187. * @param uniform defines the webGL uniform location where to store the value
  37188. * @param array defines the array of int32 to store
  37189. */
  37190. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37191. /**
  37192. * Set the value of an uniform to an array of number
  37193. * @param uniform defines the webGL uniform location where to store the value
  37194. * @param array defines the array of number to store
  37195. */
  37196. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37197. /**
  37198. * Set the value of an uniform to an array of number (stored as vec2)
  37199. * @param uniform defines the webGL uniform location where to store the value
  37200. * @param array defines the array of number to store
  37201. */
  37202. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37203. /**
  37204. * Set the value of an uniform to an array of number (stored as vec3)
  37205. * @param uniform defines the webGL uniform location where to store the value
  37206. * @param array defines the array of number to store
  37207. */
  37208. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37209. /**
  37210. * Set the value of an uniform to an array of number (stored as vec4)
  37211. * @param uniform defines the webGL uniform location where to store the value
  37212. * @param array defines the array of number to store
  37213. */
  37214. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37215. /**
  37216. * Set the value of an uniform to an array of float32 (stored as matrices)
  37217. * @param uniform defines the webGL uniform location where to store the value
  37218. * @param matrices defines the array of float32 to store
  37219. */
  37220. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  37221. /**
  37222. * Set the value of an uniform to a matrix (3x3)
  37223. * @param uniform defines the webGL uniform location where to store the value
  37224. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37225. */
  37226. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37227. /**
  37228. * Set the value of an uniform to a matrix (2x2)
  37229. * @param uniform defines the webGL uniform location where to store the value
  37230. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37231. */
  37232. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37233. /**
  37234. * Set the value of an uniform to a number (float)
  37235. * @param uniform defines the webGL uniform location where to store the value
  37236. * @param value defines the float number to store
  37237. */
  37238. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37239. /**
  37240. * Set the value of an uniform to a vec2
  37241. * @param uniform defines the webGL uniform location where to store the value
  37242. * @param x defines the 1st component of the value
  37243. * @param y defines the 2nd component of the value
  37244. */
  37245. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  37246. /**
  37247. * Set the value of an uniform to a vec3
  37248. * @param uniform defines the webGL uniform location where to store the value
  37249. * @param x defines the 1st component of the value
  37250. * @param y defines the 2nd component of the value
  37251. * @param z defines the 3rd component of the value
  37252. */
  37253. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  37254. /**
  37255. * Set the value of an uniform to a vec4
  37256. * @param uniform defines the webGL uniform location where to store the value
  37257. * @param x defines the 1st component of the value
  37258. * @param y defines the 2nd component of the value
  37259. * @param z defines the 3rd component of the value
  37260. * @param w defines the 4th component of the value
  37261. */
  37262. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  37263. /**
  37264. * Apply all cached states (depth, culling, stencil and alpha)
  37265. */
  37266. applyStates(): void;
  37267. /**
  37268. * Enable or disable color writing
  37269. * @param enable defines the state to set
  37270. */
  37271. setColorWrite(enable: boolean): void;
  37272. /**
  37273. * Gets a boolean indicating if color writing is enabled
  37274. * @returns the current color writing state
  37275. */
  37276. getColorWrite(): boolean;
  37277. /**
  37278. * Gets the depth culling state manager
  37279. */
  37280. get depthCullingState(): DepthCullingState;
  37281. /**
  37282. * Gets the alpha state manager
  37283. */
  37284. get alphaState(): AlphaState;
  37285. /**
  37286. * Gets the stencil state manager
  37287. */
  37288. get stencilState(): StencilState;
  37289. /**
  37290. * Clears the list of texture accessible through engine.
  37291. * This can help preventing texture load conflict due to name collision.
  37292. */
  37293. clearInternalTexturesCache(): void;
  37294. /**
  37295. * Force the entire cache to be cleared
  37296. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37297. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37298. */
  37299. wipeCaches(bruteForce?: boolean): void;
  37300. /** @hidden */
  37301. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37302. min: number;
  37303. mag: number;
  37304. };
  37305. /** @hidden */
  37306. _createTexture(): WebGLTexture;
  37307. /**
  37308. * Usually called from Texture.ts.
  37309. * Passed information to create a WebGLTexture
  37310. * @param url defines a value which contains one of the following:
  37311. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37312. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37313. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37314. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37315. * @param invertY when true, image is flipped when loaded. You probably want true. Certain compressed textures may invert this if their default is inverted (eg. ktx)
  37316. * @param scene needed for loading to the correct scene
  37317. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37318. * @param onLoad optional callback to be called upon successful completion
  37319. * @param onError optional callback to be called upon failure
  37320. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), HTMLImageElement (image format), or a Blob
  37321. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37322. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37323. * @param forcedExtension defines the extension to use to pick the right loader
  37324. * @param mimeType defines an optional mime type
  37325. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37326. */
  37327. createTexture(url: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string): InternalTexture;
  37328. /**
  37329. * Loads an image as an HTMLImageElement.
  37330. * @param input url string, ArrayBuffer, or Blob to load
  37331. * @param onLoad callback called when the image successfully loads
  37332. * @param onError callback called when the image fails to load
  37333. * @param offlineProvider offline provider for caching
  37334. * @param mimeType optional mime type
  37335. * @returns the HTMLImageElement of the loaded image
  37336. * @hidden
  37337. */
  37338. static _FileToolsLoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  37339. /**
  37340. * @hidden
  37341. */
  37342. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37343. private _unpackFlipYCached;
  37344. /**
  37345. * In case you are sharing the context with other applications, it might
  37346. * be interested to not cache the unpack flip y state to ensure a consistent
  37347. * value would be set.
  37348. */
  37349. enableUnpackFlipYCached: boolean;
  37350. /** @hidden */
  37351. _unpackFlipY(value: boolean): void;
  37352. /** @hidden */
  37353. _getUnpackAlignement(): number;
  37354. private _getTextureTarget;
  37355. /**
  37356. * Update the sampling mode of a given texture
  37357. * @param samplingMode defines the required sampling mode
  37358. * @param texture defines the texture to update
  37359. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37360. */
  37361. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37362. /**
  37363. * Update the sampling mode of a given texture
  37364. * @param texture defines the texture to update
  37365. * @param wrapU defines the texture wrap mode of the u coordinates
  37366. * @param wrapV defines the texture wrap mode of the v coordinates
  37367. * @param wrapR defines the texture wrap mode of the r coordinates
  37368. */
  37369. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37370. /** @hidden */
  37371. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37372. width: number;
  37373. height: number;
  37374. layers?: number;
  37375. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37376. /** @hidden */
  37377. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37378. /** @hidden */
  37379. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37380. /**
  37381. * Update a portion of an internal texture
  37382. * @param texture defines the texture to update
  37383. * @param imageData defines the data to store into the texture
  37384. * @param xOffset defines the x coordinates of the update rectangle
  37385. * @param yOffset defines the y coordinates of the update rectangle
  37386. * @param width defines the width of the update rectangle
  37387. * @param height defines the height of the update rectangle
  37388. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37389. * @param lod defines the lod level to update (0 by default)
  37390. */
  37391. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37392. /** @hidden */
  37393. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37394. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37395. private _prepareWebGLTexture;
  37396. /** @hidden */
  37397. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37398. private _getDepthStencilBuffer;
  37399. /** @hidden */
  37400. _releaseFramebufferObjects(texture: InternalTexture): void;
  37401. /** @hidden */
  37402. _releaseTexture(texture: InternalTexture): void;
  37403. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37404. protected _setProgram(program: WebGLProgram): void;
  37405. protected _boundUniforms: {
  37406. [key: number]: WebGLUniformLocation;
  37407. };
  37408. /**
  37409. * Binds an effect to the webGL context
  37410. * @param effect defines the effect to bind
  37411. */
  37412. bindSamplers(effect: Effect): void;
  37413. private _activateCurrentTexture;
  37414. /** @hidden */
  37415. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37416. /** @hidden */
  37417. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37418. /**
  37419. * Unbind all textures from the webGL context
  37420. */
  37421. unbindAllTextures(): void;
  37422. /**
  37423. * Sets a texture to the according uniform.
  37424. * @param channel The texture channel
  37425. * @param uniform The uniform to set
  37426. * @param texture The texture to apply
  37427. */
  37428. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37429. private _bindSamplerUniformToChannel;
  37430. private _getTextureWrapMode;
  37431. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37432. /**
  37433. * Sets an array of texture to the webGL context
  37434. * @param channel defines the channel where the texture array must be set
  37435. * @param uniform defines the associated uniform location
  37436. * @param textures defines the array of textures to bind
  37437. */
  37438. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37439. /** @hidden */
  37440. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37441. private _setTextureParameterFloat;
  37442. private _setTextureParameterInteger;
  37443. /**
  37444. * Unbind all vertex attributes from the webGL context
  37445. */
  37446. unbindAllAttributes(): void;
  37447. /**
  37448. * Force the engine to release all cached effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled
  37449. */
  37450. releaseEffects(): void;
  37451. /**
  37452. * Dispose and release all associated resources
  37453. */
  37454. dispose(): void;
  37455. /**
  37456. * Attach a new callback raised when context lost event is fired
  37457. * @param callback defines the callback to call
  37458. */
  37459. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37460. /**
  37461. * Attach a new callback raised when context restored event is fired
  37462. * @param callback defines the callback to call
  37463. */
  37464. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37465. /**
  37466. * Get the current error code of the webGL context
  37467. * @returns the error code
  37468. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37469. */
  37470. getError(): number;
  37471. private _canRenderToFloatFramebuffer;
  37472. private _canRenderToHalfFloatFramebuffer;
  37473. private _canRenderToFramebuffer;
  37474. /** @hidden */
  37475. _getWebGLTextureType(type: number): number;
  37476. /** @hidden */
  37477. _getInternalFormat(format: number): number;
  37478. /** @hidden */
  37479. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37480. /** @hidden */
  37481. _getRGBAMultiSampleBufferFormat(type: number): number;
  37482. /** @hidden */
  37483. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest;
  37484. /**
  37485. * Loads a file from a url
  37486. * @param url url to load
  37487. * @param onSuccess callback called when the file successfully loads
  37488. * @param onProgress callback called while file is loading (if the server supports this mode)
  37489. * @param offlineProvider defines the offline provider for caching
  37490. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37491. * @param onError callback called when the file fails to load
  37492. * @returns a file request object
  37493. * @hidden
  37494. */
  37495. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  37496. /**
  37497. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37498. * @param x defines the x coordinate of the rectangle where pixels must be read
  37499. * @param y defines the y coordinate of the rectangle where pixels must be read
  37500. * @param width defines the width of the rectangle where pixels must be read
  37501. * @param height defines the height of the rectangle where pixels must be read
  37502. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37503. * @returns a Uint8Array containing RGBA colors
  37504. */
  37505. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37506. private static _isSupported;
  37507. /**
  37508. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37509. * @returns true if the engine can be created
  37510. * @ignorenaming
  37511. */
  37512. static isSupported(): boolean;
  37513. /**
  37514. * Find the next highest power of two.
  37515. * @param x Number to start search from.
  37516. * @return Next highest power of two.
  37517. */
  37518. static CeilingPOT(x: number): number;
  37519. /**
  37520. * Find the next lowest power of two.
  37521. * @param x Number to start search from.
  37522. * @return Next lowest power of two.
  37523. */
  37524. static FloorPOT(x: number): number;
  37525. /**
  37526. * Find the nearest power of two.
  37527. * @param x Number to start search from.
  37528. * @return Next nearest power of two.
  37529. */
  37530. static NearestPOT(x: number): number;
  37531. /**
  37532. * Get the closest exponent of two
  37533. * @param value defines the value to approximate
  37534. * @param max defines the maximum value to return
  37535. * @param mode defines how to define the closest value
  37536. * @returns closest exponent of two of the given value
  37537. */
  37538. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37539. /**
  37540. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37541. * @param func - the function to be called
  37542. * @param requester - the object that will request the next frame. Falls back to window.
  37543. * @returns frame number
  37544. */
  37545. static QueueNewFrame(func: () => void, requester?: any): number;
  37546. /**
  37547. * Gets host document
  37548. * @returns the host document object
  37549. */
  37550. getHostDocument(): Nullable<Document>;
  37551. }
  37552. }
  37553. declare module "babylonjs/Maths/sphericalPolynomial" {
  37554. import { Vector3 } from "babylonjs/Maths/math.vector";
  37555. import { Color3 } from "babylonjs/Maths/math.color";
  37556. /**
  37557. * Class representing spherical harmonics coefficients to the 3rd degree
  37558. */
  37559. export class SphericalHarmonics {
  37560. /**
  37561. * Defines whether or not the harmonics have been prescaled for rendering.
  37562. */
  37563. preScaled: boolean;
  37564. /**
  37565. * The l0,0 coefficients of the spherical harmonics
  37566. */
  37567. l00: Vector3;
  37568. /**
  37569. * The l1,-1 coefficients of the spherical harmonics
  37570. */
  37571. l1_1: Vector3;
  37572. /**
  37573. * The l1,0 coefficients of the spherical harmonics
  37574. */
  37575. l10: Vector3;
  37576. /**
  37577. * The l1,1 coefficients of the spherical harmonics
  37578. */
  37579. l11: Vector3;
  37580. /**
  37581. * The l2,-2 coefficients of the spherical harmonics
  37582. */
  37583. l2_2: Vector3;
  37584. /**
  37585. * The l2,-1 coefficients of the spherical harmonics
  37586. */
  37587. l2_1: Vector3;
  37588. /**
  37589. * The l2,0 coefficients of the spherical harmonics
  37590. */
  37591. l20: Vector3;
  37592. /**
  37593. * The l2,1 coefficients of the spherical harmonics
  37594. */
  37595. l21: Vector3;
  37596. /**
  37597. * The l2,2 coefficients of the spherical harmonics
  37598. */
  37599. l22: Vector3;
  37600. /**
  37601. * Adds a light to the spherical harmonics
  37602. * @param direction the direction of the light
  37603. * @param color the color of the light
  37604. * @param deltaSolidAngle the delta solid angle of the light
  37605. */
  37606. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37607. /**
  37608. * Scales the spherical harmonics by the given amount
  37609. * @param scale the amount to scale
  37610. */
  37611. scaleInPlace(scale: number): void;
  37612. /**
  37613. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37614. *
  37615. * ```
  37616. * E_lm = A_l * L_lm
  37617. * ```
  37618. *
  37619. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37620. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37621. * the scaling factors are given in equation 9.
  37622. */
  37623. convertIncidentRadianceToIrradiance(): void;
  37624. /**
  37625. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37626. *
  37627. * ```
  37628. * L = (1/pi) * E * rho
  37629. * ```
  37630. *
  37631. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37632. */
  37633. convertIrradianceToLambertianRadiance(): void;
  37634. /**
  37635. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37636. * required operations at run time.
  37637. *
  37638. * This is simply done by scaling back the SH with Ylm constants parameter.
  37639. * The trigonometric part being applied by the shader at run time.
  37640. */
  37641. preScaleForRendering(): void;
  37642. /**
  37643. * Constructs a spherical harmonics from an array.
  37644. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37645. * @returns the spherical harmonics
  37646. */
  37647. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37648. /**
  37649. * Gets the spherical harmonics from polynomial
  37650. * @param polynomial the spherical polynomial
  37651. * @returns the spherical harmonics
  37652. */
  37653. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37654. }
  37655. /**
  37656. * Class representing spherical polynomial coefficients to the 3rd degree
  37657. */
  37658. export class SphericalPolynomial {
  37659. private _harmonics;
  37660. /**
  37661. * The spherical harmonics used to create the polynomials.
  37662. */
  37663. get preScaledHarmonics(): SphericalHarmonics;
  37664. /**
  37665. * The x coefficients of the spherical polynomial
  37666. */
  37667. x: Vector3;
  37668. /**
  37669. * The y coefficients of the spherical polynomial
  37670. */
  37671. y: Vector3;
  37672. /**
  37673. * The z coefficients of the spherical polynomial
  37674. */
  37675. z: Vector3;
  37676. /**
  37677. * The xx coefficients of the spherical polynomial
  37678. */
  37679. xx: Vector3;
  37680. /**
  37681. * The yy coefficients of the spherical polynomial
  37682. */
  37683. yy: Vector3;
  37684. /**
  37685. * The zz coefficients of the spherical polynomial
  37686. */
  37687. zz: Vector3;
  37688. /**
  37689. * The xy coefficients of the spherical polynomial
  37690. */
  37691. xy: Vector3;
  37692. /**
  37693. * The yz coefficients of the spherical polynomial
  37694. */
  37695. yz: Vector3;
  37696. /**
  37697. * The zx coefficients of the spherical polynomial
  37698. */
  37699. zx: Vector3;
  37700. /**
  37701. * Adds an ambient color to the spherical polynomial
  37702. * @param color the color to add
  37703. */
  37704. addAmbient(color: Color3): void;
  37705. /**
  37706. * Scales the spherical polynomial by the given amount
  37707. * @param scale the amount to scale
  37708. */
  37709. scaleInPlace(scale: number): void;
  37710. /**
  37711. * Gets the spherical polynomial from harmonics
  37712. * @param harmonics the spherical harmonics
  37713. * @returns the spherical polynomial
  37714. */
  37715. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37716. /**
  37717. * Constructs a spherical polynomial from an array.
  37718. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37719. * @returns the spherical polynomial
  37720. */
  37721. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37722. }
  37723. }
  37724. declare module "babylonjs/Materials/Textures/internalTexture" {
  37725. import { Observable } from "babylonjs/Misc/observable";
  37726. import { Nullable, int } from "babylonjs/types";
  37727. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37728. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37729. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37730. /**
  37731. * Defines the source of the internal texture
  37732. */
  37733. export enum InternalTextureSource {
  37734. /**
  37735. * The source of the texture data is unknown
  37736. */
  37737. Unknown = 0,
  37738. /**
  37739. * Texture data comes from an URL
  37740. */
  37741. Url = 1,
  37742. /**
  37743. * Texture data is only used for temporary storage
  37744. */
  37745. Temp = 2,
  37746. /**
  37747. * Texture data comes from raw data (ArrayBuffer)
  37748. */
  37749. Raw = 3,
  37750. /**
  37751. * Texture content is dynamic (video or dynamic texture)
  37752. */
  37753. Dynamic = 4,
  37754. /**
  37755. * Texture content is generated by rendering to it
  37756. */
  37757. RenderTarget = 5,
  37758. /**
  37759. * Texture content is part of a multi render target process
  37760. */
  37761. MultiRenderTarget = 6,
  37762. /**
  37763. * Texture data comes from a cube data file
  37764. */
  37765. Cube = 7,
  37766. /**
  37767. * Texture data comes from a raw cube data
  37768. */
  37769. CubeRaw = 8,
  37770. /**
  37771. * Texture data come from a prefiltered cube data file
  37772. */
  37773. CubePrefiltered = 9,
  37774. /**
  37775. * Texture content is raw 3D data
  37776. */
  37777. Raw3D = 10,
  37778. /**
  37779. * Texture content is raw 2D array data
  37780. */
  37781. Raw2DArray = 11,
  37782. /**
  37783. * Texture content is a depth texture
  37784. */
  37785. Depth = 12,
  37786. /**
  37787. * Texture data comes from a raw cube data encoded with RGBD
  37788. */
  37789. CubeRawRGBD = 13
  37790. }
  37791. /**
  37792. * Class used to store data associated with WebGL texture data for the engine
  37793. * This class should not be used directly
  37794. */
  37795. export class InternalTexture {
  37796. /** @hidden */
  37797. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37798. /**
  37799. * Defines if the texture is ready
  37800. */
  37801. isReady: boolean;
  37802. /**
  37803. * Defines if the texture is a cube texture
  37804. */
  37805. isCube: boolean;
  37806. /**
  37807. * Defines if the texture contains 3D data
  37808. */
  37809. is3D: boolean;
  37810. /**
  37811. * Defines if the texture contains 2D array data
  37812. */
  37813. is2DArray: boolean;
  37814. /**
  37815. * Defines if the texture contains multiview data
  37816. */
  37817. isMultiview: boolean;
  37818. /**
  37819. * Gets the URL used to load this texture
  37820. */
  37821. url: string;
  37822. /**
  37823. * Gets the sampling mode of the texture
  37824. */
  37825. samplingMode: number;
  37826. /**
  37827. * Gets a boolean indicating if the texture needs mipmaps generation
  37828. */
  37829. generateMipMaps: boolean;
  37830. /**
  37831. * Gets the number of samples used by the texture (WebGL2+ only)
  37832. */
  37833. samples: number;
  37834. /**
  37835. * Gets the type of the texture (int, float...)
  37836. */
  37837. type: number;
  37838. /**
  37839. * Gets the format of the texture (RGB, RGBA...)
  37840. */
  37841. format: number;
  37842. /**
  37843. * Observable called when the texture is loaded
  37844. */
  37845. onLoadedObservable: Observable<InternalTexture>;
  37846. /**
  37847. * Gets the width of the texture
  37848. */
  37849. width: number;
  37850. /**
  37851. * Gets the height of the texture
  37852. */
  37853. height: number;
  37854. /**
  37855. * Gets the depth of the texture
  37856. */
  37857. depth: number;
  37858. /**
  37859. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37860. */
  37861. baseWidth: number;
  37862. /**
  37863. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37864. */
  37865. baseHeight: number;
  37866. /**
  37867. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37868. */
  37869. baseDepth: number;
  37870. /**
  37871. * Gets a boolean indicating if the texture is inverted on Y axis
  37872. */
  37873. invertY: boolean;
  37874. /** @hidden */
  37875. _invertVScale: boolean;
  37876. /** @hidden */
  37877. _associatedChannel: number;
  37878. /** @hidden */
  37879. _source: InternalTextureSource;
  37880. /** @hidden */
  37881. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37882. /** @hidden */
  37883. _bufferView: Nullable<ArrayBufferView>;
  37884. /** @hidden */
  37885. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37886. /** @hidden */
  37887. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37888. /** @hidden */
  37889. _size: number;
  37890. /** @hidden */
  37891. _extension: string;
  37892. /** @hidden */
  37893. _files: Nullable<string[]>;
  37894. /** @hidden */
  37895. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37896. /** @hidden */
  37897. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37898. /** @hidden */
  37899. _framebuffer: Nullable<WebGLFramebuffer>;
  37900. /** @hidden */
  37901. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37902. /** @hidden */
  37903. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37904. /** @hidden */
  37905. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37906. /** @hidden */
  37907. _attachments: Nullable<number[]>;
  37908. /** @hidden */
  37909. _textureArray: Nullable<InternalTexture[]>;
  37910. /** @hidden */
  37911. _cachedCoordinatesMode: Nullable<number>;
  37912. /** @hidden */
  37913. _cachedWrapU: Nullable<number>;
  37914. /** @hidden */
  37915. _cachedWrapV: Nullable<number>;
  37916. /** @hidden */
  37917. _cachedWrapR: Nullable<number>;
  37918. /** @hidden */
  37919. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37920. /** @hidden */
  37921. _isDisabled: boolean;
  37922. /** @hidden */
  37923. _compression: Nullable<string>;
  37924. /** @hidden */
  37925. _generateStencilBuffer: boolean;
  37926. /** @hidden */
  37927. _generateDepthBuffer: boolean;
  37928. /** @hidden */
  37929. _comparisonFunction: number;
  37930. /** @hidden */
  37931. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37932. /** @hidden */
  37933. _lodGenerationScale: number;
  37934. /** @hidden */
  37935. _lodGenerationOffset: number;
  37936. /** @hidden */
  37937. _depthStencilTexture: Nullable<InternalTexture>;
  37938. /** @hidden */
  37939. _colorTextureArray: Nullable<WebGLTexture>;
  37940. /** @hidden */
  37941. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37942. /** @hidden */
  37943. _lodTextureHigh: Nullable<BaseTexture>;
  37944. /** @hidden */
  37945. _lodTextureMid: Nullable<BaseTexture>;
  37946. /** @hidden */
  37947. _lodTextureLow: Nullable<BaseTexture>;
  37948. /** @hidden */
  37949. _isRGBD: boolean;
  37950. /** @hidden */
  37951. _linearSpecularLOD: boolean;
  37952. /** @hidden */
  37953. _irradianceTexture: Nullable<BaseTexture>;
  37954. /** @hidden */
  37955. _webGLTexture: Nullable<WebGLTexture>;
  37956. /** @hidden */
  37957. _references: number;
  37958. private _engine;
  37959. /**
  37960. * Gets the Engine the texture belongs to.
  37961. * @returns The babylon engine
  37962. */
  37963. getEngine(): ThinEngine;
  37964. /**
  37965. * Gets the data source type of the texture
  37966. */
  37967. get source(): InternalTextureSource;
  37968. /**
  37969. * Creates a new InternalTexture
  37970. * @param engine defines the engine to use
  37971. * @param source defines the type of data that will be used
  37972. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37973. */
  37974. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37975. /**
  37976. * Increments the number of references (ie. the number of Texture that point to it)
  37977. */
  37978. incrementReferences(): void;
  37979. /**
  37980. * Change the size of the texture (not the size of the content)
  37981. * @param width defines the new width
  37982. * @param height defines the new height
  37983. * @param depth defines the new depth (1 by default)
  37984. */
  37985. updateSize(width: int, height: int, depth?: int): void;
  37986. /** @hidden */
  37987. _rebuild(): void;
  37988. /** @hidden */
  37989. _swapAndDie(target: InternalTexture): void;
  37990. /**
  37991. * Dispose the current allocated resources
  37992. */
  37993. dispose(): void;
  37994. }
  37995. }
  37996. declare module "babylonjs/Audio/analyser" {
  37997. import { Scene } from "babylonjs/scene";
  37998. /**
  37999. * Class used to work with sound analyzer using fast fourier transform (FFT)
  38000. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38001. */
  38002. export class Analyser {
  38003. /**
  38004. * Gets or sets the smoothing
  38005. * @ignorenaming
  38006. */
  38007. SMOOTHING: number;
  38008. /**
  38009. * Gets or sets the FFT table size
  38010. * @ignorenaming
  38011. */
  38012. FFT_SIZE: number;
  38013. /**
  38014. * Gets or sets the bar graph amplitude
  38015. * @ignorenaming
  38016. */
  38017. BARGRAPHAMPLITUDE: number;
  38018. /**
  38019. * Gets or sets the position of the debug canvas
  38020. * @ignorenaming
  38021. */
  38022. DEBUGCANVASPOS: {
  38023. x: number;
  38024. y: number;
  38025. };
  38026. /**
  38027. * Gets or sets the debug canvas size
  38028. * @ignorenaming
  38029. */
  38030. DEBUGCANVASSIZE: {
  38031. width: number;
  38032. height: number;
  38033. };
  38034. private _byteFreqs;
  38035. private _byteTime;
  38036. private _floatFreqs;
  38037. private _webAudioAnalyser;
  38038. private _debugCanvas;
  38039. private _debugCanvasContext;
  38040. private _scene;
  38041. private _registerFunc;
  38042. private _audioEngine;
  38043. /**
  38044. * Creates a new analyser
  38045. * @param scene defines hosting scene
  38046. */
  38047. constructor(scene: Scene);
  38048. /**
  38049. * Get the number of data values you will have to play with for the visualization
  38050. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38051. * @returns a number
  38052. */
  38053. getFrequencyBinCount(): number;
  38054. /**
  38055. * Gets the current frequency data as a byte array
  38056. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38057. * @returns a Uint8Array
  38058. */
  38059. getByteFrequencyData(): Uint8Array;
  38060. /**
  38061. * Gets the current waveform as a byte array
  38062. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38063. * @returns a Uint8Array
  38064. */
  38065. getByteTimeDomainData(): Uint8Array;
  38066. /**
  38067. * Gets the current frequency data as a float array
  38068. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38069. * @returns a Float32Array
  38070. */
  38071. getFloatFrequencyData(): Float32Array;
  38072. /**
  38073. * Renders the debug canvas
  38074. */
  38075. drawDebugCanvas(): void;
  38076. /**
  38077. * Stops rendering the debug canvas and removes it
  38078. */
  38079. stopDebugCanvas(): void;
  38080. /**
  38081. * Connects two audio nodes
  38082. * @param inputAudioNode defines first node to connect
  38083. * @param outputAudioNode defines second node to connect
  38084. */
  38085. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38086. /**
  38087. * Releases all associated resources
  38088. */
  38089. dispose(): void;
  38090. }
  38091. }
  38092. declare module "babylonjs/Audio/audioEngine" {
  38093. import { IDisposable } from "babylonjs/scene";
  38094. import { Analyser } from "babylonjs/Audio/analyser";
  38095. import { Nullable } from "babylonjs/types";
  38096. import { Observable } from "babylonjs/Misc/observable";
  38097. /**
  38098. * This represents an audio engine and it is responsible
  38099. * to play, synchronize and analyse sounds throughout the application.
  38100. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38101. */
  38102. export interface IAudioEngine extends IDisposable {
  38103. /**
  38104. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38105. */
  38106. readonly canUseWebAudio: boolean;
  38107. /**
  38108. * Gets the current AudioContext if available.
  38109. */
  38110. readonly audioContext: Nullable<AudioContext>;
  38111. /**
  38112. * The master gain node defines the global audio volume of your audio engine.
  38113. */
  38114. readonly masterGain: GainNode;
  38115. /**
  38116. * Gets whether or not mp3 are supported by your browser.
  38117. */
  38118. readonly isMP3supported: boolean;
  38119. /**
  38120. * Gets whether or not ogg are supported by your browser.
  38121. */
  38122. readonly isOGGsupported: boolean;
  38123. /**
  38124. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38125. * @ignoreNaming
  38126. */
  38127. WarnedWebAudioUnsupported: boolean;
  38128. /**
  38129. * Defines if the audio engine relies on a custom unlocked button.
  38130. * In this case, the embedded button will not be displayed.
  38131. */
  38132. useCustomUnlockedButton: boolean;
  38133. /**
  38134. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38135. */
  38136. readonly unlocked: boolean;
  38137. /**
  38138. * Event raised when audio has been unlocked on the browser.
  38139. */
  38140. onAudioUnlockedObservable: Observable<AudioEngine>;
  38141. /**
  38142. * Event raised when audio has been locked on the browser.
  38143. */
  38144. onAudioLockedObservable: Observable<AudioEngine>;
  38145. /**
  38146. * Flags the audio engine in Locked state.
  38147. * This happens due to new browser policies preventing audio to autoplay.
  38148. */
  38149. lock(): void;
  38150. /**
  38151. * Unlocks the audio engine once a user action has been done on the dom.
  38152. * This is helpful to resume play once browser policies have been satisfied.
  38153. */
  38154. unlock(): void;
  38155. /**
  38156. * Gets the global volume sets on the master gain.
  38157. * @returns the global volume if set or -1 otherwise
  38158. */
  38159. getGlobalVolume(): number;
  38160. /**
  38161. * Sets the global volume of your experience (sets on the master gain).
  38162. * @param newVolume Defines the new global volume of the application
  38163. */
  38164. setGlobalVolume(newVolume: number): void;
  38165. /**
  38166. * Connect the audio engine to an audio analyser allowing some amazing
  38167. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38168. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38169. * @param analyser The analyser to connect to the engine
  38170. */
  38171. connectToAnalyser(analyser: Analyser): void;
  38172. }
  38173. /**
  38174. * This represents the default audio engine used in babylon.
  38175. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38176. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38177. */
  38178. export class AudioEngine implements IAudioEngine {
  38179. private _audioContext;
  38180. private _audioContextInitialized;
  38181. private _muteButton;
  38182. private _hostElement;
  38183. /**
  38184. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38185. */
  38186. canUseWebAudio: boolean;
  38187. /**
  38188. * The master gain node defines the global audio volume of your audio engine.
  38189. */
  38190. masterGain: GainNode;
  38191. /**
  38192. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38193. * @ignoreNaming
  38194. */
  38195. WarnedWebAudioUnsupported: boolean;
  38196. /**
  38197. * Gets whether or not mp3 are supported by your browser.
  38198. */
  38199. isMP3supported: boolean;
  38200. /**
  38201. * Gets whether or not ogg are supported by your browser.
  38202. */
  38203. isOGGsupported: boolean;
  38204. /**
  38205. * Gets whether audio has been unlocked on the device.
  38206. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38207. * a user interaction has happened.
  38208. */
  38209. unlocked: boolean;
  38210. /**
  38211. * Defines if the audio engine relies on a custom unlocked button.
  38212. * In this case, the embedded button will not be displayed.
  38213. */
  38214. useCustomUnlockedButton: boolean;
  38215. /**
  38216. * Event raised when audio has been unlocked on the browser.
  38217. */
  38218. onAudioUnlockedObservable: Observable<AudioEngine>;
  38219. /**
  38220. * Event raised when audio has been locked on the browser.
  38221. */
  38222. onAudioLockedObservable: Observable<AudioEngine>;
  38223. /**
  38224. * Gets the current AudioContext if available.
  38225. */
  38226. get audioContext(): Nullable<AudioContext>;
  38227. private _connectedAnalyser;
  38228. /**
  38229. * Instantiates a new audio engine.
  38230. *
  38231. * There should be only one per page as some browsers restrict the number
  38232. * of audio contexts you can create.
  38233. * @param hostElement defines the host element where to display the mute icon if necessary
  38234. */
  38235. constructor(hostElement?: Nullable<HTMLElement>);
  38236. /**
  38237. * Flags the audio engine in Locked state.
  38238. * This happens due to new browser policies preventing audio to autoplay.
  38239. */
  38240. lock(): void;
  38241. /**
  38242. * Unlocks the audio engine once a user action has been done on the dom.
  38243. * This is helpful to resume play once browser policies have been satisfied.
  38244. */
  38245. unlock(): void;
  38246. private _resumeAudioContext;
  38247. private _initializeAudioContext;
  38248. private _tryToRun;
  38249. private _triggerRunningState;
  38250. private _triggerSuspendedState;
  38251. private _displayMuteButton;
  38252. private _moveButtonToTopLeft;
  38253. private _onResize;
  38254. private _hideMuteButton;
  38255. /**
  38256. * Destroy and release the resources associated with the audio ccontext.
  38257. */
  38258. dispose(): void;
  38259. /**
  38260. * Gets the global volume sets on the master gain.
  38261. * @returns the global volume if set or -1 otherwise
  38262. */
  38263. getGlobalVolume(): number;
  38264. /**
  38265. * Sets the global volume of your experience (sets on the master gain).
  38266. * @param newVolume Defines the new global volume of the application
  38267. */
  38268. setGlobalVolume(newVolume: number): void;
  38269. /**
  38270. * Connect the audio engine to an audio analyser allowing some amazing
  38271. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38272. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38273. * @param analyser The analyser to connect to the engine
  38274. */
  38275. connectToAnalyser(analyser: Analyser): void;
  38276. }
  38277. }
  38278. declare module "babylonjs/Loading/loadingScreen" {
  38279. /**
  38280. * Interface used to present a loading screen while loading a scene
  38281. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38282. */
  38283. export interface ILoadingScreen {
  38284. /**
  38285. * Function called to display the loading screen
  38286. */
  38287. displayLoadingUI: () => void;
  38288. /**
  38289. * Function called to hide the loading screen
  38290. */
  38291. hideLoadingUI: () => void;
  38292. /**
  38293. * Gets or sets the color to use for the background
  38294. */
  38295. loadingUIBackgroundColor: string;
  38296. /**
  38297. * Gets or sets the text to display while loading
  38298. */
  38299. loadingUIText: string;
  38300. }
  38301. /**
  38302. * Class used for the default loading screen
  38303. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38304. */
  38305. export class DefaultLoadingScreen implements ILoadingScreen {
  38306. private _renderingCanvas;
  38307. private _loadingText;
  38308. private _loadingDivBackgroundColor;
  38309. private _loadingDiv;
  38310. private _loadingTextDiv;
  38311. /** Gets or sets the logo url to use for the default loading screen */
  38312. static DefaultLogoUrl: string;
  38313. /** Gets or sets the spinner url to use for the default loading screen */
  38314. static DefaultSpinnerUrl: string;
  38315. /**
  38316. * Creates a new default loading screen
  38317. * @param _renderingCanvas defines the canvas used to render the scene
  38318. * @param _loadingText defines the default text to display
  38319. * @param _loadingDivBackgroundColor defines the default background color
  38320. */
  38321. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38322. /**
  38323. * Function called to display the loading screen
  38324. */
  38325. displayLoadingUI(): void;
  38326. /**
  38327. * Function called to hide the loading screen
  38328. */
  38329. hideLoadingUI(): void;
  38330. /**
  38331. * Gets or sets the text to display while loading
  38332. */
  38333. set loadingUIText(text: string);
  38334. get loadingUIText(): string;
  38335. /**
  38336. * Gets or sets the color to use for the background
  38337. */
  38338. get loadingUIBackgroundColor(): string;
  38339. set loadingUIBackgroundColor(color: string);
  38340. private _resizeLoadingUI;
  38341. }
  38342. }
  38343. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38344. /**
  38345. * Interface for any object that can request an animation frame
  38346. */
  38347. export interface ICustomAnimationFrameRequester {
  38348. /**
  38349. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38350. */
  38351. renderFunction?: Function;
  38352. /**
  38353. * Called to request the next frame to render to
  38354. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38355. */
  38356. requestAnimationFrame: Function;
  38357. /**
  38358. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38359. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38360. */
  38361. requestID?: number;
  38362. }
  38363. }
  38364. declare module "babylonjs/Misc/performanceMonitor" {
  38365. /**
  38366. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38367. */
  38368. export class PerformanceMonitor {
  38369. private _enabled;
  38370. private _rollingFrameTime;
  38371. private _lastFrameTimeMs;
  38372. /**
  38373. * constructor
  38374. * @param frameSampleSize The number of samples required to saturate the sliding window
  38375. */
  38376. constructor(frameSampleSize?: number);
  38377. /**
  38378. * Samples current frame
  38379. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38380. */
  38381. sampleFrame(timeMs?: number): void;
  38382. /**
  38383. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38384. */
  38385. get averageFrameTime(): number;
  38386. /**
  38387. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38388. */
  38389. get averageFrameTimeVariance(): number;
  38390. /**
  38391. * Returns the frame time of the most recent frame
  38392. */
  38393. get instantaneousFrameTime(): number;
  38394. /**
  38395. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38396. */
  38397. get averageFPS(): number;
  38398. /**
  38399. * Returns the average framerate in frames per second using the most recent frame time
  38400. */
  38401. get instantaneousFPS(): number;
  38402. /**
  38403. * Returns true if enough samples have been taken to completely fill the sliding window
  38404. */
  38405. get isSaturated(): boolean;
  38406. /**
  38407. * Enables contributions to the sliding window sample set
  38408. */
  38409. enable(): void;
  38410. /**
  38411. * Disables contributions to the sliding window sample set
  38412. * Samples will not be interpolated over the disabled period
  38413. */
  38414. disable(): void;
  38415. /**
  38416. * Returns true if sampling is enabled
  38417. */
  38418. get isEnabled(): boolean;
  38419. /**
  38420. * Resets performance monitor
  38421. */
  38422. reset(): void;
  38423. }
  38424. /**
  38425. * RollingAverage
  38426. *
  38427. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38428. */
  38429. export class RollingAverage {
  38430. /**
  38431. * Current average
  38432. */
  38433. average: number;
  38434. /**
  38435. * Current variance
  38436. */
  38437. variance: number;
  38438. protected _samples: Array<number>;
  38439. protected _sampleCount: number;
  38440. protected _pos: number;
  38441. protected _m2: number;
  38442. /**
  38443. * constructor
  38444. * @param length The number of samples required to saturate the sliding window
  38445. */
  38446. constructor(length: number);
  38447. /**
  38448. * Adds a sample to the sample set
  38449. * @param v The sample value
  38450. */
  38451. add(v: number): void;
  38452. /**
  38453. * Returns previously added values or null if outside of history or outside the sliding window domain
  38454. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38455. * @return Value previously recorded with add() or null if outside of range
  38456. */
  38457. history(i: number): number;
  38458. /**
  38459. * Returns true if enough samples have been taken to completely fill the sliding window
  38460. * @return true if sample-set saturated
  38461. */
  38462. isSaturated(): boolean;
  38463. /**
  38464. * Resets the rolling average (equivalent to 0 samples taken so far)
  38465. */
  38466. reset(): void;
  38467. /**
  38468. * Wraps a value around the sample range boundaries
  38469. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38470. * @return Wrapped position in sample range
  38471. */
  38472. protected _wrapPosition(i: number): number;
  38473. }
  38474. }
  38475. declare module "babylonjs/Misc/perfCounter" {
  38476. /**
  38477. * This class is used to track a performance counter which is number based.
  38478. * The user has access to many properties which give statistics of different nature.
  38479. *
  38480. * The implementer can track two kinds of Performance Counter: time and count.
  38481. * For time you can optionally call fetchNewFrame() to notify the start of a new frame to monitor, then call beginMonitoring() to start and endMonitoring() to record the lapsed time. endMonitoring takes a newFrame parameter for you to specify if the monitored time should be set for a new frame or accumulated to the current frame being monitored.
  38482. * For count you first have to call fetchNewFrame() to notify the start of a new frame to monitor, then call addCount() how many time required to increment the count value you monitor.
  38483. */
  38484. export class PerfCounter {
  38485. /**
  38486. * Gets or sets a global boolean to turn on and off all the counters
  38487. */
  38488. static Enabled: boolean;
  38489. /**
  38490. * Returns the smallest value ever
  38491. */
  38492. get min(): number;
  38493. /**
  38494. * Returns the biggest value ever
  38495. */
  38496. get max(): number;
  38497. /**
  38498. * Returns the average value since the performance counter is running
  38499. */
  38500. get average(): number;
  38501. /**
  38502. * Returns the average value of the last second the counter was monitored
  38503. */
  38504. get lastSecAverage(): number;
  38505. /**
  38506. * Returns the current value
  38507. */
  38508. get current(): number;
  38509. /**
  38510. * Gets the accumulated total
  38511. */
  38512. get total(): number;
  38513. /**
  38514. * Gets the total value count
  38515. */
  38516. get count(): number;
  38517. /**
  38518. * Creates a new counter
  38519. */
  38520. constructor();
  38521. /**
  38522. * Call this method to start monitoring a new frame.
  38523. * This scenario is typically used when you accumulate monitoring time many times for a single frame, you call this method at the start of the frame, then beginMonitoring to start recording and endMonitoring(false) to accumulated the recorded time to the PerfCounter or addCount() to accumulate a monitored count.
  38524. */
  38525. fetchNewFrame(): void;
  38526. /**
  38527. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38528. * @param newCount the count value to add to the monitored count
  38529. * @param fetchResult true when it's the last time in the frame you add to the counter and you wish to update the statistics properties (min/max/average), false if you only want to update statistics.
  38530. */
  38531. addCount(newCount: number, fetchResult: boolean): void;
  38532. /**
  38533. * Start monitoring this performance counter
  38534. */
  38535. beginMonitoring(): void;
  38536. /**
  38537. * Compute the time lapsed since the previous beginMonitoring() call.
  38538. * @param newFrame true by default to fetch the result and monitor a new frame, if false the time monitored will be added to the current frame counter
  38539. */
  38540. endMonitoring(newFrame?: boolean): void;
  38541. private _fetchResult;
  38542. private _startMonitoringTime;
  38543. private _min;
  38544. private _max;
  38545. private _average;
  38546. private _current;
  38547. private _totalValueCount;
  38548. private _totalAccumulated;
  38549. private _lastSecAverage;
  38550. private _lastSecAccumulated;
  38551. private _lastSecTime;
  38552. private _lastSecValueCount;
  38553. }
  38554. }
  38555. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38556. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38557. import { Nullable } from "babylonjs/types";
  38558. module "babylonjs/Engines/thinEngine" {
  38559. interface ThinEngine {
  38560. /** @hidden */
  38561. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38562. }
  38563. }
  38564. }
  38565. declare module "babylonjs/Engines/engine" {
  38566. import { Observable } from "babylonjs/Misc/observable";
  38567. import { Nullable } from "babylonjs/types";
  38568. import { Scene } from "babylonjs/scene";
  38569. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38570. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38571. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38572. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38573. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38574. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38575. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38576. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38577. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38578. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38579. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38580. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38581. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38582. import "babylonjs/Engines/Extensions/engine.alpha";
  38583. import "babylonjs/Engines/Extensions/engine.readTexture";
  38584. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38585. import { Material } from "babylonjs/Materials/material";
  38586. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38587. /**
  38588. * Defines the interface used by display changed events
  38589. */
  38590. export interface IDisplayChangedEventArgs {
  38591. /** Gets the vrDisplay object (if any) */
  38592. vrDisplay: Nullable<any>;
  38593. /** Gets a boolean indicating if webVR is supported */
  38594. vrSupported: boolean;
  38595. }
  38596. /**
  38597. * Defines the interface used by objects containing a viewport (like a camera)
  38598. */
  38599. interface IViewportOwnerLike {
  38600. /**
  38601. * Gets or sets the viewport
  38602. */
  38603. viewport: IViewportLike;
  38604. }
  38605. /**
  38606. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38607. */
  38608. export class Engine extends ThinEngine {
  38609. /** Defines that alpha blending is disabled */
  38610. static readonly ALPHA_DISABLE: number;
  38611. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38612. static readonly ALPHA_ADD: number;
  38613. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38614. static readonly ALPHA_COMBINE: number;
  38615. /** Defines that alpha blending to DEST - SRC * DEST */
  38616. static readonly ALPHA_SUBTRACT: number;
  38617. /** Defines that alpha blending to SRC * DEST */
  38618. static readonly ALPHA_MULTIPLY: number;
  38619. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38620. static readonly ALPHA_MAXIMIZED: number;
  38621. /** Defines that alpha blending to SRC + DEST */
  38622. static readonly ALPHA_ONEONE: number;
  38623. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38624. static readonly ALPHA_PREMULTIPLIED: number;
  38625. /**
  38626. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38627. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38628. */
  38629. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38630. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38631. static readonly ALPHA_INTERPOLATE: number;
  38632. /**
  38633. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38634. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38635. */
  38636. static readonly ALPHA_SCREENMODE: number;
  38637. /** Defines that the ressource is not delayed*/
  38638. static readonly DELAYLOADSTATE_NONE: number;
  38639. /** Defines that the ressource was successfully delay loaded */
  38640. static readonly DELAYLOADSTATE_LOADED: number;
  38641. /** Defines that the ressource is currently delay loading */
  38642. static readonly DELAYLOADSTATE_LOADING: number;
  38643. /** Defines that the ressource is delayed and has not started loading */
  38644. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38645. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38646. static readonly NEVER: number;
  38647. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  38648. static readonly ALWAYS: number;
  38649. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38650. static readonly LESS: number;
  38651. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38652. static readonly EQUAL: number;
  38653. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  38654. static readonly LEQUAL: number;
  38655. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38656. static readonly GREATER: number;
  38657. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  38658. static readonly GEQUAL: number;
  38659. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  38660. static readonly NOTEQUAL: number;
  38661. /** Passed to stencilOperation to specify that stencil value must be kept */
  38662. static readonly KEEP: number;
  38663. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38664. static readonly REPLACE: number;
  38665. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38666. static readonly INCR: number;
  38667. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38668. static readonly DECR: number;
  38669. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38670. static readonly INVERT: number;
  38671. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38672. static readonly INCR_WRAP: number;
  38673. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38674. static readonly DECR_WRAP: number;
  38675. /** Texture is not repeating outside of 0..1 UVs */
  38676. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38677. /** Texture is repeating outside of 0..1 UVs */
  38678. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38679. /** Texture is repeating and mirrored */
  38680. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38681. /** ALPHA */
  38682. static readonly TEXTUREFORMAT_ALPHA: number;
  38683. /** LUMINANCE */
  38684. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38685. /** LUMINANCE_ALPHA */
  38686. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38687. /** RGB */
  38688. static readonly TEXTUREFORMAT_RGB: number;
  38689. /** RGBA */
  38690. static readonly TEXTUREFORMAT_RGBA: number;
  38691. /** RED */
  38692. static readonly TEXTUREFORMAT_RED: number;
  38693. /** RED (2nd reference) */
  38694. static readonly TEXTUREFORMAT_R: number;
  38695. /** RG */
  38696. static readonly TEXTUREFORMAT_RG: number;
  38697. /** RED_INTEGER */
  38698. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38699. /** RED_INTEGER (2nd reference) */
  38700. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38701. /** RG_INTEGER */
  38702. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38703. /** RGB_INTEGER */
  38704. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38705. /** RGBA_INTEGER */
  38706. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38707. /** UNSIGNED_BYTE */
  38708. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38709. /** UNSIGNED_BYTE (2nd reference) */
  38710. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38711. /** FLOAT */
  38712. static readonly TEXTURETYPE_FLOAT: number;
  38713. /** HALF_FLOAT */
  38714. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38715. /** BYTE */
  38716. static readonly TEXTURETYPE_BYTE: number;
  38717. /** SHORT */
  38718. static readonly TEXTURETYPE_SHORT: number;
  38719. /** UNSIGNED_SHORT */
  38720. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38721. /** INT */
  38722. static readonly TEXTURETYPE_INT: number;
  38723. /** UNSIGNED_INT */
  38724. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38725. /** UNSIGNED_SHORT_4_4_4_4 */
  38726. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38727. /** UNSIGNED_SHORT_5_5_5_1 */
  38728. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38729. /** UNSIGNED_SHORT_5_6_5 */
  38730. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38731. /** UNSIGNED_INT_2_10_10_10_REV */
  38732. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38733. /** UNSIGNED_INT_24_8 */
  38734. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38735. /** UNSIGNED_INT_10F_11F_11F_REV */
  38736. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38737. /** UNSIGNED_INT_5_9_9_9_REV */
  38738. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38739. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38740. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38741. /** nearest is mag = nearest and min = nearest and mip = linear */
  38742. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38743. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38744. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38745. /** Trilinear is mag = linear and min = linear and mip = linear */
  38746. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38747. /** nearest is mag = nearest and min = nearest and mip = linear */
  38748. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38749. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38750. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38751. /** Trilinear is mag = linear and min = linear and mip = linear */
  38752. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38753. /** mag = nearest and min = nearest and mip = nearest */
  38754. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38755. /** mag = nearest and min = linear and mip = nearest */
  38756. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38757. /** mag = nearest and min = linear and mip = linear */
  38758. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38759. /** mag = nearest and min = linear and mip = none */
  38760. static readonly TEXTURE_NEAREST_LINEAR: number;
  38761. /** mag = nearest and min = nearest and mip = none */
  38762. static readonly TEXTURE_NEAREST_NEAREST: number;
  38763. /** mag = linear and min = nearest and mip = nearest */
  38764. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38765. /** mag = linear and min = nearest and mip = linear */
  38766. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38767. /** mag = linear and min = linear and mip = none */
  38768. static readonly TEXTURE_LINEAR_LINEAR: number;
  38769. /** mag = linear and min = nearest and mip = none */
  38770. static readonly TEXTURE_LINEAR_NEAREST: number;
  38771. /** Explicit coordinates mode */
  38772. static readonly TEXTURE_EXPLICIT_MODE: number;
  38773. /** Spherical coordinates mode */
  38774. static readonly TEXTURE_SPHERICAL_MODE: number;
  38775. /** Planar coordinates mode */
  38776. static readonly TEXTURE_PLANAR_MODE: number;
  38777. /** Cubic coordinates mode */
  38778. static readonly TEXTURE_CUBIC_MODE: number;
  38779. /** Projection coordinates mode */
  38780. static readonly TEXTURE_PROJECTION_MODE: number;
  38781. /** Skybox coordinates mode */
  38782. static readonly TEXTURE_SKYBOX_MODE: number;
  38783. /** Inverse Cubic coordinates mode */
  38784. static readonly TEXTURE_INVCUBIC_MODE: number;
  38785. /** Equirectangular coordinates mode */
  38786. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38787. /** Equirectangular Fixed coordinates mode */
  38788. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38789. /** Equirectangular Fixed Mirrored coordinates mode */
  38790. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38791. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38792. static readonly SCALEMODE_FLOOR: number;
  38793. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38794. static readonly SCALEMODE_NEAREST: number;
  38795. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38796. static readonly SCALEMODE_CEILING: number;
  38797. /**
  38798. * Returns the current npm package of the sdk
  38799. */
  38800. static get NpmPackage(): string;
  38801. /**
  38802. * Returns the current version of the framework
  38803. */
  38804. static get Version(): string;
  38805. /** Gets the list of created engines */
  38806. static get Instances(): Engine[];
  38807. /**
  38808. * Gets the latest created engine
  38809. */
  38810. static get LastCreatedEngine(): Nullable<Engine>;
  38811. /**
  38812. * Gets the latest created scene
  38813. */
  38814. static get LastCreatedScene(): Nullable<Scene>;
  38815. /**
  38816. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38817. * @param flag defines which part of the materials must be marked as dirty
  38818. * @param predicate defines a predicate used to filter which materials should be affected
  38819. */
  38820. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38821. /**
  38822. * Method called to create the default loading screen.
  38823. * This can be overriden in your own app.
  38824. * @param canvas The rendering canvas element
  38825. * @returns The loading screen
  38826. */
  38827. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38828. /**
  38829. * Method called to create the default rescale post process on each engine.
  38830. */
  38831. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38832. /**
  38833. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38834. **/
  38835. enableOfflineSupport: boolean;
  38836. /**
  38837. * Gets or sets a boolean to enable/disable checking manifest if IndexedDB support is enabled (js will always consider the database is up to date)
  38838. **/
  38839. disableManifestCheck: boolean;
  38840. /**
  38841. * Gets the list of created scenes
  38842. */
  38843. scenes: Scene[];
  38844. /**
  38845. * Event raised when a new scene is created
  38846. */
  38847. onNewSceneAddedObservable: Observable<Scene>;
  38848. /**
  38849. * Gets the list of created postprocesses
  38850. */
  38851. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38852. /**
  38853. * Gets a boolean indicating if the pointer is currently locked
  38854. */
  38855. isPointerLock: boolean;
  38856. /**
  38857. * Observable event triggered each time the rendering canvas is resized
  38858. */
  38859. onResizeObservable: Observable<Engine>;
  38860. /**
  38861. * Observable event triggered each time the canvas loses focus
  38862. */
  38863. onCanvasBlurObservable: Observable<Engine>;
  38864. /**
  38865. * Observable event triggered each time the canvas gains focus
  38866. */
  38867. onCanvasFocusObservable: Observable<Engine>;
  38868. /**
  38869. * Observable event triggered each time the canvas receives pointerout event
  38870. */
  38871. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38872. /**
  38873. * Observable raised when the engine begins a new frame
  38874. */
  38875. onBeginFrameObservable: Observable<Engine>;
  38876. /**
  38877. * If set, will be used to request the next animation frame for the render loop
  38878. */
  38879. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38880. /**
  38881. * Observable raised when the engine ends the current frame
  38882. */
  38883. onEndFrameObservable: Observable<Engine>;
  38884. /**
  38885. * Observable raised when the engine is about to compile a shader
  38886. */
  38887. onBeforeShaderCompilationObservable: Observable<Engine>;
  38888. /**
  38889. * Observable raised when the engine has jsut compiled a shader
  38890. */
  38891. onAfterShaderCompilationObservable: Observable<Engine>;
  38892. /**
  38893. * Gets the audio engine
  38894. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38895. * @ignorenaming
  38896. */
  38897. static audioEngine: IAudioEngine;
  38898. /**
  38899. * Default AudioEngine factory responsible of creating the Audio Engine.
  38900. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38901. */
  38902. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38903. /**
  38904. * Default offline support factory responsible of creating a tool used to store data locally.
  38905. * By default, this will create a Database object if the workload has been embedded.
  38906. */
  38907. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38908. private _loadingScreen;
  38909. private _pointerLockRequested;
  38910. private _rescalePostProcess;
  38911. private _deterministicLockstep;
  38912. private _lockstepMaxSteps;
  38913. private _timeStep;
  38914. protected get _supportsHardwareTextureRescaling(): boolean;
  38915. private _fps;
  38916. private _deltaTime;
  38917. /** @hidden */
  38918. _drawCalls: PerfCounter;
  38919. /** Gets or sets the tab index to set to the rendering canvas. 1 is the minimum value to set to be able to capture keyboard events */
  38920. canvasTabIndex: number;
  38921. /**
  38922. * Turn this value on if you want to pause FPS computation when in background
  38923. */
  38924. disablePerformanceMonitorInBackground: boolean;
  38925. private _performanceMonitor;
  38926. /**
  38927. * Gets the performance monitor attached to this engine
  38928. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38929. */
  38930. get performanceMonitor(): PerformanceMonitor;
  38931. private _onFocus;
  38932. private _onBlur;
  38933. private _onCanvasPointerOut;
  38934. private _onCanvasBlur;
  38935. private _onCanvasFocus;
  38936. private _onFullscreenChange;
  38937. private _onPointerLockChange;
  38938. /**
  38939. * Gets the HTML element used to attach event listeners
  38940. * @returns a HTML element
  38941. */
  38942. getInputElement(): Nullable<HTMLElement>;
  38943. /**
  38944. * Creates a new engine
  38945. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  38946. * @param antialias defines enable antialiasing (default: false)
  38947. * @param options defines further options to be sent to the getContext() function
  38948. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38949. */
  38950. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38951. /**
  38952. * Gets current aspect ratio
  38953. * @param viewportOwner defines the camera to use to get the aspect ratio
  38954. * @param useScreen defines if screen size must be used (or the current render target if any)
  38955. * @returns a number defining the aspect ratio
  38956. */
  38957. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38958. /**
  38959. * Gets current screen aspect ratio
  38960. * @returns a number defining the aspect ratio
  38961. */
  38962. getScreenAspectRatio(): number;
  38963. /**
  38964. * Gets the client rect of the HTML canvas attached with the current webGL context
  38965. * @returns a client rectanglee
  38966. */
  38967. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38968. /**
  38969. * Gets the client rect of the HTML element used for events
  38970. * @returns a client rectanglee
  38971. */
  38972. getInputElementClientRect(): Nullable<ClientRect>;
  38973. /**
  38974. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38975. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38976. * @returns true if engine is in deterministic lock step mode
  38977. */
  38978. isDeterministicLockStep(): boolean;
  38979. /**
  38980. * Gets the max steps when engine is running in deterministic lock step
  38981. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38982. * @returns the max steps
  38983. */
  38984. getLockstepMaxSteps(): number;
  38985. /**
  38986. * Returns the time in ms between steps when using deterministic lock step.
  38987. * @returns time step in (ms)
  38988. */
  38989. getTimeStep(): number;
  38990. /**
  38991. * Force the mipmap generation for the given render target texture
  38992. * @param texture defines the render target texture to use
  38993. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  38994. */
  38995. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  38996. /** States */
  38997. /**
  38998. * Set various states to the webGL context
  38999. * @param culling defines backface culling state
  39000. * @param zOffset defines the value to apply to zOffset (0 by default)
  39001. * @param force defines if states must be applied even if cache is up to date
  39002. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  39003. */
  39004. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  39005. /**
  39006. * Set the z offset to apply to current rendering
  39007. * @param value defines the offset to apply
  39008. */
  39009. setZOffset(value: number): void;
  39010. /**
  39011. * Gets the current value of the zOffset
  39012. * @returns the current zOffset state
  39013. */
  39014. getZOffset(): number;
  39015. /**
  39016. * Enable or disable depth buffering
  39017. * @param enable defines the state to set
  39018. */
  39019. setDepthBuffer(enable: boolean): void;
  39020. /**
  39021. * Gets a boolean indicating if depth writing is enabled
  39022. * @returns the current depth writing state
  39023. */
  39024. getDepthWrite(): boolean;
  39025. /**
  39026. * Enable or disable depth writing
  39027. * @param enable defines the state to set
  39028. */
  39029. setDepthWrite(enable: boolean): void;
  39030. /**
  39031. * Gets a boolean indicating if stencil buffer is enabled
  39032. * @returns the current stencil buffer state
  39033. */
  39034. getStencilBuffer(): boolean;
  39035. /**
  39036. * Enable or disable the stencil buffer
  39037. * @param enable defines if the stencil buffer must be enabled or disabled
  39038. */
  39039. setStencilBuffer(enable: boolean): void;
  39040. /**
  39041. * Gets the current stencil mask
  39042. * @returns a number defining the new stencil mask to use
  39043. */
  39044. getStencilMask(): number;
  39045. /**
  39046. * Sets the current stencil mask
  39047. * @param mask defines the new stencil mask to use
  39048. */
  39049. setStencilMask(mask: number): void;
  39050. /**
  39051. * Gets the current stencil function
  39052. * @returns a number defining the stencil function to use
  39053. */
  39054. getStencilFunction(): number;
  39055. /**
  39056. * Gets the current stencil reference value
  39057. * @returns a number defining the stencil reference value to use
  39058. */
  39059. getStencilFunctionReference(): number;
  39060. /**
  39061. * Gets the current stencil mask
  39062. * @returns a number defining the stencil mask to use
  39063. */
  39064. getStencilFunctionMask(): number;
  39065. /**
  39066. * Sets the current stencil function
  39067. * @param stencilFunc defines the new stencil function to use
  39068. */
  39069. setStencilFunction(stencilFunc: number): void;
  39070. /**
  39071. * Sets the current stencil reference
  39072. * @param reference defines the new stencil reference to use
  39073. */
  39074. setStencilFunctionReference(reference: number): void;
  39075. /**
  39076. * Sets the current stencil mask
  39077. * @param mask defines the new stencil mask to use
  39078. */
  39079. setStencilFunctionMask(mask: number): void;
  39080. /**
  39081. * Gets the current stencil operation when stencil fails
  39082. * @returns a number defining stencil operation to use when stencil fails
  39083. */
  39084. getStencilOperationFail(): number;
  39085. /**
  39086. * Gets the current stencil operation when depth fails
  39087. * @returns a number defining stencil operation to use when depth fails
  39088. */
  39089. getStencilOperationDepthFail(): number;
  39090. /**
  39091. * Gets the current stencil operation when stencil passes
  39092. * @returns a number defining stencil operation to use when stencil passes
  39093. */
  39094. getStencilOperationPass(): number;
  39095. /**
  39096. * Sets the stencil operation to use when stencil fails
  39097. * @param operation defines the stencil operation to use when stencil fails
  39098. */
  39099. setStencilOperationFail(operation: number): void;
  39100. /**
  39101. * Sets the stencil operation to use when depth fails
  39102. * @param operation defines the stencil operation to use when depth fails
  39103. */
  39104. setStencilOperationDepthFail(operation: number): void;
  39105. /**
  39106. * Sets the stencil operation to use when stencil passes
  39107. * @param operation defines the stencil operation to use when stencil passes
  39108. */
  39109. setStencilOperationPass(operation: number): void;
  39110. /**
  39111. * Sets a boolean indicating if the dithering state is enabled or disabled
  39112. * @param value defines the dithering state
  39113. */
  39114. setDitheringState(value: boolean): void;
  39115. /**
  39116. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39117. * @param value defines the rasterizer state
  39118. */
  39119. setRasterizerState(value: boolean): void;
  39120. /**
  39121. * Gets the current depth function
  39122. * @returns a number defining the depth function
  39123. */
  39124. getDepthFunction(): Nullable<number>;
  39125. /**
  39126. * Sets the current depth function
  39127. * @param depthFunc defines the function to use
  39128. */
  39129. setDepthFunction(depthFunc: number): void;
  39130. /**
  39131. * Sets the current depth function to GREATER
  39132. */
  39133. setDepthFunctionToGreater(): void;
  39134. /**
  39135. * Sets the current depth function to GEQUAL
  39136. */
  39137. setDepthFunctionToGreaterOrEqual(): void;
  39138. /**
  39139. * Sets the current depth function to LESS
  39140. */
  39141. setDepthFunctionToLess(): void;
  39142. /**
  39143. * Sets the current depth function to LEQUAL
  39144. */
  39145. setDepthFunctionToLessOrEqual(): void;
  39146. private _cachedStencilBuffer;
  39147. private _cachedStencilFunction;
  39148. private _cachedStencilMask;
  39149. private _cachedStencilOperationPass;
  39150. private _cachedStencilOperationFail;
  39151. private _cachedStencilOperationDepthFail;
  39152. private _cachedStencilReference;
  39153. /**
  39154. * Caches the the state of the stencil buffer
  39155. */
  39156. cacheStencilState(): void;
  39157. /**
  39158. * Restores the state of the stencil buffer
  39159. */
  39160. restoreStencilState(): void;
  39161. /**
  39162. * Directly set the WebGL Viewport
  39163. * @param x defines the x coordinate of the viewport (in screen space)
  39164. * @param y defines the y coordinate of the viewport (in screen space)
  39165. * @param width defines the width of the viewport (in screen space)
  39166. * @param height defines the height of the viewport (in screen space)
  39167. * @return the current viewport Object (if any) that is being replaced by this call. You can restore this viewport later on to go back to the original state
  39168. */
  39169. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39170. /**
  39171. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39172. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39173. * @param y defines the y-coordinate of the corner of the clear rectangle
  39174. * @param width defines the width of the clear rectangle
  39175. * @param height defines the height of the clear rectangle
  39176. * @param clearColor defines the clear color
  39177. */
  39178. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39179. /**
  39180. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39181. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39182. * @param y defines the y-coordinate of the corner of the clear rectangle
  39183. * @param width defines the width of the clear rectangle
  39184. * @param height defines the height of the clear rectangle
  39185. */
  39186. enableScissor(x: number, y: number, width: number, height: number): void;
  39187. /**
  39188. * Disable previously set scissor test rectangle
  39189. */
  39190. disableScissor(): void;
  39191. protected _reportDrawCall(): void;
  39192. /**
  39193. * Initializes a webVR display and starts listening to display change events
  39194. * The onVRDisplayChangedObservable will be notified upon these changes
  39195. * @returns The onVRDisplayChangedObservable
  39196. */
  39197. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39198. /** @hidden */
  39199. _prepareVRComponent(): void;
  39200. /** @hidden */
  39201. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39202. /** @hidden */
  39203. _submitVRFrame(): void;
  39204. /**
  39205. * Call this function to leave webVR mode
  39206. * Will do nothing if webVR is not supported or if there is no webVR device
  39207. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39208. */
  39209. disableVR(): void;
  39210. /**
  39211. * Gets a boolean indicating that the system is in VR mode and is presenting
  39212. * @returns true if VR mode is engaged
  39213. */
  39214. isVRPresenting(): boolean;
  39215. /** @hidden */
  39216. _requestVRFrame(): void;
  39217. /** @hidden */
  39218. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39219. /**
  39220. * Gets the source code of the vertex shader associated with a specific webGL program
  39221. * @param program defines the program to use
  39222. * @returns a string containing the source code of the vertex shader associated with the program
  39223. */
  39224. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39225. /**
  39226. * Gets the source code of the fragment shader associated with a specific webGL program
  39227. * @param program defines the program to use
  39228. * @returns a string containing the source code of the fragment shader associated with the program
  39229. */
  39230. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39231. /**
  39232. * Sets a depth stencil texture from a render target to the according uniform.
  39233. * @param channel The texture channel
  39234. * @param uniform The uniform to set
  39235. * @param texture The render target texture containing the depth stencil texture to apply
  39236. */
  39237. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39238. /**
  39239. * Sets a texture to the webGL context from a postprocess
  39240. * @param channel defines the channel to use
  39241. * @param postProcess defines the source postprocess
  39242. */
  39243. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39244. /**
  39245. * Binds the output of the passed in post process to the texture channel specified
  39246. * @param channel The channel the texture should be bound to
  39247. * @param postProcess The post process which's output should be bound
  39248. */
  39249. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39250. protected _rebuildBuffers(): void;
  39251. /** @hidden */
  39252. _renderFrame(): void;
  39253. _renderLoop(): void;
  39254. /** @hidden */
  39255. _renderViews(): boolean;
  39256. /**
  39257. * Toggle full screen mode
  39258. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39259. */
  39260. switchFullscreen(requestPointerLock: boolean): void;
  39261. /**
  39262. * Enters full screen mode
  39263. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39264. */
  39265. enterFullscreen(requestPointerLock: boolean): void;
  39266. /**
  39267. * Exits full screen mode
  39268. */
  39269. exitFullscreen(): void;
  39270. /**
  39271. * Enters Pointerlock mode
  39272. */
  39273. enterPointerlock(): void;
  39274. /**
  39275. * Exits Pointerlock mode
  39276. */
  39277. exitPointerlock(): void;
  39278. /**
  39279. * Begin a new frame
  39280. */
  39281. beginFrame(): void;
  39282. /**
  39283. * Enf the current frame
  39284. */
  39285. endFrame(): void;
  39286. resize(): void;
  39287. /**
  39288. * Force a specific size of the canvas
  39289. * @param width defines the new canvas' width
  39290. * @param height defines the new canvas' height
  39291. * @returns true if the size was changed
  39292. */
  39293. setSize(width: number, height: number): boolean;
  39294. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39295. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39296. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39297. _releaseTexture(texture: InternalTexture): void;
  39298. /**
  39299. * @hidden
  39300. * Rescales a texture
  39301. * @param source input texutre
  39302. * @param destination destination texture
  39303. * @param scene scene to use to render the resize
  39304. * @param internalFormat format to use when resizing
  39305. * @param onComplete callback to be called when resize has completed
  39306. */
  39307. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39308. /**
  39309. * Gets the current framerate
  39310. * @returns a number representing the framerate
  39311. */
  39312. getFps(): number;
  39313. /**
  39314. * Gets the time spent between current and previous frame
  39315. * @returns a number representing the delta time in ms
  39316. */
  39317. getDeltaTime(): number;
  39318. private _measureFps;
  39319. /** @hidden */
  39320. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39321. /**
  39322. * Updates the sample count of a render target texture
  39323. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39324. * @param texture defines the texture to update
  39325. * @param samples defines the sample count to set
  39326. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39327. */
  39328. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39329. /**
  39330. * Updates a depth texture Comparison Mode and Function.
  39331. * If the comparison Function is equal to 0, the mode will be set to none.
  39332. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39333. * @param texture The texture to set the comparison function for
  39334. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39335. */
  39336. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39337. /**
  39338. * Creates a webGL buffer to use with instanciation
  39339. * @param capacity defines the size of the buffer
  39340. * @returns the webGL buffer
  39341. */
  39342. createInstancesBuffer(capacity: number): DataBuffer;
  39343. /**
  39344. * Delete a webGL buffer used with instanciation
  39345. * @param buffer defines the webGL buffer to delete
  39346. */
  39347. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39348. private _clientWaitAsync;
  39349. /** @hidden */
  39350. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39351. dispose(): void;
  39352. private _disableTouchAction;
  39353. /**
  39354. * Display the loading screen
  39355. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39356. */
  39357. displayLoadingUI(): void;
  39358. /**
  39359. * Hide the loading screen
  39360. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39361. */
  39362. hideLoadingUI(): void;
  39363. /**
  39364. * Gets the current loading screen object
  39365. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39366. */
  39367. get loadingScreen(): ILoadingScreen;
  39368. /**
  39369. * Sets the current loading screen object
  39370. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39371. */
  39372. set loadingScreen(loadingScreen: ILoadingScreen);
  39373. /**
  39374. * Sets the current loading screen text
  39375. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39376. */
  39377. set loadingUIText(text: string);
  39378. /**
  39379. * Sets the current loading screen background color
  39380. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39381. */
  39382. set loadingUIBackgroundColor(color: string);
  39383. /** Pointerlock and fullscreen */
  39384. /**
  39385. * Ask the browser to promote the current element to pointerlock mode
  39386. * @param element defines the DOM element to promote
  39387. */
  39388. static _RequestPointerlock(element: HTMLElement): void;
  39389. /**
  39390. * Asks the browser to exit pointerlock mode
  39391. */
  39392. static _ExitPointerlock(): void;
  39393. /**
  39394. * Ask the browser to promote the current element to fullscreen rendering mode
  39395. * @param element defines the DOM element to promote
  39396. */
  39397. static _RequestFullscreen(element: HTMLElement): void;
  39398. /**
  39399. * Asks the browser to exit fullscreen mode
  39400. */
  39401. static _ExitFullscreen(): void;
  39402. }
  39403. }
  39404. declare module "babylonjs/Engines/engineStore" {
  39405. import { Nullable } from "babylonjs/types";
  39406. import { Engine } from "babylonjs/Engines/engine";
  39407. import { Scene } from "babylonjs/scene";
  39408. /**
  39409. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39410. * during the life time of the application.
  39411. */
  39412. export class EngineStore {
  39413. /** Gets the list of created engines */
  39414. static Instances: import("babylonjs/Engines/engine").Engine[];
  39415. /** @hidden */
  39416. static _LastCreatedScene: Nullable<Scene>;
  39417. /**
  39418. * Gets the latest created engine
  39419. */
  39420. static get LastCreatedEngine(): Nullable<Engine>;
  39421. /**
  39422. * Gets the latest created scene
  39423. */
  39424. static get LastCreatedScene(): Nullable<Scene>;
  39425. /**
  39426. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39427. * @ignorenaming
  39428. */
  39429. static UseFallbackTexture: boolean;
  39430. /**
  39431. * Texture content used if a texture cannot loaded
  39432. * @ignorenaming
  39433. */
  39434. static FallbackTexture: string;
  39435. }
  39436. }
  39437. declare module "babylonjs/Misc/promise" {
  39438. /**
  39439. * Helper class that provides a small promise polyfill
  39440. */
  39441. export class PromisePolyfill {
  39442. /**
  39443. * Static function used to check if the polyfill is required
  39444. * If this is the case then the function will inject the polyfill to window.Promise
  39445. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39446. */
  39447. static Apply(force?: boolean): void;
  39448. }
  39449. }
  39450. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39451. /**
  39452. * Interface for screenshot methods with describe argument called `size` as object with options
  39453. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39454. */
  39455. export interface IScreenshotSize {
  39456. /**
  39457. * number in pixels for canvas height
  39458. */
  39459. height?: number;
  39460. /**
  39461. * multiplier allowing render at a higher or lower resolution
  39462. * If value is defined then height and width will be ignored and taken from camera
  39463. */
  39464. precision?: number;
  39465. /**
  39466. * number in pixels for canvas width
  39467. */
  39468. width?: number;
  39469. }
  39470. }
  39471. declare module "babylonjs/Misc/tools" {
  39472. import { Nullable, float } from "babylonjs/types";
  39473. import { DomManagement } from "babylonjs/Misc/domManagement";
  39474. import { WebRequest } from "babylonjs/Misc/webRequest";
  39475. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39476. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39477. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39478. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39479. import { Camera } from "babylonjs/Cameras/camera";
  39480. import { Engine } from "babylonjs/Engines/engine";
  39481. interface IColor4Like {
  39482. r: float;
  39483. g: float;
  39484. b: float;
  39485. a: float;
  39486. }
  39487. /**
  39488. * Class containing a set of static utilities functions
  39489. */
  39490. export class Tools {
  39491. /**
  39492. * Gets or sets the base URL to use to load assets
  39493. */
  39494. static get BaseUrl(): string;
  39495. static set BaseUrl(value: string);
  39496. /**
  39497. * Enable/Disable Custom HTTP Request Headers globally.
  39498. * default = false
  39499. * @see CustomRequestHeaders
  39500. */
  39501. static UseCustomRequestHeaders: boolean;
  39502. /**
  39503. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39504. * i.e. when loading files, where the server/service expects an Authorization header
  39505. */
  39506. static CustomRequestHeaders: {
  39507. [key: string]: string;
  39508. };
  39509. /**
  39510. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39511. */
  39512. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39513. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39514. /**
  39515. * Default behaviour for cors in the application.
  39516. * It can be a string if the expected behavior is identical in the entire app.
  39517. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39518. */
  39519. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39520. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39521. /**
  39522. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39523. * @ignorenaming
  39524. */
  39525. static get UseFallbackTexture(): boolean;
  39526. static set UseFallbackTexture(value: boolean);
  39527. /**
  39528. * Use this object to register external classes like custom textures or material
  39529. * to allow the laoders to instantiate them
  39530. */
  39531. static get RegisteredExternalClasses(): {
  39532. [key: string]: Object;
  39533. };
  39534. static set RegisteredExternalClasses(classes: {
  39535. [key: string]: Object;
  39536. });
  39537. /**
  39538. * Texture content used if a texture cannot loaded
  39539. * @ignorenaming
  39540. */
  39541. static get fallbackTexture(): string;
  39542. static set fallbackTexture(value: string);
  39543. /**
  39544. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39545. * @param u defines the coordinate on X axis
  39546. * @param v defines the coordinate on Y axis
  39547. * @param width defines the width of the source data
  39548. * @param height defines the height of the source data
  39549. * @param pixels defines the source byte array
  39550. * @param color defines the output color
  39551. */
  39552. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39553. /**
  39554. * Interpolates between a and b via alpha
  39555. * @param a The lower value (returned when alpha = 0)
  39556. * @param b The upper value (returned when alpha = 1)
  39557. * @param alpha The interpolation-factor
  39558. * @return The mixed value
  39559. */
  39560. static Mix(a: number, b: number, alpha: number): number;
  39561. /**
  39562. * Tries to instantiate a new object from a given class name
  39563. * @param className defines the class name to instantiate
  39564. * @returns the new object or null if the system was not able to do the instantiation
  39565. */
  39566. static Instantiate(className: string): any;
  39567. /**
  39568. * Provides a slice function that will work even on IE
  39569. * @param data defines the array to slice
  39570. * @param start defines the start of the data (optional)
  39571. * @param end defines the end of the data (optional)
  39572. * @returns the new sliced array
  39573. */
  39574. static Slice<T>(data: T, start?: number, end?: number): T;
  39575. /**
  39576. * Polyfill for setImmediate
  39577. * @param action defines the action to execute after the current execution block
  39578. */
  39579. static SetImmediate(action: () => void): void;
  39580. /**
  39581. * Function indicating if a number is an exponent of 2
  39582. * @param value defines the value to test
  39583. * @returns true if the value is an exponent of 2
  39584. */
  39585. static IsExponentOfTwo(value: number): boolean;
  39586. private static _tmpFloatArray;
  39587. /**
  39588. * Returns the nearest 32-bit single precision float representation of a Number
  39589. * @param value A Number. If the parameter is of a different type, it will get converted
  39590. * to a number or to NaN if it cannot be converted
  39591. * @returns number
  39592. */
  39593. static FloatRound(value: number): number;
  39594. /**
  39595. * Extracts the filename from a path
  39596. * @param path defines the path to use
  39597. * @returns the filename
  39598. */
  39599. static GetFilename(path: string): string;
  39600. /**
  39601. * Extracts the "folder" part of a path (everything before the filename).
  39602. * @param uri The URI to extract the info from
  39603. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39604. * @returns The "folder" part of the path
  39605. */
  39606. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39607. /**
  39608. * Extracts text content from a DOM element hierarchy
  39609. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39610. */
  39611. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39612. /**
  39613. * Convert an angle in radians to degrees
  39614. * @param angle defines the angle to convert
  39615. * @returns the angle in degrees
  39616. */
  39617. static ToDegrees(angle: number): number;
  39618. /**
  39619. * Convert an angle in degrees to radians
  39620. * @param angle defines the angle to convert
  39621. * @returns the angle in radians
  39622. */
  39623. static ToRadians(angle: number): number;
  39624. /**
  39625. * Returns an array if obj is not an array
  39626. * @param obj defines the object to evaluate as an array
  39627. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39628. * @returns either obj directly if obj is an array or a new array containing obj
  39629. */
  39630. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39631. /**
  39632. * Gets the pointer prefix to use
  39633. * @param engine defines the engine we are finding the prefix for
  39634. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39635. */
  39636. static GetPointerPrefix(engine: Engine): string;
  39637. /**
  39638. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39639. * @param url define the url we are trying
  39640. * @param element define the dom element where to configure the cors policy
  39641. */
  39642. static SetCorsBehavior(url: string | string[], element: {
  39643. crossOrigin: string | null;
  39644. }): void;
  39645. /**
  39646. * Removes unwanted characters from an url
  39647. * @param url defines the url to clean
  39648. * @returns the cleaned url
  39649. */
  39650. static CleanUrl(url: string): string;
  39651. /**
  39652. * Gets or sets a function used to pre-process url before using them to load assets
  39653. */
  39654. static get PreprocessUrl(): (url: string) => string;
  39655. static set PreprocessUrl(processor: (url: string) => string);
  39656. /**
  39657. * Loads an image as an HTMLImageElement.
  39658. * @param input url string, ArrayBuffer, or Blob to load
  39659. * @param onLoad callback called when the image successfully loads
  39660. * @param onError callback called when the image fails to load
  39661. * @param offlineProvider offline provider for caching
  39662. * @param mimeType optional mime type
  39663. * @returns the HTMLImageElement of the loaded image
  39664. */
  39665. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39666. /**
  39667. * Loads a file from a url
  39668. * @param url url string, ArrayBuffer, or Blob to load
  39669. * @param onSuccess callback called when the file successfully loads
  39670. * @param onProgress callback called while file is loading (if the server supports this mode)
  39671. * @param offlineProvider defines the offline provider for caching
  39672. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39673. * @param onError callback called when the file fails to load
  39674. * @returns a file request object
  39675. */
  39676. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: any) => void): IFileRequest;
  39677. /**
  39678. * Loads a file from a url
  39679. * @param url the file url to load
  39680. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39681. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39682. */
  39683. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39684. /**
  39685. * Load a script (identified by an url). When the url returns, the
  39686. * content of this file is added into a new script element, attached to the DOM (body element)
  39687. * @param scriptUrl defines the url of the script to laod
  39688. * @param onSuccess defines the callback called when the script is loaded
  39689. * @param onError defines the callback to call if an error occurs
  39690. * @param scriptId defines the id of the script element
  39691. */
  39692. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39693. /**
  39694. * Load an asynchronous script (identified by an url). When the url returns, the
  39695. * content of this file is added into a new script element, attached to the DOM (body element)
  39696. * @param scriptUrl defines the url of the script to laod
  39697. * @param scriptId defines the id of the script element
  39698. * @returns a promise request object
  39699. */
  39700. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39701. /**
  39702. * Loads a file from a blob
  39703. * @param fileToLoad defines the blob to use
  39704. * @param callback defines the callback to call when data is loaded
  39705. * @param progressCallback defines the callback to call during loading process
  39706. * @returns a file request object
  39707. */
  39708. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39709. /**
  39710. * Reads a file from a File object
  39711. * @param file defines the file to load
  39712. * @param onSuccess defines the callback to call when data is loaded
  39713. * @param onProgress defines the callback to call during loading process
  39714. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39715. * @param onError defines the callback to call when an error occurs
  39716. * @returns a file request object
  39717. */
  39718. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39719. /**
  39720. * Creates a data url from a given string content
  39721. * @param content defines the content to convert
  39722. * @returns the new data url link
  39723. */
  39724. static FileAsURL(content: string): string;
  39725. /**
  39726. * Format the given number to a specific decimal format
  39727. * @param value defines the number to format
  39728. * @param decimals defines the number of decimals to use
  39729. * @returns the formatted string
  39730. */
  39731. static Format(value: number, decimals?: number): string;
  39732. /**
  39733. * Tries to copy an object by duplicating every property
  39734. * @param source defines the source object
  39735. * @param destination defines the target object
  39736. * @param doNotCopyList defines a list of properties to avoid
  39737. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39738. */
  39739. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39740. /**
  39741. * Gets a boolean indicating if the given object has no own property
  39742. * @param obj defines the object to test
  39743. * @returns true if object has no own property
  39744. */
  39745. static IsEmpty(obj: any): boolean;
  39746. /**
  39747. * Function used to register events at window level
  39748. * @param windowElement defines the Window object to use
  39749. * @param events defines the events to register
  39750. */
  39751. static RegisterTopRootEvents(windowElement: Window, events: {
  39752. name: string;
  39753. handler: Nullable<(e: FocusEvent) => any>;
  39754. }[]): void;
  39755. /**
  39756. * Function used to unregister events from window level
  39757. * @param windowElement defines the Window object to use
  39758. * @param events defines the events to unregister
  39759. */
  39760. static UnregisterTopRootEvents(windowElement: Window, events: {
  39761. name: string;
  39762. handler: Nullable<(e: FocusEvent) => any>;
  39763. }[]): void;
  39764. /**
  39765. * @ignore
  39766. */
  39767. static _ScreenshotCanvas: HTMLCanvasElement;
  39768. /**
  39769. * Dumps the current bound framebuffer
  39770. * @param width defines the rendering width
  39771. * @param height defines the rendering height
  39772. * @param engine defines the hosting engine
  39773. * @param successCallback defines the callback triggered once the data are available
  39774. * @param mimeType defines the mime type of the result
  39775. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39776. */
  39777. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39778. /**
  39779. * Converts the canvas data to blob.
  39780. * This acts as a polyfill for browsers not supporting the to blob function.
  39781. * @param canvas Defines the canvas to extract the data from
  39782. * @param successCallback Defines the callback triggered once the data are available
  39783. * @param mimeType Defines the mime type of the result
  39784. */
  39785. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39786. /**
  39787. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39788. * @param successCallback defines the callback triggered once the data are available
  39789. * @param mimeType defines the mime type of the result
  39790. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39791. */
  39792. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39793. /**
  39794. * Downloads a blob in the browser
  39795. * @param blob defines the blob to download
  39796. * @param fileName defines the name of the downloaded file
  39797. */
  39798. static Download(blob: Blob, fileName: string): void;
  39799. /**
  39800. * Captures a screenshot of the current rendering
  39801. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39802. * @param engine defines the rendering engine
  39803. * @param camera defines the source camera
  39804. * @param size This parameter can be set to a single number or to an object with the
  39805. * following (optional) properties: precision, width, height. If a single number is passed,
  39806. * it will be used for both width and height. If an object is passed, the screenshot size
  39807. * will be derived from the parameters. The precision property is a multiplier allowing
  39808. * rendering at a higher or lower resolution
  39809. * @param successCallback defines the callback receives a single parameter which contains the
  39810. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39811. * src parameter of an <img> to display it
  39812. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39813. * Check your browser for supported MIME types
  39814. */
  39815. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39816. /**
  39817. * Captures a screenshot of the current rendering
  39818. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39819. * @param engine defines the rendering engine
  39820. * @param camera defines the source camera
  39821. * @param size This parameter can be set to a single number or to an object with the
  39822. * following (optional) properties: precision, width, height. If a single number is passed,
  39823. * it will be used for both width and height. If an object is passed, the screenshot size
  39824. * will be derived from the parameters. The precision property is a multiplier allowing
  39825. * rendering at a higher or lower resolution
  39826. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39827. * Check your browser for supported MIME types
  39828. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39829. * to the src parameter of an <img> to display it
  39830. */
  39831. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39832. /**
  39833. * Generates an image screenshot from the specified camera.
  39834. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39835. * @param engine The engine to use for rendering
  39836. * @param camera The camera to use for rendering
  39837. * @param size This parameter can be set to a single number or to an object with the
  39838. * following (optional) properties: precision, width, height. If a single number is passed,
  39839. * it will be used for both width and height. If an object is passed, the screenshot size
  39840. * will be derived from the parameters. The precision property is a multiplier allowing
  39841. * rendering at a higher or lower resolution
  39842. * @param successCallback The callback receives a single parameter which contains the
  39843. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39844. * src parameter of an <img> to display it
  39845. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39846. * Check your browser for supported MIME types
  39847. * @param samples Texture samples (default: 1)
  39848. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39849. * @param fileName A name for for the downloaded file.
  39850. */
  39851. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39852. /**
  39853. * Generates an image screenshot from the specified camera.
  39854. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39855. * @param engine The engine to use for rendering
  39856. * @param camera The camera to use for rendering
  39857. * @param size This parameter can be set to a single number or to an object with the
  39858. * following (optional) properties: precision, width, height. If a single number is passed,
  39859. * it will be used for both width and height. If an object is passed, the screenshot size
  39860. * will be derived from the parameters. The precision property is a multiplier allowing
  39861. * rendering at a higher or lower resolution
  39862. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39863. * Check your browser for supported MIME types
  39864. * @param samples Texture samples (default: 1)
  39865. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39866. * @param fileName A name for for the downloaded file.
  39867. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39868. * to the src parameter of an <img> to display it
  39869. */
  39870. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39871. /**
  39872. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39873. * Be aware Math.random() could cause collisions, but:
  39874. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  39875. * @returns a pseudo random id
  39876. */
  39877. static RandomId(): string;
  39878. /**
  39879. * Test if the given uri is a base64 string
  39880. * @param uri The uri to test
  39881. * @return True if the uri is a base64 string or false otherwise
  39882. */
  39883. static IsBase64(uri: string): boolean;
  39884. /**
  39885. * Decode the given base64 uri.
  39886. * @param uri The uri to decode
  39887. * @return The decoded base64 data.
  39888. */
  39889. static DecodeBase64(uri: string): ArrayBuffer;
  39890. /**
  39891. * Gets the absolute url.
  39892. * @param url the input url
  39893. * @return the absolute url
  39894. */
  39895. static GetAbsoluteUrl(url: string): string;
  39896. /**
  39897. * No log
  39898. */
  39899. static readonly NoneLogLevel: number;
  39900. /**
  39901. * Only message logs
  39902. */
  39903. static readonly MessageLogLevel: number;
  39904. /**
  39905. * Only warning logs
  39906. */
  39907. static readonly WarningLogLevel: number;
  39908. /**
  39909. * Only error logs
  39910. */
  39911. static readonly ErrorLogLevel: number;
  39912. /**
  39913. * All logs
  39914. */
  39915. static readonly AllLogLevel: number;
  39916. /**
  39917. * Gets a value indicating the number of loading errors
  39918. * @ignorenaming
  39919. */
  39920. static get errorsCount(): number;
  39921. /**
  39922. * Callback called when a new log is added
  39923. */
  39924. static OnNewCacheEntry: (entry: string) => void;
  39925. /**
  39926. * Log a message to the console
  39927. * @param message defines the message to log
  39928. */
  39929. static Log(message: string): void;
  39930. /**
  39931. * Write a warning message to the console
  39932. * @param message defines the message to log
  39933. */
  39934. static Warn(message: string): void;
  39935. /**
  39936. * Write an error message to the console
  39937. * @param message defines the message to log
  39938. */
  39939. static Error(message: string): void;
  39940. /**
  39941. * Gets current log cache (list of logs)
  39942. */
  39943. static get LogCache(): string;
  39944. /**
  39945. * Clears the log cache
  39946. */
  39947. static ClearLogCache(): void;
  39948. /**
  39949. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39950. */
  39951. static set LogLevels(level: number);
  39952. /**
  39953. * Checks if the window object exists
  39954. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39955. */
  39956. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39957. /**
  39958. * No performance log
  39959. */
  39960. static readonly PerformanceNoneLogLevel: number;
  39961. /**
  39962. * Use user marks to log performance
  39963. */
  39964. static readonly PerformanceUserMarkLogLevel: number;
  39965. /**
  39966. * Log performance to the console
  39967. */
  39968. static readonly PerformanceConsoleLogLevel: number;
  39969. private static _performance;
  39970. /**
  39971. * Sets the current performance log level
  39972. */
  39973. static set PerformanceLogLevel(level: number);
  39974. private static _StartPerformanceCounterDisabled;
  39975. private static _EndPerformanceCounterDisabled;
  39976. private static _StartUserMark;
  39977. private static _EndUserMark;
  39978. private static _StartPerformanceConsole;
  39979. private static _EndPerformanceConsole;
  39980. /**
  39981. * Starts a performance counter
  39982. */
  39983. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39984. /**
  39985. * Ends a specific performance coutner
  39986. */
  39987. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39988. /**
  39989. * Gets either window.performance.now() if supported or Date.now() else
  39990. */
  39991. static get Now(): number;
  39992. /**
  39993. * This method will return the name of the class used to create the instance of the given object.
  39994. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  39995. * @param object the object to get the class name from
  39996. * @param isType defines if the object is actually a type
  39997. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  39998. */
  39999. static GetClassName(object: any, isType?: boolean): string;
  40000. /**
  40001. * Gets the first element of an array satisfying a given predicate
  40002. * @param array defines the array to browse
  40003. * @param predicate defines the predicate to use
  40004. * @returns null if not found or the element
  40005. */
  40006. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  40007. /**
  40008. * This method will return the name of the full name of the class, including its owning module (if any).
  40009. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator or implementing a method getClassName():string (in which case the module won't be specified).
  40010. * @param object the object to get the class name from
  40011. * @param isType defines if the object is actually a type
  40012. * @return a string that can have two forms: "moduleName.className" if module was specified when the class' Name was registered or "className" if there was not module specified.
  40013. * @ignorenaming
  40014. */
  40015. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40016. /**
  40017. * Returns a promise that resolves after the given amount of time.
  40018. * @param delay Number of milliseconds to delay
  40019. * @returns Promise that resolves after the given amount of time
  40020. */
  40021. static DelayAsync(delay: number): Promise<void>;
  40022. /**
  40023. * Utility function to detect if the current user agent is Safari
  40024. * @returns whether or not the current user agent is safari
  40025. */
  40026. static IsSafari(): boolean;
  40027. }
  40028. /**
  40029. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40030. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40031. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40032. * @param name The name of the class, case should be preserved
  40033. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40034. */
  40035. export function className(name: string, module?: string): (target: Object) => void;
  40036. /**
  40037. * An implementation of a loop for asynchronous functions.
  40038. */
  40039. export class AsyncLoop {
  40040. /**
  40041. * Defines the number of iterations for the loop
  40042. */
  40043. iterations: number;
  40044. /**
  40045. * Defines the current index of the loop.
  40046. */
  40047. index: number;
  40048. private _done;
  40049. private _fn;
  40050. private _successCallback;
  40051. /**
  40052. * Constructor.
  40053. * @param iterations the number of iterations.
  40054. * @param func the function to run each iteration
  40055. * @param successCallback the callback that will be called upon succesful execution
  40056. * @param offset starting offset.
  40057. */
  40058. constructor(
  40059. /**
  40060. * Defines the number of iterations for the loop
  40061. */
  40062. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40063. /**
  40064. * Execute the next iteration. Must be called after the last iteration was finished.
  40065. */
  40066. executeNext(): void;
  40067. /**
  40068. * Break the loop and run the success callback.
  40069. */
  40070. breakLoop(): void;
  40071. /**
  40072. * Create and run an async loop.
  40073. * @param iterations the number of iterations.
  40074. * @param fn the function to run each iteration
  40075. * @param successCallback the callback that will be called upon succesful execution
  40076. * @param offset starting offset.
  40077. * @returns the created async loop object
  40078. */
  40079. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40080. /**
  40081. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40082. * @param iterations total number of iterations
  40083. * @param syncedIterations number of synchronous iterations in each async iteration.
  40084. * @param fn the function to call each iteration.
  40085. * @param callback a success call back that will be called when iterating stops.
  40086. * @param breakFunction a break condition (optional)
  40087. * @param timeout timeout settings for the setTimeout function. default - 0.
  40088. * @returns the created async loop object
  40089. */
  40090. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40091. }
  40092. }
  40093. declare module "babylonjs/Misc/stringDictionary" {
  40094. import { Nullable } from "babylonjs/types";
  40095. /**
  40096. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40097. * The underlying implementation relies on an associative array to ensure the best performances.
  40098. * The value can be anything including 'null' but except 'undefined'
  40099. */
  40100. export class StringDictionary<T> {
  40101. /**
  40102. * This will clear this dictionary and copy the content from the 'source' one.
  40103. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40104. * @param source the dictionary to take the content from and copy to this dictionary
  40105. */
  40106. copyFrom(source: StringDictionary<T>): void;
  40107. /**
  40108. * Get a value based from its key
  40109. * @param key the given key to get the matching value from
  40110. * @return the value if found, otherwise undefined is returned
  40111. */
  40112. get(key: string): T | undefined;
  40113. /**
  40114. * Get a value from its key or add it if it doesn't exist.
  40115. * This method will ensure you that a given key/data will be present in the dictionary.
  40116. * @param key the given key to get the matching value from
  40117. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40118. * The factory will only be invoked if there's no data for the given key.
  40119. * @return the value corresponding to the key.
  40120. */
  40121. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40122. /**
  40123. * Get a value from its key if present in the dictionary otherwise add it
  40124. * @param key the key to get the value from
  40125. * @param val if there's no such key/value pair in the dictionary add it with this value
  40126. * @return the value corresponding to the key
  40127. */
  40128. getOrAdd(key: string, val: T): T;
  40129. /**
  40130. * Check if there's a given key in the dictionary
  40131. * @param key the key to check for
  40132. * @return true if the key is present, false otherwise
  40133. */
  40134. contains(key: string): boolean;
  40135. /**
  40136. * Add a new key and its corresponding value
  40137. * @param key the key to add
  40138. * @param value the value corresponding to the key
  40139. * @return true if the operation completed successfully, false if we couldn't insert the key/value because there was already this key in the dictionary
  40140. */
  40141. add(key: string, value: T): boolean;
  40142. /**
  40143. * Update a specific value associated to a key
  40144. * @param key defines the key to use
  40145. * @param value defines the value to store
  40146. * @returns true if the value was updated (or false if the key was not found)
  40147. */
  40148. set(key: string, value: T): boolean;
  40149. /**
  40150. * Get the element of the given key and remove it from the dictionary
  40151. * @param key defines the key to search
  40152. * @returns the value associated with the key or null if not found
  40153. */
  40154. getAndRemove(key: string): Nullable<T>;
  40155. /**
  40156. * Remove a key/value from the dictionary.
  40157. * @param key the key to remove
  40158. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40159. */
  40160. remove(key: string): boolean;
  40161. /**
  40162. * Clear the whole content of the dictionary
  40163. */
  40164. clear(): void;
  40165. /**
  40166. * Gets the current count
  40167. */
  40168. get count(): number;
  40169. /**
  40170. * Execute a callback on each key/val of the dictionary.
  40171. * Note that you can remove any element in this dictionary in the callback implementation
  40172. * @param callback the callback to execute on a given key/value pair
  40173. */
  40174. forEach(callback: (key: string, val: T) => void): void;
  40175. /**
  40176. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40177. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40178. * Note that you can remove any element in this dictionary in the callback implementation
  40179. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40180. * @returns the first item
  40181. */
  40182. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40183. private _count;
  40184. private _data;
  40185. }
  40186. }
  40187. declare module "babylonjs/Collisions/collisionCoordinator" {
  40188. import { Nullable } from "babylonjs/types";
  40189. import { Scene } from "babylonjs/scene";
  40190. import { Vector3 } from "babylonjs/Maths/math.vector";
  40191. import { Collider } from "babylonjs/Collisions/collider";
  40192. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40193. /** @hidden */
  40194. export interface ICollisionCoordinator {
  40195. createCollider(): Collider;
  40196. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40197. init(scene: Scene): void;
  40198. }
  40199. /** @hidden */
  40200. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40201. private _scene;
  40202. private _scaledPosition;
  40203. private _scaledVelocity;
  40204. private _finalPosition;
  40205. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40206. createCollider(): Collider;
  40207. init(scene: Scene): void;
  40208. private _collideWithWorld;
  40209. }
  40210. }
  40211. declare module "babylonjs/Inputs/scene.inputManager" {
  40212. import { Nullable } from "babylonjs/types";
  40213. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40214. import { Vector2 } from "babylonjs/Maths/math.vector";
  40215. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40216. import { Scene } from "babylonjs/scene";
  40217. /**
  40218. * Class used to manage all inputs for the scene.
  40219. */
  40220. export class InputManager {
  40221. /** The distance in pixel that you have to move to prevent some events */
  40222. static DragMovementThreshold: number;
  40223. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40224. static LongPressDelay: number;
  40225. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40226. static DoubleClickDelay: number;
  40227. /** If you need to check double click without raising a single click at first click, enable this flag */
  40228. static ExclusiveDoubleClickMode: boolean;
  40229. /** This is a defensive check to not allow control attachment prior to an already active one. If already attached, previous control is unattached before attaching the new one. */
  40230. private _alreadyAttached;
  40231. private _wheelEventName;
  40232. private _onPointerMove;
  40233. private _onPointerDown;
  40234. private _onPointerUp;
  40235. private _initClickEvent;
  40236. private _initActionManager;
  40237. private _delayedSimpleClick;
  40238. private _delayedSimpleClickTimeout;
  40239. private _previousDelayedSimpleClickTimeout;
  40240. private _meshPickProceed;
  40241. private _previousButtonPressed;
  40242. private _currentPickResult;
  40243. private _previousPickResult;
  40244. private _totalPointersPressed;
  40245. private _doubleClickOccured;
  40246. private _pointerOverMesh;
  40247. private _pickedDownMesh;
  40248. private _pickedUpMesh;
  40249. private _pointerX;
  40250. private _pointerY;
  40251. private _unTranslatedPointerX;
  40252. private _unTranslatedPointerY;
  40253. private _startingPointerPosition;
  40254. private _previousStartingPointerPosition;
  40255. private _startingPointerTime;
  40256. private _previousStartingPointerTime;
  40257. private _pointerCaptures;
  40258. private _onKeyDown;
  40259. private _onKeyUp;
  40260. private _onCanvasFocusObserver;
  40261. private _onCanvasBlurObserver;
  40262. private _scene;
  40263. /**
  40264. * Creates a new InputManager
  40265. * @param scene defines the hosting scene
  40266. */
  40267. constructor(scene: Scene);
  40268. /**
  40269. * Gets the mesh that is currently under the pointer
  40270. */
  40271. get meshUnderPointer(): Nullable<AbstractMesh>;
  40272. /**
  40273. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40274. */
  40275. get unTranslatedPointer(): Vector2;
  40276. /**
  40277. * Gets or sets the current on-screen X position of the pointer
  40278. */
  40279. get pointerX(): number;
  40280. set pointerX(value: number);
  40281. /**
  40282. * Gets or sets the current on-screen Y position of the pointer
  40283. */
  40284. get pointerY(): number;
  40285. set pointerY(value: number);
  40286. private _updatePointerPosition;
  40287. private _processPointerMove;
  40288. private _setRayOnPointerInfo;
  40289. private _checkPrePointerObservable;
  40290. /**
  40291. * Use this method to simulate a pointer move on a mesh
  40292. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40293. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40294. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40295. */
  40296. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40297. /**
  40298. * Use this method to simulate a pointer down on a mesh
  40299. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40300. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40301. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40302. */
  40303. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40304. private _processPointerDown;
  40305. /** @hidden */
  40306. _isPointerSwiping(): boolean;
  40307. /**
  40308. * Use this method to simulate a pointer up on a mesh
  40309. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40310. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40311. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40312. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40313. */
  40314. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40315. private _processPointerUp;
  40316. /**
  40317. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40318. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40319. * @returns true if the pointer was captured
  40320. */
  40321. isPointerCaptured(pointerId?: number): boolean;
  40322. /**
  40323. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40324. * @param attachUp defines if you want to attach events to pointerup
  40325. * @param attachDown defines if you want to attach events to pointerdown
  40326. * @param attachMove defines if you want to attach events to pointermove
  40327. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40328. */
  40329. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40330. /**
  40331. * Detaches all event handlers
  40332. */
  40333. detachControl(): void;
  40334. /**
  40335. * Force the value of meshUnderPointer
  40336. * @param mesh defines the mesh to use
  40337. */
  40338. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  40339. /**
  40340. * Gets the mesh under the pointer
  40341. * @returns a Mesh or null if no mesh is under the pointer
  40342. */
  40343. getPointerOverMesh(): Nullable<AbstractMesh>;
  40344. }
  40345. }
  40346. declare module "babylonjs/Animations/animationGroup" {
  40347. import { Animatable } from "babylonjs/Animations/animatable";
  40348. import { Animation } from "babylonjs/Animations/animation";
  40349. import { Scene, IDisposable } from "babylonjs/scene";
  40350. import { Observable } from "babylonjs/Misc/observable";
  40351. import { Nullable } from "babylonjs/types";
  40352. import "babylonjs/Animations/animatable";
  40353. /**
  40354. * This class defines the direct association between an animation and a target
  40355. */
  40356. export class TargetedAnimation {
  40357. /**
  40358. * Animation to perform
  40359. */
  40360. animation: Animation;
  40361. /**
  40362. * Target to animate
  40363. */
  40364. target: any;
  40365. /**
  40366. * Returns the string "TargetedAnimation"
  40367. * @returns "TargetedAnimation"
  40368. */
  40369. getClassName(): string;
  40370. /**
  40371. * Serialize the object
  40372. * @returns the JSON object representing the current entity
  40373. */
  40374. serialize(): any;
  40375. }
  40376. /**
  40377. * Use this class to create coordinated animations on multiple targets
  40378. */
  40379. export class AnimationGroup implements IDisposable {
  40380. /** The name of the animation group */
  40381. name: string;
  40382. private _scene;
  40383. private _targetedAnimations;
  40384. private _animatables;
  40385. private _from;
  40386. private _to;
  40387. private _isStarted;
  40388. private _isPaused;
  40389. private _speedRatio;
  40390. private _loopAnimation;
  40391. private _isAdditive;
  40392. /**
  40393. * Gets or sets the unique id of the node
  40394. */
  40395. uniqueId: number;
  40396. /**
  40397. * This observable will notify when one animation have ended
  40398. */
  40399. onAnimationEndObservable: Observable<TargetedAnimation>;
  40400. /**
  40401. * Observer raised when one animation loops
  40402. */
  40403. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40404. /**
  40405. * Observer raised when all animations have looped
  40406. */
  40407. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40408. /**
  40409. * This observable will notify when all animations have ended.
  40410. */
  40411. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40412. /**
  40413. * This observable will notify when all animations have paused.
  40414. */
  40415. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40416. /**
  40417. * This observable will notify when all animations are playing.
  40418. */
  40419. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40420. /**
  40421. * Gets the first frame
  40422. */
  40423. get from(): number;
  40424. /**
  40425. * Gets the last frame
  40426. */
  40427. get to(): number;
  40428. /**
  40429. * Define if the animations are started
  40430. */
  40431. get isStarted(): boolean;
  40432. /**
  40433. * Gets a value indicating that the current group is playing
  40434. */
  40435. get isPlaying(): boolean;
  40436. /**
  40437. * Gets or sets the speed ratio to use for all animations
  40438. */
  40439. get speedRatio(): number;
  40440. /**
  40441. * Gets or sets the speed ratio to use for all animations
  40442. */
  40443. set speedRatio(value: number);
  40444. /**
  40445. * Gets or sets if all animations should loop or not
  40446. */
  40447. get loopAnimation(): boolean;
  40448. set loopAnimation(value: boolean);
  40449. /**
  40450. * Gets or sets if all animations should be evaluated additively
  40451. */
  40452. get isAdditive(): boolean;
  40453. set isAdditive(value: boolean);
  40454. /**
  40455. * Gets the targeted animations for this animation group
  40456. */
  40457. get targetedAnimations(): Array<TargetedAnimation>;
  40458. /**
  40459. * returning the list of animatables controlled by this animation group.
  40460. */
  40461. get animatables(): Array<Animatable>;
  40462. /**
  40463. * Gets the list of target animations
  40464. */
  40465. get children(): TargetedAnimation[];
  40466. /**
  40467. * Instantiates a new Animation Group.
  40468. * This helps managing several animations at once.
  40469. * @see https://doc.babylonjs.com/how_to/group
  40470. * @param name Defines the name of the group
  40471. * @param scene Defines the scene the group belongs to
  40472. */
  40473. constructor(
  40474. /** The name of the animation group */
  40475. name: string, scene?: Nullable<Scene>);
  40476. /**
  40477. * Add an animation (with its target) in the group
  40478. * @param animation defines the animation we want to add
  40479. * @param target defines the target of the animation
  40480. * @returns the TargetedAnimation object
  40481. */
  40482. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40483. /**
  40484. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40485. * It can add constant keys at begin or end
  40486. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40487. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40488. * @returns the animation group
  40489. */
  40490. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40491. private _animationLoopCount;
  40492. private _animationLoopFlags;
  40493. private _processLoop;
  40494. /**
  40495. * Start all animations on given targets
  40496. * @param loop defines if animations must loop
  40497. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40498. * @param from defines the from key (optional)
  40499. * @param to defines the to key (optional)
  40500. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40501. * @returns the current animation group
  40502. */
  40503. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40504. /**
  40505. * Pause all animations
  40506. * @returns the animation group
  40507. */
  40508. pause(): AnimationGroup;
  40509. /**
  40510. * Play all animations to initial state
  40511. * This function will start() the animations if they were not started or will restart() them if they were paused
  40512. * @param loop defines if animations must loop
  40513. * @returns the animation group
  40514. */
  40515. play(loop?: boolean): AnimationGroup;
  40516. /**
  40517. * Reset all animations to initial state
  40518. * @returns the animation group
  40519. */
  40520. reset(): AnimationGroup;
  40521. /**
  40522. * Restart animations from key 0
  40523. * @returns the animation group
  40524. */
  40525. restart(): AnimationGroup;
  40526. /**
  40527. * Stop all animations
  40528. * @returns the animation group
  40529. */
  40530. stop(): AnimationGroup;
  40531. /**
  40532. * Set animation weight for all animatables
  40533. * @param weight defines the weight to use
  40534. * @return the animationGroup
  40535. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40536. */
  40537. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40538. /**
  40539. * Synchronize and normalize all animatables with a source animatable
  40540. * @param root defines the root animatable to synchronize with
  40541. * @return the animationGroup
  40542. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40543. */
  40544. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40545. /**
  40546. * Goes to a specific frame in this animation group
  40547. * @param frame the frame number to go to
  40548. * @return the animationGroup
  40549. */
  40550. goToFrame(frame: number): AnimationGroup;
  40551. /**
  40552. * Dispose all associated resources
  40553. */
  40554. dispose(): void;
  40555. private _checkAnimationGroupEnded;
  40556. /**
  40557. * Clone the current animation group and returns a copy
  40558. * @param newName defines the name of the new group
  40559. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40560. * @returns the new aniamtion group
  40561. */
  40562. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40563. /**
  40564. * Serializes the animationGroup to an object
  40565. * @returns Serialized object
  40566. */
  40567. serialize(): any;
  40568. /**
  40569. * Returns a new AnimationGroup object parsed from the source provided.
  40570. * @param parsedAnimationGroup defines the source
  40571. * @param scene defines the scene that will receive the animationGroup
  40572. * @returns a new AnimationGroup
  40573. */
  40574. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40575. /**
  40576. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40577. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40578. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40579. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40580. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40581. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40582. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40583. */
  40584. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40585. /**
  40586. * Returns the string "AnimationGroup"
  40587. * @returns "AnimationGroup"
  40588. */
  40589. getClassName(): string;
  40590. /**
  40591. * Creates a detailled string about the object
  40592. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40593. * @returns a string representing the object
  40594. */
  40595. toString(fullDetails?: boolean): string;
  40596. }
  40597. }
  40598. declare module "babylonjs/scene" {
  40599. import { Nullable } from "babylonjs/types";
  40600. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40601. import { Observable } from "babylonjs/Misc/observable";
  40602. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40603. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40604. import { Geometry } from "babylonjs/Meshes/geometry";
  40605. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40606. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40607. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40608. import { Mesh } from "babylonjs/Meshes/mesh";
  40609. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40610. import { Bone } from "babylonjs/Bones/bone";
  40611. import { Skeleton } from "babylonjs/Bones/skeleton";
  40612. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40613. import { Camera } from "babylonjs/Cameras/camera";
  40614. import { AbstractScene } from "babylonjs/abstractScene";
  40615. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40616. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40617. import { Material } from "babylonjs/Materials/material";
  40618. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40619. import { Effect } from "babylonjs/Materials/effect";
  40620. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40621. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40622. import { Light } from "babylonjs/Lights/light";
  40623. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40624. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40625. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40626. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40627. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40628. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40629. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40630. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40631. import { Engine } from "babylonjs/Engines/engine";
  40632. import { Node } from "babylonjs/node";
  40633. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40634. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40635. import { WebRequest } from "babylonjs/Misc/webRequest";
  40636. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40637. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40638. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40639. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40640. import { Plane } from "babylonjs/Maths/math.plane";
  40641. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40642. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40643. import { Ray } from "babylonjs/Culling/ray";
  40644. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40645. import { Animation } from "babylonjs/Animations/animation";
  40646. import { Animatable } from "babylonjs/Animations/animatable";
  40647. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40648. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40649. import { Collider } from "babylonjs/Collisions/collider";
  40650. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40651. /**
  40652. * Define an interface for all classes that will hold resources
  40653. */
  40654. export interface IDisposable {
  40655. /**
  40656. * Releases all held resources
  40657. */
  40658. dispose(): void;
  40659. }
  40660. /** Interface defining initialization parameters for Scene class */
  40661. export interface SceneOptions {
  40662. /**
  40663. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40664. * It will improve performance when the number of geometries becomes important.
  40665. */
  40666. useGeometryUniqueIdsMap?: boolean;
  40667. /**
  40668. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40669. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40670. */
  40671. useMaterialMeshMap?: boolean;
  40672. /**
  40673. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40674. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40675. */
  40676. useClonedMeshMap?: boolean;
  40677. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40678. virtual?: boolean;
  40679. }
  40680. /**
  40681. * Represents a scene to be rendered by the engine.
  40682. * @see https://doc.babylonjs.com/features/scene
  40683. */
  40684. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40685. /** The fog is deactivated */
  40686. static readonly FOGMODE_NONE: number;
  40687. /** The fog density is following an exponential function */
  40688. static readonly FOGMODE_EXP: number;
  40689. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40690. static readonly FOGMODE_EXP2: number;
  40691. /** The fog density is following a linear function. */
  40692. static readonly FOGMODE_LINEAR: number;
  40693. /**
  40694. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40695. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40696. */
  40697. static MinDeltaTime: number;
  40698. /**
  40699. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40700. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40701. */
  40702. static MaxDeltaTime: number;
  40703. /**
  40704. * Factory used to create the default material.
  40705. * @param name The name of the material to create
  40706. * @param scene The scene to create the material for
  40707. * @returns The default material
  40708. */
  40709. static DefaultMaterialFactory(scene: Scene): Material;
  40710. /**
  40711. * Factory used to create the a collision coordinator.
  40712. * @returns The collision coordinator
  40713. */
  40714. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40715. /** @hidden */
  40716. _inputManager: InputManager;
  40717. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40718. cameraToUseForPointers: Nullable<Camera>;
  40719. /** @hidden */
  40720. readonly _isScene: boolean;
  40721. /** @hidden */
  40722. _blockEntityCollection: boolean;
  40723. /**
  40724. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40725. */
  40726. autoClear: boolean;
  40727. /**
  40728. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40729. */
  40730. autoClearDepthAndStencil: boolean;
  40731. /**
  40732. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40733. */
  40734. clearColor: Color4;
  40735. /**
  40736. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40737. */
  40738. ambientColor: Color3;
  40739. /**
  40740. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40741. * It should only be one of the following (if not the default embedded one):
  40742. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40743. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40744. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40745. * The material properties need to be setup according to the type of texture in use.
  40746. */
  40747. environmentBRDFTexture: BaseTexture;
  40748. /**
  40749. * Texture used in all pbr material as the reflection texture.
  40750. * As in the majority of the scene they are the same (exception for multi room and so on),
  40751. * this is easier to reference from here than from all the materials.
  40752. */
  40753. get environmentTexture(): Nullable<BaseTexture>;
  40754. /**
  40755. * Texture used in all pbr material as the reflection texture.
  40756. * As in the majority of the scene they are the same (exception for multi room and so on),
  40757. * this is easier to set here than in all the materials.
  40758. */
  40759. set environmentTexture(value: Nullable<BaseTexture>);
  40760. /** @hidden */
  40761. protected _environmentIntensity: number;
  40762. /**
  40763. * Intensity of the environment in all pbr material.
  40764. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40765. * As in the majority of the scene they are the same (exception for multi room and so on),
  40766. * this is easier to reference from here than from all the materials.
  40767. */
  40768. get environmentIntensity(): number;
  40769. /**
  40770. * Intensity of the environment in all pbr material.
  40771. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40772. * As in the majority of the scene they are the same (exception for multi room and so on),
  40773. * this is easier to set here than in all the materials.
  40774. */
  40775. set environmentIntensity(value: number);
  40776. /** @hidden */
  40777. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40778. /**
  40779. * Default image processing configuration used either in the rendering
  40780. * Forward main pass or through the imageProcessingPostProcess if present.
  40781. * As in the majority of the scene they are the same (exception for multi camera),
  40782. * this is easier to reference from here than from all the materials and post process.
  40783. *
  40784. * No setter as we it is a shared configuration, you can set the values instead.
  40785. */
  40786. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40787. private _forceWireframe;
  40788. /**
  40789. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40790. */
  40791. set forceWireframe(value: boolean);
  40792. get forceWireframe(): boolean;
  40793. private _skipFrustumClipping;
  40794. /**
  40795. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40796. */
  40797. set skipFrustumClipping(value: boolean);
  40798. get skipFrustumClipping(): boolean;
  40799. private _forcePointsCloud;
  40800. /**
  40801. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40802. */
  40803. set forcePointsCloud(value: boolean);
  40804. get forcePointsCloud(): boolean;
  40805. /**
  40806. * Gets or sets the active clipplane 1
  40807. */
  40808. clipPlane: Nullable<Plane>;
  40809. /**
  40810. * Gets or sets the active clipplane 2
  40811. */
  40812. clipPlane2: Nullable<Plane>;
  40813. /**
  40814. * Gets or sets the active clipplane 3
  40815. */
  40816. clipPlane3: Nullable<Plane>;
  40817. /**
  40818. * Gets or sets the active clipplane 4
  40819. */
  40820. clipPlane4: Nullable<Plane>;
  40821. /**
  40822. * Gets or sets the active clipplane 5
  40823. */
  40824. clipPlane5: Nullable<Plane>;
  40825. /**
  40826. * Gets or sets the active clipplane 6
  40827. */
  40828. clipPlane6: Nullable<Plane>;
  40829. /**
  40830. * Gets or sets a boolean indicating if animations are enabled
  40831. */
  40832. animationsEnabled: boolean;
  40833. private _animationPropertiesOverride;
  40834. /**
  40835. * Gets or sets the animation properties override
  40836. */
  40837. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40838. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40839. /**
  40840. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40841. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40842. */
  40843. useConstantAnimationDeltaTime: boolean;
  40844. /**
  40845. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40846. * Please note that it requires to run a ray cast through the scene on every frame
  40847. */
  40848. constantlyUpdateMeshUnderPointer: boolean;
  40849. /**
  40850. * Defines the HTML cursor to use when hovering over interactive elements
  40851. */
  40852. hoverCursor: string;
  40853. /**
  40854. * Defines the HTML default cursor to use (empty by default)
  40855. */
  40856. defaultCursor: string;
  40857. /**
  40858. * Defines whether cursors are handled by the scene.
  40859. */
  40860. doNotHandleCursors: boolean;
  40861. /**
  40862. * This is used to call preventDefault() on pointer down
  40863. * in order to block unwanted artifacts like system double clicks
  40864. */
  40865. preventDefaultOnPointerDown: boolean;
  40866. /**
  40867. * This is used to call preventDefault() on pointer up
  40868. * in order to block unwanted artifacts like system double clicks
  40869. */
  40870. preventDefaultOnPointerUp: boolean;
  40871. /**
  40872. * Gets or sets user defined metadata
  40873. */
  40874. metadata: any;
  40875. /**
  40876. * For internal use only. Please do not use.
  40877. */
  40878. reservedDataStore: any;
  40879. /**
  40880. * Gets the name of the plugin used to load this scene (null by default)
  40881. */
  40882. loadingPluginName: string;
  40883. /**
  40884. * Use this array to add regular expressions used to disable offline support for specific urls
  40885. */
  40886. disableOfflineSupportExceptionRules: RegExp[];
  40887. /**
  40888. * An event triggered when the scene is disposed.
  40889. */
  40890. onDisposeObservable: Observable<Scene>;
  40891. private _onDisposeObserver;
  40892. /** Sets a function to be executed when this scene is disposed. */
  40893. set onDispose(callback: () => void);
  40894. /**
  40895. * An event triggered before rendering the scene (right after animations and physics)
  40896. */
  40897. onBeforeRenderObservable: Observable<Scene>;
  40898. private _onBeforeRenderObserver;
  40899. /** Sets a function to be executed before rendering this scene */
  40900. set beforeRender(callback: Nullable<() => void>);
  40901. /**
  40902. * An event triggered after rendering the scene
  40903. */
  40904. onAfterRenderObservable: Observable<Scene>;
  40905. /**
  40906. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40907. */
  40908. onAfterRenderCameraObservable: Observable<Camera>;
  40909. private _onAfterRenderObserver;
  40910. /** Sets a function to be executed after rendering this scene */
  40911. set afterRender(callback: Nullable<() => void>);
  40912. /**
  40913. * An event triggered before animating the scene
  40914. */
  40915. onBeforeAnimationsObservable: Observable<Scene>;
  40916. /**
  40917. * An event triggered after animations processing
  40918. */
  40919. onAfterAnimationsObservable: Observable<Scene>;
  40920. /**
  40921. * An event triggered before draw calls are ready to be sent
  40922. */
  40923. onBeforeDrawPhaseObservable: Observable<Scene>;
  40924. /**
  40925. * An event triggered after draw calls have been sent
  40926. */
  40927. onAfterDrawPhaseObservable: Observable<Scene>;
  40928. /**
  40929. * An event triggered when the scene is ready
  40930. */
  40931. onReadyObservable: Observable<Scene>;
  40932. /**
  40933. * An event triggered before rendering a camera
  40934. */
  40935. onBeforeCameraRenderObservable: Observable<Camera>;
  40936. private _onBeforeCameraRenderObserver;
  40937. /** Sets a function to be executed before rendering a camera*/
  40938. set beforeCameraRender(callback: () => void);
  40939. /**
  40940. * An event triggered after rendering a camera
  40941. */
  40942. onAfterCameraRenderObservable: Observable<Camera>;
  40943. private _onAfterCameraRenderObserver;
  40944. /** Sets a function to be executed after rendering a camera*/
  40945. set afterCameraRender(callback: () => void);
  40946. /**
  40947. * An event triggered when active meshes evaluation is about to start
  40948. */
  40949. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40950. /**
  40951. * An event triggered when active meshes evaluation is done
  40952. */
  40953. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40954. /**
  40955. * An event triggered when particles rendering is about to start
  40956. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40957. */
  40958. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40959. /**
  40960. * An event triggered when particles rendering is done
  40961. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40962. */
  40963. onAfterParticlesRenderingObservable: Observable<Scene>;
  40964. /**
  40965. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40966. */
  40967. onDataLoadedObservable: Observable<Scene>;
  40968. /**
  40969. * An event triggered when a camera is created
  40970. */
  40971. onNewCameraAddedObservable: Observable<Camera>;
  40972. /**
  40973. * An event triggered when a camera is removed
  40974. */
  40975. onCameraRemovedObservable: Observable<Camera>;
  40976. /**
  40977. * An event triggered when a light is created
  40978. */
  40979. onNewLightAddedObservable: Observable<Light>;
  40980. /**
  40981. * An event triggered when a light is removed
  40982. */
  40983. onLightRemovedObservable: Observable<Light>;
  40984. /**
  40985. * An event triggered when a geometry is created
  40986. */
  40987. onNewGeometryAddedObservable: Observable<Geometry>;
  40988. /**
  40989. * An event triggered when a geometry is removed
  40990. */
  40991. onGeometryRemovedObservable: Observable<Geometry>;
  40992. /**
  40993. * An event triggered when a transform node is created
  40994. */
  40995. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  40996. /**
  40997. * An event triggered when a transform node is removed
  40998. */
  40999. onTransformNodeRemovedObservable: Observable<TransformNode>;
  41000. /**
  41001. * An event triggered when a mesh is created
  41002. */
  41003. onNewMeshAddedObservable: Observable<AbstractMesh>;
  41004. /**
  41005. * An event triggered when a mesh is removed
  41006. */
  41007. onMeshRemovedObservable: Observable<AbstractMesh>;
  41008. /**
  41009. * An event triggered when a skeleton is created
  41010. */
  41011. onNewSkeletonAddedObservable: Observable<Skeleton>;
  41012. /**
  41013. * An event triggered when a skeleton is removed
  41014. */
  41015. onSkeletonRemovedObservable: Observable<Skeleton>;
  41016. /**
  41017. * An event triggered when a material is created
  41018. */
  41019. onNewMaterialAddedObservable: Observable<Material>;
  41020. /**
  41021. * An event triggered when a material is removed
  41022. */
  41023. onMaterialRemovedObservable: Observable<Material>;
  41024. /**
  41025. * An event triggered when a texture is created
  41026. */
  41027. onNewTextureAddedObservable: Observable<BaseTexture>;
  41028. /**
  41029. * An event triggered when a texture is removed
  41030. */
  41031. onTextureRemovedObservable: Observable<BaseTexture>;
  41032. /**
  41033. * An event triggered when render targets are about to be rendered
  41034. * Can happen multiple times per frame.
  41035. */
  41036. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41037. /**
  41038. * An event triggered when render targets were rendered.
  41039. * Can happen multiple times per frame.
  41040. */
  41041. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41042. /**
  41043. * An event triggered before calculating deterministic simulation step
  41044. */
  41045. onBeforeStepObservable: Observable<Scene>;
  41046. /**
  41047. * An event triggered after calculating deterministic simulation step
  41048. */
  41049. onAfterStepObservable: Observable<Scene>;
  41050. /**
  41051. * An event triggered when the activeCamera property is updated
  41052. */
  41053. onActiveCameraChanged: Observable<Scene>;
  41054. /**
  41055. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41056. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41057. * 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)
  41058. */
  41059. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41060. /**
  41061. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41062. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41063. * 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)
  41064. */
  41065. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41066. /**
  41067. * This Observable will when a mesh has been imported into the scene.
  41068. */
  41069. onMeshImportedObservable: Observable<AbstractMesh>;
  41070. /**
  41071. * This Observable will when an animation file has been imported into the scene.
  41072. */
  41073. onAnimationFileImportedObservable: Observable<Scene>;
  41074. /**
  41075. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41076. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41077. */
  41078. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41079. /** @hidden */
  41080. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41081. /**
  41082. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41083. */
  41084. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41085. /**
  41086. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41087. */
  41088. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41089. /**
  41090. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41091. */
  41092. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41093. /** Callback called when a pointer move is detected */
  41094. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41095. /** Callback called when a pointer down is detected */
  41096. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41097. /** Callback called when a pointer up is detected */
  41098. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41099. /** Callback called when a pointer pick is detected */
  41100. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41101. /**
  41102. * 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).
  41103. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41104. */
  41105. onPrePointerObservable: Observable<PointerInfoPre>;
  41106. /**
  41107. * Observable event triggered each time an input event is received from the rendering canvas
  41108. */
  41109. onPointerObservable: Observable<PointerInfo>;
  41110. /**
  41111. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41112. */
  41113. get unTranslatedPointer(): Vector2;
  41114. /**
  41115. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41116. */
  41117. static get DragMovementThreshold(): number;
  41118. static set DragMovementThreshold(value: number);
  41119. /**
  41120. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41121. */
  41122. static get LongPressDelay(): number;
  41123. static set LongPressDelay(value: number);
  41124. /**
  41125. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41126. */
  41127. static get DoubleClickDelay(): number;
  41128. static set DoubleClickDelay(value: number);
  41129. /** If you need to check double click without raising a single click at first click, enable this flag */
  41130. static get ExclusiveDoubleClickMode(): boolean;
  41131. static set ExclusiveDoubleClickMode(value: boolean);
  41132. /** @hidden */
  41133. _mirroredCameraPosition: Nullable<Vector3>;
  41134. /**
  41135. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41136. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41137. */
  41138. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41139. /**
  41140. * Observable event triggered each time an keyboard event is received from the hosting window
  41141. */
  41142. onKeyboardObservable: Observable<KeyboardInfo>;
  41143. private _useRightHandedSystem;
  41144. /**
  41145. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41146. */
  41147. set useRightHandedSystem(value: boolean);
  41148. get useRightHandedSystem(): boolean;
  41149. private _timeAccumulator;
  41150. private _currentStepId;
  41151. private _currentInternalStep;
  41152. /**
  41153. * Sets the step Id used by deterministic lock step
  41154. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41155. * @param newStepId defines the step Id
  41156. */
  41157. setStepId(newStepId: number): void;
  41158. /**
  41159. * Gets the step Id used by deterministic lock step
  41160. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41161. * @returns the step Id
  41162. */
  41163. getStepId(): number;
  41164. /**
  41165. * Gets the internal step used by deterministic lock step
  41166. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41167. * @returns the internal step
  41168. */
  41169. getInternalStep(): number;
  41170. private _fogEnabled;
  41171. /**
  41172. * Gets or sets a boolean indicating if fog is enabled on this scene
  41173. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41174. * (Default is true)
  41175. */
  41176. set fogEnabled(value: boolean);
  41177. get fogEnabled(): boolean;
  41178. private _fogMode;
  41179. /**
  41180. * Gets or sets the fog mode to use
  41181. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41182. * | mode | value |
  41183. * | --- | --- |
  41184. * | FOGMODE_NONE | 0 |
  41185. * | FOGMODE_EXP | 1 |
  41186. * | FOGMODE_EXP2 | 2 |
  41187. * | FOGMODE_LINEAR | 3 |
  41188. */
  41189. set fogMode(value: number);
  41190. get fogMode(): number;
  41191. /**
  41192. * Gets or sets the fog color to use
  41193. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41194. * (Default is Color3(0.2, 0.2, 0.3))
  41195. */
  41196. fogColor: Color3;
  41197. /**
  41198. * Gets or sets the fog density to use
  41199. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41200. * (Default is 0.1)
  41201. */
  41202. fogDensity: number;
  41203. /**
  41204. * Gets or sets the fog start distance to use
  41205. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41206. * (Default is 0)
  41207. */
  41208. fogStart: number;
  41209. /**
  41210. * Gets or sets the fog end distance to use
  41211. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41212. * (Default is 1000)
  41213. */
  41214. fogEnd: number;
  41215. /**
  41216. * Flag indicating that the frame buffer binding is handled by another component
  41217. */
  41218. prePass: boolean;
  41219. private _shadowsEnabled;
  41220. /**
  41221. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41222. */
  41223. set shadowsEnabled(value: boolean);
  41224. get shadowsEnabled(): boolean;
  41225. private _lightsEnabled;
  41226. /**
  41227. * Gets or sets a boolean indicating if lights are enabled on this scene
  41228. */
  41229. set lightsEnabled(value: boolean);
  41230. get lightsEnabled(): boolean;
  41231. /** All of the active cameras added to this scene. */
  41232. activeCameras: Camera[];
  41233. /** @hidden */
  41234. _activeCamera: Nullable<Camera>;
  41235. /** Gets or sets the current active camera */
  41236. get activeCamera(): Nullable<Camera>;
  41237. set activeCamera(value: Nullable<Camera>);
  41238. private _defaultMaterial;
  41239. /** The default material used on meshes when no material is affected */
  41240. get defaultMaterial(): Material;
  41241. /** The default material used on meshes when no material is affected */
  41242. set defaultMaterial(value: Material);
  41243. private _texturesEnabled;
  41244. /**
  41245. * Gets or sets a boolean indicating if textures are enabled on this scene
  41246. */
  41247. set texturesEnabled(value: boolean);
  41248. get texturesEnabled(): boolean;
  41249. /**
  41250. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41251. */
  41252. physicsEnabled: boolean;
  41253. /**
  41254. * Gets or sets a boolean indicating if particles are enabled on this scene
  41255. */
  41256. particlesEnabled: boolean;
  41257. /**
  41258. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41259. */
  41260. spritesEnabled: boolean;
  41261. private _skeletonsEnabled;
  41262. /**
  41263. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41264. */
  41265. set skeletonsEnabled(value: boolean);
  41266. get skeletonsEnabled(): boolean;
  41267. /**
  41268. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41269. */
  41270. lensFlaresEnabled: boolean;
  41271. /**
  41272. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41273. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41274. */
  41275. collisionsEnabled: boolean;
  41276. private _collisionCoordinator;
  41277. /** @hidden */
  41278. get collisionCoordinator(): ICollisionCoordinator;
  41279. /**
  41280. * Defines the gravity applied to this scene (used only for collisions)
  41281. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41282. */
  41283. gravity: Vector3;
  41284. /**
  41285. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41286. */
  41287. postProcessesEnabled: boolean;
  41288. /**
  41289. * Gets the current postprocess manager
  41290. */
  41291. postProcessManager: PostProcessManager;
  41292. /**
  41293. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41294. */
  41295. renderTargetsEnabled: boolean;
  41296. /**
  41297. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41298. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41299. */
  41300. dumpNextRenderTargets: boolean;
  41301. /**
  41302. * The list of user defined render targets added to the scene
  41303. */
  41304. customRenderTargets: RenderTargetTexture[];
  41305. /**
  41306. * Defines if texture loading must be delayed
  41307. * If true, textures will only be loaded when they need to be rendered
  41308. */
  41309. useDelayedTextureLoading: boolean;
  41310. /**
  41311. * Gets the list of meshes imported to the scene through SceneLoader
  41312. */
  41313. importedMeshesFiles: String[];
  41314. /**
  41315. * Gets or sets a boolean indicating if probes are enabled on this scene
  41316. */
  41317. probesEnabled: boolean;
  41318. /**
  41319. * Gets or sets the current offline provider to use to store scene data
  41320. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41321. */
  41322. offlineProvider: IOfflineProvider;
  41323. /**
  41324. * Gets or sets the action manager associated with the scene
  41325. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41326. */
  41327. actionManager: AbstractActionManager;
  41328. private _meshesForIntersections;
  41329. /**
  41330. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41331. */
  41332. proceduralTexturesEnabled: boolean;
  41333. private _engine;
  41334. private _totalVertices;
  41335. /** @hidden */
  41336. _activeIndices: PerfCounter;
  41337. /** @hidden */
  41338. _activeParticles: PerfCounter;
  41339. /** @hidden */
  41340. _activeBones: PerfCounter;
  41341. private _animationRatio;
  41342. /** @hidden */
  41343. _animationTimeLast: number;
  41344. /** @hidden */
  41345. _animationTime: number;
  41346. /**
  41347. * Gets or sets a general scale for animation speed
  41348. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41349. */
  41350. animationTimeScale: number;
  41351. /** @hidden */
  41352. _cachedMaterial: Nullable<Material>;
  41353. /** @hidden */
  41354. _cachedEffect: Nullable<Effect>;
  41355. /** @hidden */
  41356. _cachedVisibility: Nullable<number>;
  41357. private _renderId;
  41358. private _frameId;
  41359. private _executeWhenReadyTimeoutId;
  41360. private _intermediateRendering;
  41361. private _viewUpdateFlag;
  41362. private _projectionUpdateFlag;
  41363. /** @hidden */
  41364. _toBeDisposed: Nullable<IDisposable>[];
  41365. private _activeRequests;
  41366. /** @hidden */
  41367. _pendingData: any[];
  41368. private _isDisposed;
  41369. /**
  41370. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41371. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41372. */
  41373. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41374. private _activeMeshes;
  41375. private _processedMaterials;
  41376. private _renderTargets;
  41377. /** @hidden */
  41378. _activeParticleSystems: SmartArray<IParticleSystem>;
  41379. private _activeSkeletons;
  41380. private _softwareSkinnedMeshes;
  41381. private _renderingManager;
  41382. /** @hidden */
  41383. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41384. private _transformMatrix;
  41385. private _sceneUbo;
  41386. /** @hidden */
  41387. _viewMatrix: Matrix;
  41388. private _projectionMatrix;
  41389. /** @hidden */
  41390. _forcedViewPosition: Nullable<Vector3>;
  41391. /** @hidden */
  41392. _frustumPlanes: Plane[];
  41393. /**
  41394. * Gets the list of frustum planes (built from the active camera)
  41395. */
  41396. get frustumPlanes(): Plane[];
  41397. /**
  41398. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41399. * This is useful if there are more lights that the maximum simulteanous authorized
  41400. */
  41401. requireLightSorting: boolean;
  41402. /** @hidden */
  41403. readonly useMaterialMeshMap: boolean;
  41404. /** @hidden */
  41405. readonly useClonedMeshMap: boolean;
  41406. private _externalData;
  41407. private _uid;
  41408. /**
  41409. * @hidden
  41410. * Backing store of defined scene components.
  41411. */
  41412. _components: ISceneComponent[];
  41413. /**
  41414. * @hidden
  41415. * Backing store of defined scene components.
  41416. */
  41417. _serializableComponents: ISceneSerializableComponent[];
  41418. /**
  41419. * List of components to register on the next registration step.
  41420. */
  41421. private _transientComponents;
  41422. /**
  41423. * Registers the transient components if needed.
  41424. */
  41425. private _registerTransientComponents;
  41426. /**
  41427. * @hidden
  41428. * Add a component to the scene.
  41429. * Note that the ccomponent could be registered on th next frame if this is called after
  41430. * the register component stage.
  41431. * @param component Defines the component to add to the scene
  41432. */
  41433. _addComponent(component: ISceneComponent): void;
  41434. /**
  41435. * @hidden
  41436. * Gets a component from the scene.
  41437. * @param name defines the name of the component to retrieve
  41438. * @returns the component or null if not present
  41439. */
  41440. _getComponent(name: string): Nullable<ISceneComponent>;
  41441. /**
  41442. * @hidden
  41443. * Defines the actions happening before camera updates.
  41444. */
  41445. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41446. /**
  41447. * @hidden
  41448. * Defines the actions happening before clear the canvas.
  41449. */
  41450. _beforeClearStage: Stage<SimpleStageAction>;
  41451. /**
  41452. * @hidden
  41453. * Defines the actions when collecting render targets for the frame.
  41454. */
  41455. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41456. /**
  41457. * @hidden
  41458. * Defines the actions happening for one camera in the frame.
  41459. */
  41460. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41461. /**
  41462. * @hidden
  41463. * Defines the actions happening during the per mesh ready checks.
  41464. */
  41465. _isReadyForMeshStage: Stage<MeshStageAction>;
  41466. /**
  41467. * @hidden
  41468. * Defines the actions happening before evaluate active mesh checks.
  41469. */
  41470. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41471. /**
  41472. * @hidden
  41473. * Defines the actions happening during the evaluate sub mesh checks.
  41474. */
  41475. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41476. /**
  41477. * @hidden
  41478. * Defines the actions happening during the active mesh stage.
  41479. */
  41480. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41481. /**
  41482. * @hidden
  41483. * Defines the actions happening during the per camera render target step.
  41484. */
  41485. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41486. /**
  41487. * @hidden
  41488. * Defines the actions happening just before the active camera is drawing.
  41489. */
  41490. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41491. /**
  41492. * @hidden
  41493. * Defines the actions happening just before a render target is drawing.
  41494. */
  41495. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41496. /**
  41497. * @hidden
  41498. * Defines the actions happening just before a rendering group is drawing.
  41499. */
  41500. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41501. /**
  41502. * @hidden
  41503. * Defines the actions happening just before a mesh is drawing.
  41504. */
  41505. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41506. /**
  41507. * @hidden
  41508. * Defines the actions happening just after a mesh has been drawn.
  41509. */
  41510. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41511. /**
  41512. * @hidden
  41513. * Defines the actions happening just after a rendering group has been drawn.
  41514. */
  41515. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41516. /**
  41517. * @hidden
  41518. * Defines the actions happening just after the active camera has been drawn.
  41519. */
  41520. _afterCameraDrawStage: Stage<CameraStageAction>;
  41521. /**
  41522. * @hidden
  41523. * Defines the actions happening just after a render target has been drawn.
  41524. */
  41525. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41526. /**
  41527. * @hidden
  41528. * Defines the actions happening just after rendering all cameras and computing intersections.
  41529. */
  41530. _afterRenderStage: Stage<SimpleStageAction>;
  41531. /**
  41532. * @hidden
  41533. * Defines the actions happening when a pointer move event happens.
  41534. */
  41535. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41536. /**
  41537. * @hidden
  41538. * Defines the actions happening when a pointer down event happens.
  41539. */
  41540. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41541. /**
  41542. * @hidden
  41543. * Defines the actions happening when a pointer up event happens.
  41544. */
  41545. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41546. /**
  41547. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41548. */
  41549. private geometriesByUniqueId;
  41550. /**
  41551. * Creates a new Scene
  41552. * @param engine defines the engine to use to render this scene
  41553. * @param options defines the scene options
  41554. */
  41555. constructor(engine: Engine, options?: SceneOptions);
  41556. /**
  41557. * Gets a string identifying the name of the class
  41558. * @returns "Scene" string
  41559. */
  41560. getClassName(): string;
  41561. private _defaultMeshCandidates;
  41562. /**
  41563. * @hidden
  41564. */
  41565. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41566. private _defaultSubMeshCandidates;
  41567. /**
  41568. * @hidden
  41569. */
  41570. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41571. /**
  41572. * Sets the default candidate providers for the scene.
  41573. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41574. * and getCollidingSubMeshCandidates to their default function
  41575. */
  41576. setDefaultCandidateProviders(): void;
  41577. /**
  41578. * Gets the mesh that is currently under the pointer
  41579. */
  41580. get meshUnderPointer(): Nullable<AbstractMesh>;
  41581. /**
  41582. * Gets or sets the current on-screen X position of the pointer
  41583. */
  41584. get pointerX(): number;
  41585. set pointerX(value: number);
  41586. /**
  41587. * Gets or sets the current on-screen Y position of the pointer
  41588. */
  41589. get pointerY(): number;
  41590. set pointerY(value: number);
  41591. /**
  41592. * Gets the cached material (ie. the latest rendered one)
  41593. * @returns the cached material
  41594. */
  41595. getCachedMaterial(): Nullable<Material>;
  41596. /**
  41597. * Gets the cached effect (ie. the latest rendered one)
  41598. * @returns the cached effect
  41599. */
  41600. getCachedEffect(): Nullable<Effect>;
  41601. /**
  41602. * Gets the cached visibility state (ie. the latest rendered one)
  41603. * @returns the cached visibility state
  41604. */
  41605. getCachedVisibility(): Nullable<number>;
  41606. /**
  41607. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41608. * @param material defines the current material
  41609. * @param effect defines the current effect
  41610. * @param visibility defines the current visibility state
  41611. * @returns true if one parameter is not cached
  41612. */
  41613. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41614. /**
  41615. * Gets the engine associated with the scene
  41616. * @returns an Engine
  41617. */
  41618. getEngine(): Engine;
  41619. /**
  41620. * Gets the total number of vertices rendered per frame
  41621. * @returns the total number of vertices rendered per frame
  41622. */
  41623. getTotalVertices(): number;
  41624. /**
  41625. * Gets the performance counter for total vertices
  41626. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41627. */
  41628. get totalVerticesPerfCounter(): PerfCounter;
  41629. /**
  41630. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41631. * @returns the total number of active indices rendered per frame
  41632. */
  41633. getActiveIndices(): number;
  41634. /**
  41635. * Gets the performance counter for active indices
  41636. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41637. */
  41638. get totalActiveIndicesPerfCounter(): PerfCounter;
  41639. /**
  41640. * Gets the total number of active particles rendered per frame
  41641. * @returns the total number of active particles rendered per frame
  41642. */
  41643. getActiveParticles(): number;
  41644. /**
  41645. * Gets the performance counter for active particles
  41646. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41647. */
  41648. get activeParticlesPerfCounter(): PerfCounter;
  41649. /**
  41650. * Gets the total number of active bones rendered per frame
  41651. * @returns the total number of active bones rendered per frame
  41652. */
  41653. getActiveBones(): number;
  41654. /**
  41655. * Gets the performance counter for active bones
  41656. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41657. */
  41658. get activeBonesPerfCounter(): PerfCounter;
  41659. /**
  41660. * Gets the array of active meshes
  41661. * @returns an array of AbstractMesh
  41662. */
  41663. getActiveMeshes(): SmartArray<AbstractMesh>;
  41664. /**
  41665. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41666. * @returns a number
  41667. */
  41668. getAnimationRatio(): number;
  41669. /**
  41670. * Gets an unique Id for the current render phase
  41671. * @returns a number
  41672. */
  41673. getRenderId(): number;
  41674. /**
  41675. * Gets an unique Id for the current frame
  41676. * @returns a number
  41677. */
  41678. getFrameId(): number;
  41679. /** Call this function if you want to manually increment the render Id*/
  41680. incrementRenderId(): void;
  41681. private _createUbo;
  41682. /**
  41683. * Use this method to simulate a pointer move on a mesh
  41684. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41685. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41686. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41687. * @returns the current scene
  41688. */
  41689. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41690. /**
  41691. * Use this method to simulate a pointer down on a mesh
  41692. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41693. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41694. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41695. * @returns the current scene
  41696. */
  41697. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41698. /**
  41699. * Use this method to simulate a pointer up on a mesh
  41700. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41701. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41702. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41703. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41704. * @returns the current scene
  41705. */
  41706. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41707. /**
  41708. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41709. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41710. * @returns true if the pointer was captured
  41711. */
  41712. isPointerCaptured(pointerId?: number): boolean;
  41713. /**
  41714. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41715. * @param attachUp defines if you want to attach events to pointerup
  41716. * @param attachDown defines if you want to attach events to pointerdown
  41717. * @param attachMove defines if you want to attach events to pointermove
  41718. */
  41719. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41720. /** Detaches all event handlers*/
  41721. detachControl(): void;
  41722. /**
  41723. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41724. * Delay loaded resources are not taking in account
  41725. * @return true if all required resources are ready
  41726. */
  41727. isReady(): boolean;
  41728. /** Resets all cached information relative to material (including effect and visibility) */
  41729. resetCachedMaterial(): void;
  41730. /**
  41731. * Registers a function to be called before every frame render
  41732. * @param func defines the function to register
  41733. */
  41734. registerBeforeRender(func: () => void): void;
  41735. /**
  41736. * Unregisters a function called before every frame render
  41737. * @param func defines the function to unregister
  41738. */
  41739. unregisterBeforeRender(func: () => void): void;
  41740. /**
  41741. * Registers a function to be called after every frame render
  41742. * @param func defines the function to register
  41743. */
  41744. registerAfterRender(func: () => void): void;
  41745. /**
  41746. * Unregisters a function called after every frame render
  41747. * @param func defines the function to unregister
  41748. */
  41749. unregisterAfterRender(func: () => void): void;
  41750. private _executeOnceBeforeRender;
  41751. /**
  41752. * The provided function will run before render once and will be disposed afterwards.
  41753. * A timeout delay can be provided so that the function will be executed in N ms.
  41754. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41755. * @param func The function to be executed.
  41756. * @param timeout optional delay in ms
  41757. */
  41758. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41759. /** @hidden */
  41760. _addPendingData(data: any): void;
  41761. /** @hidden */
  41762. _removePendingData(data: any): void;
  41763. /**
  41764. * Returns the number of items waiting to be loaded
  41765. * @returns the number of items waiting to be loaded
  41766. */
  41767. getWaitingItemsCount(): number;
  41768. /**
  41769. * Returns a boolean indicating if the scene is still loading data
  41770. */
  41771. get isLoading(): boolean;
  41772. /**
  41773. * Registers a function to be executed when the scene is ready
  41774. * @param {Function} func - the function to be executed
  41775. */
  41776. executeWhenReady(func: () => void): void;
  41777. /**
  41778. * Returns a promise that resolves when the scene is ready
  41779. * @returns A promise that resolves when the scene is ready
  41780. */
  41781. whenReadyAsync(): Promise<void>;
  41782. /** @hidden */
  41783. _checkIsReady(): void;
  41784. /**
  41785. * Gets all animatable attached to the scene
  41786. */
  41787. get animatables(): Animatable[];
  41788. /**
  41789. * Resets the last animation time frame.
  41790. * Useful to override when animations start running when loading a scene for the first time.
  41791. */
  41792. resetLastAnimationTimeFrame(): void;
  41793. /**
  41794. * Gets the current view matrix
  41795. * @returns a Matrix
  41796. */
  41797. getViewMatrix(): Matrix;
  41798. /**
  41799. * Gets the current projection matrix
  41800. * @returns a Matrix
  41801. */
  41802. getProjectionMatrix(): Matrix;
  41803. /**
  41804. * Gets the current transform matrix
  41805. * @returns a Matrix made of View * Projection
  41806. */
  41807. getTransformMatrix(): Matrix;
  41808. /**
  41809. * Sets the current transform matrix
  41810. * @param viewL defines the View matrix to use
  41811. * @param projectionL defines the Projection matrix to use
  41812. * @param viewR defines the right View matrix to use (if provided)
  41813. * @param projectionR defines the right Projection matrix to use (if provided)
  41814. */
  41815. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41816. /**
  41817. * Gets the uniform buffer used to store scene data
  41818. * @returns a UniformBuffer
  41819. */
  41820. getSceneUniformBuffer(): UniformBuffer;
  41821. /**
  41822. * Gets an unique (relatively to the current scene) Id
  41823. * @returns an unique number for the scene
  41824. */
  41825. getUniqueId(): number;
  41826. /**
  41827. * Add a mesh to the list of scene's meshes
  41828. * @param newMesh defines the mesh to add
  41829. * @param recursive if all child meshes should also be added to the scene
  41830. */
  41831. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41832. /**
  41833. * Remove a mesh for the list of scene's meshes
  41834. * @param toRemove defines the mesh to remove
  41835. * @param recursive if all child meshes should also be removed from the scene
  41836. * @returns the index where the mesh was in the mesh list
  41837. */
  41838. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41839. /**
  41840. * Add a transform node to the list of scene's transform nodes
  41841. * @param newTransformNode defines the transform node to add
  41842. */
  41843. addTransformNode(newTransformNode: TransformNode): void;
  41844. /**
  41845. * Remove a transform node for the list of scene's transform nodes
  41846. * @param toRemove defines the transform node to remove
  41847. * @returns the index where the transform node was in the transform node list
  41848. */
  41849. removeTransformNode(toRemove: TransformNode): number;
  41850. /**
  41851. * Remove a skeleton for the list of scene's skeletons
  41852. * @param toRemove defines the skeleton to remove
  41853. * @returns the index where the skeleton was in the skeleton list
  41854. */
  41855. removeSkeleton(toRemove: Skeleton): number;
  41856. /**
  41857. * Remove a morph target for the list of scene's morph targets
  41858. * @param toRemove defines the morph target to remove
  41859. * @returns the index where the morph target was in the morph target list
  41860. */
  41861. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41862. /**
  41863. * Remove a light for the list of scene's lights
  41864. * @param toRemove defines the light to remove
  41865. * @returns the index where the light was in the light list
  41866. */
  41867. removeLight(toRemove: Light): number;
  41868. /**
  41869. * Remove a camera for the list of scene's cameras
  41870. * @param toRemove defines the camera to remove
  41871. * @returns the index where the camera was in the camera list
  41872. */
  41873. removeCamera(toRemove: Camera): number;
  41874. /**
  41875. * Remove a particle system for the list of scene's particle systems
  41876. * @param toRemove defines the particle system to remove
  41877. * @returns the index where the particle system was in the particle system list
  41878. */
  41879. removeParticleSystem(toRemove: IParticleSystem): number;
  41880. /**
  41881. * Remove a animation for the list of scene's animations
  41882. * @param toRemove defines the animation to remove
  41883. * @returns the index where the animation was in the animation list
  41884. */
  41885. removeAnimation(toRemove: Animation): number;
  41886. /**
  41887. * Will stop the animation of the given target
  41888. * @param target - the target
  41889. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41890. * @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)
  41891. */
  41892. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41893. /**
  41894. * Removes the given animation group from this scene.
  41895. * @param toRemove The animation group to remove
  41896. * @returns The index of the removed animation group
  41897. */
  41898. removeAnimationGroup(toRemove: AnimationGroup): number;
  41899. /**
  41900. * Removes the given multi-material from this scene.
  41901. * @param toRemove The multi-material to remove
  41902. * @returns The index of the removed multi-material
  41903. */
  41904. removeMultiMaterial(toRemove: MultiMaterial): number;
  41905. /**
  41906. * Removes the given material from this scene.
  41907. * @param toRemove The material to remove
  41908. * @returns The index of the removed material
  41909. */
  41910. removeMaterial(toRemove: Material): number;
  41911. /**
  41912. * Removes the given action manager from this scene.
  41913. * @param toRemove The action manager to remove
  41914. * @returns The index of the removed action manager
  41915. */
  41916. removeActionManager(toRemove: AbstractActionManager): number;
  41917. /**
  41918. * Removes the given texture from this scene.
  41919. * @param toRemove The texture to remove
  41920. * @returns The index of the removed texture
  41921. */
  41922. removeTexture(toRemove: BaseTexture): number;
  41923. /**
  41924. * Adds the given light to this scene
  41925. * @param newLight The light to add
  41926. */
  41927. addLight(newLight: Light): void;
  41928. /**
  41929. * Sorts the list list based on light priorities
  41930. */
  41931. sortLightsByPriority(): void;
  41932. /**
  41933. * Adds the given camera to this scene
  41934. * @param newCamera The camera to add
  41935. */
  41936. addCamera(newCamera: Camera): void;
  41937. /**
  41938. * Adds the given skeleton to this scene
  41939. * @param newSkeleton The skeleton to add
  41940. */
  41941. addSkeleton(newSkeleton: Skeleton): void;
  41942. /**
  41943. * Adds the given particle system to this scene
  41944. * @param newParticleSystem The particle system to add
  41945. */
  41946. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41947. /**
  41948. * Adds the given animation to this scene
  41949. * @param newAnimation The animation to add
  41950. */
  41951. addAnimation(newAnimation: Animation): void;
  41952. /**
  41953. * Adds the given animation group to this scene.
  41954. * @param newAnimationGroup The animation group to add
  41955. */
  41956. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41957. /**
  41958. * Adds the given multi-material to this scene
  41959. * @param newMultiMaterial The multi-material to add
  41960. */
  41961. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41962. /**
  41963. * Adds the given material to this scene
  41964. * @param newMaterial The material to add
  41965. */
  41966. addMaterial(newMaterial: Material): void;
  41967. /**
  41968. * Adds the given morph target to this scene
  41969. * @param newMorphTargetManager The morph target to add
  41970. */
  41971. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41972. /**
  41973. * Adds the given geometry to this scene
  41974. * @param newGeometry The geometry to add
  41975. */
  41976. addGeometry(newGeometry: Geometry): void;
  41977. /**
  41978. * Adds the given action manager to this scene
  41979. * @param newActionManager The action manager to add
  41980. */
  41981. addActionManager(newActionManager: AbstractActionManager): void;
  41982. /**
  41983. * Adds the given texture to this scene.
  41984. * @param newTexture The texture to add
  41985. */
  41986. addTexture(newTexture: BaseTexture): void;
  41987. /**
  41988. * Switch active camera
  41989. * @param newCamera defines the new active camera
  41990. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  41991. */
  41992. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  41993. /**
  41994. * sets the active camera of the scene using its ID
  41995. * @param id defines the camera's ID
  41996. * @return the new active camera or null if none found.
  41997. */
  41998. setActiveCameraByID(id: string): Nullable<Camera>;
  41999. /**
  42000. * sets the active camera of the scene using its name
  42001. * @param name defines the camera's name
  42002. * @returns the new active camera or null if none found.
  42003. */
  42004. setActiveCameraByName(name: string): Nullable<Camera>;
  42005. /**
  42006. * get an animation group using its name
  42007. * @param name defines the material's name
  42008. * @return the animation group or null if none found.
  42009. */
  42010. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  42011. /**
  42012. * Get a material using its unique id
  42013. * @param uniqueId defines the material's unique id
  42014. * @return the material or null if none found.
  42015. */
  42016. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42017. /**
  42018. * get a material using its id
  42019. * @param id defines the material's ID
  42020. * @return the material or null if none found.
  42021. */
  42022. getMaterialByID(id: string): Nullable<Material>;
  42023. /**
  42024. * Gets a the last added material using a given id
  42025. * @param id defines the material's ID
  42026. * @return the last material with the given id or null if none found.
  42027. */
  42028. getLastMaterialByID(id: string): Nullable<Material>;
  42029. /**
  42030. * Gets a material using its name
  42031. * @param name defines the material's name
  42032. * @return the material or null if none found.
  42033. */
  42034. getMaterialByName(name: string): Nullable<Material>;
  42035. /**
  42036. * Get a texture using its unique id
  42037. * @param uniqueId defines the texture's unique id
  42038. * @return the texture or null if none found.
  42039. */
  42040. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42041. /**
  42042. * Gets a camera using its id
  42043. * @param id defines the id to look for
  42044. * @returns the camera or null if not found
  42045. */
  42046. getCameraByID(id: string): Nullable<Camera>;
  42047. /**
  42048. * Gets a camera using its unique id
  42049. * @param uniqueId defines the unique id to look for
  42050. * @returns the camera or null if not found
  42051. */
  42052. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42053. /**
  42054. * Gets a camera using its name
  42055. * @param name defines the camera's name
  42056. * @return the camera or null if none found.
  42057. */
  42058. getCameraByName(name: string): Nullable<Camera>;
  42059. /**
  42060. * Gets a bone using its id
  42061. * @param id defines the bone's id
  42062. * @return the bone or null if not found
  42063. */
  42064. getBoneByID(id: string): Nullable<Bone>;
  42065. /**
  42066. * Gets a bone using its id
  42067. * @param name defines the bone's name
  42068. * @return the bone or null if not found
  42069. */
  42070. getBoneByName(name: string): Nullable<Bone>;
  42071. /**
  42072. * Gets a light node using its name
  42073. * @param name defines the the light's name
  42074. * @return the light or null if none found.
  42075. */
  42076. getLightByName(name: string): Nullable<Light>;
  42077. /**
  42078. * Gets a light node using its id
  42079. * @param id defines the light's id
  42080. * @return the light or null if none found.
  42081. */
  42082. getLightByID(id: string): Nullable<Light>;
  42083. /**
  42084. * Gets a light node using its scene-generated unique ID
  42085. * @param uniqueId defines the light's unique id
  42086. * @return the light or null if none found.
  42087. */
  42088. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42089. /**
  42090. * Gets a particle system by id
  42091. * @param id defines the particle system id
  42092. * @return the corresponding system or null if none found
  42093. */
  42094. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42095. /**
  42096. * Gets a geometry using its ID
  42097. * @param id defines the geometry's id
  42098. * @return the geometry or null if none found.
  42099. */
  42100. getGeometryByID(id: string): Nullable<Geometry>;
  42101. private _getGeometryByUniqueID;
  42102. /**
  42103. * Add a new geometry to this scene
  42104. * @param geometry defines the geometry to be added to the scene.
  42105. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42106. * @return a boolean defining if the geometry was added or not
  42107. */
  42108. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42109. /**
  42110. * Removes an existing geometry
  42111. * @param geometry defines the geometry to be removed from the scene
  42112. * @return a boolean defining if the geometry was removed or not
  42113. */
  42114. removeGeometry(geometry: Geometry): boolean;
  42115. /**
  42116. * Gets the list of geometries attached to the scene
  42117. * @returns an array of Geometry
  42118. */
  42119. getGeometries(): Geometry[];
  42120. /**
  42121. * Gets the first added mesh found of a given ID
  42122. * @param id defines the id to search for
  42123. * @return the mesh found or null if not found at all
  42124. */
  42125. getMeshByID(id: string): Nullable<AbstractMesh>;
  42126. /**
  42127. * Gets a list of meshes using their id
  42128. * @param id defines the id to search for
  42129. * @returns a list of meshes
  42130. */
  42131. getMeshesByID(id: string): Array<AbstractMesh>;
  42132. /**
  42133. * Gets the first added transform node found of a given ID
  42134. * @param id defines the id to search for
  42135. * @return the found transform node or null if not found at all.
  42136. */
  42137. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42138. /**
  42139. * Gets a transform node with its auto-generated unique id
  42140. * @param uniqueId efines the unique id to search for
  42141. * @return the found transform node or null if not found at all.
  42142. */
  42143. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42144. /**
  42145. * Gets a list of transform nodes using their id
  42146. * @param id defines the id to search for
  42147. * @returns a list of transform nodes
  42148. */
  42149. getTransformNodesByID(id: string): Array<TransformNode>;
  42150. /**
  42151. * Gets a mesh with its auto-generated unique id
  42152. * @param uniqueId defines the unique id to search for
  42153. * @return the found mesh or null if not found at all.
  42154. */
  42155. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42156. /**
  42157. * Gets a the last added mesh using a given id
  42158. * @param id defines the id to search for
  42159. * @return the found mesh or null if not found at all.
  42160. */
  42161. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42162. /**
  42163. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42164. * @param id defines the id to search for
  42165. * @return the found node or null if not found at all
  42166. */
  42167. getLastEntryByID(id: string): Nullable<Node>;
  42168. /**
  42169. * Gets a node (Mesh, Camera, Light) using a given id
  42170. * @param id defines the id to search for
  42171. * @return the found node or null if not found at all
  42172. */
  42173. getNodeByID(id: string): Nullable<Node>;
  42174. /**
  42175. * Gets a node (Mesh, Camera, Light) using a given name
  42176. * @param name defines the name to search for
  42177. * @return the found node or null if not found at all.
  42178. */
  42179. getNodeByName(name: string): Nullable<Node>;
  42180. /**
  42181. * Gets a mesh using a given name
  42182. * @param name defines the name to search for
  42183. * @return the found mesh or null if not found at all.
  42184. */
  42185. getMeshByName(name: string): Nullable<AbstractMesh>;
  42186. /**
  42187. * Gets a transform node using a given name
  42188. * @param name defines the name to search for
  42189. * @return the found transform node or null if not found at all.
  42190. */
  42191. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42192. /**
  42193. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42194. * @param id defines the id to search for
  42195. * @return the found skeleton or null if not found at all.
  42196. */
  42197. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42198. /**
  42199. * Gets a skeleton using a given auto generated unique id
  42200. * @param uniqueId defines the unique id to search for
  42201. * @return the found skeleton or null if not found at all.
  42202. */
  42203. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42204. /**
  42205. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42206. * @param id defines the id to search for
  42207. * @return the found skeleton or null if not found at all.
  42208. */
  42209. getSkeletonById(id: string): Nullable<Skeleton>;
  42210. /**
  42211. * Gets a skeleton using a given name
  42212. * @param name defines the name to search for
  42213. * @return the found skeleton or null if not found at all.
  42214. */
  42215. getSkeletonByName(name: string): Nullable<Skeleton>;
  42216. /**
  42217. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42218. * @param id defines the id to search for
  42219. * @return the found morph target manager or null if not found at all.
  42220. */
  42221. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42222. /**
  42223. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42224. * @param id defines the id to search for
  42225. * @return the found morph target or null if not found at all.
  42226. */
  42227. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42228. /**
  42229. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42230. * @param name defines the name to search for
  42231. * @return the found morph target or null if not found at all.
  42232. */
  42233. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42234. /**
  42235. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42236. * @param name defines the name to search for
  42237. * @return the found post process or null if not found at all.
  42238. */
  42239. getPostProcessByName(name: string): Nullable<PostProcess>;
  42240. /**
  42241. * Gets a boolean indicating if the given mesh is active
  42242. * @param mesh defines the mesh to look for
  42243. * @returns true if the mesh is in the active list
  42244. */
  42245. isActiveMesh(mesh: AbstractMesh): boolean;
  42246. /**
  42247. * Return a unique id as a string which can serve as an identifier for the scene
  42248. */
  42249. get uid(): string;
  42250. /**
  42251. * Add an externaly attached data from its key.
  42252. * This method call will fail and return false, if such key already exists.
  42253. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42254. * @param key the unique key that identifies the data
  42255. * @param data the data object to associate to the key for this Engine instance
  42256. * @return true if no such key were already present and the data was added successfully, false otherwise
  42257. */
  42258. addExternalData<T>(key: string, data: T): boolean;
  42259. /**
  42260. * Get an externaly attached data from its key
  42261. * @param key the unique key that identifies the data
  42262. * @return the associated data, if present (can be null), or undefined if not present
  42263. */
  42264. getExternalData<T>(key: string): Nullable<T>;
  42265. /**
  42266. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42267. * @param key the unique key that identifies the data
  42268. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42269. * @return the associated data, can be null if the factory returned null.
  42270. */
  42271. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42272. /**
  42273. * Remove an externaly attached data from the Engine instance
  42274. * @param key the unique key that identifies the data
  42275. * @return true if the data was successfully removed, false if it doesn't exist
  42276. */
  42277. removeExternalData(key: string): boolean;
  42278. private _evaluateSubMesh;
  42279. /**
  42280. * Clear the processed materials smart array preventing retention point in material dispose.
  42281. */
  42282. freeProcessedMaterials(): void;
  42283. private _preventFreeActiveMeshesAndRenderingGroups;
  42284. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42285. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42286. * when disposing several meshes in a row or a hierarchy of meshes.
  42287. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42288. */
  42289. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42290. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42291. /**
  42292. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42293. */
  42294. freeActiveMeshes(): void;
  42295. /**
  42296. * Clear the info related to rendering groups preventing retention points during dispose.
  42297. */
  42298. freeRenderingGroups(): void;
  42299. /** @hidden */
  42300. _isInIntermediateRendering(): boolean;
  42301. /**
  42302. * Lambda returning the list of potentially active meshes.
  42303. */
  42304. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42305. /**
  42306. * Lambda returning the list of potentially active sub meshes.
  42307. */
  42308. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42309. /**
  42310. * Lambda returning the list of potentially intersecting sub meshes.
  42311. */
  42312. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42313. /**
  42314. * Lambda returning the list of potentially colliding sub meshes.
  42315. */
  42316. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42317. private _activeMeshesFrozen;
  42318. private _skipEvaluateActiveMeshesCompletely;
  42319. /**
  42320. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42321. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42322. * @returns the current scene
  42323. */
  42324. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42325. /**
  42326. * Use this function to restart evaluating active meshes on every frame
  42327. * @returns the current scene
  42328. */
  42329. unfreezeActiveMeshes(): Scene;
  42330. private _evaluateActiveMeshes;
  42331. private _activeMesh;
  42332. /**
  42333. * Update the transform matrix to update from the current active camera
  42334. * @param force defines a boolean used to force the update even if cache is up to date
  42335. */
  42336. updateTransformMatrix(force?: boolean): void;
  42337. private _bindFrameBuffer;
  42338. /** @hidden */
  42339. _allowPostProcessClearColor: boolean;
  42340. /** @hidden */
  42341. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42342. private _processSubCameras;
  42343. private _checkIntersections;
  42344. /** @hidden */
  42345. _advancePhysicsEngineStep(step: number): void;
  42346. /**
  42347. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42348. */
  42349. getDeterministicFrameTime: () => number;
  42350. /** @hidden */
  42351. _animate(): void;
  42352. /** Execute all animations (for a frame) */
  42353. animate(): void;
  42354. /**
  42355. * Render the scene
  42356. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42357. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42358. */
  42359. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42360. /**
  42361. * Freeze all materials
  42362. * A frozen material will not be updatable but should be faster to render
  42363. */
  42364. freezeMaterials(): void;
  42365. /**
  42366. * Unfreeze all materials
  42367. * A frozen material will not be updatable but should be faster to render
  42368. */
  42369. unfreezeMaterials(): void;
  42370. /**
  42371. * Releases all held ressources
  42372. */
  42373. dispose(): void;
  42374. /**
  42375. * Gets if the scene is already disposed
  42376. */
  42377. get isDisposed(): boolean;
  42378. /**
  42379. * Call this function to reduce memory footprint of the scene.
  42380. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42381. */
  42382. clearCachedVertexData(): void;
  42383. /**
  42384. * This function will remove the local cached buffer data from texture.
  42385. * It will save memory but will prevent the texture from being rebuilt
  42386. */
  42387. cleanCachedTextureBuffer(): void;
  42388. /**
  42389. * Get the world extend vectors with an optional filter
  42390. *
  42391. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42392. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42393. */
  42394. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42395. min: Vector3;
  42396. max: Vector3;
  42397. };
  42398. /**
  42399. * Creates a ray that can be used to pick in the scene
  42400. * @param x defines the x coordinate of the origin (on-screen)
  42401. * @param y defines the y coordinate of the origin (on-screen)
  42402. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42403. * @param camera defines the camera to use for the picking
  42404. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42405. * @returns a Ray
  42406. */
  42407. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42408. /**
  42409. * Creates a ray that can be used to pick in the scene
  42410. * @param x defines the x coordinate of the origin (on-screen)
  42411. * @param y defines the y coordinate of the origin (on-screen)
  42412. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42413. * @param result defines the ray where to store the picking ray
  42414. * @param camera defines the camera to use for the picking
  42415. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42416. * @returns the current scene
  42417. */
  42418. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42419. /**
  42420. * Creates a ray that can be used to pick in the scene
  42421. * @param x defines the x coordinate of the origin (on-screen)
  42422. * @param y defines the y coordinate of the origin (on-screen)
  42423. * @param camera defines the camera to use for the picking
  42424. * @returns a Ray
  42425. */
  42426. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42427. /**
  42428. * Creates a ray that can be used to pick in the scene
  42429. * @param x defines the x coordinate of the origin (on-screen)
  42430. * @param y defines the y coordinate of the origin (on-screen)
  42431. * @param result defines the ray where to store the picking ray
  42432. * @param camera defines the camera to use for the picking
  42433. * @returns the current scene
  42434. */
  42435. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42436. /** Launch a ray to try to pick a mesh in the scene
  42437. * @param x position on screen
  42438. * @param y position on screen
  42439. * @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
  42440. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42441. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42442. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42443. * @returns a PickingInfo
  42444. */
  42445. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42446. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42447. * @param x position on screen
  42448. * @param y position on screen
  42449. * @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
  42450. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42451. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42452. * @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)
  42453. */
  42454. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42455. /** Use the given ray to pick a mesh in the scene
  42456. * @param ray The ray to use to pick meshes
  42457. * @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
  42458. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42459. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42460. * @returns a PickingInfo
  42461. */
  42462. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42463. /**
  42464. * Launch a ray to try to pick a mesh in the scene
  42465. * @param x X position on screen
  42466. * @param y Y position on screen
  42467. * @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
  42468. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42469. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42470. * @returns an array of PickingInfo
  42471. */
  42472. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42473. /**
  42474. * Launch a ray to try to pick a mesh in the scene
  42475. * @param ray Ray to use
  42476. * @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
  42477. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42478. * @returns an array of PickingInfo
  42479. */
  42480. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42481. /**
  42482. * Force the value of meshUnderPointer
  42483. * @param mesh defines the mesh to use
  42484. */
  42485. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  42486. /**
  42487. * Gets the mesh under the pointer
  42488. * @returns a Mesh or null if no mesh is under the pointer
  42489. */
  42490. getPointerOverMesh(): Nullable<AbstractMesh>;
  42491. /** @hidden */
  42492. _rebuildGeometries(): void;
  42493. /** @hidden */
  42494. _rebuildTextures(): void;
  42495. private _getByTags;
  42496. /**
  42497. * Get a list of meshes by tags
  42498. * @param tagsQuery defines the tags query to use
  42499. * @param forEach defines a predicate used to filter results
  42500. * @returns an array of Mesh
  42501. */
  42502. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42503. /**
  42504. * Get a list of cameras by tags
  42505. * @param tagsQuery defines the tags query to use
  42506. * @param forEach defines a predicate used to filter results
  42507. * @returns an array of Camera
  42508. */
  42509. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42510. /**
  42511. * Get a list of lights by tags
  42512. * @param tagsQuery defines the tags query to use
  42513. * @param forEach defines a predicate used to filter results
  42514. * @returns an array of Light
  42515. */
  42516. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42517. /**
  42518. * Get a list of materials by tags
  42519. * @param tagsQuery defines the tags query to use
  42520. * @param forEach defines a predicate used to filter results
  42521. * @returns an array of Material
  42522. */
  42523. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42524. /**
  42525. * Get a list of transform nodes by tags
  42526. * @param tagsQuery defines the tags query to use
  42527. * @param forEach defines a predicate used to filter results
  42528. * @returns an array of TransformNode
  42529. */
  42530. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  42531. /**
  42532. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42533. * This allowed control for front to back rendering or reversly depending of the special needs.
  42534. *
  42535. * @param renderingGroupId The rendering group id corresponding to its index
  42536. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42537. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42538. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42539. */
  42540. 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;
  42541. /**
  42542. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42543. *
  42544. * @param renderingGroupId The rendering group id corresponding to its index
  42545. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42546. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42547. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42548. */
  42549. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42550. /**
  42551. * Gets the current auto clear configuration for one rendering group of the rendering
  42552. * manager.
  42553. * @param index the rendering group index to get the information for
  42554. * @returns The auto clear setup for the requested rendering group
  42555. */
  42556. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42557. private _blockMaterialDirtyMechanism;
  42558. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42559. get blockMaterialDirtyMechanism(): boolean;
  42560. set blockMaterialDirtyMechanism(value: boolean);
  42561. /**
  42562. * Will flag all materials as dirty to trigger new shader compilation
  42563. * @param flag defines the flag used to specify which material part must be marked as dirty
  42564. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42565. */
  42566. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42567. /** @hidden */
  42568. _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;
  42569. /** @hidden */
  42570. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42571. /** @hidden */
  42572. _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;
  42573. /** @hidden */
  42574. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42575. /** @hidden */
  42576. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42577. /** @hidden */
  42578. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42579. }
  42580. }
  42581. declare module "babylonjs/assetContainer" {
  42582. import { AbstractScene } from "babylonjs/abstractScene";
  42583. import { Scene } from "babylonjs/scene";
  42584. import { Mesh } from "babylonjs/Meshes/mesh";
  42585. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42586. import { Skeleton } from "babylonjs/Bones/skeleton";
  42587. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42588. import { Animatable } from "babylonjs/Animations/animatable";
  42589. import { Nullable } from "babylonjs/types";
  42590. import { Node } from "babylonjs/node";
  42591. /**
  42592. * Set of assets to keep when moving a scene into an asset container.
  42593. */
  42594. export class KeepAssets extends AbstractScene {
  42595. }
  42596. /**
  42597. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42598. */
  42599. export class InstantiatedEntries {
  42600. /**
  42601. * List of new root nodes (eg. nodes with no parent)
  42602. */
  42603. rootNodes: TransformNode[];
  42604. /**
  42605. * List of new skeletons
  42606. */
  42607. skeletons: Skeleton[];
  42608. /**
  42609. * List of new animation groups
  42610. */
  42611. animationGroups: AnimationGroup[];
  42612. }
  42613. /**
  42614. * Container with a set of assets that can be added or removed from a scene.
  42615. */
  42616. export class AssetContainer extends AbstractScene {
  42617. private _wasAddedToScene;
  42618. /**
  42619. * The scene the AssetContainer belongs to.
  42620. */
  42621. scene: Scene;
  42622. /**
  42623. * Instantiates an AssetContainer.
  42624. * @param scene The scene the AssetContainer belongs to.
  42625. */
  42626. constructor(scene: Scene);
  42627. /**
  42628. * Instantiate or clone all meshes and add the new ones to the scene.
  42629. * Skeletons and animation groups will all be cloned
  42630. * @param nameFunction defines an optional function used to get new names for clones
  42631. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42632. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42633. */
  42634. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42635. /**
  42636. * Adds all the assets from the container to the scene.
  42637. */
  42638. addAllToScene(): void;
  42639. /**
  42640. * Removes all the assets in the container from the scene
  42641. */
  42642. removeAllFromScene(): void;
  42643. /**
  42644. * Disposes all the assets in the container
  42645. */
  42646. dispose(): void;
  42647. private _moveAssets;
  42648. /**
  42649. * Removes all the assets contained in the scene and adds them to the container.
  42650. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42651. */
  42652. moveAllFromScene(keepAssets?: KeepAssets): void;
  42653. /**
  42654. * 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.
  42655. * @returns the root mesh
  42656. */
  42657. createRootMesh(): Mesh;
  42658. /**
  42659. * Merge animations (direct and animation groups) from this asset container into a scene
  42660. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42661. * @param animatables set of animatables to retarget to a node from the scene
  42662. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42663. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42664. */
  42665. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42666. }
  42667. }
  42668. declare module "babylonjs/abstractScene" {
  42669. import { Scene } from "babylonjs/scene";
  42670. import { Nullable } from "babylonjs/types";
  42671. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42672. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42673. import { Geometry } from "babylonjs/Meshes/geometry";
  42674. import { Skeleton } from "babylonjs/Bones/skeleton";
  42675. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42676. import { AssetContainer } from "babylonjs/assetContainer";
  42677. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42678. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42679. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42680. import { Material } from "babylonjs/Materials/material";
  42681. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42682. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42683. import { Camera } from "babylonjs/Cameras/camera";
  42684. import { Light } from "babylonjs/Lights/light";
  42685. import { Node } from "babylonjs/node";
  42686. import { Animation } from "babylonjs/Animations/animation";
  42687. /**
  42688. * Defines how the parser contract is defined.
  42689. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42690. */
  42691. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42692. /**
  42693. * Defines how the individual parser contract is defined.
  42694. * These parser can parse an individual asset
  42695. */
  42696. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42697. /**
  42698. * Base class of the scene acting as a container for the different elements composing a scene.
  42699. * This class is dynamically extended by the different components of the scene increasing
  42700. * flexibility and reducing coupling
  42701. */
  42702. export abstract class AbstractScene {
  42703. /**
  42704. * Stores the list of available parsers in the application.
  42705. */
  42706. private static _BabylonFileParsers;
  42707. /**
  42708. * Stores the list of available individual parsers in the application.
  42709. */
  42710. private static _IndividualBabylonFileParsers;
  42711. /**
  42712. * Adds a parser in the list of available ones
  42713. * @param name Defines the name of the parser
  42714. * @param parser Defines the parser to add
  42715. */
  42716. static AddParser(name: string, parser: BabylonFileParser): void;
  42717. /**
  42718. * Gets a general parser from the list of avaialble ones
  42719. * @param name Defines the name of the parser
  42720. * @returns the requested parser or null
  42721. */
  42722. static GetParser(name: string): Nullable<BabylonFileParser>;
  42723. /**
  42724. * Adds n individual parser in the list of available ones
  42725. * @param name Defines the name of the parser
  42726. * @param parser Defines the parser to add
  42727. */
  42728. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42729. /**
  42730. * Gets an individual parser from the list of avaialble ones
  42731. * @param name Defines the name of the parser
  42732. * @returns the requested parser or null
  42733. */
  42734. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42735. /**
  42736. * Parser json data and populate both a scene and its associated container object
  42737. * @param jsonData Defines the data to parse
  42738. * @param scene Defines the scene to parse the data for
  42739. * @param container Defines the container attached to the parsing sequence
  42740. * @param rootUrl Defines the root url of the data
  42741. */
  42742. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42743. /**
  42744. * Gets the list of root nodes (ie. nodes with no parent)
  42745. */
  42746. rootNodes: Node[];
  42747. /** All of the cameras added to this scene
  42748. * @see https://doc.babylonjs.com/babylon101/cameras
  42749. */
  42750. cameras: Camera[];
  42751. /**
  42752. * All of the lights added to this scene
  42753. * @see https://doc.babylonjs.com/babylon101/lights
  42754. */
  42755. lights: Light[];
  42756. /**
  42757. * All of the (abstract) meshes added to this scene
  42758. */
  42759. meshes: AbstractMesh[];
  42760. /**
  42761. * The list of skeletons added to the scene
  42762. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42763. */
  42764. skeletons: Skeleton[];
  42765. /**
  42766. * All of the particle systems added to this scene
  42767. * @see https://doc.babylonjs.com/babylon101/particles
  42768. */
  42769. particleSystems: IParticleSystem[];
  42770. /**
  42771. * Gets a list of Animations associated with the scene
  42772. */
  42773. animations: Animation[];
  42774. /**
  42775. * All of the animation groups added to this scene
  42776. * @see https://doc.babylonjs.com/how_to/group
  42777. */
  42778. animationGroups: AnimationGroup[];
  42779. /**
  42780. * All of the multi-materials added to this scene
  42781. * @see https://doc.babylonjs.com/how_to/multi_materials
  42782. */
  42783. multiMaterials: MultiMaterial[];
  42784. /**
  42785. * All of the materials added to this scene
  42786. * In the context of a Scene, it is not supposed to be modified manually.
  42787. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42788. * Note also that the order of the Material within the array is not significant and might change.
  42789. * @see https://doc.babylonjs.com/babylon101/materials
  42790. */
  42791. materials: Material[];
  42792. /**
  42793. * The list of morph target managers added to the scene
  42794. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42795. */
  42796. morphTargetManagers: MorphTargetManager[];
  42797. /**
  42798. * The list of geometries used in the scene.
  42799. */
  42800. geometries: Geometry[];
  42801. /**
  42802. * All of the tranform nodes added to this scene
  42803. * In the context of a Scene, it is not supposed to be modified manually.
  42804. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42805. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42806. * @see https://doc.babylonjs.com/how_to/transformnode
  42807. */
  42808. transformNodes: TransformNode[];
  42809. /**
  42810. * ActionManagers available on the scene.
  42811. */
  42812. actionManagers: AbstractActionManager[];
  42813. /**
  42814. * Textures to keep.
  42815. */
  42816. textures: BaseTexture[];
  42817. /** @hidden */
  42818. protected _environmentTexture: Nullable<BaseTexture>;
  42819. /**
  42820. * Texture used in all pbr material as the reflection texture.
  42821. * As in the majority of the scene they are the same (exception for multi room and so on),
  42822. * this is easier to reference from here than from all the materials.
  42823. */
  42824. get environmentTexture(): Nullable<BaseTexture>;
  42825. set environmentTexture(value: Nullable<BaseTexture>);
  42826. /**
  42827. * The list of postprocesses added to the scene
  42828. */
  42829. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42830. /**
  42831. * @returns all meshes, lights, cameras, transformNodes and bones
  42832. */
  42833. getNodes(): Array<Node>;
  42834. }
  42835. }
  42836. declare module "babylonjs/Audio/sound" {
  42837. import { Observable } from "babylonjs/Misc/observable";
  42838. import { Vector3 } from "babylonjs/Maths/math.vector";
  42839. import { Nullable } from "babylonjs/types";
  42840. import { Scene } from "babylonjs/scene";
  42841. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42842. /**
  42843. * Interface used to define options for Sound class
  42844. */
  42845. export interface ISoundOptions {
  42846. /**
  42847. * Does the sound autoplay once loaded.
  42848. */
  42849. autoplay?: boolean;
  42850. /**
  42851. * Does the sound loop after it finishes playing once.
  42852. */
  42853. loop?: boolean;
  42854. /**
  42855. * Sound's volume
  42856. */
  42857. volume?: number;
  42858. /**
  42859. * Is it a spatial sound?
  42860. */
  42861. spatialSound?: boolean;
  42862. /**
  42863. * Maximum distance to hear that sound
  42864. */
  42865. maxDistance?: number;
  42866. /**
  42867. * Uses user defined attenuation function
  42868. */
  42869. useCustomAttenuation?: boolean;
  42870. /**
  42871. * Define the roll off factor of spatial sounds.
  42872. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42873. */
  42874. rolloffFactor?: number;
  42875. /**
  42876. * Define the reference distance the sound should be heard perfectly.
  42877. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42878. */
  42879. refDistance?: number;
  42880. /**
  42881. * Define the distance attenuation model the sound will follow.
  42882. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42883. */
  42884. distanceModel?: string;
  42885. /**
  42886. * Defines the playback speed (1 by default)
  42887. */
  42888. playbackRate?: number;
  42889. /**
  42890. * Defines if the sound is from a streaming source
  42891. */
  42892. streaming?: boolean;
  42893. /**
  42894. * Defines an optional length (in seconds) inside the sound file
  42895. */
  42896. length?: number;
  42897. /**
  42898. * Defines an optional offset (in seconds) inside the sound file
  42899. */
  42900. offset?: number;
  42901. /**
  42902. * If true, URLs will not be required to state the audio file codec to use.
  42903. */
  42904. skipCodecCheck?: boolean;
  42905. }
  42906. /**
  42907. * Defines a sound that can be played in the application.
  42908. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42909. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42910. */
  42911. export class Sound {
  42912. /**
  42913. * The name of the sound in the scene.
  42914. */
  42915. name: string;
  42916. /**
  42917. * Does the sound autoplay once loaded.
  42918. */
  42919. autoplay: boolean;
  42920. /**
  42921. * Does the sound loop after it finishes playing once.
  42922. */
  42923. loop: boolean;
  42924. /**
  42925. * Does the sound use a custom attenuation curve to simulate the falloff
  42926. * happening when the source gets further away from the camera.
  42927. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42928. */
  42929. useCustomAttenuation: boolean;
  42930. /**
  42931. * The sound track id this sound belongs to.
  42932. */
  42933. soundTrackId: number;
  42934. /**
  42935. * Is this sound currently played.
  42936. */
  42937. isPlaying: boolean;
  42938. /**
  42939. * Is this sound currently paused.
  42940. */
  42941. isPaused: boolean;
  42942. /**
  42943. * Does this sound enables spatial sound.
  42944. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42945. */
  42946. spatialSound: boolean;
  42947. /**
  42948. * Define the reference distance the sound should be heard perfectly.
  42949. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42950. */
  42951. refDistance: number;
  42952. /**
  42953. * Define the roll off factor of spatial sounds.
  42954. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42955. */
  42956. rolloffFactor: number;
  42957. /**
  42958. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42959. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42960. */
  42961. maxDistance: number;
  42962. /**
  42963. * Define the distance attenuation model the sound will follow.
  42964. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42965. */
  42966. distanceModel: string;
  42967. /**
  42968. * @hidden
  42969. * Back Compat
  42970. **/
  42971. onended: () => any;
  42972. /**
  42973. * Gets or sets an object used to store user defined information for the sound.
  42974. */
  42975. metadata: any;
  42976. /**
  42977. * Observable event when the current playing sound finishes.
  42978. */
  42979. onEndedObservable: Observable<Sound>;
  42980. private _panningModel;
  42981. private _playbackRate;
  42982. private _streaming;
  42983. private _startTime;
  42984. private _startOffset;
  42985. private _position;
  42986. /** @hidden */
  42987. _positionInEmitterSpace: boolean;
  42988. private _localDirection;
  42989. private _volume;
  42990. private _isReadyToPlay;
  42991. private _isDirectional;
  42992. private _readyToPlayCallback;
  42993. private _audioBuffer;
  42994. private _soundSource;
  42995. private _streamingSource;
  42996. private _soundPanner;
  42997. private _soundGain;
  42998. private _inputAudioNode;
  42999. private _outputAudioNode;
  43000. private _coneInnerAngle;
  43001. private _coneOuterAngle;
  43002. private _coneOuterGain;
  43003. private _scene;
  43004. private _connectedTransformNode;
  43005. private _customAttenuationFunction;
  43006. private _registerFunc;
  43007. private _isOutputConnected;
  43008. private _htmlAudioElement;
  43009. private _urlType;
  43010. private _length?;
  43011. private _offset?;
  43012. /** @hidden */
  43013. static _SceneComponentInitialization: (scene: Scene) => void;
  43014. /**
  43015. * Create a sound and attach it to a scene
  43016. * @param name Name of your sound
  43017. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  43018. * @param scene defines the scene the sound belongs to
  43019. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  43020. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  43021. */
  43022. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  43023. /**
  43024. * Release the sound and its associated resources
  43025. */
  43026. dispose(): void;
  43027. /**
  43028. * Gets if the sounds is ready to be played or not.
  43029. * @returns true if ready, otherwise false
  43030. */
  43031. isReady(): boolean;
  43032. private _soundLoaded;
  43033. /**
  43034. * Sets the data of the sound from an audiobuffer
  43035. * @param audioBuffer The audioBuffer containing the data
  43036. */
  43037. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43038. /**
  43039. * Updates the current sounds options such as maxdistance, loop...
  43040. * @param options A JSON object containing values named as the object properties
  43041. */
  43042. updateOptions(options: ISoundOptions): void;
  43043. private _createSpatialParameters;
  43044. private _updateSpatialParameters;
  43045. /**
  43046. * Switch the panning model to HRTF:
  43047. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43048. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43049. */
  43050. switchPanningModelToHRTF(): void;
  43051. /**
  43052. * Switch the panning model to Equal Power:
  43053. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43054. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43055. */
  43056. switchPanningModelToEqualPower(): void;
  43057. private _switchPanningModel;
  43058. /**
  43059. * Connect this sound to a sound track audio node like gain...
  43060. * @param soundTrackAudioNode the sound track audio node to connect to
  43061. */
  43062. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43063. /**
  43064. * Transform this sound into a directional source
  43065. * @param coneInnerAngle Size of the inner cone in degree
  43066. * @param coneOuterAngle Size of the outer cone in degree
  43067. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43068. */
  43069. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43070. /**
  43071. * Gets or sets the inner angle for the directional cone.
  43072. */
  43073. get directionalConeInnerAngle(): number;
  43074. /**
  43075. * Gets or sets the inner angle for the directional cone.
  43076. */
  43077. set directionalConeInnerAngle(value: number);
  43078. /**
  43079. * Gets or sets the outer angle for the directional cone.
  43080. */
  43081. get directionalConeOuterAngle(): number;
  43082. /**
  43083. * Gets or sets the outer angle for the directional cone.
  43084. */
  43085. set directionalConeOuterAngle(value: number);
  43086. /**
  43087. * Sets the position of the emitter if spatial sound is enabled
  43088. * @param newPosition Defines the new posisiton
  43089. */
  43090. setPosition(newPosition: Vector3): void;
  43091. /**
  43092. * Sets the local direction of the emitter if spatial sound is enabled
  43093. * @param newLocalDirection Defines the new local direction
  43094. */
  43095. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43096. private _updateDirection;
  43097. /** @hidden */
  43098. updateDistanceFromListener(): void;
  43099. /**
  43100. * Sets a new custom attenuation function for the sound.
  43101. * @param callback Defines the function used for the attenuation
  43102. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43103. */
  43104. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43105. /**
  43106. * Play the sound
  43107. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43108. * @param offset (optional) Start the sound at a specific time in seconds
  43109. * @param length (optional) Sound duration (in seconds)
  43110. */
  43111. play(time?: number, offset?: number, length?: number): void;
  43112. private _onended;
  43113. /**
  43114. * Stop the sound
  43115. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43116. */
  43117. stop(time?: number): void;
  43118. /**
  43119. * Put the sound in pause
  43120. */
  43121. pause(): void;
  43122. /**
  43123. * Sets a dedicated volume for this sounds
  43124. * @param newVolume Define the new volume of the sound
  43125. * @param time Define time for gradual change to new volume
  43126. */
  43127. setVolume(newVolume: number, time?: number): void;
  43128. /**
  43129. * Set the sound play back rate
  43130. * @param newPlaybackRate Define the playback rate the sound should be played at
  43131. */
  43132. setPlaybackRate(newPlaybackRate: number): void;
  43133. /**
  43134. * Gets the volume of the sound.
  43135. * @returns the volume of the sound
  43136. */
  43137. getVolume(): number;
  43138. /**
  43139. * Attach the sound to a dedicated mesh
  43140. * @param transformNode The transform node to connect the sound with
  43141. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43142. */
  43143. attachToMesh(transformNode: TransformNode): void;
  43144. /**
  43145. * Detach the sound from the previously attached mesh
  43146. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43147. */
  43148. detachFromMesh(): void;
  43149. private _onRegisterAfterWorldMatrixUpdate;
  43150. /**
  43151. * Clone the current sound in the scene.
  43152. * @returns the new sound clone
  43153. */
  43154. clone(): Nullable<Sound>;
  43155. /**
  43156. * Gets the current underlying audio buffer containing the data
  43157. * @returns the audio buffer
  43158. */
  43159. getAudioBuffer(): Nullable<AudioBuffer>;
  43160. /**
  43161. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43162. * @returns the source node
  43163. */
  43164. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43165. /**
  43166. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43167. * @returns the gain node
  43168. */
  43169. getSoundGain(): Nullable<GainNode>;
  43170. /**
  43171. * Serializes the Sound in a JSON representation
  43172. * @returns the JSON representation of the sound
  43173. */
  43174. serialize(): any;
  43175. /**
  43176. * Parse a JSON representation of a sound to innstantiate in a given scene
  43177. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43178. * @param scene Define the scene the new parsed sound should be created in
  43179. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43180. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43181. * @returns the newly parsed sound
  43182. */
  43183. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43184. }
  43185. }
  43186. declare module "babylonjs/Actions/directAudioActions" {
  43187. import { Action } from "babylonjs/Actions/action";
  43188. import { Condition } from "babylonjs/Actions/condition";
  43189. import { Sound } from "babylonjs/Audio/sound";
  43190. /**
  43191. * This defines an action helpful to play a defined sound on a triggered action.
  43192. */
  43193. export class PlaySoundAction extends Action {
  43194. private _sound;
  43195. /**
  43196. * Instantiate the action
  43197. * @param triggerOptions defines the trigger options
  43198. * @param sound defines the sound to play
  43199. * @param condition defines the trigger related conditions
  43200. */
  43201. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43202. /** @hidden */
  43203. _prepare(): void;
  43204. /**
  43205. * Execute the action and play the sound.
  43206. */
  43207. execute(): void;
  43208. /**
  43209. * Serializes the actions and its related information.
  43210. * @param parent defines the object to serialize in
  43211. * @returns the serialized object
  43212. */
  43213. serialize(parent: any): any;
  43214. }
  43215. /**
  43216. * This defines an action helpful to stop a defined sound on a triggered action.
  43217. */
  43218. export class StopSoundAction extends Action {
  43219. private _sound;
  43220. /**
  43221. * Instantiate the action
  43222. * @param triggerOptions defines the trigger options
  43223. * @param sound defines the sound to stop
  43224. * @param condition defines the trigger related conditions
  43225. */
  43226. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43227. /** @hidden */
  43228. _prepare(): void;
  43229. /**
  43230. * Execute the action and stop the sound.
  43231. */
  43232. execute(): void;
  43233. /**
  43234. * Serializes the actions and its related information.
  43235. * @param parent defines the object to serialize in
  43236. * @returns the serialized object
  43237. */
  43238. serialize(parent: any): any;
  43239. }
  43240. }
  43241. declare module "babylonjs/Actions/interpolateValueAction" {
  43242. import { Action } from "babylonjs/Actions/action";
  43243. import { Condition } from "babylonjs/Actions/condition";
  43244. import { Observable } from "babylonjs/Misc/observable";
  43245. /**
  43246. * This defines an action responsible to change the value of a property
  43247. * by interpolating between its current value and the newly set one once triggered.
  43248. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43249. */
  43250. export class InterpolateValueAction extends Action {
  43251. /**
  43252. * Defines the path of the property where the value should be interpolated
  43253. */
  43254. propertyPath: string;
  43255. /**
  43256. * Defines the target value at the end of the interpolation.
  43257. */
  43258. value: any;
  43259. /**
  43260. * Defines the time it will take for the property to interpolate to the value.
  43261. */
  43262. duration: number;
  43263. /**
  43264. * Defines if the other scene animations should be stopped when the action has been triggered
  43265. */
  43266. stopOtherAnimations?: boolean;
  43267. /**
  43268. * Defines a callback raised once the interpolation animation has been done.
  43269. */
  43270. onInterpolationDone?: () => void;
  43271. /**
  43272. * Observable triggered once the interpolation animation has been done.
  43273. */
  43274. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43275. private _target;
  43276. private _effectiveTarget;
  43277. private _property;
  43278. /**
  43279. * Instantiate the action
  43280. * @param triggerOptions defines the trigger options
  43281. * @param target defines the object containing the value to interpolate
  43282. * @param propertyPath defines the path to the property in the target object
  43283. * @param value defines the target value at the end of the interpolation
  43284. * @param duration deines the time it will take for the property to interpolate to the value.
  43285. * @param condition defines the trigger related conditions
  43286. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43287. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43288. */
  43289. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43290. /** @hidden */
  43291. _prepare(): void;
  43292. /**
  43293. * Execute the action starts the value interpolation.
  43294. */
  43295. execute(): void;
  43296. /**
  43297. * Serializes the actions and its related information.
  43298. * @param parent defines the object to serialize in
  43299. * @returns the serialized object
  43300. */
  43301. serialize(parent: any): any;
  43302. }
  43303. }
  43304. declare module "babylonjs/Actions/index" {
  43305. export * from "babylonjs/Actions/abstractActionManager";
  43306. export * from "babylonjs/Actions/action";
  43307. export * from "babylonjs/Actions/actionEvent";
  43308. export * from "babylonjs/Actions/actionManager";
  43309. export * from "babylonjs/Actions/condition";
  43310. export * from "babylonjs/Actions/directActions";
  43311. export * from "babylonjs/Actions/directAudioActions";
  43312. export * from "babylonjs/Actions/interpolateValueAction";
  43313. }
  43314. declare module "babylonjs/Animations/index" {
  43315. export * from "babylonjs/Animations/animatable";
  43316. export * from "babylonjs/Animations/animation";
  43317. export * from "babylonjs/Animations/animationGroup";
  43318. export * from "babylonjs/Animations/animationPropertiesOverride";
  43319. export * from "babylonjs/Animations/easing";
  43320. export * from "babylonjs/Animations/runtimeAnimation";
  43321. export * from "babylonjs/Animations/animationEvent";
  43322. export * from "babylonjs/Animations/animationGroup";
  43323. export * from "babylonjs/Animations/animationKey";
  43324. export * from "babylonjs/Animations/animationRange";
  43325. export * from "babylonjs/Animations/animatable.interface";
  43326. }
  43327. declare module "babylonjs/Audio/soundTrack" {
  43328. import { Sound } from "babylonjs/Audio/sound";
  43329. import { Analyser } from "babylonjs/Audio/analyser";
  43330. import { Scene } from "babylonjs/scene";
  43331. /**
  43332. * Options allowed during the creation of a sound track.
  43333. */
  43334. export interface ISoundTrackOptions {
  43335. /**
  43336. * The volume the sound track should take during creation
  43337. */
  43338. volume?: number;
  43339. /**
  43340. * Define if the sound track is the main sound track of the scene
  43341. */
  43342. mainTrack?: boolean;
  43343. }
  43344. /**
  43345. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43346. * It will be also used in a future release to apply effects on a specific track.
  43347. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43348. */
  43349. export class SoundTrack {
  43350. /**
  43351. * The unique identifier of the sound track in the scene.
  43352. */
  43353. id: number;
  43354. /**
  43355. * The list of sounds included in the sound track.
  43356. */
  43357. soundCollection: Array<Sound>;
  43358. private _outputAudioNode;
  43359. private _scene;
  43360. private _connectedAnalyser;
  43361. private _options;
  43362. private _isInitialized;
  43363. /**
  43364. * Creates a new sound track.
  43365. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43366. * @param scene Define the scene the sound track belongs to
  43367. * @param options
  43368. */
  43369. constructor(scene: Scene, options?: ISoundTrackOptions);
  43370. private _initializeSoundTrackAudioGraph;
  43371. /**
  43372. * Release the sound track and its associated resources
  43373. */
  43374. dispose(): void;
  43375. /**
  43376. * Adds a sound to this sound track
  43377. * @param sound define the cound to add
  43378. * @ignoreNaming
  43379. */
  43380. AddSound(sound: Sound): void;
  43381. /**
  43382. * Removes a sound to this sound track
  43383. * @param sound define the cound to remove
  43384. * @ignoreNaming
  43385. */
  43386. RemoveSound(sound: Sound): void;
  43387. /**
  43388. * Set a global volume for the full sound track.
  43389. * @param newVolume Define the new volume of the sound track
  43390. */
  43391. setVolume(newVolume: number): void;
  43392. /**
  43393. * Switch the panning model to HRTF:
  43394. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43395. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43396. */
  43397. switchPanningModelToHRTF(): void;
  43398. /**
  43399. * Switch the panning model to Equal Power:
  43400. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43401. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43402. */
  43403. switchPanningModelToEqualPower(): void;
  43404. /**
  43405. * Connect the sound track to an audio analyser allowing some amazing
  43406. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43407. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43408. * @param analyser The analyser to connect to the engine
  43409. */
  43410. connectToAnalyser(analyser: Analyser): void;
  43411. }
  43412. }
  43413. declare module "babylonjs/Audio/audioSceneComponent" {
  43414. import { Sound } from "babylonjs/Audio/sound";
  43415. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43416. import { Nullable } from "babylonjs/types";
  43417. import { Vector3 } from "babylonjs/Maths/math.vector";
  43418. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43419. import { Scene } from "babylonjs/scene";
  43420. import { AbstractScene } from "babylonjs/abstractScene";
  43421. import "babylonjs/Audio/audioEngine";
  43422. module "babylonjs/abstractScene" {
  43423. interface AbstractScene {
  43424. /**
  43425. * The list of sounds used in the scene.
  43426. */
  43427. sounds: Nullable<Array<Sound>>;
  43428. }
  43429. }
  43430. module "babylonjs/scene" {
  43431. interface Scene {
  43432. /**
  43433. * @hidden
  43434. * Backing field
  43435. */
  43436. _mainSoundTrack: SoundTrack;
  43437. /**
  43438. * The main sound track played by the scene.
  43439. * It cotains your primary collection of sounds.
  43440. */
  43441. mainSoundTrack: SoundTrack;
  43442. /**
  43443. * The list of sound tracks added to the scene
  43444. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43445. */
  43446. soundTracks: Nullable<Array<SoundTrack>>;
  43447. /**
  43448. * Gets a sound using a given name
  43449. * @param name defines the name to search for
  43450. * @return the found sound or null if not found at all.
  43451. */
  43452. getSoundByName(name: string): Nullable<Sound>;
  43453. /**
  43454. * Gets or sets if audio support is enabled
  43455. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43456. */
  43457. audioEnabled: boolean;
  43458. /**
  43459. * Gets or sets if audio will be output to headphones
  43460. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43461. */
  43462. headphone: boolean;
  43463. /**
  43464. * Gets or sets custom audio listener position provider
  43465. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43466. */
  43467. audioListenerPositionProvider: Nullable<() => Vector3>;
  43468. /**
  43469. * Gets or sets a refresh rate when using 3D audio positioning
  43470. */
  43471. audioPositioningRefreshRate: number;
  43472. }
  43473. }
  43474. /**
  43475. * Defines the sound scene component responsible to manage any sounds
  43476. * in a given scene.
  43477. */
  43478. export class AudioSceneComponent implements ISceneSerializableComponent {
  43479. /**
  43480. * The component name helpfull to identify the component in the list of scene components.
  43481. */
  43482. readonly name: string;
  43483. /**
  43484. * The scene the component belongs to.
  43485. */
  43486. scene: Scene;
  43487. private _audioEnabled;
  43488. /**
  43489. * Gets whether audio is enabled or not.
  43490. * Please use related enable/disable method to switch state.
  43491. */
  43492. get audioEnabled(): boolean;
  43493. private _headphone;
  43494. /**
  43495. * Gets whether audio is outputing to headphone or not.
  43496. * Please use the according Switch methods to change output.
  43497. */
  43498. get headphone(): boolean;
  43499. /**
  43500. * Gets or sets a refresh rate when using 3D audio positioning
  43501. */
  43502. audioPositioningRefreshRate: number;
  43503. private _audioListenerPositionProvider;
  43504. /**
  43505. * Gets the current audio listener position provider
  43506. */
  43507. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43508. /**
  43509. * Sets a custom listener position for all sounds in the scene
  43510. * By default, this is the position of the first active camera
  43511. */
  43512. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43513. /**
  43514. * Creates a new instance of the component for the given scene
  43515. * @param scene Defines the scene to register the component in
  43516. */
  43517. constructor(scene: Scene);
  43518. /**
  43519. * Registers the component in a given scene
  43520. */
  43521. register(): void;
  43522. /**
  43523. * Rebuilds the elements related to this component in case of
  43524. * context lost for instance.
  43525. */
  43526. rebuild(): void;
  43527. /**
  43528. * Serializes the component data to the specified json object
  43529. * @param serializationObject The object to serialize to
  43530. */
  43531. serialize(serializationObject: any): void;
  43532. /**
  43533. * Adds all the elements from the container to the scene
  43534. * @param container the container holding the elements
  43535. */
  43536. addFromContainer(container: AbstractScene): void;
  43537. /**
  43538. * Removes all the elements in the container from the scene
  43539. * @param container contains the elements to remove
  43540. * @param dispose if the removed element should be disposed (default: false)
  43541. */
  43542. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43543. /**
  43544. * Disposes the component and the associated ressources.
  43545. */
  43546. dispose(): void;
  43547. /**
  43548. * Disables audio in the associated scene.
  43549. */
  43550. disableAudio(): void;
  43551. /**
  43552. * Enables audio in the associated scene.
  43553. */
  43554. enableAudio(): void;
  43555. /**
  43556. * Switch audio to headphone output.
  43557. */
  43558. switchAudioModeForHeadphones(): void;
  43559. /**
  43560. * Switch audio to normal speakers.
  43561. */
  43562. switchAudioModeForNormalSpeakers(): void;
  43563. private _cachedCameraDirection;
  43564. private _cachedCameraPosition;
  43565. private _lastCheck;
  43566. private _afterRender;
  43567. }
  43568. }
  43569. declare module "babylonjs/Audio/weightedsound" {
  43570. import { Sound } from "babylonjs/Audio/sound";
  43571. /**
  43572. * Wraps one or more Sound objects and selects one with random weight for playback.
  43573. */
  43574. export class WeightedSound {
  43575. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43576. loop: boolean;
  43577. private _coneInnerAngle;
  43578. private _coneOuterAngle;
  43579. private _volume;
  43580. /** A Sound is currently playing. */
  43581. isPlaying: boolean;
  43582. /** A Sound is currently paused. */
  43583. isPaused: boolean;
  43584. private _sounds;
  43585. private _weights;
  43586. private _currentIndex?;
  43587. /**
  43588. * Creates a new WeightedSound from the list of sounds given.
  43589. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43590. * @param sounds Array of Sounds that will be selected from.
  43591. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43592. */
  43593. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43594. /**
  43595. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43596. */
  43597. get directionalConeInnerAngle(): number;
  43598. /**
  43599. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43600. */
  43601. set directionalConeInnerAngle(value: number);
  43602. /**
  43603. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43604. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43605. */
  43606. get directionalConeOuterAngle(): number;
  43607. /**
  43608. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43609. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43610. */
  43611. set directionalConeOuterAngle(value: number);
  43612. /**
  43613. * Playback volume.
  43614. */
  43615. get volume(): number;
  43616. /**
  43617. * Playback volume.
  43618. */
  43619. set volume(value: number);
  43620. private _onended;
  43621. /**
  43622. * Suspend playback
  43623. */
  43624. pause(): void;
  43625. /**
  43626. * Stop playback
  43627. */
  43628. stop(): void;
  43629. /**
  43630. * Start playback.
  43631. * @param startOffset Position the clip head at a specific time in seconds.
  43632. */
  43633. play(startOffset?: number): void;
  43634. }
  43635. }
  43636. declare module "babylonjs/Audio/index" {
  43637. export * from "babylonjs/Audio/analyser";
  43638. export * from "babylonjs/Audio/audioEngine";
  43639. export * from "babylonjs/Audio/audioSceneComponent";
  43640. export * from "babylonjs/Audio/sound";
  43641. export * from "babylonjs/Audio/soundTrack";
  43642. export * from "babylonjs/Audio/weightedsound";
  43643. }
  43644. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43645. import { Behavior } from "babylonjs/Behaviors/behavior";
  43646. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43647. import { BackEase } from "babylonjs/Animations/easing";
  43648. /**
  43649. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43650. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43651. */
  43652. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43653. /**
  43654. * Gets the name of the behavior.
  43655. */
  43656. get name(): string;
  43657. /**
  43658. * The easing function used by animations
  43659. */
  43660. static EasingFunction: BackEase;
  43661. /**
  43662. * The easing mode used by animations
  43663. */
  43664. static EasingMode: number;
  43665. /**
  43666. * The duration of the animation, in milliseconds
  43667. */
  43668. transitionDuration: number;
  43669. /**
  43670. * Length of the distance animated by the transition when lower radius is reached
  43671. */
  43672. lowerRadiusTransitionRange: number;
  43673. /**
  43674. * Length of the distance animated by the transition when upper radius is reached
  43675. */
  43676. upperRadiusTransitionRange: number;
  43677. private _autoTransitionRange;
  43678. /**
  43679. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43680. */
  43681. get autoTransitionRange(): boolean;
  43682. /**
  43683. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43684. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43685. */
  43686. set autoTransitionRange(value: boolean);
  43687. private _attachedCamera;
  43688. private _onAfterCheckInputsObserver;
  43689. private _onMeshTargetChangedObserver;
  43690. /**
  43691. * Initializes the behavior.
  43692. */
  43693. init(): void;
  43694. /**
  43695. * Attaches the behavior to its arc rotate camera.
  43696. * @param camera Defines the camera to attach the behavior to
  43697. */
  43698. attach(camera: ArcRotateCamera): void;
  43699. /**
  43700. * Detaches the behavior from its current arc rotate camera.
  43701. */
  43702. detach(): void;
  43703. private _radiusIsAnimating;
  43704. private _radiusBounceTransition;
  43705. private _animatables;
  43706. private _cachedWheelPrecision;
  43707. /**
  43708. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43709. * @param radiusLimit The limit to check against.
  43710. * @return Bool to indicate if at limit.
  43711. */
  43712. private _isRadiusAtLimit;
  43713. /**
  43714. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43715. * @param radiusDelta The delta by which to animate to. Can be negative.
  43716. */
  43717. private _applyBoundRadiusAnimation;
  43718. /**
  43719. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43720. */
  43721. protected _clearAnimationLocks(): void;
  43722. /**
  43723. * Stops and removes all animations that have been applied to the camera
  43724. */
  43725. stopAllAnimations(): void;
  43726. }
  43727. }
  43728. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43729. import { Behavior } from "babylonjs/Behaviors/behavior";
  43730. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43731. import { ExponentialEase } from "babylonjs/Animations/easing";
  43732. import { Nullable } from "babylonjs/types";
  43733. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43734. import { Vector3 } from "babylonjs/Maths/math.vector";
  43735. /**
  43736. * 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.
  43737. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43738. */
  43739. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43740. /**
  43741. * Gets the name of the behavior.
  43742. */
  43743. get name(): string;
  43744. private _mode;
  43745. private _radiusScale;
  43746. private _positionScale;
  43747. private _defaultElevation;
  43748. private _elevationReturnTime;
  43749. private _elevationReturnWaitTime;
  43750. private _zoomStopsAnimation;
  43751. private _framingTime;
  43752. /**
  43753. * The easing function used by animations
  43754. */
  43755. static EasingFunction: ExponentialEase;
  43756. /**
  43757. * The easing mode used by animations
  43758. */
  43759. static EasingMode: number;
  43760. /**
  43761. * Sets the current mode used by the behavior
  43762. */
  43763. set mode(mode: number);
  43764. /**
  43765. * Gets current mode used by the behavior.
  43766. */
  43767. get mode(): number;
  43768. /**
  43769. * Sets the scale applied to the radius (1 by default)
  43770. */
  43771. set radiusScale(radius: number);
  43772. /**
  43773. * Gets the scale applied to the radius
  43774. */
  43775. get radiusScale(): number;
  43776. /**
  43777. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43778. */
  43779. set positionScale(scale: number);
  43780. /**
  43781. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43782. */
  43783. get positionScale(): number;
  43784. /**
  43785. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43786. * behaviour is triggered, in radians.
  43787. */
  43788. set defaultElevation(elevation: number);
  43789. /**
  43790. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43791. * behaviour is triggered, in radians.
  43792. */
  43793. get defaultElevation(): number;
  43794. /**
  43795. * Sets the time (in milliseconds) taken to return to the default beta position.
  43796. * Negative value indicates camera should not return to default.
  43797. */
  43798. set elevationReturnTime(speed: number);
  43799. /**
  43800. * Gets the time (in milliseconds) taken to return to the default beta position.
  43801. * Negative value indicates camera should not return to default.
  43802. */
  43803. get elevationReturnTime(): number;
  43804. /**
  43805. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43806. */
  43807. set elevationReturnWaitTime(time: number);
  43808. /**
  43809. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43810. */
  43811. get elevationReturnWaitTime(): number;
  43812. /**
  43813. * Sets the flag that indicates if user zooming should stop animation.
  43814. */
  43815. set zoomStopsAnimation(flag: boolean);
  43816. /**
  43817. * Gets the flag that indicates if user zooming should stop animation.
  43818. */
  43819. get zoomStopsAnimation(): boolean;
  43820. /**
  43821. * Sets the transition time when framing the mesh, in milliseconds
  43822. */
  43823. set framingTime(time: number);
  43824. /**
  43825. * Gets the transition time when framing the mesh, in milliseconds
  43826. */
  43827. get framingTime(): number;
  43828. /**
  43829. * Define if the behavior should automatically change the configured
  43830. * camera limits and sensibilities.
  43831. */
  43832. autoCorrectCameraLimitsAndSensibility: boolean;
  43833. private _onPrePointerObservableObserver;
  43834. private _onAfterCheckInputsObserver;
  43835. private _onMeshTargetChangedObserver;
  43836. private _attachedCamera;
  43837. private _isPointerDown;
  43838. private _lastInteractionTime;
  43839. /**
  43840. * Initializes the behavior.
  43841. */
  43842. init(): void;
  43843. /**
  43844. * Attaches the behavior to its arc rotate camera.
  43845. * @param camera Defines the camera to attach the behavior to
  43846. */
  43847. attach(camera: ArcRotateCamera): void;
  43848. /**
  43849. * Detaches the behavior from its current arc rotate camera.
  43850. */
  43851. detach(): void;
  43852. private _animatables;
  43853. private _betaIsAnimating;
  43854. private _betaTransition;
  43855. private _radiusTransition;
  43856. private _vectorTransition;
  43857. /**
  43858. * Targets the given mesh and updates zoom level accordingly.
  43859. * @param mesh The mesh to target.
  43860. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43861. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43862. */
  43863. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43864. /**
  43865. * Targets the given mesh with its children and updates zoom level accordingly.
  43866. * @param mesh The mesh to target.
  43867. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43868. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43869. */
  43870. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43871. /**
  43872. * Targets the given meshes with their children and updates zoom level accordingly.
  43873. * @param meshes The mesh to target.
  43874. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43875. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43876. */
  43877. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43878. /**
  43879. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43880. * @param minimumWorld Determines the smaller position of the bounding box extend
  43881. * @param maximumWorld Determines the bigger position of the bounding box extend
  43882. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43883. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43884. */
  43885. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43886. /**
  43887. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43888. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43889. * frustum width.
  43890. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43891. * to fully enclose the mesh in the viewing frustum.
  43892. */
  43893. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43894. /**
  43895. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43896. * is automatically returned to its default position (expected to be above ground plane).
  43897. */
  43898. private _maintainCameraAboveGround;
  43899. /**
  43900. * Returns the frustum slope based on the canvas ratio and camera FOV
  43901. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43902. */
  43903. private _getFrustumSlope;
  43904. /**
  43905. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43906. */
  43907. private _clearAnimationLocks;
  43908. /**
  43909. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43910. */
  43911. private _applyUserInteraction;
  43912. /**
  43913. * Stops and removes all animations that have been applied to the camera
  43914. */
  43915. stopAllAnimations(): void;
  43916. /**
  43917. * Gets a value indicating if the user is moving the camera
  43918. */
  43919. get isUserIsMoving(): boolean;
  43920. /**
  43921. * The camera can move all the way towards the mesh.
  43922. */
  43923. static IgnoreBoundsSizeMode: number;
  43924. /**
  43925. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43926. */
  43927. static FitFrustumSidesMode: number;
  43928. }
  43929. }
  43930. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43931. import { Nullable } from "babylonjs/types";
  43932. import { Camera } from "babylonjs/Cameras/camera";
  43933. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43934. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43935. /**
  43936. * Base class for Camera Pointer Inputs.
  43937. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43938. * for example usage.
  43939. */
  43940. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43941. /**
  43942. * Defines the camera the input is attached to.
  43943. */
  43944. abstract camera: Camera;
  43945. /**
  43946. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43947. */
  43948. protected _altKey: boolean;
  43949. protected _ctrlKey: boolean;
  43950. protected _metaKey: boolean;
  43951. protected _shiftKey: boolean;
  43952. /**
  43953. * Which mouse buttons were pressed at time of last mouse event.
  43954. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43955. */
  43956. protected _buttonsPressed: number;
  43957. /**
  43958. * Defines the buttons associated with the input to handle camera move.
  43959. */
  43960. buttons: number[];
  43961. /**
  43962. * Attach the input controls to a specific dom element to get the input from.
  43963. * @param element Defines the element the controls should be listened from
  43964. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43965. */
  43966. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43967. /**
  43968. * Detach the current controls from the specified dom element.
  43969. * @param element Defines the element to stop listening the inputs from
  43970. */
  43971. detachControl(element: Nullable<HTMLElement>): void;
  43972. /**
  43973. * Gets the class name of the current input.
  43974. * @returns the class name
  43975. */
  43976. getClassName(): string;
  43977. /**
  43978. * Get the friendly name associated with the input class.
  43979. * @returns the input friendly name
  43980. */
  43981. getSimpleName(): string;
  43982. /**
  43983. * Called on pointer POINTERDOUBLETAP event.
  43984. * Override this method to provide functionality on POINTERDOUBLETAP event.
  43985. */
  43986. protected onDoubleTap(type: string): void;
  43987. /**
  43988. * Called on pointer POINTERMOVE event if only a single touch is active.
  43989. * Override this method to provide functionality.
  43990. */
  43991. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  43992. /**
  43993. * Called on pointer POINTERMOVE event if multiple touches are active.
  43994. * Override this method to provide functionality.
  43995. */
  43996. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  43997. /**
  43998. * Called on JS contextmenu event.
  43999. * Override this method to provide functionality.
  44000. */
  44001. protected onContextMenu(evt: PointerEvent): void;
  44002. /**
  44003. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44004. * press.
  44005. * Override this method to provide functionality.
  44006. */
  44007. protected onButtonDown(evt: PointerEvent): void;
  44008. /**
  44009. * Called each time a new POINTERUP event occurs. Ie, for each button
  44010. * release.
  44011. * Override this method to provide functionality.
  44012. */
  44013. protected onButtonUp(evt: PointerEvent): void;
  44014. /**
  44015. * Called when window becomes inactive.
  44016. * Override this method to provide functionality.
  44017. */
  44018. protected onLostFocus(): void;
  44019. private _pointerInput;
  44020. private _observer;
  44021. private _onLostFocus;
  44022. private pointA;
  44023. private pointB;
  44024. }
  44025. }
  44026. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44027. import { Nullable } from "babylonjs/types";
  44028. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44029. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44030. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44031. /**
  44032. * Manage the pointers inputs to control an arc rotate camera.
  44033. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44034. */
  44035. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44036. /**
  44037. * Defines the camera the input is attached to.
  44038. */
  44039. camera: ArcRotateCamera;
  44040. /**
  44041. * Gets the class name of the current input.
  44042. * @returns the class name
  44043. */
  44044. getClassName(): string;
  44045. /**
  44046. * Defines the buttons associated with the input to handle camera move.
  44047. */
  44048. buttons: number[];
  44049. /**
  44050. * Defines the pointer angular sensibility along the X axis or how fast is
  44051. * the camera rotating.
  44052. */
  44053. angularSensibilityX: number;
  44054. /**
  44055. * Defines the pointer angular sensibility along the Y axis or how fast is
  44056. * the camera rotating.
  44057. */
  44058. angularSensibilityY: number;
  44059. /**
  44060. * Defines the pointer pinch precision or how fast is the camera zooming.
  44061. */
  44062. pinchPrecision: number;
  44063. /**
  44064. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44065. * from 0.
  44066. * It defines the percentage of current camera.radius to use as delta when
  44067. * pinch zoom is used.
  44068. */
  44069. pinchDeltaPercentage: number;
  44070. /**
  44071. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44072. * that any object in the plane at the camera's target point will scale
  44073. * perfectly with finger motion.
  44074. * Overrides pinchDeltaPercentage and pinchPrecision.
  44075. */
  44076. useNaturalPinchZoom: boolean;
  44077. /**
  44078. * Defines the pointer panning sensibility or how fast is the camera moving.
  44079. */
  44080. panningSensibility: number;
  44081. /**
  44082. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44083. */
  44084. multiTouchPanning: boolean;
  44085. /**
  44086. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44087. * zoom (pinch) through multitouch.
  44088. */
  44089. multiTouchPanAndZoom: boolean;
  44090. /**
  44091. * Revers pinch action direction.
  44092. */
  44093. pinchInwards: boolean;
  44094. private _isPanClick;
  44095. private _twoFingerActivityCount;
  44096. private _isPinching;
  44097. /**
  44098. * Called on pointer POINTERMOVE event if only a single touch is active.
  44099. */
  44100. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44101. /**
  44102. * Called on pointer POINTERDOUBLETAP event.
  44103. */
  44104. protected onDoubleTap(type: string): void;
  44105. /**
  44106. * Called on pointer POINTERMOVE event if multiple touches are active.
  44107. */
  44108. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44109. /**
  44110. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44111. * press.
  44112. */
  44113. protected onButtonDown(evt: PointerEvent): void;
  44114. /**
  44115. * Called each time a new POINTERUP event occurs. Ie, for each button
  44116. * release.
  44117. */
  44118. protected onButtonUp(evt: PointerEvent): void;
  44119. /**
  44120. * Called when window becomes inactive.
  44121. */
  44122. protected onLostFocus(): void;
  44123. }
  44124. }
  44125. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44126. import { Nullable } from "babylonjs/types";
  44127. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44128. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44129. /**
  44130. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44131. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44132. */
  44133. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44134. /**
  44135. * Defines the camera the input is attached to.
  44136. */
  44137. camera: ArcRotateCamera;
  44138. /**
  44139. * Defines the list of key codes associated with the up action (increase alpha)
  44140. */
  44141. keysUp: number[];
  44142. /**
  44143. * Defines the list of key codes associated with the down action (decrease alpha)
  44144. */
  44145. keysDown: number[];
  44146. /**
  44147. * Defines the list of key codes associated with the left action (increase beta)
  44148. */
  44149. keysLeft: number[];
  44150. /**
  44151. * Defines the list of key codes associated with the right action (decrease beta)
  44152. */
  44153. keysRight: number[];
  44154. /**
  44155. * Defines the list of key codes associated with the reset action.
  44156. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44157. */
  44158. keysReset: number[];
  44159. /**
  44160. * Defines the panning sensibility of the inputs.
  44161. * (How fast is the camera panning)
  44162. */
  44163. panningSensibility: number;
  44164. /**
  44165. * Defines the zooming sensibility of the inputs.
  44166. * (How fast is the camera zooming)
  44167. */
  44168. zoomingSensibility: number;
  44169. /**
  44170. * Defines whether maintaining the alt key down switch the movement mode from
  44171. * orientation to zoom.
  44172. */
  44173. useAltToZoom: boolean;
  44174. /**
  44175. * Rotation speed of the camera
  44176. */
  44177. angularSpeed: number;
  44178. private _keys;
  44179. private _ctrlPressed;
  44180. private _altPressed;
  44181. private _onCanvasBlurObserver;
  44182. private _onKeyboardObserver;
  44183. private _engine;
  44184. private _scene;
  44185. /**
  44186. * Attach the input controls to a specific dom element to get the input from.
  44187. * @param element Defines the element the controls should be listened from
  44188. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44189. */
  44190. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44191. /**
  44192. * Detach the current controls from the specified dom element.
  44193. * @param element Defines the element to stop listening the inputs from
  44194. */
  44195. detachControl(element: Nullable<HTMLElement>): void;
  44196. /**
  44197. * Update the current camera state depending on the inputs that have been used this frame.
  44198. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44199. */
  44200. checkInputs(): void;
  44201. /**
  44202. * Gets the class name of the current intput.
  44203. * @returns the class name
  44204. */
  44205. getClassName(): string;
  44206. /**
  44207. * Get the friendly name associated with the input class.
  44208. * @returns the input friendly name
  44209. */
  44210. getSimpleName(): string;
  44211. }
  44212. }
  44213. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44214. import { Nullable } from "babylonjs/types";
  44215. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44216. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44217. /**
  44218. * Manage the mouse wheel inputs to control an arc rotate camera.
  44219. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44220. */
  44221. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44222. /**
  44223. * Defines the camera the input is attached to.
  44224. */
  44225. camera: ArcRotateCamera;
  44226. /**
  44227. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44228. */
  44229. wheelPrecision: number;
  44230. /**
  44231. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44232. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44233. */
  44234. wheelDeltaPercentage: number;
  44235. private _wheel;
  44236. private _observer;
  44237. private computeDeltaFromMouseWheelLegacyEvent;
  44238. /**
  44239. * Attach the input controls to a specific dom element to get the input from.
  44240. * @param element Defines the element the controls should be listened from
  44241. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44242. */
  44243. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44244. /**
  44245. * Detach the current controls from the specified dom element.
  44246. * @param element Defines the element to stop listening the inputs from
  44247. */
  44248. detachControl(element: Nullable<HTMLElement>): void;
  44249. /**
  44250. * Gets the class name of the current intput.
  44251. * @returns the class name
  44252. */
  44253. getClassName(): string;
  44254. /**
  44255. * Get the friendly name associated with the input class.
  44256. * @returns the input friendly name
  44257. */
  44258. getSimpleName(): string;
  44259. }
  44260. }
  44261. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44262. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44263. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44264. /**
  44265. * Default Inputs manager for the ArcRotateCamera.
  44266. * It groups all the default supported inputs for ease of use.
  44267. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44268. */
  44269. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44270. /**
  44271. * Instantiates a new ArcRotateCameraInputsManager.
  44272. * @param camera Defines the camera the inputs belong to
  44273. */
  44274. constructor(camera: ArcRotateCamera);
  44275. /**
  44276. * Add mouse wheel input support to the input manager.
  44277. * @returns the current input manager
  44278. */
  44279. addMouseWheel(): ArcRotateCameraInputsManager;
  44280. /**
  44281. * Add pointers input support to the input manager.
  44282. * @returns the current input manager
  44283. */
  44284. addPointers(): ArcRotateCameraInputsManager;
  44285. /**
  44286. * Add keyboard input support to the input manager.
  44287. * @returns the current input manager
  44288. */
  44289. addKeyboard(): ArcRotateCameraInputsManager;
  44290. }
  44291. }
  44292. declare module "babylonjs/Cameras/arcRotateCamera" {
  44293. import { Observable } from "babylonjs/Misc/observable";
  44294. import { Nullable } from "babylonjs/types";
  44295. import { Scene } from "babylonjs/scene";
  44296. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44297. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44298. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44299. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44300. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44301. import { Camera } from "babylonjs/Cameras/camera";
  44302. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44303. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44304. import { Collider } from "babylonjs/Collisions/collider";
  44305. /**
  44306. * This represents an orbital type of camera.
  44307. *
  44308. * 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.
  44309. * 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.
  44310. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44311. */
  44312. export class ArcRotateCamera extends TargetCamera {
  44313. /**
  44314. * Defines the rotation angle of the camera along the longitudinal axis.
  44315. */
  44316. alpha: number;
  44317. /**
  44318. * Defines the rotation angle of the camera along the latitudinal axis.
  44319. */
  44320. beta: number;
  44321. /**
  44322. * Defines the radius of the camera from it s target point.
  44323. */
  44324. radius: number;
  44325. protected _target: Vector3;
  44326. protected _targetHost: Nullable<AbstractMesh>;
  44327. /**
  44328. * Defines the target point of the camera.
  44329. * The camera looks towards it form the radius distance.
  44330. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44331. */
  44332. get target(): Vector3;
  44333. set target(value: Vector3);
  44334. /**
  44335. * Define the current local position of the camera in the scene
  44336. */
  44337. get position(): Vector3;
  44338. set position(newPosition: Vector3);
  44339. protected _upToYMatrix: Matrix;
  44340. protected _YToUpMatrix: Matrix;
  44341. /**
  44342. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44343. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44344. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44345. */
  44346. set upVector(vec: Vector3);
  44347. get upVector(): Vector3;
  44348. /**
  44349. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44350. */
  44351. setMatUp(): void;
  44352. /**
  44353. * Current inertia value on the longitudinal axis.
  44354. * The bigger this number the longer it will take for the camera to stop.
  44355. */
  44356. inertialAlphaOffset: number;
  44357. /**
  44358. * Current inertia value on the latitudinal axis.
  44359. * The bigger this number the longer it will take for the camera to stop.
  44360. */
  44361. inertialBetaOffset: number;
  44362. /**
  44363. * Current inertia value on the radius axis.
  44364. * The bigger this number the longer it will take for the camera to stop.
  44365. */
  44366. inertialRadiusOffset: number;
  44367. /**
  44368. * Minimum allowed angle on the longitudinal axis.
  44369. * This can help limiting how the Camera is able to move in the scene.
  44370. */
  44371. lowerAlphaLimit: Nullable<number>;
  44372. /**
  44373. * Maximum allowed angle on the longitudinal axis.
  44374. * This can help limiting how the Camera is able to move in the scene.
  44375. */
  44376. upperAlphaLimit: Nullable<number>;
  44377. /**
  44378. * Minimum allowed angle on the latitudinal axis.
  44379. * This can help limiting how the Camera is able to move in the scene.
  44380. */
  44381. lowerBetaLimit: number;
  44382. /**
  44383. * Maximum allowed angle on the latitudinal axis.
  44384. * This can help limiting how the Camera is able to move in the scene.
  44385. */
  44386. upperBetaLimit: number;
  44387. /**
  44388. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44389. * This can help limiting how the Camera is able to move in the scene.
  44390. */
  44391. lowerRadiusLimit: Nullable<number>;
  44392. /**
  44393. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44394. * This can help limiting how the Camera is able to move in the scene.
  44395. */
  44396. upperRadiusLimit: Nullable<number>;
  44397. /**
  44398. * Defines the current inertia value used during panning of the camera along the X axis.
  44399. */
  44400. inertialPanningX: number;
  44401. /**
  44402. * Defines the current inertia value used during panning of the camera along the Y axis.
  44403. */
  44404. inertialPanningY: number;
  44405. /**
  44406. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44407. * Basically if your fingers moves away from more than this distance you will be considered
  44408. * in pinch mode.
  44409. */
  44410. pinchToPanMaxDistance: number;
  44411. /**
  44412. * Defines the maximum distance the camera can pan.
  44413. * This could help keeping the cammera always in your scene.
  44414. */
  44415. panningDistanceLimit: Nullable<number>;
  44416. /**
  44417. * Defines the target of the camera before paning.
  44418. */
  44419. panningOriginTarget: Vector3;
  44420. /**
  44421. * Defines the value of the inertia used during panning.
  44422. * 0 would mean stop inertia and one would mean no decelleration at all.
  44423. */
  44424. panningInertia: number;
  44425. /**
  44426. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44427. */
  44428. get angularSensibilityX(): number;
  44429. set angularSensibilityX(value: number);
  44430. /**
  44431. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44432. */
  44433. get angularSensibilityY(): number;
  44434. set angularSensibilityY(value: number);
  44435. /**
  44436. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44437. */
  44438. get pinchPrecision(): number;
  44439. set pinchPrecision(value: number);
  44440. /**
  44441. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44442. * It will be used instead of pinchDeltaPrecision if different from 0.
  44443. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44444. */
  44445. get pinchDeltaPercentage(): number;
  44446. set pinchDeltaPercentage(value: number);
  44447. /**
  44448. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44449. * and pinch delta percentage.
  44450. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44451. * that any object in the plane at the camera's target point will scale
  44452. * perfectly with finger motion.
  44453. */
  44454. get useNaturalPinchZoom(): boolean;
  44455. set useNaturalPinchZoom(value: boolean);
  44456. /**
  44457. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44458. */
  44459. get panningSensibility(): number;
  44460. set panningSensibility(value: number);
  44461. /**
  44462. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44463. */
  44464. get keysUp(): number[];
  44465. set keysUp(value: number[]);
  44466. /**
  44467. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44468. */
  44469. get keysDown(): number[];
  44470. set keysDown(value: number[]);
  44471. /**
  44472. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44473. */
  44474. get keysLeft(): number[];
  44475. set keysLeft(value: number[]);
  44476. /**
  44477. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44478. */
  44479. get keysRight(): number[];
  44480. set keysRight(value: number[]);
  44481. /**
  44482. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44483. */
  44484. get wheelPrecision(): number;
  44485. set wheelPrecision(value: number);
  44486. /**
  44487. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44488. * It will be used instead of pinchDeltaPrecision if different from 0.
  44489. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44490. */
  44491. get wheelDeltaPercentage(): number;
  44492. set wheelDeltaPercentage(value: number);
  44493. /**
  44494. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44495. */
  44496. zoomOnFactor: number;
  44497. /**
  44498. * Defines a screen offset for the camera position.
  44499. */
  44500. targetScreenOffset: Vector2;
  44501. /**
  44502. * Allows the camera to be completely reversed.
  44503. * If false the camera can not arrive upside down.
  44504. */
  44505. allowUpsideDown: boolean;
  44506. /**
  44507. * Define if double tap/click is used to restore the previously saved state of the camera.
  44508. */
  44509. useInputToRestoreState: boolean;
  44510. /** @hidden */
  44511. _viewMatrix: Matrix;
  44512. /** @hidden */
  44513. _useCtrlForPanning: boolean;
  44514. /** @hidden */
  44515. _panningMouseButton: number;
  44516. /**
  44517. * Defines the input associated to the camera.
  44518. */
  44519. inputs: ArcRotateCameraInputsManager;
  44520. /** @hidden */
  44521. _reset: () => void;
  44522. /**
  44523. * Defines the allowed panning axis.
  44524. */
  44525. panningAxis: Vector3;
  44526. protected _localDirection: Vector3;
  44527. protected _transformedDirection: Vector3;
  44528. private _bouncingBehavior;
  44529. /**
  44530. * Gets the bouncing behavior of the camera if it has been enabled.
  44531. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44532. */
  44533. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44534. /**
  44535. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44536. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44537. */
  44538. get useBouncingBehavior(): boolean;
  44539. set useBouncingBehavior(value: boolean);
  44540. private _framingBehavior;
  44541. /**
  44542. * Gets the framing behavior of the camera if it has been enabled.
  44543. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44544. */
  44545. get framingBehavior(): Nullable<FramingBehavior>;
  44546. /**
  44547. * Defines if the framing behavior of the camera is enabled on the camera.
  44548. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44549. */
  44550. get useFramingBehavior(): boolean;
  44551. set useFramingBehavior(value: boolean);
  44552. private _autoRotationBehavior;
  44553. /**
  44554. * Gets the auto rotation behavior of the camera if it has been enabled.
  44555. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44556. */
  44557. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44558. /**
  44559. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44560. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44561. */
  44562. get useAutoRotationBehavior(): boolean;
  44563. set useAutoRotationBehavior(value: boolean);
  44564. /**
  44565. * Observable triggered when the mesh target has been changed on the camera.
  44566. */
  44567. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44568. /**
  44569. * Event raised when the camera is colliding with a mesh.
  44570. */
  44571. onCollide: (collidedMesh: AbstractMesh) => void;
  44572. /**
  44573. * Defines whether the camera should check collision with the objects oh the scene.
  44574. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44575. */
  44576. checkCollisions: boolean;
  44577. /**
  44578. * Defines the collision radius of the camera.
  44579. * This simulates a sphere around the camera.
  44580. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44581. */
  44582. collisionRadius: Vector3;
  44583. protected _collider: Collider;
  44584. protected _previousPosition: Vector3;
  44585. protected _collisionVelocity: Vector3;
  44586. protected _newPosition: Vector3;
  44587. protected _previousAlpha: number;
  44588. protected _previousBeta: number;
  44589. protected _previousRadius: number;
  44590. protected _collisionTriggered: boolean;
  44591. protected _targetBoundingCenter: Nullable<Vector3>;
  44592. private _computationVector;
  44593. /**
  44594. * Instantiates a new ArcRotateCamera in a given scene
  44595. * @param name Defines the name of the camera
  44596. * @param alpha Defines the camera rotation along the logitudinal axis
  44597. * @param beta Defines the camera rotation along the latitudinal axis
  44598. * @param radius Defines the camera distance from its target
  44599. * @param target Defines the camera target
  44600. * @param scene Defines the scene the camera belongs to
  44601. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44602. */
  44603. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44604. /** @hidden */
  44605. _initCache(): void;
  44606. /** @hidden */
  44607. _updateCache(ignoreParentClass?: boolean): void;
  44608. protected _getTargetPosition(): Vector3;
  44609. private _storedAlpha;
  44610. private _storedBeta;
  44611. private _storedRadius;
  44612. private _storedTarget;
  44613. private _storedTargetScreenOffset;
  44614. /**
  44615. * Stores the current state of the camera (alpha, beta, radius and target)
  44616. * @returns the camera itself
  44617. */
  44618. storeState(): Camera;
  44619. /**
  44620. * @hidden
  44621. * Restored camera state. You must call storeState() first
  44622. */
  44623. _restoreStateValues(): boolean;
  44624. /** @hidden */
  44625. _isSynchronizedViewMatrix(): boolean;
  44626. /**
  44627. * Attached controls to the current camera.
  44628. * @param element Defines the element the controls should be listened from
  44629. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44630. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44631. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44632. */
  44633. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44634. /**
  44635. * Detach the current controls from the camera.
  44636. * The camera will stop reacting to inputs.
  44637. * @param element Defines the element to stop listening the inputs from
  44638. */
  44639. detachControl(element: HTMLElement): void;
  44640. /** @hidden */
  44641. _checkInputs(): void;
  44642. protected _checkLimits(): void;
  44643. /**
  44644. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44645. */
  44646. rebuildAnglesAndRadius(): void;
  44647. /**
  44648. * Use a position to define the current camera related information like alpha, beta and radius
  44649. * @param position Defines the position to set the camera at
  44650. */
  44651. setPosition(position: Vector3): void;
  44652. /**
  44653. * Defines the target the camera should look at.
  44654. * This will automatically adapt alpha beta and radius to fit within the new target.
  44655. * @param target Defines the new target as a Vector or a mesh
  44656. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44657. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44658. */
  44659. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44660. /** @hidden */
  44661. _getViewMatrix(): Matrix;
  44662. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44663. /**
  44664. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44665. * @param meshes Defines the mesh to zoom on
  44666. * @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)
  44667. */
  44668. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44669. /**
  44670. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44671. * The target will be changed but the radius
  44672. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44673. * @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)
  44674. */
  44675. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44676. min: Vector3;
  44677. max: Vector3;
  44678. distance: number;
  44679. }, doNotUpdateMaxZ?: boolean): void;
  44680. /**
  44681. * @override
  44682. * Override Camera.createRigCamera
  44683. */
  44684. createRigCamera(name: string, cameraIndex: number): Camera;
  44685. /**
  44686. * @hidden
  44687. * @override
  44688. * Override Camera._updateRigCameras
  44689. */
  44690. _updateRigCameras(): void;
  44691. /**
  44692. * Destroy the camera and release the current resources hold by it.
  44693. */
  44694. dispose(): void;
  44695. /**
  44696. * Gets the current object class name.
  44697. * @return the class name
  44698. */
  44699. getClassName(): string;
  44700. }
  44701. }
  44702. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44703. import { Behavior } from "babylonjs/Behaviors/behavior";
  44704. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44705. /**
  44706. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44707. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44708. */
  44709. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44710. /**
  44711. * Gets the name of the behavior.
  44712. */
  44713. get name(): string;
  44714. private _zoomStopsAnimation;
  44715. private _idleRotationSpeed;
  44716. private _idleRotationWaitTime;
  44717. private _idleRotationSpinupTime;
  44718. /**
  44719. * Sets the flag that indicates if user zooming should stop animation.
  44720. */
  44721. set zoomStopsAnimation(flag: boolean);
  44722. /**
  44723. * Gets the flag that indicates if user zooming should stop animation.
  44724. */
  44725. get zoomStopsAnimation(): boolean;
  44726. /**
  44727. * Sets the default speed at which the camera rotates around the model.
  44728. */
  44729. set idleRotationSpeed(speed: number);
  44730. /**
  44731. * Gets the default speed at which the camera rotates around the model.
  44732. */
  44733. get idleRotationSpeed(): number;
  44734. /**
  44735. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44736. */
  44737. set idleRotationWaitTime(time: number);
  44738. /**
  44739. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44740. */
  44741. get idleRotationWaitTime(): number;
  44742. /**
  44743. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44744. */
  44745. set idleRotationSpinupTime(time: number);
  44746. /**
  44747. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44748. */
  44749. get idleRotationSpinupTime(): number;
  44750. /**
  44751. * Gets a value indicating if the camera is currently rotating because of this behavior
  44752. */
  44753. get rotationInProgress(): boolean;
  44754. private _onPrePointerObservableObserver;
  44755. private _onAfterCheckInputsObserver;
  44756. private _attachedCamera;
  44757. private _isPointerDown;
  44758. private _lastFrameTime;
  44759. private _lastInteractionTime;
  44760. private _cameraRotationSpeed;
  44761. /**
  44762. * Initializes the behavior.
  44763. */
  44764. init(): void;
  44765. /**
  44766. * Attaches the behavior to its arc rotate camera.
  44767. * @param camera Defines the camera to attach the behavior to
  44768. */
  44769. attach(camera: ArcRotateCamera): void;
  44770. /**
  44771. * Detaches the behavior from its current arc rotate camera.
  44772. */
  44773. detach(): void;
  44774. /**
  44775. * Returns true if user is scrolling.
  44776. * @return true if user is scrolling.
  44777. */
  44778. private _userIsZooming;
  44779. private _lastFrameRadius;
  44780. private _shouldAnimationStopForInteraction;
  44781. /**
  44782. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44783. */
  44784. private _applyUserInteraction;
  44785. private _userIsMoving;
  44786. }
  44787. }
  44788. declare module "babylonjs/Behaviors/Cameras/index" {
  44789. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44790. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44791. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44792. }
  44793. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44794. import { Mesh } from "babylonjs/Meshes/mesh";
  44795. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44796. import { Behavior } from "babylonjs/Behaviors/behavior";
  44797. /**
  44798. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44799. */
  44800. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44801. private ui;
  44802. /**
  44803. * The name of the behavior
  44804. */
  44805. name: string;
  44806. /**
  44807. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44808. */
  44809. distanceAwayFromFace: number;
  44810. /**
  44811. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44812. */
  44813. distanceAwayFromBottomOfFace: number;
  44814. private _faceVectors;
  44815. private _target;
  44816. private _scene;
  44817. private _onRenderObserver;
  44818. private _tmpMatrix;
  44819. private _tmpVector;
  44820. /**
  44821. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44822. * @param ui The transform node that should be attched to the mesh
  44823. */
  44824. constructor(ui: TransformNode);
  44825. /**
  44826. * Initializes the behavior
  44827. */
  44828. init(): void;
  44829. private _closestFace;
  44830. private _zeroVector;
  44831. private _lookAtTmpMatrix;
  44832. private _lookAtToRef;
  44833. /**
  44834. * Attaches the AttachToBoxBehavior to the passed in mesh
  44835. * @param target The mesh that the specified node will be attached to
  44836. */
  44837. attach(target: Mesh): void;
  44838. /**
  44839. * Detaches the behavior from the mesh
  44840. */
  44841. detach(): void;
  44842. }
  44843. }
  44844. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44845. import { Behavior } from "babylonjs/Behaviors/behavior";
  44846. import { Mesh } from "babylonjs/Meshes/mesh";
  44847. /**
  44848. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44849. */
  44850. export class FadeInOutBehavior implements Behavior<Mesh> {
  44851. /**
  44852. * Time in milliseconds to delay before fading in (Default: 0)
  44853. */
  44854. delay: number;
  44855. /**
  44856. * Time in milliseconds for the mesh to fade in (Default: 300)
  44857. */
  44858. fadeInTime: number;
  44859. private _millisecondsPerFrame;
  44860. private _hovered;
  44861. private _hoverValue;
  44862. private _ownerNode;
  44863. /**
  44864. * Instatiates the FadeInOutBehavior
  44865. */
  44866. constructor();
  44867. /**
  44868. * The name of the behavior
  44869. */
  44870. get name(): string;
  44871. /**
  44872. * Initializes the behavior
  44873. */
  44874. init(): void;
  44875. /**
  44876. * Attaches the fade behavior on the passed in mesh
  44877. * @param ownerNode The mesh that will be faded in/out once attached
  44878. */
  44879. attach(ownerNode: Mesh): void;
  44880. /**
  44881. * Detaches the behavior from the mesh
  44882. */
  44883. detach(): void;
  44884. /**
  44885. * Triggers the mesh to begin fading in or out
  44886. * @param value if the object should fade in or out (true to fade in)
  44887. */
  44888. fadeIn(value: boolean): void;
  44889. private _update;
  44890. private _setAllVisibility;
  44891. }
  44892. }
  44893. declare module "babylonjs/Misc/pivotTools" {
  44894. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44895. /**
  44896. * Class containing a set of static utilities functions for managing Pivots
  44897. * @hidden
  44898. */
  44899. export class PivotTools {
  44900. private static _PivotCached;
  44901. private static _OldPivotPoint;
  44902. private static _PivotTranslation;
  44903. private static _PivotTmpVector;
  44904. /** @hidden */
  44905. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44906. /** @hidden */
  44907. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44908. }
  44909. }
  44910. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44911. import { Scene } from "babylonjs/scene";
  44912. import { Vector4 } from "babylonjs/Maths/math.vector";
  44913. import { Mesh } from "babylonjs/Meshes/mesh";
  44914. import { Nullable } from "babylonjs/types";
  44915. import { Plane } from "babylonjs/Maths/math.plane";
  44916. /**
  44917. * Class containing static functions to help procedurally build meshes
  44918. */
  44919. export class PlaneBuilder {
  44920. /**
  44921. * Creates a plane mesh
  44922. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44923. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44924. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44925. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44926. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44927. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44928. * @param name defines the name of the mesh
  44929. * @param options defines the options used to create the mesh
  44930. * @param scene defines the hosting scene
  44931. * @returns the plane mesh
  44932. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44933. */
  44934. static CreatePlane(name: string, options: {
  44935. size?: number;
  44936. width?: number;
  44937. height?: number;
  44938. sideOrientation?: number;
  44939. frontUVs?: Vector4;
  44940. backUVs?: Vector4;
  44941. updatable?: boolean;
  44942. sourcePlane?: Plane;
  44943. }, scene?: Nullable<Scene>): Mesh;
  44944. }
  44945. }
  44946. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44947. import { Behavior } from "babylonjs/Behaviors/behavior";
  44948. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44949. import { Observable } from "babylonjs/Misc/observable";
  44950. import { Vector3 } from "babylonjs/Maths/math.vector";
  44951. import { Ray } from "babylonjs/Culling/ray";
  44952. import "babylonjs/Meshes/Builders/planeBuilder";
  44953. /**
  44954. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44955. */
  44956. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44957. private static _AnyMouseID;
  44958. /**
  44959. * Abstract mesh the behavior is set on
  44960. */
  44961. attachedNode: AbstractMesh;
  44962. private _dragPlane;
  44963. private _scene;
  44964. private _pointerObserver;
  44965. private _beforeRenderObserver;
  44966. private static _planeScene;
  44967. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44968. /**
  44969. * 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)
  44970. */
  44971. maxDragAngle: number;
  44972. /**
  44973. * @hidden
  44974. */
  44975. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44976. /**
  44977. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44978. */
  44979. currentDraggingPointerID: number;
  44980. /**
  44981. * The last position where the pointer hit the drag plane in world space
  44982. */
  44983. lastDragPosition: Vector3;
  44984. /**
  44985. * If the behavior is currently in a dragging state
  44986. */
  44987. dragging: boolean;
  44988. /**
  44989. * 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)
  44990. */
  44991. dragDeltaRatio: number;
  44992. /**
  44993. * If the drag plane orientation should be updated during the dragging (Default: true)
  44994. */
  44995. updateDragPlane: boolean;
  44996. private _debugMode;
  44997. private _moving;
  44998. /**
  44999. * Fires each time the attached mesh is dragged with the pointer
  45000. * * delta between last drag position and current drag position in world space
  45001. * * dragDistance along the drag axis
  45002. * * dragPlaneNormal normal of the current drag plane used during the drag
  45003. * * dragPlanePoint in world space where the drag intersects the drag plane
  45004. */
  45005. onDragObservable: Observable<{
  45006. delta: Vector3;
  45007. dragPlanePoint: Vector3;
  45008. dragPlaneNormal: Vector3;
  45009. dragDistance: number;
  45010. pointerId: number;
  45011. }>;
  45012. /**
  45013. * Fires each time a drag begins (eg. mouse down on mesh)
  45014. */
  45015. onDragStartObservable: Observable<{
  45016. dragPlanePoint: Vector3;
  45017. pointerId: number;
  45018. }>;
  45019. /**
  45020. * Fires each time a drag ends (eg. mouse release after drag)
  45021. */
  45022. onDragEndObservable: Observable<{
  45023. dragPlanePoint: Vector3;
  45024. pointerId: number;
  45025. }>;
  45026. /**
  45027. * If the attached mesh should be moved when dragged
  45028. */
  45029. moveAttached: boolean;
  45030. /**
  45031. * If the drag behavior will react to drag events (Default: true)
  45032. */
  45033. enabled: boolean;
  45034. /**
  45035. * If pointer events should start and release the drag (Default: true)
  45036. */
  45037. startAndReleaseDragOnPointerEvents: boolean;
  45038. /**
  45039. * If camera controls should be detached during the drag
  45040. */
  45041. detachCameraControls: boolean;
  45042. /**
  45043. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45044. */
  45045. useObjectOrientationForDragging: boolean;
  45046. private _options;
  45047. /**
  45048. * Gets the options used by the behavior
  45049. */
  45050. get options(): {
  45051. dragAxis?: Vector3;
  45052. dragPlaneNormal?: Vector3;
  45053. };
  45054. /**
  45055. * Sets the options used by the behavior
  45056. */
  45057. set options(options: {
  45058. dragAxis?: Vector3;
  45059. dragPlaneNormal?: Vector3;
  45060. });
  45061. /**
  45062. * Creates a pointer drag behavior that can be attached to a mesh
  45063. * @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)
  45064. */
  45065. constructor(options?: {
  45066. dragAxis?: Vector3;
  45067. dragPlaneNormal?: Vector3;
  45068. });
  45069. /**
  45070. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45071. */
  45072. validateDrag: (targetPosition: Vector3) => boolean;
  45073. /**
  45074. * The name of the behavior
  45075. */
  45076. get name(): string;
  45077. /**
  45078. * Initializes the behavior
  45079. */
  45080. init(): void;
  45081. private _tmpVector;
  45082. private _alternatePickedPoint;
  45083. private _worldDragAxis;
  45084. private _targetPosition;
  45085. private _attachedElement;
  45086. /**
  45087. * Attaches the drag behavior the passed in mesh
  45088. * @param ownerNode The mesh that will be dragged around once attached
  45089. * @param predicate Predicate to use for pick filtering
  45090. */
  45091. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45092. /**
  45093. * Force relase the drag action by code.
  45094. */
  45095. releaseDrag(): void;
  45096. private _startDragRay;
  45097. private _lastPointerRay;
  45098. /**
  45099. * Simulates the start of a pointer drag event on the behavior
  45100. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45101. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45102. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45103. */
  45104. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45105. private _startDrag;
  45106. private _dragDelta;
  45107. private _moveDrag;
  45108. private _pickWithRayOnDragPlane;
  45109. private _pointA;
  45110. private _pointC;
  45111. private _localAxis;
  45112. private _lookAt;
  45113. private _updateDragPlanePosition;
  45114. /**
  45115. * Detaches the behavior from the mesh
  45116. */
  45117. detach(): void;
  45118. }
  45119. }
  45120. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45121. import { Mesh } from "babylonjs/Meshes/mesh";
  45122. import { Behavior } from "babylonjs/Behaviors/behavior";
  45123. /**
  45124. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45125. */
  45126. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45127. private _dragBehaviorA;
  45128. private _dragBehaviorB;
  45129. private _startDistance;
  45130. private _initialScale;
  45131. private _targetScale;
  45132. private _ownerNode;
  45133. private _sceneRenderObserver;
  45134. /**
  45135. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45136. */
  45137. constructor();
  45138. /**
  45139. * The name of the behavior
  45140. */
  45141. get name(): string;
  45142. /**
  45143. * Initializes the behavior
  45144. */
  45145. init(): void;
  45146. private _getCurrentDistance;
  45147. /**
  45148. * Attaches the scale behavior the passed in mesh
  45149. * @param ownerNode The mesh that will be scaled around once attached
  45150. */
  45151. attach(ownerNode: Mesh): void;
  45152. /**
  45153. * Detaches the behavior from the mesh
  45154. */
  45155. detach(): void;
  45156. }
  45157. }
  45158. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45159. import { Behavior } from "babylonjs/Behaviors/behavior";
  45160. import { Mesh } from "babylonjs/Meshes/mesh";
  45161. import { Observable } from "babylonjs/Misc/observable";
  45162. /**
  45163. * 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
  45164. */
  45165. export class SixDofDragBehavior implements Behavior<Mesh> {
  45166. private static _virtualScene;
  45167. private _ownerNode;
  45168. private _sceneRenderObserver;
  45169. private _scene;
  45170. private _targetPosition;
  45171. private _virtualOriginMesh;
  45172. private _virtualDragMesh;
  45173. private _pointerObserver;
  45174. private _moving;
  45175. private _startingOrientation;
  45176. private _attachedElement;
  45177. /**
  45178. * 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)
  45179. */
  45180. private zDragFactor;
  45181. /**
  45182. * If the object should rotate to face the drag origin
  45183. */
  45184. rotateDraggedObject: boolean;
  45185. /**
  45186. * If the behavior is currently in a dragging state
  45187. */
  45188. dragging: boolean;
  45189. /**
  45190. * 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)
  45191. */
  45192. dragDeltaRatio: number;
  45193. /**
  45194. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45195. */
  45196. currentDraggingPointerID: number;
  45197. /**
  45198. * If camera controls should be detached during the drag
  45199. */
  45200. detachCameraControls: boolean;
  45201. /**
  45202. * Fires each time a drag starts
  45203. */
  45204. onDragStartObservable: Observable<{}>;
  45205. /**
  45206. * Fires each time a drag ends (eg. mouse release after drag)
  45207. */
  45208. onDragEndObservable: Observable<{}>;
  45209. /**
  45210. * 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
  45211. */
  45212. constructor();
  45213. /**
  45214. * The name of the behavior
  45215. */
  45216. get name(): string;
  45217. /**
  45218. * Initializes the behavior
  45219. */
  45220. init(): void;
  45221. /**
  45222. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45223. */
  45224. private get _pointerCamera();
  45225. /**
  45226. * Attaches the scale behavior the passed in mesh
  45227. * @param ownerNode The mesh that will be scaled around once attached
  45228. */
  45229. attach(ownerNode: Mesh): void;
  45230. /**
  45231. * Detaches the behavior from the mesh
  45232. */
  45233. detach(): void;
  45234. }
  45235. }
  45236. declare module "babylonjs/Behaviors/Meshes/index" {
  45237. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45238. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45239. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45240. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45241. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45242. }
  45243. declare module "babylonjs/Behaviors/index" {
  45244. export * from "babylonjs/Behaviors/behavior";
  45245. export * from "babylonjs/Behaviors/Cameras/index";
  45246. export * from "babylonjs/Behaviors/Meshes/index";
  45247. }
  45248. declare module "babylonjs/Bones/boneIKController" {
  45249. import { Bone } from "babylonjs/Bones/bone";
  45250. import { Vector3 } from "babylonjs/Maths/math.vector";
  45251. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45252. import { Nullable } from "babylonjs/types";
  45253. /**
  45254. * Class used to apply inverse kinematics to bones
  45255. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45256. */
  45257. export class BoneIKController {
  45258. private static _tmpVecs;
  45259. private static _tmpQuat;
  45260. private static _tmpMats;
  45261. /**
  45262. * Gets or sets the target mesh
  45263. */
  45264. targetMesh: AbstractMesh;
  45265. /** Gets or sets the mesh used as pole */
  45266. poleTargetMesh: AbstractMesh;
  45267. /**
  45268. * Gets or sets the bone used as pole
  45269. */
  45270. poleTargetBone: Nullable<Bone>;
  45271. /**
  45272. * Gets or sets the target position
  45273. */
  45274. targetPosition: Vector3;
  45275. /**
  45276. * Gets or sets the pole target position
  45277. */
  45278. poleTargetPosition: Vector3;
  45279. /**
  45280. * Gets or sets the pole target local offset
  45281. */
  45282. poleTargetLocalOffset: Vector3;
  45283. /**
  45284. * Gets or sets the pole angle
  45285. */
  45286. poleAngle: number;
  45287. /**
  45288. * Gets or sets the mesh associated with the controller
  45289. */
  45290. mesh: AbstractMesh;
  45291. /**
  45292. * 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)
  45293. */
  45294. slerpAmount: number;
  45295. private _bone1Quat;
  45296. private _bone1Mat;
  45297. private _bone2Ang;
  45298. private _bone1;
  45299. private _bone2;
  45300. private _bone1Length;
  45301. private _bone2Length;
  45302. private _maxAngle;
  45303. private _maxReach;
  45304. private _rightHandedSystem;
  45305. private _bendAxis;
  45306. private _slerping;
  45307. private _adjustRoll;
  45308. /**
  45309. * Gets or sets maximum allowed angle
  45310. */
  45311. get maxAngle(): number;
  45312. set maxAngle(value: number);
  45313. /**
  45314. * Creates a new BoneIKController
  45315. * @param mesh defines the mesh to control
  45316. * @param bone defines the bone to control
  45317. * @param options defines options to set up the controller
  45318. */
  45319. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45320. targetMesh?: AbstractMesh;
  45321. poleTargetMesh?: AbstractMesh;
  45322. poleTargetBone?: Bone;
  45323. poleTargetLocalOffset?: Vector3;
  45324. poleAngle?: number;
  45325. bendAxis?: Vector3;
  45326. maxAngle?: number;
  45327. slerpAmount?: number;
  45328. });
  45329. private _setMaxAngle;
  45330. /**
  45331. * Force the controller to update the bones
  45332. */
  45333. update(): void;
  45334. }
  45335. }
  45336. declare module "babylonjs/Bones/boneLookController" {
  45337. import { Vector3 } from "babylonjs/Maths/math.vector";
  45338. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45339. import { Bone } from "babylonjs/Bones/bone";
  45340. import { Space } from "babylonjs/Maths/math.axis";
  45341. /**
  45342. * Class used to make a bone look toward a point in space
  45343. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45344. */
  45345. export class BoneLookController {
  45346. private static _tmpVecs;
  45347. private static _tmpQuat;
  45348. private static _tmpMats;
  45349. /**
  45350. * The target Vector3 that the bone will look at
  45351. */
  45352. target: Vector3;
  45353. /**
  45354. * The mesh that the bone is attached to
  45355. */
  45356. mesh: AbstractMesh;
  45357. /**
  45358. * The bone that will be looking to the target
  45359. */
  45360. bone: Bone;
  45361. /**
  45362. * The up axis of the coordinate system that is used when the bone is rotated
  45363. */
  45364. upAxis: Vector3;
  45365. /**
  45366. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45367. */
  45368. upAxisSpace: Space;
  45369. /**
  45370. * Used to make an adjustment to the yaw of the bone
  45371. */
  45372. adjustYaw: number;
  45373. /**
  45374. * Used to make an adjustment to the pitch of the bone
  45375. */
  45376. adjustPitch: number;
  45377. /**
  45378. * Used to make an adjustment to the roll of the bone
  45379. */
  45380. adjustRoll: number;
  45381. /**
  45382. * 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)
  45383. */
  45384. slerpAmount: number;
  45385. private _minYaw;
  45386. private _maxYaw;
  45387. private _minPitch;
  45388. private _maxPitch;
  45389. private _minYawSin;
  45390. private _minYawCos;
  45391. private _maxYawSin;
  45392. private _maxYawCos;
  45393. private _midYawConstraint;
  45394. private _minPitchTan;
  45395. private _maxPitchTan;
  45396. private _boneQuat;
  45397. private _slerping;
  45398. private _transformYawPitch;
  45399. private _transformYawPitchInv;
  45400. private _firstFrameSkipped;
  45401. private _yawRange;
  45402. private _fowardAxis;
  45403. /**
  45404. * Gets or sets the minimum yaw angle that the bone can look to
  45405. */
  45406. get minYaw(): number;
  45407. set minYaw(value: number);
  45408. /**
  45409. * Gets or sets the maximum yaw angle that the bone can look to
  45410. */
  45411. get maxYaw(): number;
  45412. set maxYaw(value: number);
  45413. /**
  45414. * Gets or sets the minimum pitch angle that the bone can look to
  45415. */
  45416. get minPitch(): number;
  45417. set minPitch(value: number);
  45418. /**
  45419. * Gets or sets the maximum pitch angle that the bone can look to
  45420. */
  45421. get maxPitch(): number;
  45422. set maxPitch(value: number);
  45423. /**
  45424. * Create a BoneLookController
  45425. * @param mesh the mesh that the bone belongs to
  45426. * @param bone the bone that will be looking to the target
  45427. * @param target the target Vector3 to look at
  45428. * @param options optional settings:
  45429. * * maxYaw: the maximum angle the bone will yaw to
  45430. * * minYaw: the minimum angle the bone will yaw to
  45431. * * maxPitch: the maximum angle the bone will pitch to
  45432. * * minPitch: the minimum angle the bone will yaw to
  45433. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45434. * * upAxis: the up axis of the coordinate system
  45435. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45436. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45437. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45438. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45439. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45440. * * adjustRoll: used to make an adjustment to the roll of the bone
  45441. **/
  45442. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45443. maxYaw?: number;
  45444. minYaw?: number;
  45445. maxPitch?: number;
  45446. minPitch?: number;
  45447. slerpAmount?: number;
  45448. upAxis?: Vector3;
  45449. upAxisSpace?: Space;
  45450. yawAxis?: Vector3;
  45451. pitchAxis?: Vector3;
  45452. adjustYaw?: number;
  45453. adjustPitch?: number;
  45454. adjustRoll?: number;
  45455. });
  45456. /**
  45457. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45458. */
  45459. update(): void;
  45460. private _getAngleDiff;
  45461. private _getAngleBetween;
  45462. private _isAngleBetween;
  45463. }
  45464. }
  45465. declare module "babylonjs/Bones/index" {
  45466. export * from "babylonjs/Bones/bone";
  45467. export * from "babylonjs/Bones/boneIKController";
  45468. export * from "babylonjs/Bones/boneLookController";
  45469. export * from "babylonjs/Bones/skeleton";
  45470. }
  45471. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45472. import { Nullable } from "babylonjs/types";
  45473. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45474. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45475. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45476. /**
  45477. * Manage the gamepad inputs to control an arc rotate camera.
  45478. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45479. */
  45480. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45481. /**
  45482. * Defines the camera the input is attached to.
  45483. */
  45484. camera: ArcRotateCamera;
  45485. /**
  45486. * Defines the gamepad the input is gathering event from.
  45487. */
  45488. gamepad: Nullable<Gamepad>;
  45489. /**
  45490. * Defines the gamepad rotation sensiblity.
  45491. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45492. */
  45493. gamepadRotationSensibility: number;
  45494. /**
  45495. * Defines the gamepad move sensiblity.
  45496. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45497. */
  45498. gamepadMoveSensibility: number;
  45499. private _yAxisScale;
  45500. /**
  45501. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45502. */
  45503. get invertYAxis(): boolean;
  45504. set invertYAxis(value: boolean);
  45505. private _onGamepadConnectedObserver;
  45506. private _onGamepadDisconnectedObserver;
  45507. /**
  45508. * Attach the input controls to a specific dom element to get the input from.
  45509. * @param element Defines the element the controls should be listened from
  45510. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45511. */
  45512. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45513. /**
  45514. * Detach the current controls from the specified dom element.
  45515. * @param element Defines the element to stop listening the inputs from
  45516. */
  45517. detachControl(element: Nullable<HTMLElement>): void;
  45518. /**
  45519. * Update the current camera state depending on the inputs that have been used this frame.
  45520. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45521. */
  45522. checkInputs(): void;
  45523. /**
  45524. * Gets the class name of the current intput.
  45525. * @returns the class name
  45526. */
  45527. getClassName(): string;
  45528. /**
  45529. * Get the friendly name associated with the input class.
  45530. * @returns the input friendly name
  45531. */
  45532. getSimpleName(): string;
  45533. }
  45534. }
  45535. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45536. import { Nullable } from "babylonjs/types";
  45537. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45538. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45539. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45540. interface ArcRotateCameraInputsManager {
  45541. /**
  45542. * Add orientation input support to the input manager.
  45543. * @returns the current input manager
  45544. */
  45545. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45546. }
  45547. }
  45548. /**
  45549. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45550. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45551. */
  45552. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45553. /**
  45554. * Defines the camera the input is attached to.
  45555. */
  45556. camera: ArcRotateCamera;
  45557. /**
  45558. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45559. */
  45560. alphaCorrection: number;
  45561. /**
  45562. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45563. */
  45564. gammaCorrection: number;
  45565. private _alpha;
  45566. private _gamma;
  45567. private _dirty;
  45568. private _deviceOrientationHandler;
  45569. /**
  45570. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45571. */
  45572. constructor();
  45573. /**
  45574. * Attach the input controls to a specific dom element to get the input from.
  45575. * @param element Defines the element the controls should be listened from
  45576. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45577. */
  45578. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45579. /** @hidden */
  45580. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45581. /**
  45582. * Update the current camera state depending on the inputs that have been used this frame.
  45583. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45584. */
  45585. checkInputs(): void;
  45586. /**
  45587. * Detach the current controls from the specified dom element.
  45588. * @param element Defines the element to stop listening the inputs from
  45589. */
  45590. detachControl(element: Nullable<HTMLElement>): void;
  45591. /**
  45592. * Gets the class name of the current intput.
  45593. * @returns the class name
  45594. */
  45595. getClassName(): string;
  45596. /**
  45597. * Get the friendly name associated with the input class.
  45598. * @returns the input friendly name
  45599. */
  45600. getSimpleName(): string;
  45601. }
  45602. }
  45603. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45604. import { Nullable } from "babylonjs/types";
  45605. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45606. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45607. /**
  45608. * Listen to mouse events to control the camera.
  45609. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45610. */
  45611. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45612. /**
  45613. * Defines the camera the input is attached to.
  45614. */
  45615. camera: FlyCamera;
  45616. /**
  45617. * Defines if touch is enabled. (Default is true.)
  45618. */
  45619. touchEnabled: boolean;
  45620. /**
  45621. * Defines the buttons associated with the input to handle camera rotation.
  45622. */
  45623. buttons: number[];
  45624. /**
  45625. * Assign buttons for Yaw control.
  45626. */
  45627. buttonsYaw: number[];
  45628. /**
  45629. * Assign buttons for Pitch control.
  45630. */
  45631. buttonsPitch: number[];
  45632. /**
  45633. * Assign buttons for Roll control.
  45634. */
  45635. buttonsRoll: number[];
  45636. /**
  45637. * Detect if any button is being pressed while mouse is moved.
  45638. * -1 = Mouse locked.
  45639. * 0 = Left button.
  45640. * 1 = Middle Button.
  45641. * 2 = Right Button.
  45642. */
  45643. activeButton: number;
  45644. /**
  45645. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45646. * Higher values reduce its sensitivity.
  45647. */
  45648. angularSensibility: number;
  45649. private _mousemoveCallback;
  45650. private _observer;
  45651. private _rollObserver;
  45652. private previousPosition;
  45653. private noPreventDefault;
  45654. private element;
  45655. /**
  45656. * Listen to mouse events to control the camera.
  45657. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45658. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45659. */
  45660. constructor(touchEnabled?: boolean);
  45661. /**
  45662. * Attach the mouse control to the HTML DOM element.
  45663. * @param element Defines the element that listens to the input events.
  45664. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45665. */
  45666. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45667. /**
  45668. * Detach the current controls from the specified dom element.
  45669. * @param element Defines the element to stop listening the inputs from
  45670. */
  45671. detachControl(element: Nullable<HTMLElement>): void;
  45672. /**
  45673. * Gets the class name of the current input.
  45674. * @returns the class name.
  45675. */
  45676. getClassName(): string;
  45677. /**
  45678. * Get the friendly name associated with the input class.
  45679. * @returns the input's friendly name.
  45680. */
  45681. getSimpleName(): string;
  45682. private _pointerInput;
  45683. private _onMouseMove;
  45684. /**
  45685. * Rotate camera by mouse offset.
  45686. */
  45687. private rotateCamera;
  45688. }
  45689. }
  45690. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45691. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45692. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45693. /**
  45694. * Default Inputs manager for the FlyCamera.
  45695. * It groups all the default supported inputs for ease of use.
  45696. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45697. */
  45698. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45699. /**
  45700. * Instantiates a new FlyCameraInputsManager.
  45701. * @param camera Defines the camera the inputs belong to.
  45702. */
  45703. constructor(camera: FlyCamera);
  45704. /**
  45705. * Add keyboard input support to the input manager.
  45706. * @returns the new FlyCameraKeyboardMoveInput().
  45707. */
  45708. addKeyboard(): FlyCameraInputsManager;
  45709. /**
  45710. * Add mouse input support to the input manager.
  45711. * @param touchEnabled Enable touch screen support.
  45712. * @returns the new FlyCameraMouseInput().
  45713. */
  45714. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45715. }
  45716. }
  45717. declare module "babylonjs/Cameras/flyCamera" {
  45718. import { Scene } from "babylonjs/scene";
  45719. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45720. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45721. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45722. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45723. /**
  45724. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45725. * such as in a 3D Space Shooter or a Flight Simulator.
  45726. */
  45727. export class FlyCamera extends TargetCamera {
  45728. /**
  45729. * Define the collision ellipsoid of the camera.
  45730. * This is helpful for simulating a camera body, like a player's body.
  45731. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45732. */
  45733. ellipsoid: Vector3;
  45734. /**
  45735. * Define an offset for the position of the ellipsoid around the camera.
  45736. * This can be helpful if the camera is attached away from the player's body center,
  45737. * such as at its head.
  45738. */
  45739. ellipsoidOffset: Vector3;
  45740. /**
  45741. * Enable or disable collisions of the camera with the rest of the scene objects.
  45742. */
  45743. checkCollisions: boolean;
  45744. /**
  45745. * Enable or disable gravity on the camera.
  45746. */
  45747. applyGravity: boolean;
  45748. /**
  45749. * Define the current direction the camera is moving to.
  45750. */
  45751. cameraDirection: Vector3;
  45752. /**
  45753. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45754. * This overrides and empties cameraRotation.
  45755. */
  45756. rotationQuaternion: Quaternion;
  45757. /**
  45758. * Track Roll to maintain the wanted Rolling when looking around.
  45759. */
  45760. _trackRoll: number;
  45761. /**
  45762. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45763. */
  45764. rollCorrect: number;
  45765. /**
  45766. * Mimic a banked turn, Rolling the camera when Yawing.
  45767. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45768. */
  45769. bankedTurn: boolean;
  45770. /**
  45771. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45772. */
  45773. bankedTurnLimit: number;
  45774. /**
  45775. * Value of 0 disables the banked Roll.
  45776. * Value of 1 is equal to the Yaw angle in radians.
  45777. */
  45778. bankedTurnMultiplier: number;
  45779. /**
  45780. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45781. */
  45782. inputs: FlyCameraInputsManager;
  45783. /**
  45784. * Gets the input sensibility for mouse input.
  45785. * Higher values reduce sensitivity.
  45786. */
  45787. get angularSensibility(): number;
  45788. /**
  45789. * Sets the input sensibility for a mouse input.
  45790. * Higher values reduce sensitivity.
  45791. */
  45792. set angularSensibility(value: number);
  45793. /**
  45794. * Get the keys for camera movement forward.
  45795. */
  45796. get keysForward(): number[];
  45797. /**
  45798. * Set the keys for camera movement forward.
  45799. */
  45800. set keysForward(value: number[]);
  45801. /**
  45802. * Get the keys for camera movement backward.
  45803. */
  45804. get keysBackward(): number[];
  45805. set keysBackward(value: number[]);
  45806. /**
  45807. * Get the keys for camera movement up.
  45808. */
  45809. get keysUp(): number[];
  45810. /**
  45811. * Set the keys for camera movement up.
  45812. */
  45813. set keysUp(value: number[]);
  45814. /**
  45815. * Get the keys for camera movement down.
  45816. */
  45817. get keysDown(): number[];
  45818. /**
  45819. * Set the keys for camera movement down.
  45820. */
  45821. set keysDown(value: number[]);
  45822. /**
  45823. * Get the keys for camera movement left.
  45824. */
  45825. get keysLeft(): number[];
  45826. /**
  45827. * Set the keys for camera movement left.
  45828. */
  45829. set keysLeft(value: number[]);
  45830. /**
  45831. * Set the keys for camera movement right.
  45832. */
  45833. get keysRight(): number[];
  45834. /**
  45835. * Set the keys for camera movement right.
  45836. */
  45837. set keysRight(value: number[]);
  45838. /**
  45839. * Event raised when the camera collides with a mesh in the scene.
  45840. */
  45841. onCollide: (collidedMesh: AbstractMesh) => void;
  45842. private _collider;
  45843. private _needMoveForGravity;
  45844. private _oldPosition;
  45845. private _diffPosition;
  45846. private _newPosition;
  45847. /** @hidden */
  45848. _localDirection: Vector3;
  45849. /** @hidden */
  45850. _transformedDirection: Vector3;
  45851. /**
  45852. * Instantiates a FlyCamera.
  45853. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45854. * such as in a 3D Space Shooter or a Flight Simulator.
  45855. * @param name Define the name of the camera in the scene.
  45856. * @param position Define the starting position of the camera in the scene.
  45857. * @param scene Define the scene the camera belongs to.
  45858. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45859. */
  45860. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45861. /**
  45862. * Attach a control to the HTML DOM element.
  45863. * @param element Defines the element that listens to the input events.
  45864. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45865. */
  45866. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45867. /**
  45868. * Detach a control from the HTML DOM element.
  45869. * The camera will stop reacting to that input.
  45870. * @param element Defines the element that listens to the input events.
  45871. */
  45872. detachControl(element: HTMLElement): void;
  45873. private _collisionMask;
  45874. /**
  45875. * Get the mask that the camera ignores in collision events.
  45876. */
  45877. get collisionMask(): number;
  45878. /**
  45879. * Set the mask that the camera ignores in collision events.
  45880. */
  45881. set collisionMask(mask: number);
  45882. /** @hidden */
  45883. _collideWithWorld(displacement: Vector3): void;
  45884. /** @hidden */
  45885. private _onCollisionPositionChange;
  45886. /** @hidden */
  45887. _checkInputs(): void;
  45888. /** @hidden */
  45889. _decideIfNeedsToMove(): boolean;
  45890. /** @hidden */
  45891. _updatePosition(): void;
  45892. /**
  45893. * Restore the Roll to its target value at the rate specified.
  45894. * @param rate - Higher means slower restoring.
  45895. * @hidden
  45896. */
  45897. restoreRoll(rate: number): void;
  45898. /**
  45899. * Destroy the camera and release the current resources held by it.
  45900. */
  45901. dispose(): void;
  45902. /**
  45903. * Get the current object class name.
  45904. * @returns the class name.
  45905. */
  45906. getClassName(): string;
  45907. }
  45908. }
  45909. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45910. import { Nullable } from "babylonjs/types";
  45911. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45912. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45913. /**
  45914. * Listen to keyboard events to control the camera.
  45915. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45916. */
  45917. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45918. /**
  45919. * Defines the camera the input is attached to.
  45920. */
  45921. camera: FlyCamera;
  45922. /**
  45923. * The list of keyboard keys used to control the forward move of the camera.
  45924. */
  45925. keysForward: number[];
  45926. /**
  45927. * The list of keyboard keys used to control the backward move of the camera.
  45928. */
  45929. keysBackward: number[];
  45930. /**
  45931. * The list of keyboard keys used to control the forward move of the camera.
  45932. */
  45933. keysUp: number[];
  45934. /**
  45935. * The list of keyboard keys used to control the backward move of the camera.
  45936. */
  45937. keysDown: number[];
  45938. /**
  45939. * The list of keyboard keys used to control the right strafe move of the camera.
  45940. */
  45941. keysRight: number[];
  45942. /**
  45943. * The list of keyboard keys used to control the left strafe move of the camera.
  45944. */
  45945. keysLeft: number[];
  45946. private _keys;
  45947. private _onCanvasBlurObserver;
  45948. private _onKeyboardObserver;
  45949. private _engine;
  45950. private _scene;
  45951. /**
  45952. * Attach the input controls to a specific dom element to get the input from.
  45953. * @param element Defines the element the controls should be listened from
  45954. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45955. */
  45956. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45957. /**
  45958. * Detach the current controls from the specified dom element.
  45959. * @param element Defines the element to stop listening the inputs from
  45960. */
  45961. detachControl(element: Nullable<HTMLElement>): void;
  45962. /**
  45963. * Gets the class name of the current intput.
  45964. * @returns the class name
  45965. */
  45966. getClassName(): string;
  45967. /** @hidden */
  45968. _onLostFocus(e: FocusEvent): void;
  45969. /**
  45970. * Get the friendly name associated with the input class.
  45971. * @returns the input friendly name
  45972. */
  45973. getSimpleName(): string;
  45974. /**
  45975. * Update the current camera state depending on the inputs that have been used this frame.
  45976. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45977. */
  45978. checkInputs(): void;
  45979. }
  45980. }
  45981. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  45982. import { Nullable } from "babylonjs/types";
  45983. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45984. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45985. /**
  45986. * Manage the mouse wheel inputs to control a follow camera.
  45987. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45988. */
  45989. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  45990. /**
  45991. * Defines the camera the input is attached to.
  45992. */
  45993. camera: FollowCamera;
  45994. /**
  45995. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  45996. */
  45997. axisControlRadius: boolean;
  45998. /**
  45999. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  46000. */
  46001. axisControlHeight: boolean;
  46002. /**
  46003. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  46004. */
  46005. axisControlRotation: boolean;
  46006. /**
  46007. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  46008. * relation to mouseWheel events.
  46009. */
  46010. wheelPrecision: number;
  46011. /**
  46012. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  46013. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  46014. */
  46015. wheelDeltaPercentage: number;
  46016. private _wheel;
  46017. private _observer;
  46018. /**
  46019. * Attach the input controls to a specific dom element to get the input from.
  46020. * @param element Defines the element the controls should be listened from
  46021. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46022. */
  46023. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46024. /**
  46025. * Detach the current controls from the specified dom element.
  46026. * @param element Defines the element to stop listening the inputs from
  46027. */
  46028. detachControl(element: Nullable<HTMLElement>): void;
  46029. /**
  46030. * Gets the class name of the current intput.
  46031. * @returns the class name
  46032. */
  46033. getClassName(): string;
  46034. /**
  46035. * Get the friendly name associated with the input class.
  46036. * @returns the input friendly name
  46037. */
  46038. getSimpleName(): string;
  46039. }
  46040. }
  46041. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46042. import { Nullable } from "babylonjs/types";
  46043. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46044. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46045. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46046. /**
  46047. * Manage the pointers inputs to control an follow camera.
  46048. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46049. */
  46050. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46051. /**
  46052. * Defines the camera the input is attached to.
  46053. */
  46054. camera: FollowCamera;
  46055. /**
  46056. * Gets the class name of the current input.
  46057. * @returns the class name
  46058. */
  46059. getClassName(): string;
  46060. /**
  46061. * Defines the pointer angular sensibility along the X axis or how fast is
  46062. * the camera rotating.
  46063. * A negative number will reverse the axis direction.
  46064. */
  46065. angularSensibilityX: number;
  46066. /**
  46067. * Defines the pointer angular sensibility along the Y axis or how fast is
  46068. * the camera rotating.
  46069. * A negative number will reverse the axis direction.
  46070. */
  46071. angularSensibilityY: number;
  46072. /**
  46073. * Defines the pointer pinch precision or how fast is the camera zooming.
  46074. * A negative number will reverse the axis direction.
  46075. */
  46076. pinchPrecision: number;
  46077. /**
  46078. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46079. * from 0.
  46080. * It defines the percentage of current camera.radius to use as delta when
  46081. * pinch zoom is used.
  46082. */
  46083. pinchDeltaPercentage: number;
  46084. /**
  46085. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46086. */
  46087. axisXControlRadius: boolean;
  46088. /**
  46089. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46090. */
  46091. axisXControlHeight: boolean;
  46092. /**
  46093. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46094. */
  46095. axisXControlRotation: boolean;
  46096. /**
  46097. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46098. */
  46099. axisYControlRadius: boolean;
  46100. /**
  46101. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46102. */
  46103. axisYControlHeight: boolean;
  46104. /**
  46105. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46106. */
  46107. axisYControlRotation: boolean;
  46108. /**
  46109. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46110. */
  46111. axisPinchControlRadius: boolean;
  46112. /**
  46113. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46114. */
  46115. axisPinchControlHeight: boolean;
  46116. /**
  46117. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46118. */
  46119. axisPinchControlRotation: boolean;
  46120. /**
  46121. * Log error messages if basic misconfiguration has occurred.
  46122. */
  46123. warningEnable: boolean;
  46124. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46125. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46126. private _warningCounter;
  46127. private _warning;
  46128. }
  46129. }
  46130. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46131. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46132. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46133. /**
  46134. * Default Inputs manager for the FollowCamera.
  46135. * It groups all the default supported inputs for ease of use.
  46136. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46137. */
  46138. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46139. /**
  46140. * Instantiates a new FollowCameraInputsManager.
  46141. * @param camera Defines the camera the inputs belong to
  46142. */
  46143. constructor(camera: FollowCamera);
  46144. /**
  46145. * Add keyboard input support to the input manager.
  46146. * @returns the current input manager
  46147. */
  46148. addKeyboard(): FollowCameraInputsManager;
  46149. /**
  46150. * Add mouse wheel input support to the input manager.
  46151. * @returns the current input manager
  46152. */
  46153. addMouseWheel(): FollowCameraInputsManager;
  46154. /**
  46155. * Add pointers input support to the input manager.
  46156. * @returns the current input manager
  46157. */
  46158. addPointers(): FollowCameraInputsManager;
  46159. /**
  46160. * Add orientation input support to the input manager.
  46161. * @returns the current input manager
  46162. */
  46163. addVRDeviceOrientation(): FollowCameraInputsManager;
  46164. }
  46165. }
  46166. declare module "babylonjs/Cameras/followCamera" {
  46167. import { Nullable } from "babylonjs/types";
  46168. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46169. import { Scene } from "babylonjs/scene";
  46170. import { Vector3 } from "babylonjs/Maths/math.vector";
  46171. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46172. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46173. /**
  46174. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46175. * an arc rotate version arcFollowCamera are available.
  46176. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46177. */
  46178. export class FollowCamera extends TargetCamera {
  46179. /**
  46180. * Distance the follow camera should follow an object at
  46181. */
  46182. radius: number;
  46183. /**
  46184. * Minimum allowed distance of the camera to the axis of rotation
  46185. * (The camera can not get closer).
  46186. * This can help limiting how the Camera is able to move in the scene.
  46187. */
  46188. lowerRadiusLimit: Nullable<number>;
  46189. /**
  46190. * Maximum allowed distance of the camera to the axis of rotation
  46191. * (The camera can not get further).
  46192. * This can help limiting how the Camera is able to move in the scene.
  46193. */
  46194. upperRadiusLimit: Nullable<number>;
  46195. /**
  46196. * Define a rotation offset between the camera and the object it follows
  46197. */
  46198. rotationOffset: number;
  46199. /**
  46200. * Minimum allowed angle to camera position relative to target object.
  46201. * This can help limiting how the Camera is able to move in the scene.
  46202. */
  46203. lowerRotationOffsetLimit: Nullable<number>;
  46204. /**
  46205. * Maximum allowed angle to camera position relative to target object.
  46206. * This can help limiting how the Camera is able to move in the scene.
  46207. */
  46208. upperRotationOffsetLimit: Nullable<number>;
  46209. /**
  46210. * Define a height offset between the camera and the object it follows.
  46211. * It can help following an object from the top (like a car chaing a plane)
  46212. */
  46213. heightOffset: number;
  46214. /**
  46215. * Minimum allowed height of camera position relative to target object.
  46216. * This can help limiting how the Camera is able to move in the scene.
  46217. */
  46218. lowerHeightOffsetLimit: Nullable<number>;
  46219. /**
  46220. * Maximum allowed height of camera position relative to target object.
  46221. * This can help limiting how the Camera is able to move in the scene.
  46222. */
  46223. upperHeightOffsetLimit: Nullable<number>;
  46224. /**
  46225. * Define how fast the camera can accelerate to follow it s target.
  46226. */
  46227. cameraAcceleration: number;
  46228. /**
  46229. * Define the speed limit of the camera following an object.
  46230. */
  46231. maxCameraSpeed: number;
  46232. /**
  46233. * Define the target of the camera.
  46234. */
  46235. lockedTarget: Nullable<AbstractMesh>;
  46236. /**
  46237. * Defines the input associated with the camera.
  46238. */
  46239. inputs: FollowCameraInputsManager;
  46240. /**
  46241. * Instantiates the follow camera.
  46242. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46243. * @param name Define the name of the camera in the scene
  46244. * @param position Define the position of the camera
  46245. * @param scene Define the scene the camera belong to
  46246. * @param lockedTarget Define the target of the camera
  46247. */
  46248. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46249. private _follow;
  46250. /**
  46251. * Attached controls to the current camera.
  46252. * @param element Defines the element the controls should be listened from
  46253. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46254. */
  46255. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46256. /**
  46257. * Detach the current controls from the camera.
  46258. * The camera will stop reacting to inputs.
  46259. * @param element Defines the element to stop listening the inputs from
  46260. */
  46261. detachControl(element: HTMLElement): void;
  46262. /** @hidden */
  46263. _checkInputs(): void;
  46264. private _checkLimits;
  46265. /**
  46266. * Gets the camera class name.
  46267. * @returns the class name
  46268. */
  46269. getClassName(): string;
  46270. }
  46271. /**
  46272. * Arc Rotate version of the follow camera.
  46273. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46274. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46275. */
  46276. export class ArcFollowCamera extends TargetCamera {
  46277. /** The longitudinal angle of the camera */
  46278. alpha: number;
  46279. /** The latitudinal angle of the camera */
  46280. beta: number;
  46281. /** The radius of the camera from its target */
  46282. radius: number;
  46283. private _cartesianCoordinates;
  46284. /** Define the camera target (the mesh it should follow) */
  46285. private _meshTarget;
  46286. /**
  46287. * Instantiates a new ArcFollowCamera
  46288. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46289. * @param name Define the name of the camera
  46290. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46291. * @param beta Define the rotation angle of the camera around the elevation axis
  46292. * @param radius Define the radius of the camera from its target point
  46293. * @param target Define the target of the camera
  46294. * @param scene Define the scene the camera belongs to
  46295. */
  46296. constructor(name: string,
  46297. /** The longitudinal angle of the camera */
  46298. alpha: number,
  46299. /** The latitudinal angle of the camera */
  46300. beta: number,
  46301. /** The radius of the camera from its target */
  46302. radius: number,
  46303. /** Define the camera target (the mesh it should follow) */
  46304. target: Nullable<AbstractMesh>, scene: Scene);
  46305. private _follow;
  46306. /** @hidden */
  46307. _checkInputs(): void;
  46308. /**
  46309. * Returns the class name of the object.
  46310. * It is mostly used internally for serialization purposes.
  46311. */
  46312. getClassName(): string;
  46313. }
  46314. }
  46315. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46316. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46317. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46318. import { Nullable } from "babylonjs/types";
  46319. /**
  46320. * Manage the keyboard inputs to control the movement of a follow camera.
  46321. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46322. */
  46323. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46324. /**
  46325. * Defines the camera the input is attached to.
  46326. */
  46327. camera: FollowCamera;
  46328. /**
  46329. * Defines the list of key codes associated with the up action (increase heightOffset)
  46330. */
  46331. keysHeightOffsetIncr: number[];
  46332. /**
  46333. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46334. */
  46335. keysHeightOffsetDecr: number[];
  46336. /**
  46337. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46338. */
  46339. keysHeightOffsetModifierAlt: boolean;
  46340. /**
  46341. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46342. */
  46343. keysHeightOffsetModifierCtrl: boolean;
  46344. /**
  46345. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46346. */
  46347. keysHeightOffsetModifierShift: boolean;
  46348. /**
  46349. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46350. */
  46351. keysRotationOffsetIncr: number[];
  46352. /**
  46353. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46354. */
  46355. keysRotationOffsetDecr: number[];
  46356. /**
  46357. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46358. */
  46359. keysRotationOffsetModifierAlt: boolean;
  46360. /**
  46361. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46362. */
  46363. keysRotationOffsetModifierCtrl: boolean;
  46364. /**
  46365. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46366. */
  46367. keysRotationOffsetModifierShift: boolean;
  46368. /**
  46369. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46370. */
  46371. keysRadiusIncr: number[];
  46372. /**
  46373. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46374. */
  46375. keysRadiusDecr: number[];
  46376. /**
  46377. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46378. */
  46379. keysRadiusModifierAlt: boolean;
  46380. /**
  46381. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46382. */
  46383. keysRadiusModifierCtrl: boolean;
  46384. /**
  46385. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46386. */
  46387. keysRadiusModifierShift: boolean;
  46388. /**
  46389. * Defines the rate of change of heightOffset.
  46390. */
  46391. heightSensibility: number;
  46392. /**
  46393. * Defines the rate of change of rotationOffset.
  46394. */
  46395. rotationSensibility: number;
  46396. /**
  46397. * Defines the rate of change of radius.
  46398. */
  46399. radiusSensibility: number;
  46400. private _keys;
  46401. private _ctrlPressed;
  46402. private _altPressed;
  46403. private _shiftPressed;
  46404. private _onCanvasBlurObserver;
  46405. private _onKeyboardObserver;
  46406. private _engine;
  46407. private _scene;
  46408. /**
  46409. * Attach the input controls to a specific dom element to get the input from.
  46410. * @param element Defines the element the controls should be listened from
  46411. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46412. */
  46413. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46414. /**
  46415. * Detach the current controls from the specified dom element.
  46416. * @param element Defines the element to stop listening the inputs from
  46417. */
  46418. detachControl(element: Nullable<HTMLElement>): void;
  46419. /**
  46420. * Update the current camera state depending on the inputs that have been used this frame.
  46421. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46422. */
  46423. checkInputs(): void;
  46424. /**
  46425. * Gets the class name of the current input.
  46426. * @returns the class name
  46427. */
  46428. getClassName(): string;
  46429. /**
  46430. * Get the friendly name associated with the input class.
  46431. * @returns the input friendly name
  46432. */
  46433. getSimpleName(): string;
  46434. /**
  46435. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46436. * allow modification of the heightOffset value.
  46437. */
  46438. private _modifierHeightOffset;
  46439. /**
  46440. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46441. * allow modification of the rotationOffset value.
  46442. */
  46443. private _modifierRotationOffset;
  46444. /**
  46445. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46446. * allow modification of the radius value.
  46447. */
  46448. private _modifierRadius;
  46449. }
  46450. }
  46451. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46452. import { Nullable } from "babylonjs/types";
  46453. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46454. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46455. import { Observable } from "babylonjs/Misc/observable";
  46456. module "babylonjs/Cameras/freeCameraInputsManager" {
  46457. interface FreeCameraInputsManager {
  46458. /**
  46459. * @hidden
  46460. */
  46461. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46462. /**
  46463. * Add orientation input support to the input manager.
  46464. * @returns the current input manager
  46465. */
  46466. addDeviceOrientation(): FreeCameraInputsManager;
  46467. }
  46468. }
  46469. /**
  46470. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46471. * Screen rotation is taken into account.
  46472. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46473. */
  46474. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46475. private _camera;
  46476. private _screenOrientationAngle;
  46477. private _constantTranform;
  46478. private _screenQuaternion;
  46479. private _alpha;
  46480. private _beta;
  46481. private _gamma;
  46482. /**
  46483. * Can be used to detect if a device orientation sensor is available on a device
  46484. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46485. * @returns a promise that will resolve on orientation change
  46486. */
  46487. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46488. /**
  46489. * @hidden
  46490. */
  46491. _onDeviceOrientationChangedObservable: Observable<void>;
  46492. /**
  46493. * Instantiates a new input
  46494. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46495. */
  46496. constructor();
  46497. /**
  46498. * Define the camera controlled by the input.
  46499. */
  46500. get camera(): FreeCamera;
  46501. set camera(camera: FreeCamera);
  46502. /**
  46503. * Attach the input controls to a specific dom element to get the input from.
  46504. * @param element Defines the element the controls should be listened from
  46505. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46506. */
  46507. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46508. private _orientationChanged;
  46509. private _deviceOrientation;
  46510. /**
  46511. * Detach the current controls from the specified dom element.
  46512. * @param element Defines the element to stop listening the inputs from
  46513. */
  46514. detachControl(element: Nullable<HTMLElement>): void;
  46515. /**
  46516. * Update the current camera state depending on the inputs that have been used this frame.
  46517. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46518. */
  46519. checkInputs(): void;
  46520. /**
  46521. * Gets the class name of the current intput.
  46522. * @returns the class name
  46523. */
  46524. getClassName(): string;
  46525. /**
  46526. * Get the friendly name associated with the input class.
  46527. * @returns the input friendly name
  46528. */
  46529. getSimpleName(): string;
  46530. }
  46531. }
  46532. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46533. import { Nullable } from "babylonjs/types";
  46534. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46535. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46536. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46537. /**
  46538. * Manage the gamepad inputs to control a free camera.
  46539. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46540. */
  46541. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46542. /**
  46543. * Define the camera the input is attached to.
  46544. */
  46545. camera: FreeCamera;
  46546. /**
  46547. * Define the Gamepad controlling the input
  46548. */
  46549. gamepad: Nullable<Gamepad>;
  46550. /**
  46551. * Defines the gamepad rotation sensiblity.
  46552. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46553. */
  46554. gamepadAngularSensibility: number;
  46555. /**
  46556. * Defines the gamepad move sensiblity.
  46557. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46558. */
  46559. gamepadMoveSensibility: number;
  46560. private _yAxisScale;
  46561. /**
  46562. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46563. */
  46564. get invertYAxis(): boolean;
  46565. set invertYAxis(value: boolean);
  46566. private _onGamepadConnectedObserver;
  46567. private _onGamepadDisconnectedObserver;
  46568. private _cameraTransform;
  46569. private _deltaTransform;
  46570. private _vector3;
  46571. private _vector2;
  46572. /**
  46573. * Attach the input controls to a specific dom element to get the input from.
  46574. * @param element Defines the element the controls should be listened from
  46575. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46576. */
  46577. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46578. /**
  46579. * Detach the current controls from the specified dom element.
  46580. * @param element Defines the element to stop listening the inputs from
  46581. */
  46582. detachControl(element: Nullable<HTMLElement>): void;
  46583. /**
  46584. * Update the current camera state depending on the inputs that have been used this frame.
  46585. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46586. */
  46587. checkInputs(): void;
  46588. /**
  46589. * Gets the class name of the current intput.
  46590. * @returns the class name
  46591. */
  46592. getClassName(): string;
  46593. /**
  46594. * Get the friendly name associated with the input class.
  46595. * @returns the input friendly name
  46596. */
  46597. getSimpleName(): string;
  46598. }
  46599. }
  46600. declare module "babylonjs/Misc/virtualJoystick" {
  46601. import { Nullable } from "babylonjs/types";
  46602. import { Vector3 } from "babylonjs/Maths/math.vector";
  46603. /**
  46604. * Defines the potential axis of a Joystick
  46605. */
  46606. export enum JoystickAxis {
  46607. /** X axis */
  46608. X = 0,
  46609. /** Y axis */
  46610. Y = 1,
  46611. /** Z axis */
  46612. Z = 2
  46613. }
  46614. /**
  46615. * Represents the different customization options available
  46616. * for VirtualJoystick
  46617. */
  46618. interface VirtualJoystickCustomizations {
  46619. /**
  46620. * Size of the joystick's puck
  46621. */
  46622. puckSize: number;
  46623. /**
  46624. * Size of the joystick's container
  46625. */
  46626. containerSize: number;
  46627. /**
  46628. * Color of the joystick && puck
  46629. */
  46630. color: string;
  46631. /**
  46632. * Image URL for the joystick's puck
  46633. */
  46634. puckImage?: string;
  46635. /**
  46636. * Image URL for the joystick's container
  46637. */
  46638. containerImage?: string;
  46639. /**
  46640. * Defines the unmoving position of the joystick container
  46641. */
  46642. position?: {
  46643. x: number;
  46644. y: number;
  46645. };
  46646. /**
  46647. * Defines whether or not the joystick container is always visible
  46648. */
  46649. alwaysVisible: boolean;
  46650. /**
  46651. * Defines whether or not to limit the movement of the puck to the joystick's container
  46652. */
  46653. limitToContainer: boolean;
  46654. }
  46655. /**
  46656. * Class used to define virtual joystick (used in touch mode)
  46657. */
  46658. export class VirtualJoystick {
  46659. /**
  46660. * Gets or sets a boolean indicating that left and right values must be inverted
  46661. */
  46662. reverseLeftRight: boolean;
  46663. /**
  46664. * Gets or sets a boolean indicating that up and down values must be inverted
  46665. */
  46666. reverseUpDown: boolean;
  46667. /**
  46668. * Gets the offset value for the position (ie. the change of the position value)
  46669. */
  46670. deltaPosition: Vector3;
  46671. /**
  46672. * Gets a boolean indicating if the virtual joystick was pressed
  46673. */
  46674. pressed: boolean;
  46675. /**
  46676. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46677. */
  46678. static Canvas: Nullable<HTMLCanvasElement>;
  46679. /**
  46680. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46681. */
  46682. limitToContainer: boolean;
  46683. private static _globalJoystickIndex;
  46684. private static _alwaysVisibleSticks;
  46685. private static vjCanvasContext;
  46686. private static vjCanvasWidth;
  46687. private static vjCanvasHeight;
  46688. private static halfWidth;
  46689. private static _GetDefaultOptions;
  46690. private _action;
  46691. private _axisTargetedByLeftAndRight;
  46692. private _axisTargetedByUpAndDown;
  46693. private _joystickSensibility;
  46694. private _inversedSensibility;
  46695. private _joystickPointerID;
  46696. private _joystickColor;
  46697. private _joystickPointerPos;
  46698. private _joystickPreviousPointerPos;
  46699. private _joystickPointerStartPos;
  46700. private _deltaJoystickVector;
  46701. private _leftJoystick;
  46702. private _touches;
  46703. private _joystickPosition;
  46704. private _alwaysVisible;
  46705. private _puckImage;
  46706. private _containerImage;
  46707. private _joystickPuckSize;
  46708. private _joystickContainerSize;
  46709. private _clearPuckSize;
  46710. private _clearContainerSize;
  46711. private _clearPuckSizeOffset;
  46712. private _clearContainerSizeOffset;
  46713. private _onPointerDownHandlerRef;
  46714. private _onPointerMoveHandlerRef;
  46715. private _onPointerUpHandlerRef;
  46716. private _onResize;
  46717. /**
  46718. * Creates a new virtual joystick
  46719. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46720. * @param customizations Defines the options we want to customize the VirtualJoystick
  46721. */
  46722. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46723. /**
  46724. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46725. * @param newJoystickSensibility defines the new sensibility
  46726. */
  46727. setJoystickSensibility(newJoystickSensibility: number): void;
  46728. private _onPointerDown;
  46729. private _onPointerMove;
  46730. private _onPointerUp;
  46731. /**
  46732. * Change the color of the virtual joystick
  46733. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46734. */
  46735. setJoystickColor(newColor: string): void;
  46736. /**
  46737. * Size of the joystick's container
  46738. */
  46739. set containerSize(newSize: number);
  46740. get containerSize(): number;
  46741. /**
  46742. * Size of the joystick's puck
  46743. */
  46744. set puckSize(newSize: number);
  46745. get puckSize(): number;
  46746. /**
  46747. * Clears the set position of the joystick
  46748. */
  46749. clearPosition(): void;
  46750. /**
  46751. * Defines whether or not the joystick container is always visible
  46752. */
  46753. set alwaysVisible(value: boolean);
  46754. get alwaysVisible(): boolean;
  46755. /**
  46756. * Sets the constant position of the Joystick container
  46757. * @param x X axis coordinate
  46758. * @param y Y axis coordinate
  46759. */
  46760. setPosition(x: number, y: number): void;
  46761. /**
  46762. * Defines a callback to call when the joystick is touched
  46763. * @param action defines the callback
  46764. */
  46765. setActionOnTouch(action: () => any): void;
  46766. /**
  46767. * Defines which axis you'd like to control for left & right
  46768. * @param axis defines the axis to use
  46769. */
  46770. setAxisForLeftRight(axis: JoystickAxis): void;
  46771. /**
  46772. * Defines which axis you'd like to control for up & down
  46773. * @param axis defines the axis to use
  46774. */
  46775. setAxisForUpDown(axis: JoystickAxis): void;
  46776. /**
  46777. * Clears the canvas from the previous puck / container draw
  46778. */
  46779. private _clearPreviousDraw;
  46780. /**
  46781. * Loads `urlPath` to be used for the container's image
  46782. * @param urlPath defines the urlPath of an image to use
  46783. */
  46784. setContainerImage(urlPath: string): void;
  46785. /**
  46786. * Loads `urlPath` to be used for the puck's image
  46787. * @param urlPath defines the urlPath of an image to use
  46788. */
  46789. setPuckImage(urlPath: string): void;
  46790. /**
  46791. * Draws the Virtual Joystick's container
  46792. */
  46793. private _drawContainer;
  46794. /**
  46795. * Draws the Virtual Joystick's puck
  46796. */
  46797. private _drawPuck;
  46798. private _drawVirtualJoystick;
  46799. /**
  46800. * Release internal HTML canvas
  46801. */
  46802. releaseCanvas(): void;
  46803. }
  46804. }
  46805. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46806. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46807. import { Nullable } from "babylonjs/types";
  46808. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46809. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46810. module "babylonjs/Cameras/freeCameraInputsManager" {
  46811. interface FreeCameraInputsManager {
  46812. /**
  46813. * Add virtual joystick input support to the input manager.
  46814. * @returns the current input manager
  46815. */
  46816. addVirtualJoystick(): FreeCameraInputsManager;
  46817. }
  46818. }
  46819. /**
  46820. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46821. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46822. */
  46823. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46824. /**
  46825. * Defines the camera the input is attached to.
  46826. */
  46827. camera: FreeCamera;
  46828. private _leftjoystick;
  46829. private _rightjoystick;
  46830. /**
  46831. * Gets the left stick of the virtual joystick.
  46832. * @returns The virtual Joystick
  46833. */
  46834. getLeftJoystick(): VirtualJoystick;
  46835. /**
  46836. * Gets the right stick of the virtual joystick.
  46837. * @returns The virtual Joystick
  46838. */
  46839. getRightJoystick(): VirtualJoystick;
  46840. /**
  46841. * Update the current camera state depending on the inputs that have been used this frame.
  46842. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46843. */
  46844. checkInputs(): void;
  46845. /**
  46846. * Attach the input controls to a specific dom element to get the input from.
  46847. * @param element Defines the element the controls should be listened from
  46848. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46849. */
  46850. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46851. /**
  46852. * Detach the current controls from the specified dom element.
  46853. * @param element Defines the element to stop listening the inputs from
  46854. */
  46855. detachControl(element: Nullable<HTMLElement>): void;
  46856. /**
  46857. * Gets the class name of the current intput.
  46858. * @returns the class name
  46859. */
  46860. getClassName(): string;
  46861. /**
  46862. * Get the friendly name associated with the input class.
  46863. * @returns the input friendly name
  46864. */
  46865. getSimpleName(): string;
  46866. }
  46867. }
  46868. declare module "babylonjs/Cameras/Inputs/index" {
  46869. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46870. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46871. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46872. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46873. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46874. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46875. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46876. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46877. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46878. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46879. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46880. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46881. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46882. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46883. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46884. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46885. }
  46886. declare module "babylonjs/Cameras/touchCamera" {
  46887. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46888. import { Scene } from "babylonjs/scene";
  46889. import { Vector3 } from "babylonjs/Maths/math.vector";
  46890. /**
  46891. * This represents a FPS type of camera controlled by touch.
  46892. * This is like a universal camera minus the Gamepad controls.
  46893. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46894. */
  46895. export class TouchCamera extends FreeCamera {
  46896. /**
  46897. * Defines the touch sensibility for rotation.
  46898. * The higher the faster.
  46899. */
  46900. get touchAngularSensibility(): number;
  46901. set touchAngularSensibility(value: number);
  46902. /**
  46903. * Defines the touch sensibility for move.
  46904. * The higher the faster.
  46905. */
  46906. get touchMoveSensibility(): number;
  46907. set touchMoveSensibility(value: number);
  46908. /**
  46909. * Instantiates a new touch camera.
  46910. * This represents a FPS type of camera controlled by touch.
  46911. * This is like a universal camera minus the Gamepad controls.
  46912. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46913. * @param name Define the name of the camera in the scene
  46914. * @param position Define the start position of the camera in the scene
  46915. * @param scene Define the scene the camera belongs to
  46916. */
  46917. constructor(name: string, position: Vector3, scene: Scene);
  46918. /**
  46919. * Gets the current object class name.
  46920. * @return the class name
  46921. */
  46922. getClassName(): string;
  46923. /** @hidden */
  46924. _setupInputs(): void;
  46925. }
  46926. }
  46927. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46928. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46929. import { Scene } from "babylonjs/scene";
  46930. import { Vector3 } from "babylonjs/Maths/math.vector";
  46931. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46932. import { Axis } from "babylonjs/Maths/math.axis";
  46933. /**
  46934. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46935. * being tilted forward or back and left or right.
  46936. */
  46937. export class DeviceOrientationCamera extends FreeCamera {
  46938. private _initialQuaternion;
  46939. private _quaternionCache;
  46940. private _tmpDragQuaternion;
  46941. private _disablePointerInputWhenUsingDeviceOrientation;
  46942. /**
  46943. * Creates a new device orientation camera
  46944. * @param name The name of the camera
  46945. * @param position The start position camera
  46946. * @param scene The scene the camera belongs to
  46947. */
  46948. constructor(name: string, position: Vector3, scene: Scene);
  46949. /**
  46950. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46951. */
  46952. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46953. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46954. private _dragFactor;
  46955. /**
  46956. * Enabled turning on the y axis when the orientation sensor is active
  46957. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46958. */
  46959. enableHorizontalDragging(dragFactor?: number): void;
  46960. /**
  46961. * Gets the current instance class name ("DeviceOrientationCamera").
  46962. * This helps avoiding instanceof at run time.
  46963. * @returns the class name
  46964. */
  46965. getClassName(): string;
  46966. /**
  46967. * @hidden
  46968. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46969. */
  46970. _checkInputs(): void;
  46971. /**
  46972. * Reset the camera to its default orientation on the specified axis only.
  46973. * @param axis The axis to reset
  46974. */
  46975. resetToCurrentRotation(axis?: Axis): void;
  46976. }
  46977. }
  46978. declare module "babylonjs/Gamepads/xboxGamepad" {
  46979. import { Observable } from "babylonjs/Misc/observable";
  46980. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46981. /**
  46982. * Defines supported buttons for XBox360 compatible gamepads
  46983. */
  46984. export enum Xbox360Button {
  46985. /** A */
  46986. A = 0,
  46987. /** B */
  46988. B = 1,
  46989. /** X */
  46990. X = 2,
  46991. /** Y */
  46992. Y = 3,
  46993. /** Left button */
  46994. LB = 4,
  46995. /** Right button */
  46996. RB = 5,
  46997. /** Back */
  46998. Back = 8,
  46999. /** Start */
  47000. Start = 9,
  47001. /** Left stick */
  47002. LeftStick = 10,
  47003. /** Right stick */
  47004. RightStick = 11
  47005. }
  47006. /** Defines values for XBox360 DPad */
  47007. export enum Xbox360Dpad {
  47008. /** Up */
  47009. Up = 12,
  47010. /** Down */
  47011. Down = 13,
  47012. /** Left */
  47013. Left = 14,
  47014. /** Right */
  47015. Right = 15
  47016. }
  47017. /**
  47018. * Defines a XBox360 gamepad
  47019. */
  47020. export class Xbox360Pad extends Gamepad {
  47021. private _leftTrigger;
  47022. private _rightTrigger;
  47023. private _onlefttriggerchanged;
  47024. private _onrighttriggerchanged;
  47025. private _onbuttondown;
  47026. private _onbuttonup;
  47027. private _ondpaddown;
  47028. private _ondpadup;
  47029. /** Observable raised when a button is pressed */
  47030. onButtonDownObservable: Observable<Xbox360Button>;
  47031. /** Observable raised when a button is released */
  47032. onButtonUpObservable: Observable<Xbox360Button>;
  47033. /** Observable raised when a pad is pressed */
  47034. onPadDownObservable: Observable<Xbox360Dpad>;
  47035. /** Observable raised when a pad is released */
  47036. onPadUpObservable: Observable<Xbox360Dpad>;
  47037. private _buttonA;
  47038. private _buttonB;
  47039. private _buttonX;
  47040. private _buttonY;
  47041. private _buttonBack;
  47042. private _buttonStart;
  47043. private _buttonLB;
  47044. private _buttonRB;
  47045. private _buttonLeftStick;
  47046. private _buttonRightStick;
  47047. private _dPadUp;
  47048. private _dPadDown;
  47049. private _dPadLeft;
  47050. private _dPadRight;
  47051. private _isXboxOnePad;
  47052. /**
  47053. * Creates a new XBox360 gamepad object
  47054. * @param id defines the id of this gamepad
  47055. * @param index defines its index
  47056. * @param gamepad defines the internal HTML gamepad object
  47057. * @param xboxOne defines if it is a XBox One gamepad
  47058. */
  47059. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47060. /**
  47061. * Defines the callback to call when left trigger is pressed
  47062. * @param callback defines the callback to use
  47063. */
  47064. onlefttriggerchanged(callback: (value: number) => void): void;
  47065. /**
  47066. * Defines the callback to call when right trigger is pressed
  47067. * @param callback defines the callback to use
  47068. */
  47069. onrighttriggerchanged(callback: (value: number) => void): void;
  47070. /**
  47071. * Gets the left trigger value
  47072. */
  47073. get leftTrigger(): number;
  47074. /**
  47075. * Sets the left trigger value
  47076. */
  47077. set leftTrigger(newValue: number);
  47078. /**
  47079. * Gets the right trigger value
  47080. */
  47081. get rightTrigger(): number;
  47082. /**
  47083. * Sets the right trigger value
  47084. */
  47085. set rightTrigger(newValue: number);
  47086. /**
  47087. * Defines the callback to call when a button is pressed
  47088. * @param callback defines the callback to use
  47089. */
  47090. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47091. /**
  47092. * Defines the callback to call when a button is released
  47093. * @param callback defines the callback to use
  47094. */
  47095. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47096. /**
  47097. * Defines the callback to call when a pad is pressed
  47098. * @param callback defines the callback to use
  47099. */
  47100. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47101. /**
  47102. * Defines the callback to call when a pad is released
  47103. * @param callback defines the callback to use
  47104. */
  47105. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47106. private _setButtonValue;
  47107. private _setDPadValue;
  47108. /**
  47109. * Gets the value of the `A` button
  47110. */
  47111. get buttonA(): number;
  47112. /**
  47113. * Sets the value of the `A` button
  47114. */
  47115. set buttonA(value: number);
  47116. /**
  47117. * Gets the value of the `B` button
  47118. */
  47119. get buttonB(): number;
  47120. /**
  47121. * Sets the value of the `B` button
  47122. */
  47123. set buttonB(value: number);
  47124. /**
  47125. * Gets the value of the `X` button
  47126. */
  47127. get buttonX(): number;
  47128. /**
  47129. * Sets the value of the `X` button
  47130. */
  47131. set buttonX(value: number);
  47132. /**
  47133. * Gets the value of the `Y` button
  47134. */
  47135. get buttonY(): number;
  47136. /**
  47137. * Sets the value of the `Y` button
  47138. */
  47139. set buttonY(value: number);
  47140. /**
  47141. * Gets the value of the `Start` button
  47142. */
  47143. get buttonStart(): number;
  47144. /**
  47145. * Sets the value of the `Start` button
  47146. */
  47147. set buttonStart(value: number);
  47148. /**
  47149. * Gets the value of the `Back` button
  47150. */
  47151. get buttonBack(): number;
  47152. /**
  47153. * Sets the value of the `Back` button
  47154. */
  47155. set buttonBack(value: number);
  47156. /**
  47157. * Gets the value of the `Left` button
  47158. */
  47159. get buttonLB(): number;
  47160. /**
  47161. * Sets the value of the `Left` button
  47162. */
  47163. set buttonLB(value: number);
  47164. /**
  47165. * Gets the value of the `Right` button
  47166. */
  47167. get buttonRB(): number;
  47168. /**
  47169. * Sets the value of the `Right` button
  47170. */
  47171. set buttonRB(value: number);
  47172. /**
  47173. * Gets the value of the Left joystick
  47174. */
  47175. get buttonLeftStick(): number;
  47176. /**
  47177. * Sets the value of the Left joystick
  47178. */
  47179. set buttonLeftStick(value: number);
  47180. /**
  47181. * Gets the value of the Right joystick
  47182. */
  47183. get buttonRightStick(): number;
  47184. /**
  47185. * Sets the value of the Right joystick
  47186. */
  47187. set buttonRightStick(value: number);
  47188. /**
  47189. * Gets the value of D-pad up
  47190. */
  47191. get dPadUp(): number;
  47192. /**
  47193. * Sets the value of D-pad up
  47194. */
  47195. set dPadUp(value: number);
  47196. /**
  47197. * Gets the value of D-pad down
  47198. */
  47199. get dPadDown(): number;
  47200. /**
  47201. * Sets the value of D-pad down
  47202. */
  47203. set dPadDown(value: number);
  47204. /**
  47205. * Gets the value of D-pad left
  47206. */
  47207. get dPadLeft(): number;
  47208. /**
  47209. * Sets the value of D-pad left
  47210. */
  47211. set dPadLeft(value: number);
  47212. /**
  47213. * Gets the value of D-pad right
  47214. */
  47215. get dPadRight(): number;
  47216. /**
  47217. * Sets the value of D-pad right
  47218. */
  47219. set dPadRight(value: number);
  47220. /**
  47221. * Force the gamepad to synchronize with device values
  47222. */
  47223. update(): void;
  47224. /**
  47225. * Disposes the gamepad
  47226. */
  47227. dispose(): void;
  47228. }
  47229. }
  47230. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47231. import { Observable } from "babylonjs/Misc/observable";
  47232. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47233. /**
  47234. * Defines supported buttons for DualShock compatible gamepads
  47235. */
  47236. export enum DualShockButton {
  47237. /** Cross */
  47238. Cross = 0,
  47239. /** Circle */
  47240. Circle = 1,
  47241. /** Square */
  47242. Square = 2,
  47243. /** Triangle */
  47244. Triangle = 3,
  47245. /** L1 */
  47246. L1 = 4,
  47247. /** R1 */
  47248. R1 = 5,
  47249. /** Share */
  47250. Share = 8,
  47251. /** Options */
  47252. Options = 9,
  47253. /** Left stick */
  47254. LeftStick = 10,
  47255. /** Right stick */
  47256. RightStick = 11
  47257. }
  47258. /** Defines values for DualShock DPad */
  47259. export enum DualShockDpad {
  47260. /** Up */
  47261. Up = 12,
  47262. /** Down */
  47263. Down = 13,
  47264. /** Left */
  47265. Left = 14,
  47266. /** Right */
  47267. Right = 15
  47268. }
  47269. /**
  47270. * Defines a DualShock gamepad
  47271. */
  47272. export class DualShockPad extends Gamepad {
  47273. private _leftTrigger;
  47274. private _rightTrigger;
  47275. private _onlefttriggerchanged;
  47276. private _onrighttriggerchanged;
  47277. private _onbuttondown;
  47278. private _onbuttonup;
  47279. private _ondpaddown;
  47280. private _ondpadup;
  47281. /** Observable raised when a button is pressed */
  47282. onButtonDownObservable: Observable<DualShockButton>;
  47283. /** Observable raised when a button is released */
  47284. onButtonUpObservable: Observable<DualShockButton>;
  47285. /** Observable raised when a pad is pressed */
  47286. onPadDownObservable: Observable<DualShockDpad>;
  47287. /** Observable raised when a pad is released */
  47288. onPadUpObservable: Observable<DualShockDpad>;
  47289. private _buttonCross;
  47290. private _buttonCircle;
  47291. private _buttonSquare;
  47292. private _buttonTriangle;
  47293. private _buttonShare;
  47294. private _buttonOptions;
  47295. private _buttonL1;
  47296. private _buttonR1;
  47297. private _buttonLeftStick;
  47298. private _buttonRightStick;
  47299. private _dPadUp;
  47300. private _dPadDown;
  47301. private _dPadLeft;
  47302. private _dPadRight;
  47303. /**
  47304. * Creates a new DualShock gamepad object
  47305. * @param id defines the id of this gamepad
  47306. * @param index defines its index
  47307. * @param gamepad defines the internal HTML gamepad object
  47308. */
  47309. constructor(id: string, index: number, gamepad: any);
  47310. /**
  47311. * Defines the callback to call when left trigger is pressed
  47312. * @param callback defines the callback to use
  47313. */
  47314. onlefttriggerchanged(callback: (value: number) => void): void;
  47315. /**
  47316. * Defines the callback to call when right trigger is pressed
  47317. * @param callback defines the callback to use
  47318. */
  47319. onrighttriggerchanged(callback: (value: number) => void): void;
  47320. /**
  47321. * Gets the left trigger value
  47322. */
  47323. get leftTrigger(): number;
  47324. /**
  47325. * Sets the left trigger value
  47326. */
  47327. set leftTrigger(newValue: number);
  47328. /**
  47329. * Gets the right trigger value
  47330. */
  47331. get rightTrigger(): number;
  47332. /**
  47333. * Sets the right trigger value
  47334. */
  47335. set rightTrigger(newValue: number);
  47336. /**
  47337. * Defines the callback to call when a button is pressed
  47338. * @param callback defines the callback to use
  47339. */
  47340. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47341. /**
  47342. * Defines the callback to call when a button is released
  47343. * @param callback defines the callback to use
  47344. */
  47345. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47346. /**
  47347. * Defines the callback to call when a pad is pressed
  47348. * @param callback defines the callback to use
  47349. */
  47350. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47351. /**
  47352. * Defines the callback to call when a pad is released
  47353. * @param callback defines the callback to use
  47354. */
  47355. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47356. private _setButtonValue;
  47357. private _setDPadValue;
  47358. /**
  47359. * Gets the value of the `Cross` button
  47360. */
  47361. get buttonCross(): number;
  47362. /**
  47363. * Sets the value of the `Cross` button
  47364. */
  47365. set buttonCross(value: number);
  47366. /**
  47367. * Gets the value of the `Circle` button
  47368. */
  47369. get buttonCircle(): number;
  47370. /**
  47371. * Sets the value of the `Circle` button
  47372. */
  47373. set buttonCircle(value: number);
  47374. /**
  47375. * Gets the value of the `Square` button
  47376. */
  47377. get buttonSquare(): number;
  47378. /**
  47379. * Sets the value of the `Square` button
  47380. */
  47381. set buttonSquare(value: number);
  47382. /**
  47383. * Gets the value of the `Triangle` button
  47384. */
  47385. get buttonTriangle(): number;
  47386. /**
  47387. * Sets the value of the `Triangle` button
  47388. */
  47389. set buttonTriangle(value: number);
  47390. /**
  47391. * Gets the value of the `Options` button
  47392. */
  47393. get buttonOptions(): number;
  47394. /**
  47395. * Sets the value of the `Options` button
  47396. */
  47397. set buttonOptions(value: number);
  47398. /**
  47399. * Gets the value of the `Share` button
  47400. */
  47401. get buttonShare(): number;
  47402. /**
  47403. * Sets the value of the `Share` button
  47404. */
  47405. set buttonShare(value: number);
  47406. /**
  47407. * Gets the value of the `L1` button
  47408. */
  47409. get buttonL1(): number;
  47410. /**
  47411. * Sets the value of the `L1` button
  47412. */
  47413. set buttonL1(value: number);
  47414. /**
  47415. * Gets the value of the `R1` button
  47416. */
  47417. get buttonR1(): number;
  47418. /**
  47419. * Sets the value of the `R1` button
  47420. */
  47421. set buttonR1(value: number);
  47422. /**
  47423. * Gets the value of the Left joystick
  47424. */
  47425. get buttonLeftStick(): number;
  47426. /**
  47427. * Sets the value of the Left joystick
  47428. */
  47429. set buttonLeftStick(value: number);
  47430. /**
  47431. * Gets the value of the Right joystick
  47432. */
  47433. get buttonRightStick(): number;
  47434. /**
  47435. * Sets the value of the Right joystick
  47436. */
  47437. set buttonRightStick(value: number);
  47438. /**
  47439. * Gets the value of D-pad up
  47440. */
  47441. get dPadUp(): number;
  47442. /**
  47443. * Sets the value of D-pad up
  47444. */
  47445. set dPadUp(value: number);
  47446. /**
  47447. * Gets the value of D-pad down
  47448. */
  47449. get dPadDown(): number;
  47450. /**
  47451. * Sets the value of D-pad down
  47452. */
  47453. set dPadDown(value: number);
  47454. /**
  47455. * Gets the value of D-pad left
  47456. */
  47457. get dPadLeft(): number;
  47458. /**
  47459. * Sets the value of D-pad left
  47460. */
  47461. set dPadLeft(value: number);
  47462. /**
  47463. * Gets the value of D-pad right
  47464. */
  47465. get dPadRight(): number;
  47466. /**
  47467. * Sets the value of D-pad right
  47468. */
  47469. set dPadRight(value: number);
  47470. /**
  47471. * Force the gamepad to synchronize with device values
  47472. */
  47473. update(): void;
  47474. /**
  47475. * Disposes the gamepad
  47476. */
  47477. dispose(): void;
  47478. }
  47479. }
  47480. declare module "babylonjs/Gamepads/gamepadManager" {
  47481. import { Observable } from "babylonjs/Misc/observable";
  47482. import { Nullable } from "babylonjs/types";
  47483. import { Scene } from "babylonjs/scene";
  47484. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47485. /**
  47486. * Manager for handling gamepads
  47487. */
  47488. export class GamepadManager {
  47489. private _scene?;
  47490. private _babylonGamepads;
  47491. private _oneGamepadConnected;
  47492. /** @hidden */
  47493. _isMonitoring: boolean;
  47494. private _gamepadEventSupported;
  47495. private _gamepadSupport?;
  47496. /**
  47497. * observable to be triggered when the gamepad controller has been connected
  47498. */
  47499. onGamepadConnectedObservable: Observable<Gamepad>;
  47500. /**
  47501. * observable to be triggered when the gamepad controller has been disconnected
  47502. */
  47503. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47504. private _onGamepadConnectedEvent;
  47505. private _onGamepadDisconnectedEvent;
  47506. /**
  47507. * Initializes the gamepad manager
  47508. * @param _scene BabylonJS scene
  47509. */
  47510. constructor(_scene?: Scene | undefined);
  47511. /**
  47512. * The gamepads in the game pad manager
  47513. */
  47514. get gamepads(): Gamepad[];
  47515. /**
  47516. * Get the gamepad controllers based on type
  47517. * @param type The type of gamepad controller
  47518. * @returns Nullable gamepad
  47519. */
  47520. getGamepadByType(type?: number): Nullable<Gamepad>;
  47521. /**
  47522. * Disposes the gamepad manager
  47523. */
  47524. dispose(): void;
  47525. private _addNewGamepad;
  47526. private _startMonitoringGamepads;
  47527. private _stopMonitoringGamepads;
  47528. /** @hidden */
  47529. _checkGamepadsStatus(): void;
  47530. private _updateGamepadObjects;
  47531. }
  47532. }
  47533. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47534. import { Nullable } from "babylonjs/types";
  47535. import { Scene } from "babylonjs/scene";
  47536. import { ISceneComponent } from "babylonjs/sceneComponent";
  47537. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47538. module "babylonjs/scene" {
  47539. interface Scene {
  47540. /** @hidden */
  47541. _gamepadManager: Nullable<GamepadManager>;
  47542. /**
  47543. * Gets the gamepad manager associated with the scene
  47544. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47545. */
  47546. gamepadManager: GamepadManager;
  47547. }
  47548. }
  47549. module "babylonjs/Cameras/freeCameraInputsManager" {
  47550. /**
  47551. * Interface representing a free camera inputs manager
  47552. */
  47553. interface FreeCameraInputsManager {
  47554. /**
  47555. * Adds gamepad input support to the FreeCameraInputsManager.
  47556. * @returns the FreeCameraInputsManager
  47557. */
  47558. addGamepad(): FreeCameraInputsManager;
  47559. }
  47560. }
  47561. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47562. /**
  47563. * Interface representing an arc rotate camera inputs manager
  47564. */
  47565. interface ArcRotateCameraInputsManager {
  47566. /**
  47567. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47568. * @returns the camera inputs manager
  47569. */
  47570. addGamepad(): ArcRotateCameraInputsManager;
  47571. }
  47572. }
  47573. /**
  47574. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47575. */
  47576. export class GamepadSystemSceneComponent implements ISceneComponent {
  47577. /**
  47578. * The component name helpfull to identify the component in the list of scene components.
  47579. */
  47580. readonly name: string;
  47581. /**
  47582. * The scene the component belongs to.
  47583. */
  47584. scene: Scene;
  47585. /**
  47586. * Creates a new instance of the component for the given scene
  47587. * @param scene Defines the scene to register the component in
  47588. */
  47589. constructor(scene: Scene);
  47590. /**
  47591. * Registers the component in a given scene
  47592. */
  47593. register(): void;
  47594. /**
  47595. * Rebuilds the elements related to this component in case of
  47596. * context lost for instance.
  47597. */
  47598. rebuild(): void;
  47599. /**
  47600. * Disposes the component and the associated ressources
  47601. */
  47602. dispose(): void;
  47603. private _beforeCameraUpdate;
  47604. }
  47605. }
  47606. declare module "babylonjs/Cameras/universalCamera" {
  47607. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47608. import { Scene } from "babylonjs/scene";
  47609. import { Vector3 } from "babylonjs/Maths/math.vector";
  47610. import "babylonjs/Gamepads/gamepadSceneComponent";
  47611. /**
  47612. * 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,
  47613. * which still works and will still be found in many Playgrounds.
  47614. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47615. */
  47616. export class UniversalCamera extends TouchCamera {
  47617. /**
  47618. * Defines the gamepad rotation sensiblity.
  47619. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47620. */
  47621. get gamepadAngularSensibility(): number;
  47622. set gamepadAngularSensibility(value: number);
  47623. /**
  47624. * Defines the gamepad move sensiblity.
  47625. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47626. */
  47627. get gamepadMoveSensibility(): number;
  47628. set gamepadMoveSensibility(value: number);
  47629. /**
  47630. * 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,
  47631. * which still works and will still be found in many Playgrounds.
  47632. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47633. * @param name Define the name of the camera in the scene
  47634. * @param position Define the start position of the camera in the scene
  47635. * @param scene Define the scene the camera belongs to
  47636. */
  47637. constructor(name: string, position: Vector3, scene: Scene);
  47638. /**
  47639. * Gets the current object class name.
  47640. * @return the class name
  47641. */
  47642. getClassName(): string;
  47643. }
  47644. }
  47645. declare module "babylonjs/Cameras/gamepadCamera" {
  47646. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47647. import { Scene } from "babylonjs/scene";
  47648. import { Vector3 } from "babylonjs/Maths/math.vector";
  47649. /**
  47650. * This represents a FPS type of camera. This is only here for back compat purpose.
  47651. * Please use the UniversalCamera instead as both are identical.
  47652. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47653. */
  47654. export class GamepadCamera extends UniversalCamera {
  47655. /**
  47656. * Instantiates a new Gamepad Camera
  47657. * This represents a FPS type of camera. This is only here for back compat purpose.
  47658. * Please use the UniversalCamera instead as both are identical.
  47659. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47660. * @param name Define the name of the camera in the scene
  47661. * @param position Define the start position of the camera in the scene
  47662. * @param scene Define the scene the camera belongs to
  47663. */
  47664. constructor(name: string, position: Vector3, scene: Scene);
  47665. /**
  47666. * Gets the current object class name.
  47667. * @return the class name
  47668. */
  47669. getClassName(): string;
  47670. }
  47671. }
  47672. declare module "babylonjs/Shaders/pass.fragment" {
  47673. /** @hidden */
  47674. export var passPixelShader: {
  47675. name: string;
  47676. shader: string;
  47677. };
  47678. }
  47679. declare module "babylonjs/Shaders/passCube.fragment" {
  47680. /** @hidden */
  47681. export var passCubePixelShader: {
  47682. name: string;
  47683. shader: string;
  47684. };
  47685. }
  47686. declare module "babylonjs/PostProcesses/passPostProcess" {
  47687. import { Nullable } from "babylonjs/types";
  47688. import { Camera } from "babylonjs/Cameras/camera";
  47689. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47690. import { Engine } from "babylonjs/Engines/engine";
  47691. import "babylonjs/Shaders/pass.fragment";
  47692. import "babylonjs/Shaders/passCube.fragment";
  47693. import { Scene } from "babylonjs/scene";
  47694. /**
  47695. * PassPostProcess which produces an output the same as it's input
  47696. */
  47697. export class PassPostProcess extends PostProcess {
  47698. /**
  47699. * Gets a string identifying the name of the class
  47700. * @returns "PassPostProcess" string
  47701. */
  47702. getClassName(): string;
  47703. /**
  47704. * Creates the PassPostProcess
  47705. * @param name The name of the effect.
  47706. * @param options The required width/height ratio to downsize to before computing the render pass.
  47707. * @param camera The camera to apply the render pass to.
  47708. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47709. * @param engine The engine which the post process will be applied. (default: current engine)
  47710. * @param reusable If the post process can be reused on the same frame. (default: false)
  47711. * @param textureType The type of texture to be used when performing the post processing.
  47712. * @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)
  47713. */
  47714. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47715. /** @hidden */
  47716. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47717. }
  47718. /**
  47719. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47720. */
  47721. export class PassCubePostProcess extends PostProcess {
  47722. private _face;
  47723. /**
  47724. * Gets or sets the cube face to display.
  47725. * * 0 is +X
  47726. * * 1 is -X
  47727. * * 2 is +Y
  47728. * * 3 is -Y
  47729. * * 4 is +Z
  47730. * * 5 is -Z
  47731. */
  47732. get face(): number;
  47733. set face(value: number);
  47734. /**
  47735. * Gets a string identifying the name of the class
  47736. * @returns "PassCubePostProcess" string
  47737. */
  47738. getClassName(): string;
  47739. /**
  47740. * Creates the PassCubePostProcess
  47741. * @param name The name of the effect.
  47742. * @param options The required width/height ratio to downsize to before computing the render pass.
  47743. * @param camera The camera to apply the render pass to.
  47744. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47745. * @param engine The engine which the post process will be applied. (default: current engine)
  47746. * @param reusable If the post process can be reused on the same frame. (default: false)
  47747. * @param textureType The type of texture to be used when performing the post processing.
  47748. * @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)
  47749. */
  47750. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47751. /** @hidden */
  47752. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47753. }
  47754. }
  47755. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47756. /** @hidden */
  47757. export var anaglyphPixelShader: {
  47758. name: string;
  47759. shader: string;
  47760. };
  47761. }
  47762. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47763. import { Engine } from "babylonjs/Engines/engine";
  47764. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47765. import { Camera } from "babylonjs/Cameras/camera";
  47766. import "babylonjs/Shaders/anaglyph.fragment";
  47767. /**
  47768. * Postprocess used to generate anaglyphic rendering
  47769. */
  47770. export class AnaglyphPostProcess extends PostProcess {
  47771. private _passedProcess;
  47772. /**
  47773. * Gets a string identifying the name of the class
  47774. * @returns "AnaglyphPostProcess" string
  47775. */
  47776. getClassName(): string;
  47777. /**
  47778. * Creates a new AnaglyphPostProcess
  47779. * @param name defines postprocess name
  47780. * @param options defines creation options or target ratio scale
  47781. * @param rigCameras defines cameras using this postprocess
  47782. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47783. * @param engine defines hosting engine
  47784. * @param reusable defines if the postprocess will be reused multiple times per frame
  47785. */
  47786. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47787. }
  47788. }
  47789. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47790. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47791. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47792. import { Scene } from "babylonjs/scene";
  47793. import { Vector3 } from "babylonjs/Maths/math.vector";
  47794. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47795. /**
  47796. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47797. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47798. */
  47799. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47800. /**
  47801. * Creates a new AnaglyphArcRotateCamera
  47802. * @param name defines camera name
  47803. * @param alpha defines alpha angle (in radians)
  47804. * @param beta defines beta angle (in radians)
  47805. * @param radius defines radius
  47806. * @param target defines camera target
  47807. * @param interaxialDistance defines distance between each color axis
  47808. * @param scene defines the hosting scene
  47809. */
  47810. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47811. /**
  47812. * Gets camera class name
  47813. * @returns AnaglyphArcRotateCamera
  47814. */
  47815. getClassName(): string;
  47816. }
  47817. }
  47818. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47819. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47820. import { Scene } from "babylonjs/scene";
  47821. import { Vector3 } from "babylonjs/Maths/math.vector";
  47822. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47823. /**
  47824. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47825. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47826. */
  47827. export class AnaglyphFreeCamera extends FreeCamera {
  47828. /**
  47829. * Creates a new AnaglyphFreeCamera
  47830. * @param name defines camera name
  47831. * @param position defines initial position
  47832. * @param interaxialDistance defines distance between each color axis
  47833. * @param scene defines the hosting scene
  47834. */
  47835. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47836. /**
  47837. * Gets camera class name
  47838. * @returns AnaglyphFreeCamera
  47839. */
  47840. getClassName(): string;
  47841. }
  47842. }
  47843. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47844. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47845. import { Scene } from "babylonjs/scene";
  47846. import { Vector3 } from "babylonjs/Maths/math.vector";
  47847. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47848. /**
  47849. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47850. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47851. */
  47852. export class AnaglyphGamepadCamera extends GamepadCamera {
  47853. /**
  47854. * Creates a new AnaglyphGamepadCamera
  47855. * @param name defines camera name
  47856. * @param position defines initial position
  47857. * @param interaxialDistance defines distance between each color axis
  47858. * @param scene defines the hosting scene
  47859. */
  47860. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47861. /**
  47862. * Gets camera class name
  47863. * @returns AnaglyphGamepadCamera
  47864. */
  47865. getClassName(): string;
  47866. }
  47867. }
  47868. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47869. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47870. import { Scene } from "babylonjs/scene";
  47871. import { Vector3 } from "babylonjs/Maths/math.vector";
  47872. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47873. /**
  47874. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47875. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47876. */
  47877. export class AnaglyphUniversalCamera extends UniversalCamera {
  47878. /**
  47879. * Creates a new AnaglyphUniversalCamera
  47880. * @param name defines camera name
  47881. * @param position defines initial position
  47882. * @param interaxialDistance defines distance between each color axis
  47883. * @param scene defines the hosting scene
  47884. */
  47885. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47886. /**
  47887. * Gets camera class name
  47888. * @returns AnaglyphUniversalCamera
  47889. */
  47890. getClassName(): string;
  47891. }
  47892. }
  47893. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47894. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47895. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47896. import { Scene } from "babylonjs/scene";
  47897. import { Vector3 } from "babylonjs/Maths/math.vector";
  47898. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47899. /**
  47900. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47901. * @see https://doc.babylonjs.com/features/cameras
  47902. */
  47903. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47904. /**
  47905. * Creates a new StereoscopicArcRotateCamera
  47906. * @param name defines camera name
  47907. * @param alpha defines alpha angle (in radians)
  47908. * @param beta defines beta angle (in radians)
  47909. * @param radius defines radius
  47910. * @param target defines camera target
  47911. * @param interaxialDistance defines distance between each color axis
  47912. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47913. * @param scene defines the hosting scene
  47914. */
  47915. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47916. /**
  47917. * Gets camera class name
  47918. * @returns StereoscopicArcRotateCamera
  47919. */
  47920. getClassName(): string;
  47921. }
  47922. }
  47923. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47924. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47925. import { Scene } from "babylonjs/scene";
  47926. import { Vector3 } from "babylonjs/Maths/math.vector";
  47927. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47928. /**
  47929. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  47930. * @see https://doc.babylonjs.com/features/cameras
  47931. */
  47932. export class StereoscopicFreeCamera extends FreeCamera {
  47933. /**
  47934. * Creates a new StereoscopicFreeCamera
  47935. * @param name defines camera name
  47936. * @param position defines initial position
  47937. * @param interaxialDistance defines distance between each color axis
  47938. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47939. * @param scene defines the hosting scene
  47940. */
  47941. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47942. /**
  47943. * Gets camera class name
  47944. * @returns StereoscopicFreeCamera
  47945. */
  47946. getClassName(): string;
  47947. }
  47948. }
  47949. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47950. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47951. import { Scene } from "babylonjs/scene";
  47952. import { Vector3 } from "babylonjs/Maths/math.vector";
  47953. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47954. /**
  47955. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  47956. * @see https://doc.babylonjs.com/features/cameras
  47957. */
  47958. export class StereoscopicGamepadCamera extends GamepadCamera {
  47959. /**
  47960. * Creates a new StereoscopicGamepadCamera
  47961. * @param name defines camera name
  47962. * @param position defines initial position
  47963. * @param interaxialDistance defines distance between each color axis
  47964. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47965. * @param scene defines the hosting scene
  47966. */
  47967. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47968. /**
  47969. * Gets camera class name
  47970. * @returns StereoscopicGamepadCamera
  47971. */
  47972. getClassName(): string;
  47973. }
  47974. }
  47975. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47976. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47977. import { Scene } from "babylonjs/scene";
  47978. import { Vector3 } from "babylonjs/Maths/math.vector";
  47979. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47980. /**
  47981. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  47982. * @see https://doc.babylonjs.com/features/cameras
  47983. */
  47984. export class StereoscopicUniversalCamera extends UniversalCamera {
  47985. /**
  47986. * Creates a new StereoscopicUniversalCamera
  47987. * @param name defines camera name
  47988. * @param position defines initial position
  47989. * @param interaxialDistance defines distance between each color axis
  47990. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47991. * @param scene defines the hosting scene
  47992. */
  47993. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47994. /**
  47995. * Gets camera class name
  47996. * @returns StereoscopicUniversalCamera
  47997. */
  47998. getClassName(): string;
  47999. }
  48000. }
  48001. declare module "babylonjs/Cameras/Stereoscopic/index" {
  48002. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  48003. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  48004. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  48005. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  48006. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  48007. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  48008. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  48009. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  48010. }
  48011. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  48012. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48013. import { Scene } from "babylonjs/scene";
  48014. import { Vector3 } from "babylonjs/Maths/math.vector";
  48015. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  48016. /**
  48017. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  48018. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48019. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48020. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48021. */
  48022. export class VirtualJoysticksCamera extends FreeCamera {
  48023. /**
  48024. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48025. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48026. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48027. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48028. * @param name Define the name of the camera in the scene
  48029. * @param position Define the start position of the camera in the scene
  48030. * @param scene Define the scene the camera belongs to
  48031. */
  48032. constructor(name: string, position: Vector3, scene: Scene);
  48033. /**
  48034. * Gets the current object class name.
  48035. * @return the class name
  48036. */
  48037. getClassName(): string;
  48038. }
  48039. }
  48040. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48041. import { Matrix } from "babylonjs/Maths/math.vector";
  48042. /**
  48043. * This represents all the required metrics to create a VR camera.
  48044. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48045. */
  48046. export class VRCameraMetrics {
  48047. /**
  48048. * Define the horizontal resolution off the screen.
  48049. */
  48050. hResolution: number;
  48051. /**
  48052. * Define the vertical resolution off the screen.
  48053. */
  48054. vResolution: number;
  48055. /**
  48056. * Define the horizontal screen size.
  48057. */
  48058. hScreenSize: number;
  48059. /**
  48060. * Define the vertical screen size.
  48061. */
  48062. vScreenSize: number;
  48063. /**
  48064. * Define the vertical screen center position.
  48065. */
  48066. vScreenCenter: number;
  48067. /**
  48068. * Define the distance of the eyes to the screen.
  48069. */
  48070. eyeToScreenDistance: number;
  48071. /**
  48072. * Define the distance between both lenses
  48073. */
  48074. lensSeparationDistance: number;
  48075. /**
  48076. * Define the distance between both viewer's eyes.
  48077. */
  48078. interpupillaryDistance: number;
  48079. /**
  48080. * Define the distortion factor of the VR postprocess.
  48081. * Please, touch with care.
  48082. */
  48083. distortionK: number[];
  48084. /**
  48085. * Define the chromatic aberration correction factors for the VR post process.
  48086. */
  48087. chromaAbCorrection: number[];
  48088. /**
  48089. * Define the scale factor of the post process.
  48090. * The smaller the better but the slower.
  48091. */
  48092. postProcessScaleFactor: number;
  48093. /**
  48094. * Define an offset for the lens center.
  48095. */
  48096. lensCenterOffset: number;
  48097. /**
  48098. * Define if the current vr camera should compensate the distortion of the lense or not.
  48099. */
  48100. compensateDistortion: boolean;
  48101. /**
  48102. * Defines if multiview should be enabled when rendering (Default: false)
  48103. */
  48104. multiviewEnabled: boolean;
  48105. /**
  48106. * Gets the rendering aspect ratio based on the provided resolutions.
  48107. */
  48108. get aspectRatio(): number;
  48109. /**
  48110. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48111. */
  48112. get aspectRatioFov(): number;
  48113. /**
  48114. * @hidden
  48115. */
  48116. get leftHMatrix(): Matrix;
  48117. /**
  48118. * @hidden
  48119. */
  48120. get rightHMatrix(): Matrix;
  48121. /**
  48122. * @hidden
  48123. */
  48124. get leftPreViewMatrix(): Matrix;
  48125. /**
  48126. * @hidden
  48127. */
  48128. get rightPreViewMatrix(): Matrix;
  48129. /**
  48130. * Get the default VRMetrics based on the most generic setup.
  48131. * @returns the default vr metrics
  48132. */
  48133. static GetDefault(): VRCameraMetrics;
  48134. }
  48135. }
  48136. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48137. /** @hidden */
  48138. export var vrDistortionCorrectionPixelShader: {
  48139. name: string;
  48140. shader: string;
  48141. };
  48142. }
  48143. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48144. import { Camera } from "babylonjs/Cameras/camera";
  48145. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48146. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48147. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48148. /**
  48149. * VRDistortionCorrectionPostProcess used for mobile VR
  48150. */
  48151. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48152. private _isRightEye;
  48153. private _distortionFactors;
  48154. private _postProcessScaleFactor;
  48155. private _lensCenterOffset;
  48156. private _scaleIn;
  48157. private _scaleFactor;
  48158. private _lensCenter;
  48159. /**
  48160. * Gets a string identifying the name of the class
  48161. * @returns "VRDistortionCorrectionPostProcess" string
  48162. */
  48163. getClassName(): string;
  48164. /**
  48165. * Initializes the VRDistortionCorrectionPostProcess
  48166. * @param name The name of the effect.
  48167. * @param camera The camera to apply the render pass to.
  48168. * @param isRightEye If this is for the right eye distortion
  48169. * @param vrMetrics All the required metrics for the VR camera
  48170. */
  48171. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48172. }
  48173. }
  48174. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48175. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48176. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48177. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48178. import { Scene } from "babylonjs/scene";
  48179. import { Vector3 } from "babylonjs/Maths/math.vector";
  48180. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48181. import "babylonjs/Cameras/RigModes/vrRigMode";
  48182. /**
  48183. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48184. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48185. */
  48186. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48187. /**
  48188. * Creates a new VRDeviceOrientationArcRotateCamera
  48189. * @param name defines camera name
  48190. * @param alpha defines the camera rotation along the logitudinal axis
  48191. * @param beta defines the camera rotation along the latitudinal axis
  48192. * @param radius defines the camera distance from its target
  48193. * @param target defines the camera target
  48194. * @param scene defines the scene the camera belongs to
  48195. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48196. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48197. */
  48198. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48199. /**
  48200. * Gets camera class name
  48201. * @returns VRDeviceOrientationArcRotateCamera
  48202. */
  48203. getClassName(): string;
  48204. }
  48205. }
  48206. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48207. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48208. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48209. import { Scene } from "babylonjs/scene";
  48210. import { Vector3 } from "babylonjs/Maths/math.vector";
  48211. import "babylonjs/Cameras/RigModes/vrRigMode";
  48212. /**
  48213. * Camera used to simulate VR rendering (based on FreeCamera)
  48214. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48215. */
  48216. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48217. /**
  48218. * Creates a new VRDeviceOrientationFreeCamera
  48219. * @param name defines camera name
  48220. * @param position defines the start position of the camera
  48221. * @param scene defines the scene the camera belongs to
  48222. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48223. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48224. */
  48225. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48226. /**
  48227. * Gets camera class name
  48228. * @returns VRDeviceOrientationFreeCamera
  48229. */
  48230. getClassName(): string;
  48231. }
  48232. }
  48233. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48234. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48235. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48236. import { Scene } from "babylonjs/scene";
  48237. import { Vector3 } from "babylonjs/Maths/math.vector";
  48238. import "babylonjs/Gamepads/gamepadSceneComponent";
  48239. /**
  48240. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48241. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48242. */
  48243. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48244. /**
  48245. * Creates a new VRDeviceOrientationGamepadCamera
  48246. * @param name defines camera name
  48247. * @param position defines the start position of the camera
  48248. * @param scene defines the scene the camera belongs to
  48249. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48250. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48251. */
  48252. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48253. /**
  48254. * Gets camera class name
  48255. * @returns VRDeviceOrientationGamepadCamera
  48256. */
  48257. getClassName(): string;
  48258. }
  48259. }
  48260. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48261. import { Scene } from "babylonjs/scene";
  48262. import { Texture } from "babylonjs/Materials/Textures/texture";
  48263. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48264. /**
  48265. * A class extending Texture allowing drawing on a texture
  48266. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48267. */
  48268. export class DynamicTexture extends Texture {
  48269. private _generateMipMaps;
  48270. private _canvas;
  48271. private _context;
  48272. /**
  48273. * Creates a DynamicTexture
  48274. * @param name defines the name of the texture
  48275. * @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
  48276. * @param scene defines the scene where you want the texture
  48277. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48278. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48279. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48280. */
  48281. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48282. /**
  48283. * Get the current class name of the texture useful for serialization or dynamic coding.
  48284. * @returns "DynamicTexture"
  48285. */
  48286. getClassName(): string;
  48287. /**
  48288. * Gets the current state of canRescale
  48289. */
  48290. get canRescale(): boolean;
  48291. private _recreate;
  48292. /**
  48293. * Scales the texture
  48294. * @param ratio the scale factor to apply to both width and height
  48295. */
  48296. scale(ratio: number): void;
  48297. /**
  48298. * Resizes the texture
  48299. * @param width the new width
  48300. * @param height the new height
  48301. */
  48302. scaleTo(width: number, height: number): void;
  48303. /**
  48304. * Gets the context of the canvas used by the texture
  48305. * @returns the canvas context of the dynamic texture
  48306. */
  48307. getContext(): CanvasRenderingContext2D;
  48308. /**
  48309. * Clears the texture
  48310. */
  48311. clear(): void;
  48312. /**
  48313. * Updates the texture
  48314. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48315. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48316. */
  48317. update(invertY?: boolean, premulAlpha?: boolean): void;
  48318. /**
  48319. * Draws text onto the texture
  48320. * @param text defines the text to be drawn
  48321. * @param x defines the placement of the text from the left
  48322. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48323. * @param font defines the font to be used with font-style, font-size, font-name
  48324. * @param color defines the color used for the text
  48325. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48326. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48327. * @param update defines whether texture is immediately update (default is true)
  48328. */
  48329. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48330. /**
  48331. * Clones the texture
  48332. * @returns the clone of the texture.
  48333. */
  48334. clone(): DynamicTexture;
  48335. /**
  48336. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48337. * @returns a serialized dynamic texture object
  48338. */
  48339. serialize(): any;
  48340. private _IsCanvasElement;
  48341. /** @hidden */
  48342. _rebuild(): void;
  48343. }
  48344. }
  48345. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48346. import { Scene } from "babylonjs/scene";
  48347. import { Color3 } from "babylonjs/Maths/math.color";
  48348. import { Mesh } from "babylonjs/Meshes/mesh";
  48349. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48350. import { Nullable } from "babylonjs/types";
  48351. /**
  48352. * Class containing static functions to help procedurally build meshes
  48353. */
  48354. export class GroundBuilder {
  48355. /**
  48356. * Creates a ground mesh
  48357. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48358. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48359. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48360. * @param name defines the name of the mesh
  48361. * @param options defines the options used to create the mesh
  48362. * @param scene defines the hosting scene
  48363. * @returns the ground mesh
  48364. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48365. */
  48366. static CreateGround(name: string, options: {
  48367. width?: number;
  48368. height?: number;
  48369. subdivisions?: number;
  48370. subdivisionsX?: number;
  48371. subdivisionsY?: number;
  48372. updatable?: boolean;
  48373. }, scene: any): Mesh;
  48374. /**
  48375. * Creates a tiled ground mesh
  48376. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48377. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48378. * * 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
  48379. * * 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
  48380. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48381. * @param name defines the name of the mesh
  48382. * @param options defines the options used to create the mesh
  48383. * @param scene defines the hosting scene
  48384. * @returns the tiled ground mesh
  48385. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48386. */
  48387. static CreateTiledGround(name: string, options: {
  48388. xmin: number;
  48389. zmin: number;
  48390. xmax: number;
  48391. zmax: number;
  48392. subdivisions?: {
  48393. w: number;
  48394. h: number;
  48395. };
  48396. precision?: {
  48397. w: number;
  48398. h: number;
  48399. };
  48400. updatable?: boolean;
  48401. }, scene?: Nullable<Scene>): Mesh;
  48402. /**
  48403. * Creates a ground mesh from a height map
  48404. * * The parameter `url` sets the URL of the height map image resource.
  48405. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48406. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48407. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48408. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48409. * * 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.
  48410. * * 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).
  48411. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48412. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48413. * @param name defines the name of the mesh
  48414. * @param url defines the url to the height map
  48415. * @param options defines the options used to create the mesh
  48416. * @param scene defines the hosting scene
  48417. * @returns the ground mesh
  48418. * @see https://doc.babylonjs.com/babylon101/height_map
  48419. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48420. */
  48421. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48422. width?: number;
  48423. height?: number;
  48424. subdivisions?: number;
  48425. minHeight?: number;
  48426. maxHeight?: number;
  48427. colorFilter?: Color3;
  48428. alphaFilter?: number;
  48429. updatable?: boolean;
  48430. onReady?: (mesh: GroundMesh) => void;
  48431. }, scene?: Nullable<Scene>): GroundMesh;
  48432. }
  48433. }
  48434. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48435. import { Vector4 } from "babylonjs/Maths/math.vector";
  48436. import { Mesh } from "babylonjs/Meshes/mesh";
  48437. /**
  48438. * Class containing static functions to help procedurally build meshes
  48439. */
  48440. export class TorusBuilder {
  48441. /**
  48442. * Creates a torus mesh
  48443. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48444. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48445. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48446. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48447. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48448. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48449. * @param name defines the name of the mesh
  48450. * @param options defines the options used to create the mesh
  48451. * @param scene defines the hosting scene
  48452. * @returns the torus mesh
  48453. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48454. */
  48455. static CreateTorus(name: string, options: {
  48456. diameter?: number;
  48457. thickness?: number;
  48458. tessellation?: number;
  48459. updatable?: boolean;
  48460. sideOrientation?: number;
  48461. frontUVs?: Vector4;
  48462. backUVs?: Vector4;
  48463. }, scene: any): Mesh;
  48464. }
  48465. }
  48466. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48467. import { Vector4 } from "babylonjs/Maths/math.vector";
  48468. import { Color4 } from "babylonjs/Maths/math.color";
  48469. import { Mesh } from "babylonjs/Meshes/mesh";
  48470. /**
  48471. * Class containing static functions to help procedurally build meshes
  48472. */
  48473. export class CylinderBuilder {
  48474. /**
  48475. * Creates a cylinder or a cone mesh
  48476. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48477. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48478. * * 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.
  48479. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48480. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48481. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48482. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48483. * * 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).
  48484. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48485. * * 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).
  48486. * * 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
  48487. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48488. * * 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
  48489. * * 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.
  48490. * * If `enclose` is false, a ring surface is one element.
  48491. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48492. * * 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
  48493. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48494. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48495. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48496. * @param name defines the name of the mesh
  48497. * @param options defines the options used to create the mesh
  48498. * @param scene defines the hosting scene
  48499. * @returns the cylinder mesh
  48500. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48501. */
  48502. static CreateCylinder(name: string, options: {
  48503. height?: number;
  48504. diameterTop?: number;
  48505. diameterBottom?: number;
  48506. diameter?: number;
  48507. tessellation?: number;
  48508. subdivisions?: number;
  48509. arc?: number;
  48510. faceColors?: Color4[];
  48511. faceUV?: Vector4[];
  48512. updatable?: boolean;
  48513. hasRings?: boolean;
  48514. enclose?: boolean;
  48515. cap?: number;
  48516. sideOrientation?: number;
  48517. frontUVs?: Vector4;
  48518. backUVs?: Vector4;
  48519. }, scene: any): Mesh;
  48520. }
  48521. }
  48522. declare module "babylonjs/XR/webXRTypes" {
  48523. import { Nullable } from "babylonjs/types";
  48524. import { IDisposable } from "babylonjs/scene";
  48525. /**
  48526. * States of the webXR experience
  48527. */
  48528. export enum WebXRState {
  48529. /**
  48530. * Transitioning to being in XR mode
  48531. */
  48532. ENTERING_XR = 0,
  48533. /**
  48534. * Transitioning to non XR mode
  48535. */
  48536. EXITING_XR = 1,
  48537. /**
  48538. * In XR mode and presenting
  48539. */
  48540. IN_XR = 2,
  48541. /**
  48542. * Not entered XR mode
  48543. */
  48544. NOT_IN_XR = 3
  48545. }
  48546. /**
  48547. * Abstraction of the XR render target
  48548. */
  48549. export interface WebXRRenderTarget extends IDisposable {
  48550. /**
  48551. * xrpresent context of the canvas which can be used to display/mirror xr content
  48552. */
  48553. canvasContext: WebGLRenderingContext;
  48554. /**
  48555. * xr layer for the canvas
  48556. */
  48557. xrLayer: Nullable<XRWebGLLayer>;
  48558. /**
  48559. * Initializes the xr layer for the session
  48560. * @param xrSession xr session
  48561. * @returns a promise that will resolve once the XR Layer has been created
  48562. */
  48563. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48564. }
  48565. }
  48566. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48567. import { Nullable } from "babylonjs/types";
  48568. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  48569. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48570. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48571. import { Observable } from "babylonjs/Misc/observable";
  48572. /**
  48573. * COnfiguration object for WebXR output canvas
  48574. */
  48575. export class WebXRManagedOutputCanvasOptions {
  48576. /**
  48577. * An optional canvas in case you wish to create it yourself and provide it here.
  48578. * If not provided, a new canvas will be created
  48579. */
  48580. canvasElement?: HTMLCanvasElement;
  48581. /**
  48582. * Options for this XR Layer output
  48583. */
  48584. canvasOptions?: XRWebGLLayerOptions;
  48585. /**
  48586. * CSS styling for a newly created canvas (if not provided)
  48587. */
  48588. newCanvasCssStyle?: string;
  48589. /**
  48590. * Get the default values of the configuration object
  48591. * @param engine defines the engine to use (can be null)
  48592. * @returns default values of this configuration object
  48593. */
  48594. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  48595. }
  48596. /**
  48597. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48598. */
  48599. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48600. private _options;
  48601. private _canvas;
  48602. private _engine;
  48603. private _originalCanvasSize;
  48604. /**
  48605. * Rendering context of the canvas which can be used to display/mirror xr content
  48606. */
  48607. canvasContext: WebGLRenderingContext;
  48608. /**
  48609. * xr layer for the canvas
  48610. */
  48611. xrLayer: Nullable<XRWebGLLayer>;
  48612. /**
  48613. * Obseervers registered here will be triggered when the xr layer was initialized
  48614. */
  48615. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48616. /**
  48617. * Initializes the canvas to be added/removed upon entering/exiting xr
  48618. * @param _xrSessionManager The XR Session manager
  48619. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48620. */
  48621. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48622. /**
  48623. * Disposes of the object
  48624. */
  48625. dispose(): void;
  48626. /**
  48627. * Initializes the xr layer for the session
  48628. * @param xrSession xr session
  48629. * @returns a promise that will resolve once the XR Layer has been created
  48630. */
  48631. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48632. private _addCanvas;
  48633. private _removeCanvas;
  48634. private _setCanvasSize;
  48635. private _setManagedOutputCanvas;
  48636. }
  48637. }
  48638. declare module "babylonjs/XR/webXRSessionManager" {
  48639. import { Observable } from "babylonjs/Misc/observable";
  48640. import { Nullable } from "babylonjs/types";
  48641. import { IDisposable, Scene } from "babylonjs/scene";
  48642. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48643. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48644. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48645. /**
  48646. * Manages an XRSession to work with Babylon's engine
  48647. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48648. */
  48649. export class WebXRSessionManager implements IDisposable {
  48650. /** The scene which the session should be created for */
  48651. scene: Scene;
  48652. private _referenceSpace;
  48653. private _rttProvider;
  48654. private _sessionEnded;
  48655. private _xrNavigator;
  48656. private baseLayer;
  48657. /**
  48658. * The base reference space from which the session started. good if you want to reset your
  48659. * reference space
  48660. */
  48661. baseReferenceSpace: XRReferenceSpace;
  48662. /**
  48663. * Current XR frame
  48664. */
  48665. currentFrame: Nullable<XRFrame>;
  48666. /** WebXR timestamp updated every frame */
  48667. currentTimestamp: number;
  48668. /**
  48669. * Used just in case of a failure to initialize an immersive session.
  48670. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48671. */
  48672. defaultHeightCompensation: number;
  48673. /**
  48674. * Fires every time a new xrFrame arrives which can be used to update the camera
  48675. */
  48676. onXRFrameObservable: Observable<XRFrame>;
  48677. /**
  48678. * Fires when the reference space changed
  48679. */
  48680. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48681. /**
  48682. * Fires when the xr session is ended either by the device or manually done
  48683. */
  48684. onXRSessionEnded: Observable<any>;
  48685. /**
  48686. * Fires when the xr session is ended either by the device or manually done
  48687. */
  48688. onXRSessionInit: Observable<XRSession>;
  48689. /**
  48690. * Underlying xr session
  48691. */
  48692. session: XRSession;
  48693. /**
  48694. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48695. * or get the offset the player is currently at.
  48696. */
  48697. viewerReferenceSpace: XRReferenceSpace;
  48698. /**
  48699. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48700. * @param scene The scene which the session should be created for
  48701. */
  48702. constructor(
  48703. /** The scene which the session should be created for */
  48704. scene: Scene);
  48705. /**
  48706. * The current reference space used in this session. This reference space can constantly change!
  48707. * It is mainly used to offset the camera's position.
  48708. */
  48709. get referenceSpace(): XRReferenceSpace;
  48710. /**
  48711. * Set a new reference space and triggers the observable
  48712. */
  48713. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48714. /**
  48715. * Disposes of the session manager
  48716. */
  48717. dispose(): void;
  48718. /**
  48719. * Stops the xrSession and restores the render loop
  48720. * @returns Promise which resolves after it exits XR
  48721. */
  48722. exitXRAsync(): Promise<void>;
  48723. /**
  48724. * Gets the correct render target texture to be rendered this frame for this eye
  48725. * @param eye the eye for which to get the render target
  48726. * @returns the render target for the specified eye
  48727. */
  48728. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48729. /**
  48730. * Creates a WebXRRenderTarget object for the XR session
  48731. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48732. * @param options optional options to provide when creating a new render target
  48733. * @returns a WebXR render target to which the session can render
  48734. */
  48735. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48736. /**
  48737. * Initializes the manager
  48738. * After initialization enterXR can be called to start an XR session
  48739. * @returns Promise which resolves after it is initialized
  48740. */
  48741. initializeAsync(): Promise<void>;
  48742. /**
  48743. * Initializes an xr session
  48744. * @param xrSessionMode mode to initialize
  48745. * @param xrSessionInit defines optional and required values to pass to the session builder
  48746. * @returns a promise which will resolve once the session has been initialized
  48747. */
  48748. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48749. /**
  48750. * Checks if a session would be supported for the creation options specified
  48751. * @param sessionMode session mode to check if supported eg. immersive-vr
  48752. * @returns A Promise that resolves to true if supported and false if not
  48753. */
  48754. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48755. /**
  48756. * Resets the reference space to the one started the session
  48757. */
  48758. resetReferenceSpace(): void;
  48759. /**
  48760. * Starts rendering to the xr layer
  48761. */
  48762. runXRRenderLoop(): void;
  48763. /**
  48764. * Sets the reference space on the xr session
  48765. * @param referenceSpaceType space to set
  48766. * @returns a promise that will resolve once the reference space has been set
  48767. */
  48768. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48769. /**
  48770. * Updates the render state of the session
  48771. * @param state state to set
  48772. * @returns a promise that resolves once the render state has been updated
  48773. */
  48774. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48775. /**
  48776. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48777. * @param sessionMode defines the session to test
  48778. * @returns a promise with boolean as final value
  48779. */
  48780. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48781. private _createRenderTargetTexture;
  48782. }
  48783. }
  48784. declare module "babylonjs/XR/webXRCamera" {
  48785. import { Vector3 } from "babylonjs/Maths/math.vector";
  48786. import { Scene } from "babylonjs/scene";
  48787. import { Camera } from "babylonjs/Cameras/camera";
  48788. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48789. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48790. import { Observable } from "babylonjs/Misc/observable";
  48791. /**
  48792. * WebXR Camera which holds the views for the xrSession
  48793. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48794. */
  48795. export class WebXRCamera extends FreeCamera {
  48796. private _xrSessionManager;
  48797. private _firstFrame;
  48798. private _referenceQuaternion;
  48799. private _referencedPosition;
  48800. private _xrInvPositionCache;
  48801. private _xrInvQuaternionCache;
  48802. /**
  48803. * Observable raised before camera teleportation
  48804. */
  48805. onBeforeCameraTeleport: Observable<Vector3>;
  48806. /**
  48807. * Observable raised after camera teleportation
  48808. */
  48809. onAfterCameraTeleport: Observable<Vector3>;
  48810. /**
  48811. * Should position compensation execute on first frame.
  48812. * This is used when copying the position from a native (non XR) camera
  48813. */
  48814. compensateOnFirstFrame: boolean;
  48815. /**
  48816. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48817. * @param name the name of the camera
  48818. * @param scene the scene to add the camera to
  48819. * @param _xrSessionManager a constructed xr session manager
  48820. */
  48821. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48822. /**
  48823. * Return the user's height, unrelated to the current ground.
  48824. * This will be the y position of this camera, when ground level is 0.
  48825. */
  48826. get realWorldHeight(): number;
  48827. /** @hidden */
  48828. _updateForDualEyeDebugging(): void;
  48829. /**
  48830. * Sets this camera's transformation based on a non-vr camera
  48831. * @param otherCamera the non-vr camera to copy the transformation from
  48832. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48833. */
  48834. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48835. /**
  48836. * Gets the current instance class name ("WebXRCamera").
  48837. * @returns the class name
  48838. */
  48839. getClassName(): string;
  48840. private _rotate180;
  48841. private _updateFromXRSession;
  48842. private _updateNumberOfRigCameras;
  48843. private _updateReferenceSpace;
  48844. private _updateReferenceSpaceOffset;
  48845. }
  48846. }
  48847. declare module "babylonjs/XR/webXRFeaturesManager" {
  48848. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48849. import { IDisposable } from "babylonjs/scene";
  48850. /**
  48851. * Defining the interface required for a (webxr) feature
  48852. */
  48853. export interface IWebXRFeature extends IDisposable {
  48854. /**
  48855. * Is this feature attached
  48856. */
  48857. attached: boolean;
  48858. /**
  48859. * Should auto-attach be disabled?
  48860. */
  48861. disableAutoAttach: boolean;
  48862. /**
  48863. * Attach the feature to the session
  48864. * Will usually be called by the features manager
  48865. *
  48866. * @param force should attachment be forced (even when already attached)
  48867. * @returns true if successful.
  48868. */
  48869. attach(force?: boolean): boolean;
  48870. /**
  48871. * Detach the feature from the session
  48872. * Will usually be called by the features manager
  48873. *
  48874. * @returns true if successful.
  48875. */
  48876. detach(): boolean;
  48877. /**
  48878. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  48879. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  48880. *
  48881. * @returns whether or not the feature is compatible in this environment
  48882. */
  48883. isCompatible(): boolean;
  48884. /**
  48885. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  48886. */
  48887. xrNativeFeatureName?: string;
  48888. /**
  48889. * A list of (Babylon WebXR) features this feature depends on
  48890. */
  48891. dependsOn?: string[];
  48892. }
  48893. /**
  48894. * A list of the currently available features without referencing them
  48895. */
  48896. export class WebXRFeatureName {
  48897. /**
  48898. * The name of the anchor system feature
  48899. */
  48900. static readonly ANCHOR_SYSTEM: string;
  48901. /**
  48902. * The name of the background remover feature
  48903. */
  48904. static readonly BACKGROUND_REMOVER: string;
  48905. /**
  48906. * The name of the hit test feature
  48907. */
  48908. static readonly HIT_TEST: string;
  48909. /**
  48910. * physics impostors for xr controllers feature
  48911. */
  48912. static readonly PHYSICS_CONTROLLERS: string;
  48913. /**
  48914. * The name of the plane detection feature
  48915. */
  48916. static readonly PLANE_DETECTION: string;
  48917. /**
  48918. * The name of the pointer selection feature
  48919. */
  48920. static readonly POINTER_SELECTION: string;
  48921. /**
  48922. * The name of the teleportation feature
  48923. */
  48924. static readonly TELEPORTATION: string;
  48925. /**
  48926. * The name of the feature points feature.
  48927. */
  48928. static readonly FEATURE_POINTS: string;
  48929. /**
  48930. * The name of the hand tracking feature.
  48931. */
  48932. static readonly HAND_TRACKING: string;
  48933. }
  48934. /**
  48935. * Defining the constructor of a feature. Used to register the modules.
  48936. */
  48937. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48938. /**
  48939. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48940. * It is mainly used in AR sessions.
  48941. *
  48942. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48943. */
  48944. export class WebXRFeaturesManager implements IDisposable {
  48945. private _xrSessionManager;
  48946. private static readonly _AvailableFeatures;
  48947. private _features;
  48948. /**
  48949. * constructs a new features manages.
  48950. *
  48951. * @param _xrSessionManager an instance of WebXRSessionManager
  48952. */
  48953. constructor(_xrSessionManager: WebXRSessionManager);
  48954. /**
  48955. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48956. * Mainly used internally.
  48957. *
  48958. * @param featureName the name of the feature to register
  48959. * @param constructorFunction the function used to construct the module
  48960. * @param version the (babylon) version of the module
  48961. * @param stable is that a stable version of this module
  48962. */
  48963. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48964. /**
  48965. * Returns a constructor of a specific feature.
  48966. *
  48967. * @param featureName the name of the feature to construct
  48968. * @param version the version of the feature to load
  48969. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48970. * @param options optional options provided to the module.
  48971. * @returns a function that, when called, will return a new instance of this feature
  48972. */
  48973. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48974. /**
  48975. * Can be used to return the list of features currently registered
  48976. *
  48977. * @returns an Array of available features
  48978. */
  48979. static GetAvailableFeatures(): string[];
  48980. /**
  48981. * Gets the versions available for a specific feature
  48982. * @param featureName the name of the feature
  48983. * @returns an array with the available versions
  48984. */
  48985. static GetAvailableVersions(featureName: string): string[];
  48986. /**
  48987. * Return the latest unstable version of this feature
  48988. * @param featureName the name of the feature to search
  48989. * @returns the version number. if not found will return -1
  48990. */
  48991. static GetLatestVersionOfFeature(featureName: string): number;
  48992. /**
  48993. * Return the latest stable version of this feature
  48994. * @param featureName the name of the feature to search
  48995. * @returns the version number. if not found will return -1
  48996. */
  48997. static GetStableVersionOfFeature(featureName: string): number;
  48998. /**
  48999. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  49000. * Can be used during a session to start a feature
  49001. * @param featureName the name of feature to attach
  49002. */
  49003. attachFeature(featureName: string): void;
  49004. /**
  49005. * Can be used inside a session or when the session ends to detach a specific feature
  49006. * @param featureName the name of the feature to detach
  49007. */
  49008. detachFeature(featureName: string): void;
  49009. /**
  49010. * Used to disable an already-enabled feature
  49011. * The feature will be disposed and will be recreated once enabled.
  49012. * @param featureName the feature to disable
  49013. * @returns true if disable was successful
  49014. */
  49015. disableFeature(featureName: string | {
  49016. Name: string;
  49017. }): boolean;
  49018. /**
  49019. * dispose this features manager
  49020. */
  49021. dispose(): void;
  49022. /**
  49023. * 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.
  49024. * 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.
  49025. *
  49026. * @param featureName the name of the feature to load or the class of the feature
  49027. * @param version optional version to load. if not provided the latest version will be enabled
  49028. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  49029. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  49030. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  49031. * @returns a new constructed feature or throws an error if feature not found.
  49032. */
  49033. enableFeature(featureName: string | {
  49034. Name: string;
  49035. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  49036. /**
  49037. * get the implementation of an enabled feature.
  49038. * @param featureName the name of the feature to load
  49039. * @returns the feature class, if found
  49040. */
  49041. getEnabledFeature(featureName: string): IWebXRFeature;
  49042. /**
  49043. * Get the list of enabled features
  49044. * @returns an array of enabled features
  49045. */
  49046. getEnabledFeatures(): string[];
  49047. /**
  49048. * This function will exten the session creation configuration object with enabled features.
  49049. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49050. * according to the defined "required" variable, provided during enableFeature call
  49051. * @param xrSessionInit the xr Session init object to extend
  49052. *
  49053. * @returns an extended XRSessionInit object
  49054. */
  49055. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49056. }
  49057. }
  49058. declare module "babylonjs/XR/webXRExperienceHelper" {
  49059. import { Observable } from "babylonjs/Misc/observable";
  49060. import { IDisposable, Scene } from "babylonjs/scene";
  49061. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49062. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49063. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49064. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49065. /**
  49066. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49067. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49068. */
  49069. export class WebXRExperienceHelper implements IDisposable {
  49070. private scene;
  49071. private _nonVRCamera;
  49072. private _originalSceneAutoClear;
  49073. private _supported;
  49074. /**
  49075. * Camera used to render xr content
  49076. */
  49077. camera: WebXRCamera;
  49078. /** A features manager for this xr session */
  49079. featuresManager: WebXRFeaturesManager;
  49080. /**
  49081. * Observers registered here will be triggered after the camera's initial transformation is set
  49082. * This can be used to set a different ground level or an extra rotation.
  49083. *
  49084. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49085. * to the position set after this observable is done executing.
  49086. */
  49087. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49088. /**
  49089. * Fires when the state of the experience helper has changed
  49090. */
  49091. onStateChangedObservable: Observable<WebXRState>;
  49092. /** Session manager used to keep track of xr session */
  49093. sessionManager: WebXRSessionManager;
  49094. /**
  49095. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49096. */
  49097. state: WebXRState;
  49098. /**
  49099. * Creates a WebXRExperienceHelper
  49100. * @param scene The scene the helper should be created in
  49101. */
  49102. private constructor();
  49103. /**
  49104. * Creates the experience helper
  49105. * @param scene the scene to attach the experience helper to
  49106. * @returns a promise for the experience helper
  49107. */
  49108. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49109. /**
  49110. * Disposes of the experience helper
  49111. */
  49112. dispose(): void;
  49113. /**
  49114. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49115. * @param sessionMode options for the XR session
  49116. * @param referenceSpaceType frame of reference of the XR session
  49117. * @param renderTarget the output canvas that will be used to enter XR mode
  49118. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49119. * @returns promise that resolves after xr mode has entered
  49120. */
  49121. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49122. /**
  49123. * Exits XR mode and returns the scene to its original state
  49124. * @returns promise that resolves after xr mode has exited
  49125. */
  49126. exitXRAsync(): Promise<void>;
  49127. private _nonXRToXRCamera;
  49128. private _setState;
  49129. }
  49130. }
  49131. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49132. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49133. import { Observable } from "babylonjs/Misc/observable";
  49134. import { IDisposable } from "babylonjs/scene";
  49135. /**
  49136. * X-Y values for axes in WebXR
  49137. */
  49138. export interface IWebXRMotionControllerAxesValue {
  49139. /**
  49140. * The value of the x axis
  49141. */
  49142. x: number;
  49143. /**
  49144. * The value of the y-axis
  49145. */
  49146. y: number;
  49147. }
  49148. /**
  49149. * changed / previous values for the values of this component
  49150. */
  49151. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49152. /**
  49153. * current (this frame) value
  49154. */
  49155. current: T;
  49156. /**
  49157. * previous (last change) value
  49158. */
  49159. previous: T;
  49160. }
  49161. /**
  49162. * Represents changes in the component between current frame and last values recorded
  49163. */
  49164. export interface IWebXRMotionControllerComponentChanges {
  49165. /**
  49166. * will be populated with previous and current values if axes changed
  49167. */
  49168. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49169. /**
  49170. * will be populated with previous and current values if pressed changed
  49171. */
  49172. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49173. /**
  49174. * will be populated with previous and current values if touched changed
  49175. */
  49176. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49177. /**
  49178. * will be populated with previous and current values if value changed
  49179. */
  49180. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49181. }
  49182. /**
  49183. * This class represents a single component (for example button or thumbstick) of a motion controller
  49184. */
  49185. export class WebXRControllerComponent implements IDisposable {
  49186. /**
  49187. * the id of this component
  49188. */
  49189. id: string;
  49190. /**
  49191. * the type of the component
  49192. */
  49193. type: MotionControllerComponentType;
  49194. private _buttonIndex;
  49195. private _axesIndices;
  49196. private _axes;
  49197. private _changes;
  49198. private _currentValue;
  49199. private _hasChanges;
  49200. private _pressed;
  49201. private _touched;
  49202. /**
  49203. * button component type
  49204. */
  49205. static BUTTON_TYPE: MotionControllerComponentType;
  49206. /**
  49207. * squeeze component type
  49208. */
  49209. static SQUEEZE_TYPE: MotionControllerComponentType;
  49210. /**
  49211. * Thumbstick component type
  49212. */
  49213. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49214. /**
  49215. * Touchpad component type
  49216. */
  49217. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49218. /**
  49219. * trigger component type
  49220. */
  49221. static TRIGGER_TYPE: MotionControllerComponentType;
  49222. /**
  49223. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49224. * the axes data changes
  49225. */
  49226. onAxisValueChangedObservable: Observable<{
  49227. x: number;
  49228. y: number;
  49229. }>;
  49230. /**
  49231. * Observers registered here will be triggered when the state of a button changes
  49232. * State change is either pressed / touched / value
  49233. */
  49234. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49235. /**
  49236. * Creates a new component for a motion controller.
  49237. * It is created by the motion controller itself
  49238. *
  49239. * @param id the id of this component
  49240. * @param type the type of the component
  49241. * @param _buttonIndex index in the buttons array of the gamepad
  49242. * @param _axesIndices indices of the values in the axes array of the gamepad
  49243. */
  49244. constructor(
  49245. /**
  49246. * the id of this component
  49247. */
  49248. id: string,
  49249. /**
  49250. * the type of the component
  49251. */
  49252. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49253. /**
  49254. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49255. */
  49256. get axes(): IWebXRMotionControllerAxesValue;
  49257. /**
  49258. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49259. */
  49260. get changes(): IWebXRMotionControllerComponentChanges;
  49261. /**
  49262. * Return whether or not the component changed the last frame
  49263. */
  49264. get hasChanges(): boolean;
  49265. /**
  49266. * is the button currently pressed
  49267. */
  49268. get pressed(): boolean;
  49269. /**
  49270. * is the button currently touched
  49271. */
  49272. get touched(): boolean;
  49273. /**
  49274. * Get the current value of this component
  49275. */
  49276. get value(): number;
  49277. /**
  49278. * Dispose this component
  49279. */
  49280. dispose(): void;
  49281. /**
  49282. * Are there axes correlating to this component
  49283. * @return true is axes data is available
  49284. */
  49285. isAxes(): boolean;
  49286. /**
  49287. * Is this component a button (hence - pressable)
  49288. * @returns true if can be pressed
  49289. */
  49290. isButton(): boolean;
  49291. /**
  49292. * update this component using the gamepad object it is in. Called on every frame
  49293. * @param nativeController the native gamepad controller object
  49294. */
  49295. update(nativeController: IMinimalMotionControllerObject): void;
  49296. }
  49297. }
  49298. declare module "babylonjs/Loading/sceneLoader" {
  49299. import { Observable } from "babylonjs/Misc/observable";
  49300. import { Nullable } from "babylonjs/types";
  49301. import { Scene } from "babylonjs/scene";
  49302. import { Engine } from "babylonjs/Engines/engine";
  49303. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49304. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49305. import { AssetContainer } from "babylonjs/assetContainer";
  49306. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49307. import { Skeleton } from "babylonjs/Bones/skeleton";
  49308. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49309. import { WebRequest } from "babylonjs/Misc/webRequest";
  49310. /**
  49311. * Interface used to represent data loading progression
  49312. */
  49313. export interface ISceneLoaderProgressEvent {
  49314. /**
  49315. * Defines if data length to load can be evaluated
  49316. */
  49317. readonly lengthComputable: boolean;
  49318. /**
  49319. * Defines the loaded data length
  49320. */
  49321. readonly loaded: number;
  49322. /**
  49323. * Defines the data length to load
  49324. */
  49325. readonly total: number;
  49326. }
  49327. /**
  49328. * Interface used by SceneLoader plugins to define supported file extensions
  49329. */
  49330. export interface ISceneLoaderPluginExtensions {
  49331. /**
  49332. * Defines the list of supported extensions
  49333. */
  49334. [extension: string]: {
  49335. isBinary: boolean;
  49336. };
  49337. }
  49338. /**
  49339. * Interface used by SceneLoader plugin factory
  49340. */
  49341. export interface ISceneLoaderPluginFactory {
  49342. /**
  49343. * Defines the name of the factory
  49344. */
  49345. name: string;
  49346. /**
  49347. * Function called to create a new plugin
  49348. * @return the new plugin
  49349. */
  49350. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49351. /**
  49352. * The callback that returns true if the data can be directly loaded.
  49353. * @param data string containing the file data
  49354. * @returns if the data can be loaded directly
  49355. */
  49356. canDirectLoad?(data: string): boolean;
  49357. }
  49358. /**
  49359. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49360. */
  49361. export interface ISceneLoaderPluginBase {
  49362. /**
  49363. * The friendly name of this plugin.
  49364. */
  49365. name: string;
  49366. /**
  49367. * The file extensions supported by this plugin.
  49368. */
  49369. extensions: string | ISceneLoaderPluginExtensions;
  49370. /**
  49371. * The callback called when loading from a url.
  49372. * @param scene scene loading this url
  49373. * @param url url to load
  49374. * @param onSuccess callback called when the file successfully loads
  49375. * @param onProgress callback called while file is loading (if the server supports this mode)
  49376. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49377. * @param onError callback called when the file fails to load
  49378. * @returns a file request object
  49379. */
  49380. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49381. /**
  49382. * The callback called when loading from a file object.
  49383. * @param scene scene loading this file
  49384. * @param file defines the file to load
  49385. * @param onSuccess defines the callback to call when data is loaded
  49386. * @param onProgress defines the callback to call during loading process
  49387. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49388. * @param onError defines the callback to call when an error occurs
  49389. * @returns a file request object
  49390. */
  49391. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49392. /**
  49393. * The callback that returns true if the data can be directly loaded.
  49394. * @param data string containing the file data
  49395. * @returns if the data can be loaded directly
  49396. */
  49397. canDirectLoad?(data: string): boolean;
  49398. /**
  49399. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49400. * @param scene scene loading this data
  49401. * @param data string containing the data
  49402. * @returns data to pass to the plugin
  49403. */
  49404. directLoad?(scene: Scene, data: string): any;
  49405. /**
  49406. * The callback that allows custom handling of the root url based on the response url.
  49407. * @param rootUrl the original root url
  49408. * @param responseURL the response url if available
  49409. * @returns the new root url
  49410. */
  49411. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49412. }
  49413. /**
  49414. * Interface used to define a SceneLoader plugin
  49415. */
  49416. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49417. /**
  49418. * Import meshes into a scene.
  49419. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49420. * @param scene The scene to import into
  49421. * @param data The data to import
  49422. * @param rootUrl The root url for scene and resources
  49423. * @param meshes The meshes array to import into
  49424. * @param particleSystems The particle systems array to import into
  49425. * @param skeletons The skeletons array to import into
  49426. * @param onError The callback when import fails
  49427. * @returns True if successful or false otherwise
  49428. */
  49429. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49430. /**
  49431. * Load into a scene.
  49432. * @param scene The scene to load into
  49433. * @param data The data to import
  49434. * @param rootUrl The root url for scene and resources
  49435. * @param onError The callback when import fails
  49436. * @returns True if successful or false otherwise
  49437. */
  49438. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49439. /**
  49440. * Load into an asset container.
  49441. * @param scene The scene to load into
  49442. * @param data The data to import
  49443. * @param rootUrl The root url for scene and resources
  49444. * @param onError The callback when import fails
  49445. * @returns The loaded asset container
  49446. */
  49447. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49448. }
  49449. /**
  49450. * Interface used to define an async SceneLoader plugin
  49451. */
  49452. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49453. /**
  49454. * Import meshes into a scene.
  49455. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49456. * @param scene The scene to import into
  49457. * @param data The data to import
  49458. * @param rootUrl The root url for scene and resources
  49459. * @param onProgress The callback when the load progresses
  49460. * @param fileName Defines the name of the file to load
  49461. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49462. */
  49463. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49464. meshes: AbstractMesh[];
  49465. particleSystems: IParticleSystem[];
  49466. skeletons: Skeleton[];
  49467. animationGroups: AnimationGroup[];
  49468. }>;
  49469. /**
  49470. * Load into a scene.
  49471. * @param scene The scene to load into
  49472. * @param data The data to import
  49473. * @param rootUrl The root url for scene and resources
  49474. * @param onProgress The callback when the load progresses
  49475. * @param fileName Defines the name of the file to load
  49476. * @returns Nothing
  49477. */
  49478. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49479. /**
  49480. * Load into an asset container.
  49481. * @param scene The scene to load into
  49482. * @param data The data to import
  49483. * @param rootUrl The root url for scene and resources
  49484. * @param onProgress The callback when the load progresses
  49485. * @param fileName Defines the name of the file to load
  49486. * @returns The loaded asset container
  49487. */
  49488. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49489. }
  49490. /**
  49491. * Mode that determines how to handle old animation groups before loading new ones.
  49492. */
  49493. export enum SceneLoaderAnimationGroupLoadingMode {
  49494. /**
  49495. * Reset all old animations to initial state then dispose them.
  49496. */
  49497. Clean = 0,
  49498. /**
  49499. * Stop all old animations.
  49500. */
  49501. Stop = 1,
  49502. /**
  49503. * Restart old animations from first frame.
  49504. */
  49505. Sync = 2,
  49506. /**
  49507. * Old animations remains untouched.
  49508. */
  49509. NoSync = 3
  49510. }
  49511. /**
  49512. * Defines a plugin registered by the SceneLoader
  49513. */
  49514. interface IRegisteredPlugin {
  49515. /**
  49516. * Defines the plugin to use
  49517. */
  49518. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49519. /**
  49520. * Defines if the plugin supports binary data
  49521. */
  49522. isBinary: boolean;
  49523. }
  49524. /**
  49525. * Class used to load scene from various file formats using registered plugins
  49526. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49527. */
  49528. export class SceneLoader {
  49529. /**
  49530. * No logging while loading
  49531. */
  49532. static readonly NO_LOGGING: number;
  49533. /**
  49534. * Minimal logging while loading
  49535. */
  49536. static readonly MINIMAL_LOGGING: number;
  49537. /**
  49538. * Summary logging while loading
  49539. */
  49540. static readonly SUMMARY_LOGGING: number;
  49541. /**
  49542. * Detailled logging while loading
  49543. */
  49544. static readonly DETAILED_LOGGING: number;
  49545. /**
  49546. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49547. */
  49548. static get ForceFullSceneLoadingForIncremental(): boolean;
  49549. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49550. /**
  49551. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49552. */
  49553. static get ShowLoadingScreen(): boolean;
  49554. static set ShowLoadingScreen(value: boolean);
  49555. /**
  49556. * Defines the current logging level (while loading the scene)
  49557. * @ignorenaming
  49558. */
  49559. static get loggingLevel(): number;
  49560. static set loggingLevel(value: number);
  49561. /**
  49562. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49563. */
  49564. static get CleanBoneMatrixWeights(): boolean;
  49565. static set CleanBoneMatrixWeights(value: boolean);
  49566. /**
  49567. * Event raised when a plugin is used to load a scene
  49568. */
  49569. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49570. private static _registeredPlugins;
  49571. private static _showingLoadingScreen;
  49572. /**
  49573. * Gets the default plugin (used to load Babylon files)
  49574. * @returns the .babylon plugin
  49575. */
  49576. static GetDefaultPlugin(): IRegisteredPlugin;
  49577. private static _GetPluginForExtension;
  49578. private static _GetPluginForDirectLoad;
  49579. private static _GetPluginForFilename;
  49580. private static _GetDirectLoad;
  49581. private static _LoadData;
  49582. private static _GetFileInfo;
  49583. /**
  49584. * Gets a plugin that can load the given extension
  49585. * @param extension defines the extension to load
  49586. * @returns a plugin or null if none works
  49587. */
  49588. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49589. /**
  49590. * Gets a boolean indicating that the given extension can be loaded
  49591. * @param extension defines the extension to load
  49592. * @returns true if the extension is supported
  49593. */
  49594. static IsPluginForExtensionAvailable(extension: string): boolean;
  49595. /**
  49596. * Adds a new plugin to the list of registered plugins
  49597. * @param plugin defines the plugin to add
  49598. */
  49599. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49600. /**
  49601. * Import meshes into a scene
  49602. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49603. * @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)
  49604. * @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)
  49605. * @param scene the instance of BABYLON.Scene to append to
  49606. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49607. * @param onProgress a callback with a progress event for each file being loaded
  49608. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49609. * @param pluginExtension the extension used to determine the plugin
  49610. * @returns The loaded plugin
  49611. */
  49612. 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>;
  49613. /**
  49614. * Import meshes into a scene
  49615. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49616. * @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)
  49617. * @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)
  49618. * @param scene the instance of BABYLON.Scene to append to
  49619. * @param onProgress a callback with a progress event for each file being loaded
  49620. * @param pluginExtension the extension used to determine the plugin
  49621. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49622. */
  49623. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49624. meshes: AbstractMesh[];
  49625. particleSystems: IParticleSystem[];
  49626. skeletons: Skeleton[];
  49627. animationGroups: AnimationGroup[];
  49628. }>;
  49629. /**
  49630. * Load a scene
  49631. * @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)
  49632. * @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)
  49633. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49634. * @param onSuccess a callback with the scene when import succeeds
  49635. * @param onProgress a callback with a progress event for each file being loaded
  49636. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49637. * @param pluginExtension the extension used to determine the plugin
  49638. * @returns The loaded plugin
  49639. */
  49640. 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>;
  49641. /**
  49642. * Load a scene
  49643. * @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)
  49644. * @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)
  49645. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49646. * @param onProgress a callback with a progress event for each file being loaded
  49647. * @param pluginExtension the extension used to determine the plugin
  49648. * @returns The loaded scene
  49649. */
  49650. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49651. /**
  49652. * Append a scene
  49653. * @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)
  49654. * @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)
  49655. * @param scene is the instance of BABYLON.Scene to append to
  49656. * @param onSuccess a callback with the scene when import succeeds
  49657. * @param onProgress a callback with a progress event for each file being loaded
  49658. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49659. * @param pluginExtension the extension used to determine the plugin
  49660. * @returns The loaded plugin
  49661. */
  49662. 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>;
  49663. /**
  49664. * Append a scene
  49665. * @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)
  49666. * @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)
  49667. * @param scene is the instance of BABYLON.Scene to append to
  49668. * @param onProgress a callback with a progress event for each file being loaded
  49669. * @param pluginExtension the extension used to determine the plugin
  49670. * @returns The given scene
  49671. */
  49672. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49673. /**
  49674. * Load a scene into an asset container
  49675. * @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)
  49676. * @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)
  49677. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49678. * @param onSuccess a callback with the scene when import succeeds
  49679. * @param onProgress a callback with a progress event for each file being loaded
  49680. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49681. * @param pluginExtension the extension used to determine the plugin
  49682. * @returns The loaded plugin
  49683. */
  49684. 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>;
  49685. /**
  49686. * Load a scene into an asset container
  49687. * @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)
  49688. * @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)
  49689. * @param scene is the instance of Scene to append to
  49690. * @param onProgress a callback with a progress event for each file being loaded
  49691. * @param pluginExtension the extension used to determine the plugin
  49692. * @returns The loaded asset container
  49693. */
  49694. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49695. /**
  49696. * Import animations from a file into a scene
  49697. * @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)
  49698. * @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)
  49699. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49700. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49701. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49702. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49703. * @param onSuccess a callback with the scene when import succeeds
  49704. * @param onProgress a callback with a progress event for each file being loaded
  49705. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49706. * @param pluginExtension the extension used to determine the plugin
  49707. */
  49708. 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;
  49709. /**
  49710. * Import animations from a file into a scene
  49711. * @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)
  49712. * @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)
  49713. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49714. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49715. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49716. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49717. * @param onSuccess a callback with the scene when import succeeds
  49718. * @param onProgress a callback with a progress event for each file being loaded
  49719. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49720. * @param pluginExtension the extension used to determine the plugin
  49721. * @returns the updated scene with imported animations
  49722. */
  49723. 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>;
  49724. }
  49725. }
  49726. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49727. import { IDisposable, Scene } from "babylonjs/scene";
  49728. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49729. import { Observable } from "babylonjs/Misc/observable";
  49730. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49731. import { Nullable } from "babylonjs/types";
  49732. /**
  49733. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49734. */
  49735. export type MotionControllerHandedness = "none" | "left" | "right";
  49736. /**
  49737. * The type of components available in motion controllers.
  49738. * This is not the name of the component.
  49739. */
  49740. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49741. /**
  49742. * The state of a controller component
  49743. */
  49744. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49745. /**
  49746. * The schema of motion controller layout.
  49747. * No object will be initialized using this interface
  49748. * This is used just to define the profile.
  49749. */
  49750. export interface IMotionControllerLayout {
  49751. /**
  49752. * Path to load the assets. Usually relative to the base path
  49753. */
  49754. assetPath: string;
  49755. /**
  49756. * Available components (unsorted)
  49757. */
  49758. components: {
  49759. /**
  49760. * A map of component Ids
  49761. */
  49762. [componentId: string]: {
  49763. /**
  49764. * The type of input the component outputs
  49765. */
  49766. type: MotionControllerComponentType;
  49767. /**
  49768. * The indices of this component in the gamepad object
  49769. */
  49770. gamepadIndices: {
  49771. /**
  49772. * Index of button
  49773. */
  49774. button?: number;
  49775. /**
  49776. * If available, index of x-axis
  49777. */
  49778. xAxis?: number;
  49779. /**
  49780. * If available, index of y-axis
  49781. */
  49782. yAxis?: number;
  49783. };
  49784. /**
  49785. * The mesh's root node name
  49786. */
  49787. rootNodeName: string;
  49788. /**
  49789. * Animation definitions for this model
  49790. */
  49791. visualResponses: {
  49792. [stateKey: string]: {
  49793. /**
  49794. * What property will be animated
  49795. */
  49796. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49797. /**
  49798. * What states influence this visual response
  49799. */
  49800. states: MotionControllerComponentStateType[];
  49801. /**
  49802. * Type of animation - movement or visibility
  49803. */
  49804. valueNodeProperty: "transform" | "visibility";
  49805. /**
  49806. * Base node name to move. Its position will be calculated according to the min and max nodes
  49807. */
  49808. valueNodeName?: string;
  49809. /**
  49810. * Minimum movement node
  49811. */
  49812. minNodeName?: string;
  49813. /**
  49814. * Max movement node
  49815. */
  49816. maxNodeName?: string;
  49817. };
  49818. };
  49819. /**
  49820. * If touch enabled, what is the name of node to display user feedback
  49821. */
  49822. touchPointNodeName?: string;
  49823. };
  49824. };
  49825. /**
  49826. * Is it xr standard mapping or not
  49827. */
  49828. gamepadMapping: "" | "xr-standard";
  49829. /**
  49830. * Base root node of this entire model
  49831. */
  49832. rootNodeName: string;
  49833. /**
  49834. * Defines the main button component id
  49835. */
  49836. selectComponentId: string;
  49837. }
  49838. /**
  49839. * A definition for the layout map in the input profile
  49840. */
  49841. export interface IMotionControllerLayoutMap {
  49842. /**
  49843. * Layouts with handedness type as a key
  49844. */
  49845. [handedness: string]: IMotionControllerLayout;
  49846. }
  49847. /**
  49848. * The XR Input profile schema
  49849. * Profiles can be found here:
  49850. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49851. */
  49852. export interface IMotionControllerProfile {
  49853. /**
  49854. * fallback profiles for this profileId
  49855. */
  49856. fallbackProfileIds: string[];
  49857. /**
  49858. * The layout map, with handedness as key
  49859. */
  49860. layouts: IMotionControllerLayoutMap;
  49861. /**
  49862. * The id of this profile
  49863. * correlates to the profile(s) in the xrInput.profiles array
  49864. */
  49865. profileId: string;
  49866. }
  49867. /**
  49868. * A helper-interface for the 3 meshes needed for controller button animation
  49869. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49870. */
  49871. export interface IMotionControllerButtonMeshMap {
  49872. /**
  49873. * the mesh that defines the pressed value mesh position.
  49874. * This is used to find the max-position of this button
  49875. */
  49876. pressedMesh: AbstractMesh;
  49877. /**
  49878. * the mesh that defines the unpressed value mesh position.
  49879. * This is used to find the min (or initial) position of this button
  49880. */
  49881. unpressedMesh: AbstractMesh;
  49882. /**
  49883. * The mesh that will be changed when value changes
  49884. */
  49885. valueMesh: AbstractMesh;
  49886. }
  49887. /**
  49888. * A helper-interface for the 3 meshes needed for controller axis animation.
  49889. * This will be expanded when touchpad animations are fully supported
  49890. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49891. */
  49892. export interface IMotionControllerMeshMap {
  49893. /**
  49894. * the mesh that defines the maximum value mesh position.
  49895. */
  49896. maxMesh?: AbstractMesh;
  49897. /**
  49898. * the mesh that defines the minimum value mesh position.
  49899. */
  49900. minMesh?: AbstractMesh;
  49901. /**
  49902. * The mesh that will be changed when axis value changes
  49903. */
  49904. valueMesh?: AbstractMesh;
  49905. }
  49906. /**
  49907. * The elements needed for change-detection of the gamepad objects in motion controllers
  49908. */
  49909. export interface IMinimalMotionControllerObject {
  49910. /**
  49911. * Available axes of this controller
  49912. */
  49913. axes: number[];
  49914. /**
  49915. * An array of available buttons
  49916. */
  49917. buttons: Array<{
  49918. /**
  49919. * Value of the button/trigger
  49920. */
  49921. value: number;
  49922. /**
  49923. * If the button/trigger is currently touched
  49924. */
  49925. touched: boolean;
  49926. /**
  49927. * If the button/trigger is currently pressed
  49928. */
  49929. pressed: boolean;
  49930. }>;
  49931. /**
  49932. * EXPERIMENTAL haptic support.
  49933. */
  49934. hapticActuators?: Array<{
  49935. pulse: (value: number, duration: number) => Promise<boolean>;
  49936. }>;
  49937. }
  49938. /**
  49939. * An Abstract Motion controller
  49940. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49941. * Each component has an observable to check for changes in value and state
  49942. */
  49943. export abstract class WebXRAbstractMotionController implements IDisposable {
  49944. protected scene: Scene;
  49945. protected layout: IMotionControllerLayout;
  49946. /**
  49947. * The gamepad object correlating to this controller
  49948. */
  49949. gamepadObject: IMinimalMotionControllerObject;
  49950. /**
  49951. * handedness (left/right/none) of this controller
  49952. */
  49953. handedness: MotionControllerHandedness;
  49954. private _initComponent;
  49955. private _modelReady;
  49956. /**
  49957. * A map of components (WebXRControllerComponent) in this motion controller
  49958. * Components have a ComponentType and can also have both button and axis definitions
  49959. */
  49960. readonly components: {
  49961. [id: string]: WebXRControllerComponent;
  49962. };
  49963. /**
  49964. * Disable the model's animation. Can be set at any time.
  49965. */
  49966. disableAnimation: boolean;
  49967. /**
  49968. * Observers registered here will be triggered when the model of this controller is done loading
  49969. */
  49970. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49971. /**
  49972. * The profile id of this motion controller
  49973. */
  49974. abstract profileId: string;
  49975. /**
  49976. * The root mesh of the model. It is null if the model was not yet initialized
  49977. */
  49978. rootMesh: Nullable<AbstractMesh>;
  49979. /**
  49980. * constructs a new abstract motion controller
  49981. * @param scene the scene to which the model of the controller will be added
  49982. * @param layout The profile layout to load
  49983. * @param gamepadObject The gamepad object correlating to this controller
  49984. * @param handedness handedness (left/right/none) of this controller
  49985. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49986. */
  49987. constructor(scene: Scene, layout: IMotionControllerLayout,
  49988. /**
  49989. * The gamepad object correlating to this controller
  49990. */
  49991. gamepadObject: IMinimalMotionControllerObject,
  49992. /**
  49993. * handedness (left/right/none) of this controller
  49994. */
  49995. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  49996. /**
  49997. * Dispose this controller, the model mesh and all its components
  49998. */
  49999. dispose(): void;
  50000. /**
  50001. * Returns all components of specific type
  50002. * @param type the type to search for
  50003. * @return an array of components with this type
  50004. */
  50005. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  50006. /**
  50007. * get a component based an its component id as defined in layout.components
  50008. * @param id the id of the component
  50009. * @returns the component correlates to the id or undefined if not found
  50010. */
  50011. getComponent(id: string): WebXRControllerComponent;
  50012. /**
  50013. * Get the list of components available in this motion controller
  50014. * @returns an array of strings correlating to available components
  50015. */
  50016. getComponentIds(): string[];
  50017. /**
  50018. * Get the first component of specific type
  50019. * @param type type of component to find
  50020. * @return a controller component or null if not found
  50021. */
  50022. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  50023. /**
  50024. * Get the main (Select) component of this controller as defined in the layout
  50025. * @returns the main component of this controller
  50026. */
  50027. getMainComponent(): WebXRControllerComponent;
  50028. /**
  50029. * Loads the model correlating to this controller
  50030. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  50031. * @returns A promise fulfilled with the result of the model loading
  50032. */
  50033. loadModel(): Promise<boolean>;
  50034. /**
  50035. * Update this model using the current XRFrame
  50036. * @param xrFrame the current xr frame to use and update the model
  50037. */
  50038. updateFromXRFrame(xrFrame: XRFrame): void;
  50039. /**
  50040. * Backwards compatibility due to a deeply-integrated typo
  50041. */
  50042. get handness(): XREye;
  50043. /**
  50044. * Pulse (vibrate) this controller
  50045. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50046. * Consecutive calls to this function will cancel the last pulse call
  50047. *
  50048. * @param value the strength of the pulse in 0.0...1.0 range
  50049. * @param duration Duration of the pulse in milliseconds
  50050. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50051. * @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
  50052. */
  50053. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50054. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50055. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50056. /**
  50057. * Moves the axis on the controller mesh based on its current state
  50058. * @param axis the index of the axis
  50059. * @param axisValue the value of the axis which determines the meshes new position
  50060. * @hidden
  50061. */
  50062. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50063. /**
  50064. * Update the model itself with the current frame data
  50065. * @param xrFrame the frame to use for updating the model mesh
  50066. */
  50067. protected updateModel(xrFrame: XRFrame): void;
  50068. /**
  50069. * Get the filename and path for this controller's model
  50070. * @returns a map of filename and path
  50071. */
  50072. protected abstract _getFilenameAndPath(): {
  50073. filename: string;
  50074. path: string;
  50075. };
  50076. /**
  50077. * This function is called before the mesh is loaded. It checks for loading constraints.
  50078. * For example, this function can check if the GLB loader is available
  50079. * If this function returns false, the generic controller will be loaded instead
  50080. * @returns Is the client ready to load the mesh
  50081. */
  50082. protected abstract _getModelLoadingConstraints(): boolean;
  50083. /**
  50084. * This function will be called after the model was successfully loaded and can be used
  50085. * for mesh transformations before it is available for the user
  50086. * @param meshes the loaded meshes
  50087. */
  50088. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50089. /**
  50090. * Set the root mesh for this controller. Important for the WebXR controller class
  50091. * @param meshes the loaded meshes
  50092. */
  50093. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50094. /**
  50095. * A function executed each frame that updates the mesh (if needed)
  50096. * @param xrFrame the current xrFrame
  50097. */
  50098. protected abstract _updateModel(xrFrame: XRFrame): void;
  50099. private _getGenericFilenameAndPath;
  50100. private _getGenericParentMesh;
  50101. }
  50102. }
  50103. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50104. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50105. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50106. import { Scene } from "babylonjs/scene";
  50107. /**
  50108. * A generic trigger-only motion controller for WebXR
  50109. */
  50110. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50111. /**
  50112. * Static version of the profile id of this controller
  50113. */
  50114. static ProfileId: string;
  50115. profileId: string;
  50116. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50117. protected _getFilenameAndPath(): {
  50118. filename: string;
  50119. path: string;
  50120. };
  50121. protected _getModelLoadingConstraints(): boolean;
  50122. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50123. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50124. protected _updateModel(): void;
  50125. }
  50126. }
  50127. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50128. import { Vector4 } from "babylonjs/Maths/math.vector";
  50129. import { Mesh } from "babylonjs/Meshes/mesh";
  50130. import { Scene } from "babylonjs/scene";
  50131. import { Nullable } from "babylonjs/types";
  50132. /**
  50133. * Class containing static functions to help procedurally build meshes
  50134. */
  50135. export class SphereBuilder {
  50136. /**
  50137. * Creates a sphere mesh
  50138. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50139. * * 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`)
  50140. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50141. * * 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
  50142. * * 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)
  50143. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50144. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  50145. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50146. * @param name defines the name of the mesh
  50147. * @param options defines the options used to create the mesh
  50148. * @param scene defines the hosting scene
  50149. * @returns the sphere mesh
  50150. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50151. */
  50152. static CreateSphere(name: string, options: {
  50153. segments?: number;
  50154. diameter?: number;
  50155. diameterX?: number;
  50156. diameterY?: number;
  50157. diameterZ?: number;
  50158. arc?: number;
  50159. slice?: number;
  50160. sideOrientation?: number;
  50161. frontUVs?: Vector4;
  50162. backUVs?: Vector4;
  50163. updatable?: boolean;
  50164. }, scene?: Nullable<Scene>): Mesh;
  50165. }
  50166. }
  50167. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50168. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50169. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50170. import { Scene } from "babylonjs/scene";
  50171. /**
  50172. * A profiled motion controller has its profile loaded from an online repository.
  50173. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50174. */
  50175. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50176. private _repositoryUrl;
  50177. private _buttonMeshMapping;
  50178. private _touchDots;
  50179. /**
  50180. * The profile ID of this controller. Will be populated when the controller initializes.
  50181. */
  50182. profileId: string;
  50183. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50184. dispose(): void;
  50185. protected _getFilenameAndPath(): {
  50186. filename: string;
  50187. path: string;
  50188. };
  50189. protected _getModelLoadingConstraints(): boolean;
  50190. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50191. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50192. protected _updateModel(_xrFrame: XRFrame): void;
  50193. }
  50194. }
  50195. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50196. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50197. import { Scene } from "babylonjs/scene";
  50198. /**
  50199. * A construction function type to create a new controller based on an xrInput object
  50200. */
  50201. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50202. /**
  50203. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50204. *
  50205. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50206. * it should be replaced with auto-loaded controllers.
  50207. *
  50208. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50209. */
  50210. export class WebXRMotionControllerManager {
  50211. private static _AvailableControllers;
  50212. private static _Fallbacks;
  50213. private static _ProfileLoadingPromises;
  50214. private static _ProfilesList;
  50215. /**
  50216. * The base URL of the online controller repository. Can be changed at any time.
  50217. */
  50218. static BaseRepositoryUrl: string;
  50219. /**
  50220. * Which repository gets priority - local or online
  50221. */
  50222. static PrioritizeOnlineRepository: boolean;
  50223. /**
  50224. * Use the online repository, or use only locally-defined controllers
  50225. */
  50226. static UseOnlineRepository: boolean;
  50227. /**
  50228. * Clear the cache used for profile loading and reload when requested again
  50229. */
  50230. static ClearProfilesCache(): void;
  50231. /**
  50232. * Register the default fallbacks.
  50233. * This function is called automatically when this file is imported.
  50234. */
  50235. static DefaultFallbacks(): void;
  50236. /**
  50237. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50238. * @param profileId the profile to which a fallback needs to be found
  50239. * @return an array with corresponding fallback profiles
  50240. */
  50241. static FindFallbackWithProfileId(profileId: string): string[];
  50242. /**
  50243. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50244. * The order of search:
  50245. *
  50246. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50247. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50248. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50249. * 4) return the generic trigger controller if none were found
  50250. *
  50251. * @param xrInput the xrInput to which a new controller is initialized
  50252. * @param scene the scene to which the model will be added
  50253. * @param forceProfile force a certain profile for this controller
  50254. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50255. */
  50256. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50257. /**
  50258. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50259. *
  50260. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50261. *
  50262. * @param type the profile type to register
  50263. * @param constructFunction the function to be called when loading this profile
  50264. */
  50265. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50266. /**
  50267. * Register a fallback to a specific profile.
  50268. * @param profileId the profileId that will receive the fallbacks
  50269. * @param fallbacks A list of fallback profiles
  50270. */
  50271. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50272. /**
  50273. * Will update the list of profiles available in the repository
  50274. * @return a promise that resolves to a map of profiles available online
  50275. */
  50276. static UpdateProfilesList(): Promise<{
  50277. [profile: string]: string;
  50278. }>;
  50279. private static _LoadProfileFromRepository;
  50280. private static _LoadProfilesFromAvailableControllers;
  50281. }
  50282. }
  50283. declare module "babylonjs/XR/webXRInputSource" {
  50284. import { Observable } from "babylonjs/Misc/observable";
  50285. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50286. import { Ray } from "babylonjs/Culling/ray";
  50287. import { Scene } from "babylonjs/scene";
  50288. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50289. /**
  50290. * Configuration options for the WebXR controller creation
  50291. */
  50292. export interface IWebXRControllerOptions {
  50293. /**
  50294. * Should the controller mesh be animated when a user interacts with it
  50295. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50296. */
  50297. disableMotionControllerAnimation?: boolean;
  50298. /**
  50299. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50300. */
  50301. doNotLoadControllerMesh?: boolean;
  50302. /**
  50303. * Force a specific controller type for this controller.
  50304. * This can be used when creating your own profile or when testing different controllers
  50305. */
  50306. forceControllerProfile?: string;
  50307. /**
  50308. * Defines a rendering group ID for meshes that will be loaded.
  50309. * This is for the default controllers only.
  50310. */
  50311. renderingGroupId?: number;
  50312. }
  50313. /**
  50314. * Represents an XR controller
  50315. */
  50316. export class WebXRInputSource {
  50317. private _scene;
  50318. /** The underlying input source for the controller */
  50319. inputSource: XRInputSource;
  50320. private _options;
  50321. private _tmpVector;
  50322. private _uniqueId;
  50323. private _disposed;
  50324. /**
  50325. * 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
  50326. */
  50327. grip?: AbstractMesh;
  50328. /**
  50329. * If available, this is the gamepad object related to this controller.
  50330. * Using this object it is possible to get click events and trackpad changes of the
  50331. * webxr controller that is currently being used.
  50332. */
  50333. motionController?: WebXRAbstractMotionController;
  50334. /**
  50335. * Event that fires when the controller is removed/disposed.
  50336. * The object provided as event data is this controller, after associated assets were disposed.
  50337. * uniqueId is still available.
  50338. */
  50339. onDisposeObservable: Observable<WebXRInputSource>;
  50340. /**
  50341. * Will be triggered when the mesh associated with the motion controller is done loading.
  50342. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50343. * A shortened version of controller -> motion controller -> on mesh loaded.
  50344. */
  50345. onMeshLoadedObservable: Observable<AbstractMesh>;
  50346. /**
  50347. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50348. */
  50349. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50350. /**
  50351. * Pointer which can be used to select objects or attach a visible laser to
  50352. */
  50353. pointer: AbstractMesh;
  50354. /**
  50355. * Creates the input source object
  50356. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50357. * @param _scene the scene which the controller should be associated to
  50358. * @param inputSource the underlying input source for the controller
  50359. * @param _options options for this controller creation
  50360. */
  50361. constructor(_scene: Scene,
  50362. /** The underlying input source for the controller */
  50363. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50364. /**
  50365. * Get this controllers unique id
  50366. */
  50367. get uniqueId(): string;
  50368. /**
  50369. * Disposes of the object
  50370. */
  50371. dispose(): void;
  50372. /**
  50373. * Gets a world space ray coming from the pointer or grip
  50374. * @param result the resulting ray
  50375. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50376. */
  50377. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50378. /**
  50379. * Updates the controller pose based on the given XRFrame
  50380. * @param xrFrame xr frame to update the pose with
  50381. * @param referenceSpace reference space to use
  50382. */
  50383. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50384. }
  50385. }
  50386. declare module "babylonjs/XR/webXRInput" {
  50387. import { Observable } from "babylonjs/Misc/observable";
  50388. import { IDisposable } from "babylonjs/scene";
  50389. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50390. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50391. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50392. /**
  50393. * The schema for initialization options of the XR Input class
  50394. */
  50395. export interface IWebXRInputOptions {
  50396. /**
  50397. * If set to true no model will be automatically loaded
  50398. */
  50399. doNotLoadControllerMeshes?: boolean;
  50400. /**
  50401. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50402. * If not found, the xr input profile data will be used.
  50403. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50404. */
  50405. forceInputProfile?: string;
  50406. /**
  50407. * Do not send a request to the controller repository to load the profile.
  50408. *
  50409. * Instead, use the controllers available in babylon itself.
  50410. */
  50411. disableOnlineControllerRepository?: boolean;
  50412. /**
  50413. * A custom URL for the controllers repository
  50414. */
  50415. customControllersRepositoryURL?: string;
  50416. /**
  50417. * Should the controller model's components not move according to the user input
  50418. */
  50419. disableControllerAnimation?: boolean;
  50420. /**
  50421. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50422. */
  50423. controllerOptions?: IWebXRControllerOptions;
  50424. }
  50425. /**
  50426. * XR input used to track XR inputs such as controllers/rays
  50427. */
  50428. export class WebXRInput implements IDisposable {
  50429. /**
  50430. * the xr session manager for this session
  50431. */
  50432. xrSessionManager: WebXRSessionManager;
  50433. /**
  50434. * the WebXR camera for this session. Mainly used for teleportation
  50435. */
  50436. xrCamera: WebXRCamera;
  50437. private readonly options;
  50438. /**
  50439. * XR controllers being tracked
  50440. */
  50441. controllers: Array<WebXRInputSource>;
  50442. private _frameObserver;
  50443. private _sessionEndedObserver;
  50444. private _sessionInitObserver;
  50445. /**
  50446. * Event when a controller has been connected/added
  50447. */
  50448. onControllerAddedObservable: Observable<WebXRInputSource>;
  50449. /**
  50450. * Event when a controller has been removed/disconnected
  50451. */
  50452. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50453. /**
  50454. * Initializes the WebXRInput
  50455. * @param xrSessionManager the xr session manager for this session
  50456. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50457. * @param options = initialization options for this xr input
  50458. */
  50459. constructor(
  50460. /**
  50461. * the xr session manager for this session
  50462. */
  50463. xrSessionManager: WebXRSessionManager,
  50464. /**
  50465. * the WebXR camera for this session. Mainly used for teleportation
  50466. */
  50467. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50468. private _onInputSourcesChange;
  50469. private _addAndRemoveControllers;
  50470. /**
  50471. * Disposes of the object
  50472. */
  50473. dispose(): void;
  50474. }
  50475. }
  50476. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50477. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50478. import { Observable, EventState } from "babylonjs/Misc/observable";
  50479. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50480. /**
  50481. * This is the base class for all WebXR features.
  50482. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50483. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50484. */
  50485. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50486. protected _xrSessionManager: WebXRSessionManager;
  50487. private _attached;
  50488. private _removeOnDetach;
  50489. /**
  50490. * Should auto-attach be disabled?
  50491. */
  50492. disableAutoAttach: boolean;
  50493. /**
  50494. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50495. */
  50496. xrNativeFeatureName: string;
  50497. /**
  50498. * Construct a new (abstract) WebXR feature
  50499. * @param _xrSessionManager the xr session manager for this feature
  50500. */
  50501. constructor(_xrSessionManager: WebXRSessionManager);
  50502. /**
  50503. * Is this feature attached
  50504. */
  50505. get attached(): boolean;
  50506. /**
  50507. * attach this feature
  50508. *
  50509. * @param force should attachment be forced (even when already attached)
  50510. * @returns true if successful, false is failed or already attached
  50511. */
  50512. attach(force?: boolean): boolean;
  50513. /**
  50514. * detach this feature.
  50515. *
  50516. * @returns true if successful, false if failed or already detached
  50517. */
  50518. detach(): boolean;
  50519. /**
  50520. * Dispose this feature and all of the resources attached
  50521. */
  50522. dispose(): void;
  50523. /**
  50524. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50525. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50526. *
  50527. * @returns whether or not the feature is compatible in this environment
  50528. */
  50529. isCompatible(): boolean;
  50530. /**
  50531. * This is used to register callbacks that will automatically be removed when detach is called.
  50532. * @param observable the observable to which the observer will be attached
  50533. * @param callback the callback to register
  50534. */
  50535. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50536. /**
  50537. * Code in this function will be executed on each xrFrame received from the browser.
  50538. * This function will not execute after the feature is detached.
  50539. * @param _xrFrame the current frame
  50540. */
  50541. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50542. }
  50543. }
  50544. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50545. import { IDisposable, Scene } from "babylonjs/scene";
  50546. import { Nullable } from "babylonjs/types";
  50547. import { Observable } from "babylonjs/Misc/observable";
  50548. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50549. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50550. import { Camera } from "babylonjs/Cameras/camera";
  50551. /**
  50552. * Renders a layer on top of an existing scene
  50553. */
  50554. export class UtilityLayerRenderer implements IDisposable {
  50555. /** the original scene that will be rendered on top of */
  50556. originalScene: Scene;
  50557. private _pointerCaptures;
  50558. private _lastPointerEvents;
  50559. private static _DefaultUtilityLayer;
  50560. private static _DefaultKeepDepthUtilityLayer;
  50561. private _sharedGizmoLight;
  50562. private _renderCamera;
  50563. /**
  50564. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50565. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50566. * @returns the camera that is used when rendering the utility layer
  50567. */
  50568. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50569. /**
  50570. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50571. * @param cam the camera that should be used when rendering the utility layer
  50572. */
  50573. setRenderCamera(cam: Nullable<Camera>): void;
  50574. /**
  50575. * @hidden
  50576. * Light which used by gizmos to get light shading
  50577. */
  50578. _getSharedGizmoLight(): HemisphericLight;
  50579. /**
  50580. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50581. */
  50582. pickUtilitySceneFirst: boolean;
  50583. /**
  50584. * 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)
  50585. */
  50586. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50587. /**
  50588. * 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)
  50589. */
  50590. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50591. /**
  50592. * The scene that is rendered on top of the original scene
  50593. */
  50594. utilityLayerScene: Scene;
  50595. /**
  50596. * If the utility layer should automatically be rendered on top of existing scene
  50597. */
  50598. shouldRender: boolean;
  50599. /**
  50600. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50601. */
  50602. onlyCheckPointerDownEvents: boolean;
  50603. /**
  50604. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50605. */
  50606. processAllEvents: boolean;
  50607. /**
  50608. * Observable raised when the pointer move from the utility layer scene to the main scene
  50609. */
  50610. onPointerOutObservable: Observable<number>;
  50611. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50612. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50613. private _afterRenderObserver;
  50614. private _sceneDisposeObserver;
  50615. private _originalPointerObserver;
  50616. /**
  50617. * Instantiates a UtilityLayerRenderer
  50618. * @param originalScene the original scene that will be rendered on top of
  50619. * @param handleEvents boolean indicating if the utility layer should handle events
  50620. */
  50621. constructor(
  50622. /** the original scene that will be rendered on top of */
  50623. originalScene: Scene, handleEvents?: boolean);
  50624. private _notifyObservers;
  50625. /**
  50626. * Renders the utility layers scene on top of the original scene
  50627. */
  50628. render(): void;
  50629. /**
  50630. * Disposes of the renderer
  50631. */
  50632. dispose(): void;
  50633. private _updateCamera;
  50634. }
  50635. }
  50636. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50637. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50638. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50639. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50640. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50641. import { Scene } from "babylonjs/scene";
  50642. import { Nullable } from "babylonjs/types";
  50643. import { Color3 } from "babylonjs/Maths/math.color";
  50644. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50645. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50646. /**
  50647. * Options interface for the pointer selection module
  50648. */
  50649. export interface IWebXRControllerPointerSelectionOptions {
  50650. /**
  50651. * if provided, this scene will be used to render meshes.
  50652. */
  50653. customUtilityLayerScene?: Scene;
  50654. /**
  50655. * 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)
  50656. * If not disabled, the last picked point will be used to execute a pointer up event
  50657. * If disabled, pointer up event will be triggered right after the pointer down event.
  50658. * Used in screen and gaze target ray mode only
  50659. */
  50660. disablePointerUpOnTouchOut: boolean;
  50661. /**
  50662. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50663. */
  50664. forceGazeMode: boolean;
  50665. /**
  50666. * 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
  50667. * to start a new countdown to the pointer down event.
  50668. * Defaults to 1.
  50669. */
  50670. gazeModePointerMovedFactor?: number;
  50671. /**
  50672. * Different button type to use instead of the main component
  50673. */
  50674. overrideButtonId?: string;
  50675. /**
  50676. * use this rendering group id for the meshes (optional)
  50677. */
  50678. renderingGroupId?: number;
  50679. /**
  50680. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50681. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50682. * 3000 means 3 seconds between pointing at something and selecting it
  50683. */
  50684. timeToSelect?: number;
  50685. /**
  50686. * Should meshes created here be added to a utility layer or the main scene
  50687. */
  50688. useUtilityLayer?: boolean;
  50689. /**
  50690. * Optional WebXR camera to be used for gaze selection
  50691. */
  50692. gazeCamera?: WebXRCamera;
  50693. /**
  50694. * the xr input to use with this pointer selection
  50695. */
  50696. xrInput: WebXRInput;
  50697. }
  50698. /**
  50699. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50700. */
  50701. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50702. private readonly _options;
  50703. private static _idCounter;
  50704. private _attachController;
  50705. private _controllers;
  50706. private _scene;
  50707. private _tmpVectorForPickCompare;
  50708. /**
  50709. * The module's name
  50710. */
  50711. static readonly Name: string;
  50712. /**
  50713. * The (Babylon) version of this module.
  50714. * This is an integer representing the implementation version.
  50715. * This number does not correspond to the WebXR specs version
  50716. */
  50717. static readonly Version: number;
  50718. /**
  50719. * Disable lighting on the laser pointer (so it will always be visible)
  50720. */
  50721. disablePointerLighting: boolean;
  50722. /**
  50723. * Disable lighting on the selection mesh (so it will always be visible)
  50724. */
  50725. disableSelectionMeshLighting: boolean;
  50726. /**
  50727. * Should the laser pointer be displayed
  50728. */
  50729. displayLaserPointer: boolean;
  50730. /**
  50731. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50732. */
  50733. displaySelectionMesh: boolean;
  50734. /**
  50735. * This color will be set to the laser pointer when selection is triggered
  50736. */
  50737. laserPointerPickedColor: Color3;
  50738. /**
  50739. * Default color of the laser pointer
  50740. */
  50741. laserPointerDefaultColor: Color3;
  50742. /**
  50743. * default color of the selection ring
  50744. */
  50745. selectionMeshDefaultColor: Color3;
  50746. /**
  50747. * This color will be applied to the selection ring when selection is triggered
  50748. */
  50749. selectionMeshPickedColor: Color3;
  50750. /**
  50751. * Optional filter to be used for ray selection. This predicate shares behavior with
  50752. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50753. */
  50754. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50755. /**
  50756. * constructs a new background remover module
  50757. * @param _xrSessionManager the session manager for this module
  50758. * @param _options read-only options to be used in this module
  50759. */
  50760. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50761. /**
  50762. * attach this feature
  50763. * Will usually be called by the features manager
  50764. *
  50765. * @returns true if successful.
  50766. */
  50767. attach(): boolean;
  50768. /**
  50769. * detach this feature.
  50770. * Will usually be called by the features manager
  50771. *
  50772. * @returns true if successful.
  50773. */
  50774. detach(): boolean;
  50775. /**
  50776. * Will get the mesh under a specific pointer.
  50777. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50778. * @param controllerId the controllerId to check
  50779. * @returns The mesh under pointer or null if no mesh is under the pointer
  50780. */
  50781. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50782. /**
  50783. * Get the xr controller that correlates to the pointer id in the pointer event
  50784. *
  50785. * @param id the pointer id to search for
  50786. * @returns the controller that correlates to this id or null if not found
  50787. */
  50788. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50789. protected _onXRFrame(_xrFrame: XRFrame): void;
  50790. private _attachGazeMode;
  50791. private _attachScreenRayMode;
  50792. private _attachTrackedPointerRayMode;
  50793. private _convertNormalToDirectionOfRay;
  50794. private _detachController;
  50795. private _generateNewMeshPair;
  50796. private _pickingMoved;
  50797. private _updatePointerDistance;
  50798. /** @hidden */
  50799. get lasterPointerDefaultColor(): Color3;
  50800. }
  50801. }
  50802. declare module "babylonjs/XR/webXREnterExitUI" {
  50803. import { Nullable } from "babylonjs/types";
  50804. import { Observable } from "babylonjs/Misc/observable";
  50805. import { IDisposable, Scene } from "babylonjs/scene";
  50806. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50807. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50808. /**
  50809. * Button which can be used to enter a different mode of XR
  50810. */
  50811. export class WebXREnterExitUIButton {
  50812. /** button element */
  50813. element: HTMLElement;
  50814. /** XR initialization options for the button */
  50815. sessionMode: XRSessionMode;
  50816. /** Reference space type */
  50817. referenceSpaceType: XRReferenceSpaceType;
  50818. /**
  50819. * Creates a WebXREnterExitUIButton
  50820. * @param element button element
  50821. * @param sessionMode XR initialization session mode
  50822. * @param referenceSpaceType the type of reference space to be used
  50823. */
  50824. constructor(
  50825. /** button element */
  50826. element: HTMLElement,
  50827. /** XR initialization options for the button */
  50828. sessionMode: XRSessionMode,
  50829. /** Reference space type */
  50830. referenceSpaceType: XRReferenceSpaceType);
  50831. /**
  50832. * Extendable function which can be used to update the button's visuals when the state changes
  50833. * @param activeButton the current active button in the UI
  50834. */
  50835. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50836. }
  50837. /**
  50838. * Options to create the webXR UI
  50839. */
  50840. export class WebXREnterExitUIOptions {
  50841. /**
  50842. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50843. */
  50844. customButtons?: Array<WebXREnterExitUIButton>;
  50845. /**
  50846. * A reference space type to use when creating the default button.
  50847. * Default is local-floor
  50848. */
  50849. referenceSpaceType?: XRReferenceSpaceType;
  50850. /**
  50851. * Context to enter xr with
  50852. */
  50853. renderTarget?: Nullable<WebXRRenderTarget>;
  50854. /**
  50855. * A session mode to use when creating the default button.
  50856. * Default is immersive-vr
  50857. */
  50858. sessionMode?: XRSessionMode;
  50859. /**
  50860. * A list of optional features to init the session with
  50861. */
  50862. optionalFeatures?: string[];
  50863. /**
  50864. * A list of optional features to init the session with
  50865. */
  50866. requiredFeatures?: string[];
  50867. }
  50868. /**
  50869. * UI to allow the user to enter/exit XR mode
  50870. */
  50871. export class WebXREnterExitUI implements IDisposable {
  50872. private scene;
  50873. /** version of the options passed to this UI */
  50874. options: WebXREnterExitUIOptions;
  50875. private _activeButton;
  50876. private _buttons;
  50877. /**
  50878. * The HTML Div Element to which buttons are added.
  50879. */
  50880. readonly overlay: HTMLDivElement;
  50881. /**
  50882. * Fired every time the active button is changed.
  50883. *
  50884. * When xr is entered via a button that launches xr that button will be the callback parameter
  50885. *
  50886. * When exiting xr the callback parameter will be null)
  50887. */
  50888. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50889. /**
  50890. *
  50891. * @param scene babylon scene object to use
  50892. * @param options (read-only) version of the options passed to this UI
  50893. */
  50894. private constructor();
  50895. /**
  50896. * Creates UI to allow the user to enter/exit XR mode
  50897. * @param scene the scene to add the ui to
  50898. * @param helper the xr experience helper to enter/exit xr with
  50899. * @param options options to configure the UI
  50900. * @returns the created ui
  50901. */
  50902. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50903. /**
  50904. * Disposes of the XR UI component
  50905. */
  50906. dispose(): void;
  50907. private _updateButtons;
  50908. }
  50909. }
  50910. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50911. import { Vector3 } from "babylonjs/Maths/math.vector";
  50912. import { Color4 } from "babylonjs/Maths/math.color";
  50913. import { Nullable } from "babylonjs/types";
  50914. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50915. import { Scene } from "babylonjs/scene";
  50916. /**
  50917. * Class containing static functions to help procedurally build meshes
  50918. */
  50919. export class LinesBuilder {
  50920. /**
  50921. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50922. * * 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
  50923. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50924. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50925. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50926. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50927. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50928. * * 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
  50929. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50930. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50931. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50932. * @param name defines the name of the new line system
  50933. * @param options defines the options used to create the line system
  50934. * @param scene defines the hosting scene
  50935. * @returns a new line system mesh
  50936. */
  50937. static CreateLineSystem(name: string, options: {
  50938. lines: Vector3[][];
  50939. updatable?: boolean;
  50940. instance?: Nullable<LinesMesh>;
  50941. colors?: Nullable<Color4[][]>;
  50942. useVertexAlpha?: boolean;
  50943. }, scene: Nullable<Scene>): LinesMesh;
  50944. /**
  50945. * Creates a line mesh
  50946. * 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
  50947. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50948. * * The parameter `points` is an array successive Vector3
  50949. * * 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
  50950. * * The optional parameter `colors` is an array of successive Color4, one per line point
  50951. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50952. * * When updating an instance, remember that only point positions can change, not the number of points
  50953. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50954. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50955. * @param name defines the name of the new line system
  50956. * @param options defines the options used to create the line system
  50957. * @param scene defines the hosting scene
  50958. * @returns a new line mesh
  50959. */
  50960. static CreateLines(name: string, options: {
  50961. points: Vector3[];
  50962. updatable?: boolean;
  50963. instance?: Nullable<LinesMesh>;
  50964. colors?: Color4[];
  50965. useVertexAlpha?: boolean;
  50966. }, scene?: Nullable<Scene>): LinesMesh;
  50967. /**
  50968. * Creates a dashed line mesh
  50969. * * 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
  50970. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50971. * * The parameter `points` is an array successive Vector3
  50972. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50973. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50974. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50975. * * 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
  50976. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50977. * * When updating an instance, remember that only point positions can change, not the number of points
  50978. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50979. * @param name defines the name of the mesh
  50980. * @param options defines the options used to create the mesh
  50981. * @param scene defines the hosting scene
  50982. * @returns the dashed line mesh
  50983. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  50984. */
  50985. static CreateDashedLines(name: string, options: {
  50986. points: Vector3[];
  50987. dashSize?: number;
  50988. gapSize?: number;
  50989. dashNb?: number;
  50990. updatable?: boolean;
  50991. instance?: LinesMesh;
  50992. useVertexAlpha?: boolean;
  50993. }, scene?: Nullable<Scene>): LinesMesh;
  50994. }
  50995. }
  50996. declare module "babylonjs/Misc/timer" {
  50997. import { Observable, Observer } from "babylonjs/Misc/observable";
  50998. import { Nullable } from "babylonjs/types";
  50999. import { IDisposable } from "babylonjs/scene";
  51000. /**
  51001. * Construction options for a timer
  51002. */
  51003. export interface ITimerOptions<T> {
  51004. /**
  51005. * Time-to-end
  51006. */
  51007. timeout: number;
  51008. /**
  51009. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  51010. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  51011. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  51012. */
  51013. contextObservable: Observable<T>;
  51014. /**
  51015. * Optional parameters when adding an observer to the observable
  51016. */
  51017. observableParameters?: {
  51018. mask?: number;
  51019. insertFirst?: boolean;
  51020. scope?: any;
  51021. };
  51022. /**
  51023. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  51024. */
  51025. breakCondition?: (data?: ITimerData<T>) => boolean;
  51026. /**
  51027. * Will be triggered when the time condition has met
  51028. */
  51029. onEnded?: (data: ITimerData<any>) => void;
  51030. /**
  51031. * Will be triggered when the break condition has met (prematurely ended)
  51032. */
  51033. onAborted?: (data: ITimerData<any>) => void;
  51034. /**
  51035. * Optional function to execute on each tick (or count)
  51036. */
  51037. onTick?: (data: ITimerData<any>) => void;
  51038. }
  51039. /**
  51040. * An interface defining the data sent by the timer
  51041. */
  51042. export interface ITimerData<T> {
  51043. /**
  51044. * When did it start
  51045. */
  51046. startTime: number;
  51047. /**
  51048. * Time now
  51049. */
  51050. currentTime: number;
  51051. /**
  51052. * Time passed since started
  51053. */
  51054. deltaTime: number;
  51055. /**
  51056. * How much is completed, in [0.0...1.0].
  51057. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51058. */
  51059. completeRate: number;
  51060. /**
  51061. * What the registered observable sent in the last count
  51062. */
  51063. payload: T;
  51064. }
  51065. /**
  51066. * The current state of the timer
  51067. */
  51068. export enum TimerState {
  51069. /**
  51070. * Timer initialized, not yet started
  51071. */
  51072. INIT = 0,
  51073. /**
  51074. * Timer started and counting
  51075. */
  51076. STARTED = 1,
  51077. /**
  51078. * Timer ended (whether aborted or time reached)
  51079. */
  51080. ENDED = 2
  51081. }
  51082. /**
  51083. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51084. *
  51085. * @param options options with which to initialize this timer
  51086. */
  51087. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51088. /**
  51089. * An advanced implementation of a timer class
  51090. */
  51091. export class AdvancedTimer<T = any> implements IDisposable {
  51092. /**
  51093. * Will notify each time the timer calculates the remaining time
  51094. */
  51095. onEachCountObservable: Observable<ITimerData<T>>;
  51096. /**
  51097. * Will trigger when the timer was aborted due to the break condition
  51098. */
  51099. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51100. /**
  51101. * Will trigger when the timer ended successfully
  51102. */
  51103. onTimerEndedObservable: Observable<ITimerData<T>>;
  51104. /**
  51105. * Will trigger when the timer state has changed
  51106. */
  51107. onStateChangedObservable: Observable<TimerState>;
  51108. private _observer;
  51109. private _contextObservable;
  51110. private _observableParameters;
  51111. private _startTime;
  51112. private _timer;
  51113. private _state;
  51114. private _breakCondition;
  51115. private _timeToEnd;
  51116. private _breakOnNextTick;
  51117. /**
  51118. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51119. * @param options construction options for this advanced timer
  51120. */
  51121. constructor(options: ITimerOptions<T>);
  51122. /**
  51123. * set a breaking condition for this timer. Default is to never break during count
  51124. * @param predicate the new break condition. Returns true to break, false otherwise
  51125. */
  51126. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51127. /**
  51128. * Reset ALL associated observables in this advanced timer
  51129. */
  51130. clearObservables(): void;
  51131. /**
  51132. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51133. *
  51134. * @param timeToEnd how much time to measure until timer ended
  51135. */
  51136. start(timeToEnd?: number): void;
  51137. /**
  51138. * Will force a stop on the next tick.
  51139. */
  51140. stop(): void;
  51141. /**
  51142. * Dispose this timer, clearing all resources
  51143. */
  51144. dispose(): void;
  51145. private _setState;
  51146. private _tick;
  51147. private _stop;
  51148. }
  51149. }
  51150. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51151. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51152. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51153. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51154. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51155. import { Vector3 } from "babylonjs/Maths/math.vector";
  51156. import { Material } from "babylonjs/Materials/material";
  51157. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51158. import { Scene } from "babylonjs/scene";
  51159. /**
  51160. * The options container for the teleportation module
  51161. */
  51162. export interface IWebXRTeleportationOptions {
  51163. /**
  51164. * if provided, this scene will be used to render meshes.
  51165. */
  51166. customUtilityLayerScene?: Scene;
  51167. /**
  51168. * Values to configure the default target mesh
  51169. */
  51170. defaultTargetMeshOptions?: {
  51171. /**
  51172. * Fill color of the teleportation area
  51173. */
  51174. teleportationFillColor?: string;
  51175. /**
  51176. * Border color for the teleportation area
  51177. */
  51178. teleportationBorderColor?: string;
  51179. /**
  51180. * Disable the mesh's animation sequence
  51181. */
  51182. disableAnimation?: boolean;
  51183. /**
  51184. * Disable lighting on the material or the ring and arrow
  51185. */
  51186. disableLighting?: boolean;
  51187. /**
  51188. * Override the default material of the torus and arrow
  51189. */
  51190. torusArrowMaterial?: Material;
  51191. };
  51192. /**
  51193. * A list of meshes to use as floor meshes.
  51194. * Meshes can be added and removed after initializing the feature using the
  51195. * addFloorMesh and removeFloorMesh functions
  51196. * If empty, rotation will still work
  51197. */
  51198. floorMeshes?: AbstractMesh[];
  51199. /**
  51200. * use this rendering group id for the meshes (optional)
  51201. */
  51202. renderingGroupId?: number;
  51203. /**
  51204. * Should teleportation move only to snap points
  51205. */
  51206. snapPointsOnly?: boolean;
  51207. /**
  51208. * An array of points to which the teleportation will snap to.
  51209. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51210. */
  51211. snapPositions?: Vector3[];
  51212. /**
  51213. * How close should the teleportation ray be in order to snap to position.
  51214. * Default to 0.8 units (meters)
  51215. */
  51216. snapToPositionRadius?: number;
  51217. /**
  51218. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51219. * If you want to support rotation, make sure your mesh has a direction indicator.
  51220. *
  51221. * When left untouched, the default mesh will be initialized.
  51222. */
  51223. teleportationTargetMesh?: AbstractMesh;
  51224. /**
  51225. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51226. */
  51227. timeToTeleport?: number;
  51228. /**
  51229. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51230. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51231. */
  51232. useMainComponentOnly?: boolean;
  51233. /**
  51234. * Should meshes created here be added to a utility layer or the main scene
  51235. */
  51236. useUtilityLayer?: boolean;
  51237. /**
  51238. * Babylon XR Input class for controller
  51239. */
  51240. xrInput: WebXRInput;
  51241. }
  51242. /**
  51243. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51244. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51245. * the input of the attached controllers.
  51246. */
  51247. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51248. private _options;
  51249. private _controllers;
  51250. private _currentTeleportationControllerId;
  51251. private _floorMeshes;
  51252. private _quadraticBezierCurve;
  51253. private _selectionFeature;
  51254. private _snapToPositions;
  51255. private _snappedToPoint;
  51256. private _teleportationRingMaterial?;
  51257. private _tmpRay;
  51258. private _tmpVector;
  51259. /**
  51260. * The module's name
  51261. */
  51262. static readonly Name: string;
  51263. /**
  51264. * The (Babylon) version of this module.
  51265. * This is an integer representing the implementation version.
  51266. * This number does not correspond to the webxr specs version
  51267. */
  51268. static readonly Version: number;
  51269. /**
  51270. * Is movement backwards enabled
  51271. */
  51272. backwardsMovementEnabled: boolean;
  51273. /**
  51274. * Distance to travel when moving backwards
  51275. */
  51276. backwardsTeleportationDistance: number;
  51277. /**
  51278. * The distance from the user to the inspection point in the direction of the controller
  51279. * A higher number will allow the user to move further
  51280. * defaults to 5 (meters, in xr units)
  51281. */
  51282. parabolicCheckRadius: number;
  51283. /**
  51284. * Should the module support parabolic ray on top of direct ray
  51285. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51286. * Very helpful when moving between floors / different heights
  51287. */
  51288. parabolicRayEnabled: boolean;
  51289. /**
  51290. * How much rotation should be applied when rotating right and left
  51291. */
  51292. rotationAngle: number;
  51293. /**
  51294. * Is rotation enabled when moving forward?
  51295. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51296. */
  51297. rotationEnabled: boolean;
  51298. /**
  51299. * constructs a new anchor system
  51300. * @param _xrSessionManager an instance of WebXRSessionManager
  51301. * @param _options configuration object for this feature
  51302. */
  51303. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51304. /**
  51305. * Get the snapPointsOnly flag
  51306. */
  51307. get snapPointsOnly(): boolean;
  51308. /**
  51309. * Sets the snapPointsOnly flag
  51310. * @param snapToPoints should teleportation be exclusively to snap points
  51311. */
  51312. set snapPointsOnly(snapToPoints: boolean);
  51313. /**
  51314. * Add a new mesh to the floor meshes array
  51315. * @param mesh the mesh to use as floor mesh
  51316. */
  51317. addFloorMesh(mesh: AbstractMesh): void;
  51318. /**
  51319. * Add a new snap-to point to fix teleportation to this position
  51320. * @param newSnapPoint The new Snap-To point
  51321. */
  51322. addSnapPoint(newSnapPoint: Vector3): void;
  51323. attach(): boolean;
  51324. detach(): boolean;
  51325. dispose(): void;
  51326. /**
  51327. * Remove a mesh from the floor meshes array
  51328. * @param mesh the mesh to remove
  51329. */
  51330. removeFloorMesh(mesh: AbstractMesh): void;
  51331. /**
  51332. * Remove a mesh from the floor meshes array using its name
  51333. * @param name the mesh name to remove
  51334. */
  51335. removeFloorMeshByName(name: string): void;
  51336. /**
  51337. * 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
  51338. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51339. * @returns was the point found and removed or not
  51340. */
  51341. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51342. /**
  51343. * This function sets a selection feature that will be disabled when
  51344. * the forward ray is shown and will be reattached when hidden.
  51345. * This is used to remove the selection rays when moving.
  51346. * @param selectionFeature the feature to disable when forward movement is enabled
  51347. */
  51348. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  51349. protected _onXRFrame(_xrFrame: XRFrame): void;
  51350. private _attachController;
  51351. private _createDefaultTargetMesh;
  51352. private _detachController;
  51353. private _findClosestSnapPointWithRadius;
  51354. private _setTargetMeshPosition;
  51355. private _setTargetMeshVisibility;
  51356. private _showParabolicPath;
  51357. private _teleportForward;
  51358. }
  51359. }
  51360. declare module "babylonjs/XR/webXRDefaultExperience" {
  51361. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51362. import { Scene } from "babylonjs/scene";
  51363. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51364. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51365. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51366. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51367. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51368. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51369. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51370. /**
  51371. * Options for the default xr helper
  51372. */
  51373. export class WebXRDefaultExperienceOptions {
  51374. /**
  51375. * Enable or disable default UI to enter XR
  51376. */
  51377. disableDefaultUI?: boolean;
  51378. /**
  51379. * Should teleportation not initialize. defaults to false.
  51380. */
  51381. disableTeleportation?: boolean;
  51382. /**
  51383. * Floor meshes that will be used for teleport
  51384. */
  51385. floorMeshes?: Array<AbstractMesh>;
  51386. /**
  51387. * If set to true, the first frame will not be used to reset position
  51388. * The first frame is mainly used when copying transformation from the old camera
  51389. * Mainly used in AR
  51390. */
  51391. ignoreNativeCameraTransformation?: boolean;
  51392. /**
  51393. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51394. */
  51395. inputOptions?: IWebXRInputOptions;
  51396. /**
  51397. * optional configuration for the output canvas
  51398. */
  51399. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51400. /**
  51401. * optional UI options. This can be used among other to change session mode and reference space type
  51402. */
  51403. uiOptions?: WebXREnterExitUIOptions;
  51404. /**
  51405. * When loading teleportation and pointer select, use stable versions instead of latest.
  51406. */
  51407. useStablePlugins?: boolean;
  51408. /**
  51409. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51410. */
  51411. renderingGroupId?: number;
  51412. /**
  51413. * A list of optional features to init the session with
  51414. * If set to true, all features we support will be added
  51415. */
  51416. optionalFeatures?: boolean | string[];
  51417. }
  51418. /**
  51419. * Default experience which provides a similar setup to the previous webVRExperience
  51420. */
  51421. export class WebXRDefaultExperience {
  51422. /**
  51423. * Base experience
  51424. */
  51425. baseExperience: WebXRExperienceHelper;
  51426. /**
  51427. * Enables ui for entering/exiting xr
  51428. */
  51429. enterExitUI: WebXREnterExitUI;
  51430. /**
  51431. * Input experience extension
  51432. */
  51433. input: WebXRInput;
  51434. /**
  51435. * Enables laser pointer and selection
  51436. */
  51437. pointerSelection: WebXRControllerPointerSelection;
  51438. /**
  51439. * Default target xr should render to
  51440. */
  51441. renderTarget: WebXRRenderTarget;
  51442. /**
  51443. * Enables teleportation
  51444. */
  51445. teleportation: WebXRMotionControllerTeleportation;
  51446. private constructor();
  51447. /**
  51448. * Creates the default xr experience
  51449. * @param scene scene
  51450. * @param options options for basic configuration
  51451. * @returns resulting WebXRDefaultExperience
  51452. */
  51453. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51454. /**
  51455. * DIsposes of the experience helper
  51456. */
  51457. dispose(): void;
  51458. }
  51459. }
  51460. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51461. import { Observable } from "babylonjs/Misc/observable";
  51462. import { Nullable } from "babylonjs/types";
  51463. import { Camera } from "babylonjs/Cameras/camera";
  51464. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51465. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51466. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51467. import { Scene } from "babylonjs/scene";
  51468. import { Vector3 } from "babylonjs/Maths/math.vector";
  51469. import { Color3 } from "babylonjs/Maths/math.color";
  51470. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51471. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51472. import { Mesh } from "babylonjs/Meshes/mesh";
  51473. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51474. import { EasingFunction } from "babylonjs/Animations/easing";
  51475. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51476. import "babylonjs/Meshes/Builders/groundBuilder";
  51477. import "babylonjs/Meshes/Builders/torusBuilder";
  51478. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51479. import "babylonjs/Gamepads/gamepadSceneComponent";
  51480. import "babylonjs/Animations/animatable";
  51481. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51482. /**
  51483. * Options to modify the vr teleportation behavior.
  51484. */
  51485. export interface VRTeleportationOptions {
  51486. /**
  51487. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51488. */
  51489. floorMeshName?: string;
  51490. /**
  51491. * A list of meshes to be used as the teleportation floor. (default: empty)
  51492. */
  51493. floorMeshes?: Mesh[];
  51494. /**
  51495. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51496. */
  51497. teleportationMode?: number;
  51498. /**
  51499. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51500. */
  51501. teleportationTime?: number;
  51502. /**
  51503. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51504. */
  51505. teleportationSpeed?: number;
  51506. /**
  51507. * The easing function used in the animation or null for Linear. (default CircleEase)
  51508. */
  51509. easingFunction?: EasingFunction;
  51510. }
  51511. /**
  51512. * Options to modify the vr experience helper's behavior.
  51513. */
  51514. export interface VRExperienceHelperOptions extends WebVROptions {
  51515. /**
  51516. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51517. */
  51518. createDeviceOrientationCamera?: boolean;
  51519. /**
  51520. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51521. */
  51522. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51523. /**
  51524. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51525. */
  51526. laserToggle?: boolean;
  51527. /**
  51528. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51529. */
  51530. floorMeshes?: Mesh[];
  51531. /**
  51532. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51533. */
  51534. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51535. /**
  51536. * Defines if WebXR should be used instead of WebVR (if available)
  51537. */
  51538. useXR?: boolean;
  51539. }
  51540. /**
  51541. * Event containing information after VR has been entered
  51542. */
  51543. export class OnAfterEnteringVRObservableEvent {
  51544. /**
  51545. * If entering vr was successful
  51546. */
  51547. success: boolean;
  51548. }
  51549. /**
  51550. * Helps to quickly add VR support to an existing scene.
  51551. * See https://doc.babylonjs.com/how_to/webvr_helper
  51552. */
  51553. export class VRExperienceHelper {
  51554. /** Options to modify the vr experience helper's behavior. */
  51555. webVROptions: VRExperienceHelperOptions;
  51556. private _scene;
  51557. private _position;
  51558. private _btnVR;
  51559. private _btnVRDisplayed;
  51560. private _webVRsupported;
  51561. private _webVRready;
  51562. private _webVRrequesting;
  51563. private _webVRpresenting;
  51564. private _hasEnteredVR;
  51565. private _fullscreenVRpresenting;
  51566. private _inputElement;
  51567. private _webVRCamera;
  51568. private _vrDeviceOrientationCamera;
  51569. private _deviceOrientationCamera;
  51570. private _existingCamera;
  51571. private _onKeyDown;
  51572. private _onVrDisplayPresentChange;
  51573. private _onVRDisplayChanged;
  51574. private _onVRRequestPresentStart;
  51575. private _onVRRequestPresentComplete;
  51576. /**
  51577. * 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)
  51578. */
  51579. enableGazeEvenWhenNoPointerLock: boolean;
  51580. /**
  51581. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51582. */
  51583. exitVROnDoubleTap: boolean;
  51584. /**
  51585. * Observable raised right before entering VR.
  51586. */
  51587. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51588. /**
  51589. * Observable raised when entering VR has completed.
  51590. */
  51591. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51592. /**
  51593. * Observable raised when exiting VR.
  51594. */
  51595. onExitingVRObservable: Observable<VRExperienceHelper>;
  51596. /**
  51597. * Observable raised when controller mesh is loaded.
  51598. */
  51599. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51600. /** Return this.onEnteringVRObservable
  51601. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51602. */
  51603. get onEnteringVR(): Observable<VRExperienceHelper>;
  51604. /** Return this.onExitingVRObservable
  51605. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51606. */
  51607. get onExitingVR(): Observable<VRExperienceHelper>;
  51608. /** Return this.onControllerMeshLoadedObservable
  51609. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51610. */
  51611. get onControllerMeshLoaded(): Observable<WebVRController>;
  51612. private _rayLength;
  51613. private _useCustomVRButton;
  51614. private _teleportationRequested;
  51615. private _teleportActive;
  51616. private _floorMeshName;
  51617. private _floorMeshesCollection;
  51618. private _teleportationMode;
  51619. private _teleportationTime;
  51620. private _teleportationSpeed;
  51621. private _teleportationEasing;
  51622. private _rotationAllowed;
  51623. private _teleportBackwardsVector;
  51624. private _teleportationTarget;
  51625. private _isDefaultTeleportationTarget;
  51626. private _postProcessMove;
  51627. private _teleportationFillColor;
  51628. private _teleportationBorderColor;
  51629. private _rotationAngle;
  51630. private _haloCenter;
  51631. private _cameraGazer;
  51632. private _padSensibilityUp;
  51633. private _padSensibilityDown;
  51634. private _leftController;
  51635. private _rightController;
  51636. private _gazeColor;
  51637. private _laserColor;
  51638. private _pickedLaserColor;
  51639. private _pickedGazeColor;
  51640. /**
  51641. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51642. */
  51643. onNewMeshSelected: Observable<AbstractMesh>;
  51644. /**
  51645. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51646. * This observable will provide the mesh and the controller used to select the mesh
  51647. */
  51648. onMeshSelectedWithController: Observable<{
  51649. mesh: AbstractMesh;
  51650. controller: WebVRController;
  51651. }>;
  51652. /**
  51653. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51654. */
  51655. onNewMeshPicked: Observable<PickingInfo>;
  51656. private _circleEase;
  51657. /**
  51658. * Observable raised before camera teleportation
  51659. */
  51660. onBeforeCameraTeleport: Observable<Vector3>;
  51661. /**
  51662. * Observable raised after camera teleportation
  51663. */
  51664. onAfterCameraTeleport: Observable<Vector3>;
  51665. /**
  51666. * Observable raised when current selected mesh gets unselected
  51667. */
  51668. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51669. private _raySelectionPredicate;
  51670. /**
  51671. * To be optionaly changed by user to define custom ray selection
  51672. */
  51673. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51674. /**
  51675. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51676. */
  51677. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51678. /**
  51679. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51680. */
  51681. teleportationEnabled: boolean;
  51682. private _defaultHeight;
  51683. private _teleportationInitialized;
  51684. private _interactionsEnabled;
  51685. private _interactionsRequested;
  51686. private _displayGaze;
  51687. private _displayLaserPointer;
  51688. /**
  51689. * The mesh used to display where the user is going to teleport.
  51690. */
  51691. get teleportationTarget(): Mesh;
  51692. /**
  51693. * Sets the mesh to be used to display where the user is going to teleport.
  51694. */
  51695. set teleportationTarget(value: Mesh);
  51696. /**
  51697. * 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
  51698. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51699. * See https://doc.babylonjs.com/resources/baking_transformations
  51700. */
  51701. get gazeTrackerMesh(): Mesh;
  51702. set gazeTrackerMesh(value: Mesh);
  51703. /**
  51704. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51705. */
  51706. updateGazeTrackerScale: boolean;
  51707. /**
  51708. * If the gaze trackers color should be updated when selecting meshes
  51709. */
  51710. updateGazeTrackerColor: boolean;
  51711. /**
  51712. * If the controller laser color should be updated when selecting meshes
  51713. */
  51714. updateControllerLaserColor: boolean;
  51715. /**
  51716. * The gaze tracking mesh corresponding to the left controller
  51717. */
  51718. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51719. /**
  51720. * The gaze tracking mesh corresponding to the right controller
  51721. */
  51722. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51723. /**
  51724. * If the ray of the gaze should be displayed.
  51725. */
  51726. get displayGaze(): boolean;
  51727. /**
  51728. * Sets if the ray of the gaze should be displayed.
  51729. */
  51730. set displayGaze(value: boolean);
  51731. /**
  51732. * If the ray of the LaserPointer should be displayed.
  51733. */
  51734. get displayLaserPointer(): boolean;
  51735. /**
  51736. * Sets if the ray of the LaserPointer should be displayed.
  51737. */
  51738. set displayLaserPointer(value: boolean);
  51739. /**
  51740. * The deviceOrientationCamera used as the camera when not in VR.
  51741. */
  51742. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51743. /**
  51744. * Based on the current WebVR support, returns the current VR camera used.
  51745. */
  51746. get currentVRCamera(): Nullable<Camera>;
  51747. /**
  51748. * The webVRCamera which is used when in VR.
  51749. */
  51750. get webVRCamera(): WebVRFreeCamera;
  51751. /**
  51752. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51753. */
  51754. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51755. /**
  51756. * The html button that is used to trigger entering into VR.
  51757. */
  51758. get vrButton(): Nullable<HTMLButtonElement>;
  51759. private get _teleportationRequestInitiated();
  51760. /**
  51761. * Defines whether or not Pointer lock should be requested when switching to
  51762. * full screen.
  51763. */
  51764. requestPointerLockOnFullScreen: boolean;
  51765. /**
  51766. * If asking to force XR, this will be populated with the default xr experience
  51767. */
  51768. xr: WebXRDefaultExperience;
  51769. /**
  51770. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51771. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51772. */
  51773. xrTestDone: boolean;
  51774. /**
  51775. * Instantiates a VRExperienceHelper.
  51776. * Helps to quickly add VR support to an existing scene.
  51777. * @param scene The scene the VRExperienceHelper belongs to.
  51778. * @param webVROptions Options to modify the vr experience helper's behavior.
  51779. */
  51780. constructor(scene: Scene,
  51781. /** Options to modify the vr experience helper's behavior. */
  51782. webVROptions?: VRExperienceHelperOptions);
  51783. private completeVRInit;
  51784. private _onDefaultMeshLoaded;
  51785. private _onResize;
  51786. private _onFullscreenChange;
  51787. /**
  51788. * Gets a value indicating if we are currently in VR mode.
  51789. */
  51790. get isInVRMode(): boolean;
  51791. private onVrDisplayPresentChange;
  51792. private onVRDisplayChanged;
  51793. private moveButtonToBottomRight;
  51794. private displayVRButton;
  51795. private updateButtonVisibility;
  51796. private _cachedAngularSensibility;
  51797. /**
  51798. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51799. * Otherwise, will use the fullscreen API.
  51800. */
  51801. enterVR(): void;
  51802. /**
  51803. * Attempt to exit VR, or fullscreen.
  51804. */
  51805. exitVR(): void;
  51806. /**
  51807. * The position of the vr experience helper.
  51808. */
  51809. get position(): Vector3;
  51810. /**
  51811. * Sets the position of the vr experience helper.
  51812. */
  51813. set position(value: Vector3);
  51814. /**
  51815. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51816. */
  51817. enableInteractions(): void;
  51818. private get _noControllerIsActive();
  51819. private beforeRender;
  51820. private _isTeleportationFloor;
  51821. /**
  51822. * Adds a floor mesh to be used for teleportation.
  51823. * @param floorMesh the mesh to be used for teleportation.
  51824. */
  51825. addFloorMesh(floorMesh: Mesh): void;
  51826. /**
  51827. * Removes a floor mesh from being used for teleportation.
  51828. * @param floorMesh the mesh to be removed.
  51829. */
  51830. removeFloorMesh(floorMesh: Mesh): void;
  51831. /**
  51832. * Enables interactions and teleportation using the VR controllers and gaze.
  51833. * @param vrTeleportationOptions options to modify teleportation behavior.
  51834. */
  51835. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51836. private _onNewGamepadConnected;
  51837. private _tryEnableInteractionOnController;
  51838. private _onNewGamepadDisconnected;
  51839. private _enableInteractionOnController;
  51840. private _checkTeleportWithRay;
  51841. private _checkRotate;
  51842. private _checkTeleportBackwards;
  51843. private _enableTeleportationOnController;
  51844. private _createTeleportationCircles;
  51845. private _displayTeleportationTarget;
  51846. private _hideTeleportationTarget;
  51847. private _rotateCamera;
  51848. private _moveTeleportationSelectorTo;
  51849. private _workingVector;
  51850. private _workingQuaternion;
  51851. private _workingMatrix;
  51852. /**
  51853. * Time Constant Teleportation Mode
  51854. */
  51855. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51856. /**
  51857. * Speed Constant Teleportation Mode
  51858. */
  51859. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51860. /**
  51861. * Teleports the users feet to the desired location
  51862. * @param location The location where the user's feet should be placed
  51863. */
  51864. teleportCamera(location: Vector3): void;
  51865. private _convertNormalToDirectionOfRay;
  51866. private _castRayAndSelectObject;
  51867. private _notifySelectedMeshUnselected;
  51868. /**
  51869. * Permanently set new colors for the laser pointer
  51870. * @param color the new laser color
  51871. * @param pickedColor the new laser color when picked mesh detected
  51872. */
  51873. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51874. /**
  51875. * Set lighting enabled / disabled on the laser pointer of both controllers
  51876. * @param enabled should the lighting be enabled on the laser pointer
  51877. */
  51878. setLaserLightingState(enabled?: boolean): void;
  51879. /**
  51880. * Permanently set new colors for the gaze pointer
  51881. * @param color the new gaze color
  51882. * @param pickedColor the new gaze color when picked mesh detected
  51883. */
  51884. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51885. /**
  51886. * Sets the color of the laser ray from the vr controllers.
  51887. * @param color new color for the ray.
  51888. */
  51889. changeLaserColor(color: Color3): void;
  51890. /**
  51891. * Sets the color of the ray from the vr headsets gaze.
  51892. * @param color new color for the ray.
  51893. */
  51894. changeGazeColor(color: Color3): void;
  51895. /**
  51896. * Exits VR and disposes of the vr experience helper
  51897. */
  51898. dispose(): void;
  51899. /**
  51900. * Gets the name of the VRExperienceHelper class
  51901. * @returns "VRExperienceHelper"
  51902. */
  51903. getClassName(): string;
  51904. }
  51905. }
  51906. declare module "babylonjs/Cameras/VR/index" {
  51907. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51908. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51909. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51910. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51911. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51912. export * from "babylonjs/Cameras/VR/webVRCamera";
  51913. }
  51914. declare module "babylonjs/Cameras/RigModes/index" {
  51915. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51916. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51917. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51918. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51919. }
  51920. declare module "babylonjs/Cameras/index" {
  51921. export * from "babylonjs/Cameras/Inputs/index";
  51922. export * from "babylonjs/Cameras/cameraInputsManager";
  51923. export * from "babylonjs/Cameras/camera";
  51924. export * from "babylonjs/Cameras/targetCamera";
  51925. export * from "babylonjs/Cameras/freeCamera";
  51926. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51927. export * from "babylonjs/Cameras/touchCamera";
  51928. export * from "babylonjs/Cameras/arcRotateCamera";
  51929. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51930. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51931. export * from "babylonjs/Cameras/flyCamera";
  51932. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51933. export * from "babylonjs/Cameras/followCamera";
  51934. export * from "babylonjs/Cameras/followCameraInputsManager";
  51935. export * from "babylonjs/Cameras/gamepadCamera";
  51936. export * from "babylonjs/Cameras/Stereoscopic/index";
  51937. export * from "babylonjs/Cameras/universalCamera";
  51938. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51939. export * from "babylonjs/Cameras/VR/index";
  51940. export * from "babylonjs/Cameras/RigModes/index";
  51941. }
  51942. declare module "babylonjs/Collisions/index" {
  51943. export * from "babylonjs/Collisions/collider";
  51944. export * from "babylonjs/Collisions/collisionCoordinator";
  51945. export * from "babylonjs/Collisions/pickingInfo";
  51946. export * from "babylonjs/Collisions/intersectionInfo";
  51947. export * from "babylonjs/Collisions/meshCollisionData";
  51948. }
  51949. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51950. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51951. import { Vector3 } from "babylonjs/Maths/math.vector";
  51952. import { Ray } from "babylonjs/Culling/ray";
  51953. import { Plane } from "babylonjs/Maths/math.plane";
  51954. /**
  51955. * Contains an array of blocks representing the octree
  51956. */
  51957. export interface IOctreeContainer<T> {
  51958. /**
  51959. * Blocks within the octree
  51960. */
  51961. blocks: Array<OctreeBlock<T>>;
  51962. }
  51963. /**
  51964. * Class used to store a cell in an octree
  51965. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51966. */
  51967. export class OctreeBlock<T> {
  51968. /**
  51969. * Gets the content of the current block
  51970. */
  51971. entries: T[];
  51972. /**
  51973. * Gets the list of block children
  51974. */
  51975. blocks: Array<OctreeBlock<T>>;
  51976. private _depth;
  51977. private _maxDepth;
  51978. private _capacity;
  51979. private _minPoint;
  51980. private _maxPoint;
  51981. private _boundingVectors;
  51982. private _creationFunc;
  51983. /**
  51984. * Creates a new block
  51985. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  51986. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  51987. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51988. * @param depth defines the current depth of this block in the octree
  51989. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  51990. * @param creationFunc defines a callback to call when an element is added to the block
  51991. */
  51992. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  51993. /**
  51994. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51995. */
  51996. get capacity(): number;
  51997. /**
  51998. * Gets the minimum vector (in world space) of the block's bounding box
  51999. */
  52000. get minPoint(): Vector3;
  52001. /**
  52002. * Gets the maximum vector (in world space) of the block's bounding box
  52003. */
  52004. get maxPoint(): Vector3;
  52005. /**
  52006. * Add a new element to this block
  52007. * @param entry defines the element to add
  52008. */
  52009. addEntry(entry: T): void;
  52010. /**
  52011. * Remove an element from this block
  52012. * @param entry defines the element to remove
  52013. */
  52014. removeEntry(entry: T): void;
  52015. /**
  52016. * Add an array of elements to this block
  52017. * @param entries defines the array of elements to add
  52018. */
  52019. addEntries(entries: T[]): void;
  52020. /**
  52021. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  52022. * @param frustumPlanes defines the frustum planes to test
  52023. * @param selection defines the array to store current content if selection is positive
  52024. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52025. */
  52026. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52027. /**
  52028. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  52029. * @param sphereCenter defines the bounding sphere center
  52030. * @param sphereRadius defines the bounding sphere radius
  52031. * @param selection defines the array to store current content if selection is positive
  52032. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52033. */
  52034. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52035. /**
  52036. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  52037. * @param ray defines the ray to test with
  52038. * @param selection defines the array to store current content if selection is positive
  52039. */
  52040. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  52041. /**
  52042. * Subdivide the content into child blocks (this block will then be empty)
  52043. */
  52044. createInnerBlocks(): void;
  52045. /**
  52046. * @hidden
  52047. */
  52048. 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;
  52049. }
  52050. }
  52051. declare module "babylonjs/Culling/Octrees/octree" {
  52052. import { SmartArray } from "babylonjs/Misc/smartArray";
  52053. import { Vector3 } from "babylonjs/Maths/math.vector";
  52054. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52055. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52056. import { Ray } from "babylonjs/Culling/ray";
  52057. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52058. import { Plane } from "babylonjs/Maths/math.plane";
  52059. /**
  52060. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52061. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52062. */
  52063. export class Octree<T> {
  52064. /** 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.) */
  52065. maxDepth: number;
  52066. /**
  52067. * Blocks within the octree containing objects
  52068. */
  52069. blocks: Array<OctreeBlock<T>>;
  52070. /**
  52071. * Content stored in the octree
  52072. */
  52073. dynamicContent: T[];
  52074. private _maxBlockCapacity;
  52075. private _selectionContent;
  52076. private _creationFunc;
  52077. /**
  52078. * Creates a octree
  52079. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52080. * @param creationFunc function to be used to instatiate the octree
  52081. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52082. * @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.)
  52083. */
  52084. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52085. /** 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.) */
  52086. maxDepth?: number);
  52087. /**
  52088. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52089. * @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);
  52090. * @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);
  52091. * @param entries meshes to be added to the octree blocks
  52092. */
  52093. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52094. /**
  52095. * Adds a mesh to the octree
  52096. * @param entry Mesh to add to the octree
  52097. */
  52098. addMesh(entry: T): void;
  52099. /**
  52100. * Remove an element from the octree
  52101. * @param entry defines the element to remove
  52102. */
  52103. removeMesh(entry: T): void;
  52104. /**
  52105. * Selects an array of meshes within the frustum
  52106. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52107. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52108. * @returns array of meshes within the frustum
  52109. */
  52110. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52111. /**
  52112. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52113. * @param sphereCenter defines the bounding sphere center
  52114. * @param sphereRadius defines the bounding sphere radius
  52115. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52116. * @returns an array of objects that intersect the sphere
  52117. */
  52118. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52119. /**
  52120. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52121. * @param ray defines the ray to test with
  52122. * @returns array of intersected objects
  52123. */
  52124. intersectsRay(ray: Ray): SmartArray<T>;
  52125. /**
  52126. * Adds a mesh into the octree block if it intersects the block
  52127. */
  52128. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52129. /**
  52130. * Adds a submesh into the octree block if it intersects the block
  52131. */
  52132. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52133. }
  52134. }
  52135. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52136. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52137. import { Scene } from "babylonjs/scene";
  52138. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52139. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52140. import { Ray } from "babylonjs/Culling/ray";
  52141. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52142. import { Collider } from "babylonjs/Collisions/collider";
  52143. module "babylonjs/scene" {
  52144. interface Scene {
  52145. /**
  52146. * @hidden
  52147. * Backing Filed
  52148. */
  52149. _selectionOctree: Octree<AbstractMesh>;
  52150. /**
  52151. * Gets the octree used to boost mesh selection (picking)
  52152. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52153. */
  52154. selectionOctree: Octree<AbstractMesh>;
  52155. /**
  52156. * Creates or updates the octree used to boost selection (picking)
  52157. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52158. * @param maxCapacity defines the maximum capacity per leaf
  52159. * @param maxDepth defines the maximum depth of the octree
  52160. * @returns an octree of AbstractMesh
  52161. */
  52162. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52163. }
  52164. }
  52165. module "babylonjs/Meshes/abstractMesh" {
  52166. interface AbstractMesh {
  52167. /**
  52168. * @hidden
  52169. * Backing Field
  52170. */
  52171. _submeshesOctree: Octree<SubMesh>;
  52172. /**
  52173. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52174. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52175. * @param maxCapacity defines the maximum size of each block (64 by default)
  52176. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52177. * @returns the new octree
  52178. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52179. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52180. */
  52181. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52182. }
  52183. }
  52184. /**
  52185. * Defines the octree scene component responsible to manage any octrees
  52186. * in a given scene.
  52187. */
  52188. export class OctreeSceneComponent {
  52189. /**
  52190. * The component name help to identify the component in the list of scene components.
  52191. */
  52192. readonly name: string;
  52193. /**
  52194. * The scene the component belongs to.
  52195. */
  52196. scene: Scene;
  52197. /**
  52198. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52199. */
  52200. readonly checksIsEnabled: boolean;
  52201. /**
  52202. * Creates a new instance of the component for the given scene
  52203. * @param scene Defines the scene to register the component in
  52204. */
  52205. constructor(scene: Scene);
  52206. /**
  52207. * Registers the component in a given scene
  52208. */
  52209. register(): void;
  52210. /**
  52211. * Return the list of active meshes
  52212. * @returns the list of active meshes
  52213. */
  52214. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52215. /**
  52216. * Return the list of active sub meshes
  52217. * @param mesh The mesh to get the candidates sub meshes from
  52218. * @returns the list of active sub meshes
  52219. */
  52220. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52221. private _tempRay;
  52222. /**
  52223. * Return the list of sub meshes intersecting with a given local ray
  52224. * @param mesh defines the mesh to find the submesh for
  52225. * @param localRay defines the ray in local space
  52226. * @returns the list of intersecting sub meshes
  52227. */
  52228. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52229. /**
  52230. * Return the list of sub meshes colliding with a collider
  52231. * @param mesh defines the mesh to find the submesh for
  52232. * @param collider defines the collider to evaluate the collision against
  52233. * @returns the list of colliding sub meshes
  52234. */
  52235. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52236. /**
  52237. * Rebuilds the elements related to this component in case of
  52238. * context lost for instance.
  52239. */
  52240. rebuild(): void;
  52241. /**
  52242. * Disposes the component and the associated ressources.
  52243. */
  52244. dispose(): void;
  52245. }
  52246. }
  52247. declare module "babylonjs/Culling/Octrees/index" {
  52248. export * from "babylonjs/Culling/Octrees/octree";
  52249. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52250. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52251. }
  52252. declare module "babylonjs/Culling/index" {
  52253. export * from "babylonjs/Culling/boundingBox";
  52254. export * from "babylonjs/Culling/boundingInfo";
  52255. export * from "babylonjs/Culling/boundingSphere";
  52256. export * from "babylonjs/Culling/Octrees/index";
  52257. export * from "babylonjs/Culling/ray";
  52258. }
  52259. declare module "babylonjs/Gizmos/gizmo" {
  52260. import { Nullable } from "babylonjs/types";
  52261. import { IDisposable } from "babylonjs/scene";
  52262. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52263. import { Mesh } from "babylonjs/Meshes/mesh";
  52264. import { Node } from "babylonjs/node";
  52265. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52266. /**
  52267. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52268. */
  52269. export class Gizmo implements IDisposable {
  52270. /** The utility layer the gizmo will be added to */
  52271. gizmoLayer: UtilityLayerRenderer;
  52272. /**
  52273. * The root mesh of the gizmo
  52274. */
  52275. _rootMesh: Mesh;
  52276. private _attachedMesh;
  52277. private _attachedNode;
  52278. /**
  52279. * Ratio for the scale of the gizmo (Default: 1)
  52280. */
  52281. protected _scaleRatio: number;
  52282. /**
  52283. * Ratio for the scale of the gizmo (Default: 1)
  52284. */
  52285. set scaleRatio(value: number);
  52286. get scaleRatio(): number;
  52287. /**
  52288. * If a custom mesh has been set (Default: false)
  52289. */
  52290. protected _customMeshSet: boolean;
  52291. /**
  52292. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52293. * * When set, interactions will be enabled
  52294. */
  52295. get attachedMesh(): Nullable<AbstractMesh>;
  52296. set attachedMesh(value: Nullable<AbstractMesh>);
  52297. /**
  52298. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52299. * * When set, interactions will be enabled
  52300. */
  52301. get attachedNode(): Nullable<Node>;
  52302. set attachedNode(value: Nullable<Node>);
  52303. /**
  52304. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52305. * @param mesh The mesh to replace the default mesh of the gizmo
  52306. */
  52307. setCustomMesh(mesh: Mesh): void;
  52308. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  52309. /**
  52310. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52311. */
  52312. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52313. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52314. /**
  52315. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52316. */
  52317. updateGizmoPositionToMatchAttachedMesh: boolean;
  52318. /**
  52319. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52320. */
  52321. updateScale: boolean;
  52322. protected _interactionsEnabled: boolean;
  52323. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52324. private _beforeRenderObserver;
  52325. private _tempQuaternion;
  52326. private _tempVector;
  52327. private _tempVector2;
  52328. /**
  52329. * Creates a gizmo
  52330. * @param gizmoLayer The utility layer the gizmo will be added to
  52331. */
  52332. constructor(
  52333. /** The utility layer the gizmo will be added to */
  52334. gizmoLayer?: UtilityLayerRenderer);
  52335. /**
  52336. * Updates the gizmo to match the attached mesh's position/rotation
  52337. */
  52338. protected _update(): void;
  52339. /**
  52340. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52341. * @param value Node, TransformNode or mesh
  52342. */
  52343. protected _matrixChanged(): void;
  52344. /**
  52345. * Disposes of the gizmo
  52346. */
  52347. dispose(): void;
  52348. }
  52349. }
  52350. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52351. import { Observable } from "babylonjs/Misc/observable";
  52352. import { Nullable } from "babylonjs/types";
  52353. import { Vector3 } from "babylonjs/Maths/math.vector";
  52354. import { Color3 } from "babylonjs/Maths/math.color";
  52355. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52356. import { Node } from "babylonjs/node";
  52357. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52358. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52359. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52360. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52361. import { Scene } from "babylonjs/scene";
  52362. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52363. /**
  52364. * Single plane drag gizmo
  52365. */
  52366. export class PlaneDragGizmo extends Gizmo {
  52367. /**
  52368. * Drag behavior responsible for the gizmos dragging interactions
  52369. */
  52370. dragBehavior: PointerDragBehavior;
  52371. private _pointerObserver;
  52372. /**
  52373. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52374. */
  52375. snapDistance: number;
  52376. /**
  52377. * Event that fires each time the gizmo snaps to a new location.
  52378. * * snapDistance is the the change in distance
  52379. */
  52380. onSnapObservable: Observable<{
  52381. snapDistance: number;
  52382. }>;
  52383. private _plane;
  52384. private _coloredMaterial;
  52385. private _hoverMaterial;
  52386. private _isEnabled;
  52387. private _parent;
  52388. /** @hidden */
  52389. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52390. /** @hidden */
  52391. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52392. /**
  52393. * Creates a PlaneDragGizmo
  52394. * @param gizmoLayer The utility layer the gizmo will be added to
  52395. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52396. * @param color The color of the gizmo
  52397. */
  52398. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52399. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52400. /**
  52401. * If the gizmo is enabled
  52402. */
  52403. set isEnabled(value: boolean);
  52404. get isEnabled(): boolean;
  52405. /**
  52406. * Disposes of the gizmo
  52407. */
  52408. dispose(): void;
  52409. }
  52410. }
  52411. declare module "babylonjs/Gizmos/positionGizmo" {
  52412. import { Observable } from "babylonjs/Misc/observable";
  52413. import { Nullable } from "babylonjs/types";
  52414. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52415. import { Node } from "babylonjs/node";
  52416. import { Mesh } from "babylonjs/Meshes/mesh";
  52417. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52418. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52419. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52420. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52421. /**
  52422. * Gizmo that enables dragging a mesh along 3 axis
  52423. */
  52424. export class PositionGizmo extends Gizmo {
  52425. /**
  52426. * Internal gizmo used for interactions on the x axis
  52427. */
  52428. xGizmo: AxisDragGizmo;
  52429. /**
  52430. * Internal gizmo used for interactions on the y axis
  52431. */
  52432. yGizmo: AxisDragGizmo;
  52433. /**
  52434. * Internal gizmo used for interactions on the z axis
  52435. */
  52436. zGizmo: AxisDragGizmo;
  52437. /**
  52438. * Internal gizmo used for interactions on the yz plane
  52439. */
  52440. xPlaneGizmo: PlaneDragGizmo;
  52441. /**
  52442. * Internal gizmo used for interactions on the xz plane
  52443. */
  52444. yPlaneGizmo: PlaneDragGizmo;
  52445. /**
  52446. * Internal gizmo used for interactions on the xy plane
  52447. */
  52448. zPlaneGizmo: PlaneDragGizmo;
  52449. /**
  52450. * private variables
  52451. */
  52452. private _meshAttached;
  52453. private _nodeAttached;
  52454. private _snapDistance;
  52455. /** Fires an event when any of it's sub gizmos are dragged */
  52456. onDragStartObservable: Observable<unknown>;
  52457. /** Fires an event when any of it's sub gizmos are released from dragging */
  52458. onDragEndObservable: Observable<unknown>;
  52459. /**
  52460. * If set to true, planar drag is enabled
  52461. */
  52462. private _planarGizmoEnabled;
  52463. get attachedMesh(): Nullable<AbstractMesh>;
  52464. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52465. get attachedNode(): Nullable<Node>;
  52466. set attachedNode(node: Nullable<Node>);
  52467. /**
  52468. * Creates a PositionGizmo
  52469. * @param gizmoLayer The utility layer the gizmo will be added to
  52470. @param thickness display gizmo axis thickness
  52471. */
  52472. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52473. /**
  52474. * If the planar drag gizmo is enabled
  52475. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52476. */
  52477. set planarGizmoEnabled(value: boolean);
  52478. get planarGizmoEnabled(): boolean;
  52479. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52480. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52481. /**
  52482. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52483. */
  52484. set snapDistance(value: number);
  52485. get snapDistance(): number;
  52486. /**
  52487. * Ratio for the scale of the gizmo (Default: 1)
  52488. */
  52489. set scaleRatio(value: number);
  52490. get scaleRatio(): number;
  52491. /**
  52492. * Disposes of the gizmo
  52493. */
  52494. dispose(): void;
  52495. /**
  52496. * CustomMeshes are not supported by this gizmo
  52497. * @param mesh The mesh to replace the default mesh of the gizmo
  52498. */
  52499. setCustomMesh(mesh: Mesh): void;
  52500. }
  52501. }
  52502. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52503. import { Observable } from "babylonjs/Misc/observable";
  52504. import { Nullable } from "babylonjs/types";
  52505. import { Vector3 } from "babylonjs/Maths/math.vector";
  52506. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52507. import { Node } from "babylonjs/node";
  52508. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52509. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52510. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52511. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52512. import { Scene } from "babylonjs/scene";
  52513. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52514. import { Color3 } from "babylonjs/Maths/math.color";
  52515. /**
  52516. * Single axis drag gizmo
  52517. */
  52518. export class AxisDragGizmo extends Gizmo {
  52519. /**
  52520. * Drag behavior responsible for the gizmos dragging interactions
  52521. */
  52522. dragBehavior: PointerDragBehavior;
  52523. private _pointerObserver;
  52524. /**
  52525. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52526. */
  52527. snapDistance: number;
  52528. /**
  52529. * Event that fires each time the gizmo snaps to a new location.
  52530. * * snapDistance is the the change in distance
  52531. */
  52532. onSnapObservable: Observable<{
  52533. snapDistance: number;
  52534. }>;
  52535. private _isEnabled;
  52536. private _parent;
  52537. private _arrow;
  52538. private _coloredMaterial;
  52539. private _hoverMaterial;
  52540. /** @hidden */
  52541. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52542. /** @hidden */
  52543. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52544. /**
  52545. * Creates an AxisDragGizmo
  52546. * @param gizmoLayer The utility layer the gizmo will be added to
  52547. * @param dragAxis The axis which the gizmo will be able to drag on
  52548. * @param color The color of the gizmo
  52549. * @param thickness display gizmo axis thickness
  52550. */
  52551. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52552. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52553. /**
  52554. * If the gizmo is enabled
  52555. */
  52556. set isEnabled(value: boolean);
  52557. get isEnabled(): boolean;
  52558. /**
  52559. * Disposes of the gizmo
  52560. */
  52561. dispose(): void;
  52562. }
  52563. }
  52564. declare module "babylonjs/Debug/axesViewer" {
  52565. import { Vector3 } from "babylonjs/Maths/math.vector";
  52566. import { Nullable } from "babylonjs/types";
  52567. import { Scene } from "babylonjs/scene";
  52568. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52569. /**
  52570. * The Axes viewer will show 3 axes in a specific point in space
  52571. */
  52572. export class AxesViewer {
  52573. private _xAxis;
  52574. private _yAxis;
  52575. private _zAxis;
  52576. private _scaleLinesFactor;
  52577. private _instanced;
  52578. /**
  52579. * Gets the hosting scene
  52580. */
  52581. scene: Nullable<Scene>;
  52582. /**
  52583. * Gets or sets a number used to scale line length
  52584. */
  52585. scaleLines: number;
  52586. /** Gets the node hierarchy used to render x-axis */
  52587. get xAxis(): TransformNode;
  52588. /** Gets the node hierarchy used to render y-axis */
  52589. get yAxis(): TransformNode;
  52590. /** Gets the node hierarchy used to render z-axis */
  52591. get zAxis(): TransformNode;
  52592. /**
  52593. * Creates a new AxesViewer
  52594. * @param scene defines the hosting scene
  52595. * @param scaleLines defines a number used to scale line length (1 by default)
  52596. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52597. * @param xAxis defines the node hierarchy used to render the x-axis
  52598. * @param yAxis defines the node hierarchy used to render the y-axis
  52599. * @param zAxis defines the node hierarchy used to render the z-axis
  52600. */
  52601. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52602. /**
  52603. * Force the viewer to update
  52604. * @param position defines the position of the viewer
  52605. * @param xaxis defines the x axis of the viewer
  52606. * @param yaxis defines the y axis of the viewer
  52607. * @param zaxis defines the z axis of the viewer
  52608. */
  52609. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52610. /**
  52611. * Creates an instance of this axes viewer.
  52612. * @returns a new axes viewer with instanced meshes
  52613. */
  52614. createInstance(): AxesViewer;
  52615. /** Releases resources */
  52616. dispose(): void;
  52617. private static _SetRenderingGroupId;
  52618. }
  52619. }
  52620. declare module "babylonjs/Debug/boneAxesViewer" {
  52621. import { Nullable } from "babylonjs/types";
  52622. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52623. import { Vector3 } from "babylonjs/Maths/math.vector";
  52624. import { Mesh } from "babylonjs/Meshes/mesh";
  52625. import { Bone } from "babylonjs/Bones/bone";
  52626. import { Scene } from "babylonjs/scene";
  52627. /**
  52628. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52629. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52630. */
  52631. export class BoneAxesViewer extends AxesViewer {
  52632. /**
  52633. * Gets or sets the target mesh where to display the axes viewer
  52634. */
  52635. mesh: Nullable<Mesh>;
  52636. /**
  52637. * Gets or sets the target bone where to display the axes viewer
  52638. */
  52639. bone: Nullable<Bone>;
  52640. /** Gets current position */
  52641. pos: Vector3;
  52642. /** Gets direction of X axis */
  52643. xaxis: Vector3;
  52644. /** Gets direction of Y axis */
  52645. yaxis: Vector3;
  52646. /** Gets direction of Z axis */
  52647. zaxis: Vector3;
  52648. /**
  52649. * Creates a new BoneAxesViewer
  52650. * @param scene defines the hosting scene
  52651. * @param bone defines the target bone
  52652. * @param mesh defines the target mesh
  52653. * @param scaleLines defines a scaling factor for line length (1 by default)
  52654. */
  52655. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52656. /**
  52657. * Force the viewer to update
  52658. */
  52659. update(): void;
  52660. /** Releases resources */
  52661. dispose(): void;
  52662. }
  52663. }
  52664. declare module "babylonjs/Debug/debugLayer" {
  52665. import { Scene } from "babylonjs/scene";
  52666. /**
  52667. * Interface used to define scene explorer extensibility option
  52668. */
  52669. export interface IExplorerExtensibilityOption {
  52670. /**
  52671. * Define the option label
  52672. */
  52673. label: string;
  52674. /**
  52675. * Defines the action to execute on click
  52676. */
  52677. action: (entity: any) => void;
  52678. }
  52679. /**
  52680. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52681. */
  52682. export interface IExplorerExtensibilityGroup {
  52683. /**
  52684. * Defines a predicate to test if a given type mut be extended
  52685. */
  52686. predicate: (entity: any) => boolean;
  52687. /**
  52688. * Gets the list of options added to a type
  52689. */
  52690. entries: IExplorerExtensibilityOption[];
  52691. }
  52692. /**
  52693. * Interface used to define the options to use to create the Inspector
  52694. */
  52695. export interface IInspectorOptions {
  52696. /**
  52697. * Display in overlay mode (default: false)
  52698. */
  52699. overlay?: boolean;
  52700. /**
  52701. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52702. */
  52703. globalRoot?: HTMLElement;
  52704. /**
  52705. * Display the Scene explorer
  52706. */
  52707. showExplorer?: boolean;
  52708. /**
  52709. * Display the property inspector
  52710. */
  52711. showInspector?: boolean;
  52712. /**
  52713. * Display in embed mode (both panes on the right)
  52714. */
  52715. embedMode?: boolean;
  52716. /**
  52717. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52718. */
  52719. handleResize?: boolean;
  52720. /**
  52721. * Allow the panes to popup (default: true)
  52722. */
  52723. enablePopup?: boolean;
  52724. /**
  52725. * Allow the panes to be closed by users (default: true)
  52726. */
  52727. enableClose?: boolean;
  52728. /**
  52729. * Optional list of extensibility entries
  52730. */
  52731. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52732. /**
  52733. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52734. */
  52735. inspectorURL?: string;
  52736. /**
  52737. * Optional initial tab (default to DebugLayerTab.Properties)
  52738. */
  52739. initialTab?: DebugLayerTab;
  52740. }
  52741. module "babylonjs/scene" {
  52742. interface Scene {
  52743. /**
  52744. * @hidden
  52745. * Backing field
  52746. */
  52747. _debugLayer: DebugLayer;
  52748. /**
  52749. * Gets the debug layer (aka Inspector) associated with the scene
  52750. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52751. */
  52752. debugLayer: DebugLayer;
  52753. }
  52754. }
  52755. /**
  52756. * Enum of inspector action tab
  52757. */
  52758. export enum DebugLayerTab {
  52759. /**
  52760. * Properties tag (default)
  52761. */
  52762. Properties = 0,
  52763. /**
  52764. * Debug tab
  52765. */
  52766. Debug = 1,
  52767. /**
  52768. * Statistics tab
  52769. */
  52770. Statistics = 2,
  52771. /**
  52772. * Tools tab
  52773. */
  52774. Tools = 3,
  52775. /**
  52776. * Settings tab
  52777. */
  52778. Settings = 4
  52779. }
  52780. /**
  52781. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52782. * what is happening in your scene
  52783. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52784. */
  52785. export class DebugLayer {
  52786. /**
  52787. * Define the url to get the inspector script from.
  52788. * By default it uses the babylonjs CDN.
  52789. * @ignoreNaming
  52790. */
  52791. static InspectorURL: string;
  52792. private _scene;
  52793. private BJSINSPECTOR;
  52794. private _onPropertyChangedObservable?;
  52795. /**
  52796. * Observable triggered when a property is changed through the inspector.
  52797. */
  52798. get onPropertyChangedObservable(): any;
  52799. /**
  52800. * Instantiates a new debug layer.
  52801. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52802. * what is happening in your scene
  52803. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52804. * @param scene Defines the scene to inspect
  52805. */
  52806. constructor(scene: Scene);
  52807. /** Creates the inspector window. */
  52808. private _createInspector;
  52809. /**
  52810. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52811. * @param entity defines the entity to select
  52812. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52813. */
  52814. select(entity: any, lineContainerTitles?: string | string[]): void;
  52815. /** Get the inspector from bundle or global */
  52816. private _getGlobalInspector;
  52817. /**
  52818. * Get if the inspector is visible or not.
  52819. * @returns true if visible otherwise, false
  52820. */
  52821. isVisible(): boolean;
  52822. /**
  52823. * Hide the inspector and close its window.
  52824. */
  52825. hide(): void;
  52826. /**
  52827. * Update the scene in the inspector
  52828. */
  52829. setAsActiveScene(): void;
  52830. /**
  52831. * Launch the debugLayer.
  52832. * @param config Define the configuration of the inspector
  52833. * @return a promise fulfilled when the debug layer is visible
  52834. */
  52835. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52836. }
  52837. }
  52838. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52839. import { Nullable } from "babylonjs/types";
  52840. import { Scene } from "babylonjs/scene";
  52841. import { Vector4 } from "babylonjs/Maths/math.vector";
  52842. import { Color4 } from "babylonjs/Maths/math.color";
  52843. import { Mesh } from "babylonjs/Meshes/mesh";
  52844. /**
  52845. * Class containing static functions to help procedurally build meshes
  52846. */
  52847. export class BoxBuilder {
  52848. /**
  52849. * Creates a box mesh
  52850. * * The parameter `size` sets the size (float) of each box side (default 1)
  52851. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52852. * * 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)
  52853. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52854. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52855. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52856. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52857. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52858. * @param name defines the name of the mesh
  52859. * @param options defines the options used to create the mesh
  52860. * @param scene defines the hosting scene
  52861. * @returns the box mesh
  52862. */
  52863. static CreateBox(name: string, options: {
  52864. size?: number;
  52865. width?: number;
  52866. height?: number;
  52867. depth?: number;
  52868. faceUV?: Vector4[];
  52869. faceColors?: Color4[];
  52870. sideOrientation?: number;
  52871. frontUVs?: Vector4;
  52872. backUVs?: Vector4;
  52873. wrap?: boolean;
  52874. topBaseAt?: number;
  52875. bottomBaseAt?: number;
  52876. updatable?: boolean;
  52877. }, scene?: Nullable<Scene>): Mesh;
  52878. }
  52879. }
  52880. declare module "babylonjs/Debug/physicsViewer" {
  52881. import { Nullable } from "babylonjs/types";
  52882. import { Scene } from "babylonjs/scene";
  52883. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52884. import { Mesh } from "babylonjs/Meshes/mesh";
  52885. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52886. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52887. /**
  52888. * Used to show the physics impostor around the specific mesh
  52889. */
  52890. export class PhysicsViewer {
  52891. /** @hidden */
  52892. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52893. /** @hidden */
  52894. protected _meshes: Array<Nullable<AbstractMesh>>;
  52895. /** @hidden */
  52896. protected _scene: Nullable<Scene>;
  52897. /** @hidden */
  52898. protected _numMeshes: number;
  52899. /** @hidden */
  52900. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52901. private _renderFunction;
  52902. private _utilityLayer;
  52903. private _debugBoxMesh;
  52904. private _debugSphereMesh;
  52905. private _debugCylinderMesh;
  52906. private _debugMaterial;
  52907. private _debugMeshMeshes;
  52908. /**
  52909. * Creates a new PhysicsViewer
  52910. * @param scene defines the hosting scene
  52911. */
  52912. constructor(scene: Scene);
  52913. /** @hidden */
  52914. protected _updateDebugMeshes(): void;
  52915. /**
  52916. * Renders a specified physic impostor
  52917. * @param impostor defines the impostor to render
  52918. * @param targetMesh defines the mesh represented by the impostor
  52919. * @returns the new debug mesh used to render the impostor
  52920. */
  52921. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52922. /**
  52923. * Hides a specified physic impostor
  52924. * @param impostor defines the impostor to hide
  52925. */
  52926. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52927. private _getDebugMaterial;
  52928. private _getDebugBoxMesh;
  52929. private _getDebugSphereMesh;
  52930. private _getDebugCylinderMesh;
  52931. private _getDebugMeshMesh;
  52932. private _getDebugMesh;
  52933. /** Releases all resources */
  52934. dispose(): void;
  52935. }
  52936. }
  52937. declare module "babylonjs/Debug/rayHelper" {
  52938. import { Nullable } from "babylonjs/types";
  52939. import { Ray } from "babylonjs/Culling/ray";
  52940. import { Vector3 } from "babylonjs/Maths/math.vector";
  52941. import { Color3 } from "babylonjs/Maths/math.color";
  52942. import { Scene } from "babylonjs/scene";
  52943. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52944. import "babylonjs/Meshes/Builders/linesBuilder";
  52945. /**
  52946. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52947. * in order to better appreciate the issue one might have.
  52948. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52949. */
  52950. export class RayHelper {
  52951. /**
  52952. * Defines the ray we are currently tryin to visualize.
  52953. */
  52954. ray: Nullable<Ray>;
  52955. private _renderPoints;
  52956. private _renderLine;
  52957. private _renderFunction;
  52958. private _scene;
  52959. private _onAfterRenderObserver;
  52960. private _onAfterStepObserver;
  52961. private _attachedToMesh;
  52962. private _meshSpaceDirection;
  52963. private _meshSpaceOrigin;
  52964. /**
  52965. * Helper function to create a colored helper in a scene in one line.
  52966. * @param ray Defines the ray we are currently tryin to visualize
  52967. * @param scene Defines the scene the ray is used in
  52968. * @param color Defines the color we want to see the ray in
  52969. * @returns The newly created ray helper.
  52970. */
  52971. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52972. /**
  52973. * Instantiate a new ray helper.
  52974. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52975. * in order to better appreciate the issue one might have.
  52976. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52977. * @param ray Defines the ray we are currently tryin to visualize
  52978. */
  52979. constructor(ray: Ray);
  52980. /**
  52981. * Shows the ray we are willing to debug.
  52982. * @param scene Defines the scene the ray needs to be rendered in
  52983. * @param color Defines the color the ray needs to be rendered in
  52984. */
  52985. show(scene: Scene, color?: Color3): void;
  52986. /**
  52987. * Hides the ray we are debugging.
  52988. */
  52989. hide(): void;
  52990. private _render;
  52991. /**
  52992. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  52993. * @param mesh Defines the mesh we want the helper attached to
  52994. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  52995. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  52996. * @param length Defines the length of the ray
  52997. */
  52998. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  52999. /**
  53000. * Detach the ray helper from the mesh it has previously been attached to.
  53001. */
  53002. detachFromMesh(): void;
  53003. private _updateToMesh;
  53004. /**
  53005. * Dispose the helper and release its associated resources.
  53006. */
  53007. dispose(): void;
  53008. }
  53009. }
  53010. declare module "babylonjs/Debug/ISkeletonViewer" {
  53011. /**
  53012. * Defines the options associated with the creation of a SkeletonViewer.
  53013. */
  53014. export interface ISkeletonViewerOptions {
  53015. /** Should the system pause animations before building the Viewer? */
  53016. pauseAnimations: boolean;
  53017. /** Should the system return the skeleton to rest before building? */
  53018. returnToRest: boolean;
  53019. /** public Display Mode of the Viewer */
  53020. displayMode: number;
  53021. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53022. displayOptions: ISkeletonViewerDisplayOptions;
  53023. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53024. computeBonesUsingShaders: boolean;
  53025. }
  53026. /**
  53027. * Defines how to display the various bone meshes for the viewer.
  53028. */
  53029. export interface ISkeletonViewerDisplayOptions {
  53030. /** How far down to start tapering the bone spurs */
  53031. midStep?: number;
  53032. /** How big is the midStep? */
  53033. midStepFactor?: number;
  53034. /** Base for the Sphere Size */
  53035. sphereBaseSize?: number;
  53036. /** The ratio of the sphere to the longest bone in units */
  53037. sphereScaleUnit?: number;
  53038. /** Ratio for the Sphere Size */
  53039. sphereFactor?: number;
  53040. }
  53041. }
  53042. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53043. import { Nullable } from "babylonjs/types";
  53044. import { Scene } from "babylonjs/scene";
  53045. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53046. import { Color4 } from "babylonjs/Maths/math.color";
  53047. import { Mesh } from "babylonjs/Meshes/mesh";
  53048. /**
  53049. * Class containing static functions to help procedurally build meshes
  53050. */
  53051. export class RibbonBuilder {
  53052. /**
  53053. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53054. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53055. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53056. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53057. * * 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
  53058. * * 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
  53059. * * 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
  53060. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53061. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53062. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53063. * * 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
  53064. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53065. * * 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
  53066. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53067. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53068. * @param name defines the name of the mesh
  53069. * @param options defines the options used to create the mesh
  53070. * @param scene defines the hosting scene
  53071. * @returns the ribbon mesh
  53072. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53073. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53074. */
  53075. static CreateRibbon(name: string, options: {
  53076. pathArray: Vector3[][];
  53077. closeArray?: boolean;
  53078. closePath?: boolean;
  53079. offset?: number;
  53080. updatable?: boolean;
  53081. sideOrientation?: number;
  53082. frontUVs?: Vector4;
  53083. backUVs?: Vector4;
  53084. instance?: Mesh;
  53085. invertUV?: boolean;
  53086. uvs?: Vector2[];
  53087. colors?: Color4[];
  53088. }, scene?: Nullable<Scene>): Mesh;
  53089. }
  53090. }
  53091. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53092. import { Nullable } from "babylonjs/types";
  53093. import { Scene } from "babylonjs/scene";
  53094. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53095. import { Mesh } from "babylonjs/Meshes/mesh";
  53096. /**
  53097. * Class containing static functions to help procedurally build meshes
  53098. */
  53099. export class ShapeBuilder {
  53100. /**
  53101. * 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.
  53102. * * 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.
  53103. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53104. * * 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.
  53105. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53106. * * 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
  53107. * * 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
  53108. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53109. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53110. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53111. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53112. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53113. * @param name defines the name of the mesh
  53114. * @param options defines the options used to create the mesh
  53115. * @param scene defines the hosting scene
  53116. * @returns the extruded shape mesh
  53117. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53118. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53119. */
  53120. static ExtrudeShape(name: string, options: {
  53121. shape: Vector3[];
  53122. path: Vector3[];
  53123. scale?: number;
  53124. rotation?: number;
  53125. cap?: number;
  53126. updatable?: boolean;
  53127. sideOrientation?: number;
  53128. frontUVs?: Vector4;
  53129. backUVs?: Vector4;
  53130. instance?: Mesh;
  53131. invertUV?: boolean;
  53132. }, scene?: Nullable<Scene>): Mesh;
  53133. /**
  53134. * Creates an custom extruded shape mesh.
  53135. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53136. * * 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.
  53137. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53138. * * 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
  53139. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53140. * * 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
  53141. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53142. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53143. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53144. * * 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
  53145. * * 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
  53146. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53147. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53148. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53149. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53150. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53151. * @param name defines the name of the mesh
  53152. * @param options defines the options used to create the mesh
  53153. * @param scene defines the hosting scene
  53154. * @returns the custom extruded shape mesh
  53155. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53156. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53157. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53158. */
  53159. static ExtrudeShapeCustom(name: string, options: {
  53160. shape: Vector3[];
  53161. path: Vector3[];
  53162. scaleFunction?: any;
  53163. rotationFunction?: any;
  53164. ribbonCloseArray?: boolean;
  53165. ribbonClosePath?: boolean;
  53166. cap?: number;
  53167. updatable?: boolean;
  53168. sideOrientation?: number;
  53169. frontUVs?: Vector4;
  53170. backUVs?: Vector4;
  53171. instance?: Mesh;
  53172. invertUV?: boolean;
  53173. }, scene?: Nullable<Scene>): Mesh;
  53174. private static _ExtrudeShapeGeneric;
  53175. }
  53176. }
  53177. declare module "babylonjs/Debug/skeletonViewer" {
  53178. import { Color3 } from "babylonjs/Maths/math.color";
  53179. import { Scene } from "babylonjs/scene";
  53180. import { Nullable } from "babylonjs/types";
  53181. import { Skeleton } from "babylonjs/Bones/skeleton";
  53182. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53183. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53184. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53185. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  53186. import { ISkeletonViewerOptions } from "babylonjs/Debug/ISkeletonViewer";
  53187. /**
  53188. * Class used to render a debug view of a given skeleton
  53189. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53190. */
  53191. export class SkeletonViewer {
  53192. /** defines the skeleton to render */
  53193. skeleton: Skeleton;
  53194. /** defines the mesh attached to the skeleton */
  53195. mesh: AbstractMesh;
  53196. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53197. autoUpdateBonesMatrices: boolean;
  53198. /** defines the rendering group id to use with the viewer */
  53199. renderingGroupId: number;
  53200. /** is the options for the viewer */
  53201. options: Partial<ISkeletonViewerOptions>;
  53202. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53203. static readonly DISPLAY_LINES: number;
  53204. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53205. static readonly DISPLAY_SPHERES: number;
  53206. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53207. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53208. /** If SkeletonViewer scene scope. */
  53209. private _scene;
  53210. /** Gets or sets the color used to render the skeleton */
  53211. color: Color3;
  53212. /** Array of the points of the skeleton fo the line view. */
  53213. private _debugLines;
  53214. /** The SkeletonViewers Mesh. */
  53215. private _debugMesh;
  53216. /** If SkeletonViewer is enabled. */
  53217. private _isEnabled;
  53218. /** If SkeletonViewer is ready. */
  53219. private _ready;
  53220. /** SkeletonViewer render observable. */
  53221. private _obs;
  53222. /** The Utility Layer to render the gizmos in. */
  53223. private _utilityLayer;
  53224. private _boneIndices;
  53225. /** Gets the Scene. */
  53226. get scene(): Scene;
  53227. /** Gets the utilityLayer. */
  53228. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53229. /** Checks Ready Status. */
  53230. get isReady(): Boolean;
  53231. /** Sets Ready Status. */
  53232. set ready(value: boolean);
  53233. /** Gets the debugMesh */
  53234. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53235. /** Sets the debugMesh */
  53236. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53237. /** Gets the material */
  53238. get material(): StandardMaterial;
  53239. /** Sets the material */
  53240. set material(value: StandardMaterial);
  53241. /** Gets the material */
  53242. get displayMode(): number;
  53243. /** Sets the material */
  53244. set displayMode(value: number);
  53245. /**
  53246. * Creates a new SkeletonViewer
  53247. * @param skeleton defines the skeleton to render
  53248. * @param mesh defines the mesh attached to the skeleton
  53249. * @param scene defines the hosting scene
  53250. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53251. * @param renderingGroupId defines the rendering group id to use with the viewer
  53252. * @param options All of the extra constructor options for the SkeletonViewer
  53253. */
  53254. constructor(
  53255. /** defines the skeleton to render */
  53256. skeleton: Skeleton,
  53257. /** defines the mesh attached to the skeleton */
  53258. mesh: AbstractMesh,
  53259. /** The Scene scope*/
  53260. scene: Scene,
  53261. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53262. autoUpdateBonesMatrices?: boolean,
  53263. /** defines the rendering group id to use with the viewer */
  53264. renderingGroupId?: number,
  53265. /** is the options for the viewer */
  53266. options?: Partial<ISkeletonViewerOptions>);
  53267. /** The Dynamic bindings for the update functions */
  53268. private _bindObs;
  53269. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53270. update(): void;
  53271. /** Gets or sets a boolean indicating if the viewer is enabled */
  53272. set isEnabled(value: boolean);
  53273. get isEnabled(): boolean;
  53274. private _getBonePosition;
  53275. private _getLinesForBonesWithLength;
  53276. private _getLinesForBonesNoLength;
  53277. /** function to revert the mesh and scene back to the initial state. */
  53278. private _revert;
  53279. /** function to build and bind sphere joint points and spur bone representations. */
  53280. private _buildSpheresAndSpurs;
  53281. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53282. private _displayLinesUpdate;
  53283. /** Changes the displayMode of the skeleton viewer
  53284. * @param mode The displayMode numerical value
  53285. */
  53286. changeDisplayMode(mode: number): void;
  53287. /** Changes the displayMode of the skeleton viewer
  53288. * @param option String of the option name
  53289. * @param value The numerical option value
  53290. */
  53291. changeDisplayOptions(option: string, value: number): void;
  53292. /** Release associated resources */
  53293. dispose(): void;
  53294. }
  53295. }
  53296. declare module "babylonjs/Debug/index" {
  53297. export * from "babylonjs/Debug/axesViewer";
  53298. export * from "babylonjs/Debug/boneAxesViewer";
  53299. export * from "babylonjs/Debug/debugLayer";
  53300. export * from "babylonjs/Debug/physicsViewer";
  53301. export * from "babylonjs/Debug/rayHelper";
  53302. export * from "babylonjs/Debug/skeletonViewer";
  53303. export * from "babylonjs/Debug/ISkeletonViewer";
  53304. }
  53305. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53306. /**
  53307. * Enum for Device Types
  53308. */
  53309. export enum DeviceType {
  53310. /** Generic */
  53311. Generic = 0,
  53312. /** Keyboard */
  53313. Keyboard = 1,
  53314. /** Mouse */
  53315. Mouse = 2,
  53316. /** Touch Pointers */
  53317. Touch = 3,
  53318. /** PS4 Dual Shock */
  53319. DualShock = 4,
  53320. /** Xbox */
  53321. Xbox = 5,
  53322. /** Switch Controller */
  53323. Switch = 6
  53324. }
  53325. /**
  53326. * Enum for All Pointers (Touch/Mouse)
  53327. */
  53328. export enum PointerInput {
  53329. /** Horizontal Axis */
  53330. Horizontal = 0,
  53331. /** Vertical Axis */
  53332. Vertical = 1,
  53333. /** Left Click or Touch */
  53334. LeftClick = 2,
  53335. /** Middle Click */
  53336. MiddleClick = 3,
  53337. /** Right Click */
  53338. RightClick = 4,
  53339. /** Browser Back */
  53340. BrowserBack = 5,
  53341. /** Browser Forward */
  53342. BrowserForward = 6
  53343. }
  53344. /**
  53345. * Enum for Dual Shock Gamepad
  53346. */
  53347. export enum DualShockInput {
  53348. /** Cross */
  53349. Cross = 0,
  53350. /** Circle */
  53351. Circle = 1,
  53352. /** Square */
  53353. Square = 2,
  53354. /** Triangle */
  53355. Triangle = 3,
  53356. /** L1 */
  53357. L1 = 4,
  53358. /** R1 */
  53359. R1 = 5,
  53360. /** L2 */
  53361. L2 = 6,
  53362. /** R2 */
  53363. R2 = 7,
  53364. /** Share */
  53365. Share = 8,
  53366. /** Options */
  53367. Options = 9,
  53368. /** L3 */
  53369. L3 = 10,
  53370. /** R3 */
  53371. R3 = 11,
  53372. /** DPadUp */
  53373. DPadUp = 12,
  53374. /** DPadDown */
  53375. DPadDown = 13,
  53376. /** DPadLeft */
  53377. DPadLeft = 14,
  53378. /** DRight */
  53379. DPadRight = 15,
  53380. /** Home */
  53381. Home = 16,
  53382. /** TouchPad */
  53383. TouchPad = 17,
  53384. /** LStickXAxis */
  53385. LStickXAxis = 18,
  53386. /** LStickYAxis */
  53387. LStickYAxis = 19,
  53388. /** RStickXAxis */
  53389. RStickXAxis = 20,
  53390. /** RStickYAxis */
  53391. RStickYAxis = 21
  53392. }
  53393. /**
  53394. * Enum for Xbox Gamepad
  53395. */
  53396. export enum XboxInput {
  53397. /** A */
  53398. A = 0,
  53399. /** B */
  53400. B = 1,
  53401. /** X */
  53402. X = 2,
  53403. /** Y */
  53404. Y = 3,
  53405. /** LB */
  53406. LB = 4,
  53407. /** RB */
  53408. RB = 5,
  53409. /** LT */
  53410. LT = 6,
  53411. /** RT */
  53412. RT = 7,
  53413. /** Back */
  53414. Back = 8,
  53415. /** Start */
  53416. Start = 9,
  53417. /** LS */
  53418. LS = 10,
  53419. /** RS */
  53420. RS = 11,
  53421. /** DPadUp */
  53422. DPadUp = 12,
  53423. /** DPadDown */
  53424. DPadDown = 13,
  53425. /** DPadLeft */
  53426. DPadLeft = 14,
  53427. /** DRight */
  53428. DPadRight = 15,
  53429. /** Home */
  53430. Home = 16,
  53431. /** LStickXAxis */
  53432. LStickXAxis = 17,
  53433. /** LStickYAxis */
  53434. LStickYAxis = 18,
  53435. /** RStickXAxis */
  53436. RStickXAxis = 19,
  53437. /** RStickYAxis */
  53438. RStickYAxis = 20
  53439. }
  53440. /**
  53441. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53442. */
  53443. export enum SwitchInput {
  53444. /** B */
  53445. B = 0,
  53446. /** A */
  53447. A = 1,
  53448. /** Y */
  53449. Y = 2,
  53450. /** X */
  53451. X = 3,
  53452. /** L */
  53453. L = 4,
  53454. /** R */
  53455. R = 5,
  53456. /** ZL */
  53457. ZL = 6,
  53458. /** ZR */
  53459. ZR = 7,
  53460. /** Minus */
  53461. Minus = 8,
  53462. /** Plus */
  53463. Plus = 9,
  53464. /** LS */
  53465. LS = 10,
  53466. /** RS */
  53467. RS = 11,
  53468. /** DPadUp */
  53469. DPadUp = 12,
  53470. /** DPadDown */
  53471. DPadDown = 13,
  53472. /** DPadLeft */
  53473. DPadLeft = 14,
  53474. /** DRight */
  53475. DPadRight = 15,
  53476. /** Home */
  53477. Home = 16,
  53478. /** Capture */
  53479. Capture = 17,
  53480. /** LStickXAxis */
  53481. LStickXAxis = 18,
  53482. /** LStickYAxis */
  53483. LStickYAxis = 19,
  53484. /** RStickXAxis */
  53485. RStickXAxis = 20,
  53486. /** RStickYAxis */
  53487. RStickYAxis = 21
  53488. }
  53489. }
  53490. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53491. import { Engine } from "babylonjs/Engines/engine";
  53492. import { IDisposable } from "babylonjs/scene";
  53493. import { Nullable } from "babylonjs/types";
  53494. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53495. /**
  53496. * This class will take all inputs from Keyboard, Pointer, and
  53497. * any Gamepads and provide a polling system that all devices
  53498. * will use. This class assumes that there will only be one
  53499. * pointer device and one keyboard.
  53500. */
  53501. export class DeviceInputSystem implements IDisposable {
  53502. /**
  53503. * Callback to be triggered when a device is connected
  53504. */
  53505. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53506. /**
  53507. * Callback to be triggered when a device is disconnected
  53508. */
  53509. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53510. /**
  53511. * Callback to be triggered when event driven input is updated
  53512. */
  53513. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53514. private _inputs;
  53515. private _gamepads;
  53516. private _keyboardActive;
  53517. private _pointerActive;
  53518. private _elementToAttachTo;
  53519. private _keyboardDownEvent;
  53520. private _keyboardUpEvent;
  53521. private _pointerMoveEvent;
  53522. private _pointerDownEvent;
  53523. private _pointerUpEvent;
  53524. private _gamepadConnectedEvent;
  53525. private _gamepadDisconnectedEvent;
  53526. private static _MAX_KEYCODES;
  53527. private static _MAX_POINTER_INPUTS;
  53528. private constructor();
  53529. /**
  53530. * Creates a new DeviceInputSystem instance
  53531. * @param engine Engine to pull input element from
  53532. * @returns The new instance
  53533. */
  53534. static Create(engine: Engine): DeviceInputSystem;
  53535. /**
  53536. * Checks for current device input value, given an id and input index
  53537. * @param deviceName Id of connected device
  53538. * @param inputIndex Index of device input
  53539. * @returns Current value of input
  53540. */
  53541. /**
  53542. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53543. * @param deviceType Enum specifiying device type
  53544. * @param deviceSlot "Slot" or index that device is referenced in
  53545. * @param inputIndex Id of input to be checked
  53546. * @returns Current value of input
  53547. */
  53548. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53549. /**
  53550. * Dispose of all the eventlisteners
  53551. */
  53552. dispose(): void;
  53553. /**
  53554. * Add device and inputs to device array
  53555. * @param deviceType Enum specifiying device type
  53556. * @param deviceSlot "Slot" or index that device is referenced in
  53557. * @param numberOfInputs Number of input entries to create for given device
  53558. */
  53559. private _registerDevice;
  53560. /**
  53561. * Given a specific device name, remove that device from the device map
  53562. * @param deviceType Enum specifiying device type
  53563. * @param deviceSlot "Slot" or index that device is referenced in
  53564. */
  53565. private _unregisterDevice;
  53566. /**
  53567. * Handle all actions that come from keyboard interaction
  53568. */
  53569. private _handleKeyActions;
  53570. /**
  53571. * Handle all actions that come from pointer interaction
  53572. */
  53573. private _handlePointerActions;
  53574. /**
  53575. * Handle all actions that come from gamepad interaction
  53576. */
  53577. private _handleGamepadActions;
  53578. /**
  53579. * Update all non-event based devices with each frame
  53580. * @param deviceType Enum specifiying device type
  53581. * @param deviceSlot "Slot" or index that device is referenced in
  53582. * @param inputIndex Id of input to be checked
  53583. */
  53584. private _updateDevice;
  53585. /**
  53586. * Gets DeviceType from the device name
  53587. * @param deviceName Name of Device from DeviceInputSystem
  53588. * @returns DeviceType enum value
  53589. */
  53590. private _getGamepadDeviceType;
  53591. }
  53592. }
  53593. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53594. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53595. /**
  53596. * Type to handle enforcement of inputs
  53597. */
  53598. 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;
  53599. }
  53600. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53601. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53602. import { Engine } from "babylonjs/Engines/engine";
  53603. import { IDisposable } from "babylonjs/scene";
  53604. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53605. import { Nullable } from "babylonjs/types";
  53606. import { Observable } from "babylonjs/Misc/observable";
  53607. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53608. /**
  53609. * Class that handles all input for a specific device
  53610. */
  53611. export class DeviceSource<T extends DeviceType> {
  53612. /** Type of device */
  53613. readonly deviceType: DeviceType;
  53614. /** "Slot" or index that device is referenced in */
  53615. readonly deviceSlot: number;
  53616. /**
  53617. * Observable to handle device input changes per device
  53618. */
  53619. readonly onInputChangedObservable: Observable<{
  53620. inputIndex: DeviceInput<T>;
  53621. previousState: Nullable<number>;
  53622. currentState: Nullable<number>;
  53623. }>;
  53624. private readonly _deviceInputSystem;
  53625. /**
  53626. * Default Constructor
  53627. * @param deviceInputSystem Reference to DeviceInputSystem
  53628. * @param deviceType Type of device
  53629. * @param deviceSlot "Slot" or index that device is referenced in
  53630. */
  53631. constructor(deviceInputSystem: DeviceInputSystem,
  53632. /** Type of device */
  53633. deviceType: DeviceType,
  53634. /** "Slot" or index that device is referenced in */
  53635. deviceSlot?: number);
  53636. /**
  53637. * Get input for specific input
  53638. * @param inputIndex index of specific input on device
  53639. * @returns Input value from DeviceInputSystem
  53640. */
  53641. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  53642. }
  53643. /**
  53644. * Class to keep track of devices
  53645. */
  53646. export class DeviceSourceManager implements IDisposable {
  53647. /**
  53648. * Observable to be triggered when before a device is connected
  53649. */
  53650. readonly onBeforeDeviceConnectedObservable: Observable<{
  53651. deviceType: DeviceType;
  53652. deviceSlot: number;
  53653. }>;
  53654. /**
  53655. * Observable to be triggered when before a device is disconnected
  53656. */
  53657. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53658. deviceType: DeviceType;
  53659. deviceSlot: number;
  53660. }>;
  53661. /**
  53662. * Observable to be triggered when after a device is connected
  53663. */
  53664. readonly onAfterDeviceConnectedObservable: Observable<{
  53665. deviceType: DeviceType;
  53666. deviceSlot: number;
  53667. }>;
  53668. /**
  53669. * Observable to be triggered when after a device is disconnected
  53670. */
  53671. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53672. deviceType: DeviceType;
  53673. deviceSlot: number;
  53674. }>;
  53675. private readonly _devices;
  53676. private readonly _firstDevice;
  53677. private readonly _deviceInputSystem;
  53678. /**
  53679. * Default Constructor
  53680. * @param engine engine to pull input element from
  53681. */
  53682. constructor(engine: Engine);
  53683. /**
  53684. * Gets a DeviceSource, given a type and slot
  53685. * @param deviceType Enum specifying device type
  53686. * @param deviceSlot "Slot" or index that device is referenced in
  53687. * @returns DeviceSource object
  53688. */
  53689. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53690. /**
  53691. * Gets an array of DeviceSource objects for a given device type
  53692. * @param deviceType Enum specifying device type
  53693. * @returns Array of DeviceSource objects
  53694. */
  53695. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53696. /**
  53697. * Dispose of DeviceInputSystem and other parts
  53698. */
  53699. dispose(): void;
  53700. /**
  53701. * Function to add device name to device list
  53702. * @param deviceType Enum specifying device type
  53703. * @param deviceSlot "Slot" or index that device is referenced in
  53704. */
  53705. private _addDevice;
  53706. /**
  53707. * Function to remove device name to device list
  53708. * @param deviceType Enum specifying device type
  53709. * @param deviceSlot "Slot" or index that device is referenced in
  53710. */
  53711. private _removeDevice;
  53712. /**
  53713. * Updates array storing first connected device of each type
  53714. * @param type Type of Device
  53715. */
  53716. private _updateFirstDevices;
  53717. }
  53718. }
  53719. declare module "babylonjs/DeviceInput/index" {
  53720. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53721. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53722. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53723. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53724. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53725. }
  53726. declare module "babylonjs/Engines/nullEngine" {
  53727. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53728. import { Engine } from "babylonjs/Engines/engine";
  53729. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53730. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53731. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53732. import { Effect } from "babylonjs/Materials/effect";
  53733. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53734. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53735. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53736. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53737. /**
  53738. * Options to create the null engine
  53739. */
  53740. export class NullEngineOptions {
  53741. /**
  53742. * Render width (Default: 512)
  53743. */
  53744. renderWidth: number;
  53745. /**
  53746. * Render height (Default: 256)
  53747. */
  53748. renderHeight: number;
  53749. /**
  53750. * Texture size (Default: 512)
  53751. */
  53752. textureSize: number;
  53753. /**
  53754. * If delta time between frames should be constant
  53755. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53756. */
  53757. deterministicLockstep: boolean;
  53758. /**
  53759. * Maximum about of steps between frames (Default: 4)
  53760. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53761. */
  53762. lockstepMaxSteps: number;
  53763. /**
  53764. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53765. */
  53766. useHighPrecisionMatrix?: boolean;
  53767. }
  53768. /**
  53769. * The null engine class provides support for headless version of babylon.js.
  53770. * This can be used in server side scenario or for testing purposes
  53771. */
  53772. export class NullEngine extends Engine {
  53773. private _options;
  53774. /**
  53775. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53776. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53777. * @returns true if engine is in deterministic lock step mode
  53778. */
  53779. isDeterministicLockStep(): boolean;
  53780. /**
  53781. * Gets the max steps when engine is running in deterministic lock step
  53782. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53783. * @returns the max steps
  53784. */
  53785. getLockstepMaxSteps(): number;
  53786. /**
  53787. * Gets the current hardware scaling level.
  53788. * By default the hardware scaling level is computed from the window device ratio.
  53789. * 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.
  53790. * @returns a number indicating the current hardware scaling level
  53791. */
  53792. getHardwareScalingLevel(): number;
  53793. constructor(options?: NullEngineOptions);
  53794. /**
  53795. * Creates a vertex buffer
  53796. * @param vertices the data for the vertex buffer
  53797. * @returns the new WebGL static buffer
  53798. */
  53799. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53800. /**
  53801. * Creates a new index buffer
  53802. * @param indices defines the content of the index buffer
  53803. * @param updatable defines if the index buffer must be updatable
  53804. * @returns a new webGL buffer
  53805. */
  53806. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53807. /**
  53808. * Clear the current render buffer or the current render target (if any is set up)
  53809. * @param color defines the color to use
  53810. * @param backBuffer defines if the back buffer must be cleared
  53811. * @param depth defines if the depth buffer must be cleared
  53812. * @param stencil defines if the stencil buffer must be cleared
  53813. */
  53814. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53815. /**
  53816. * Gets the current render width
  53817. * @param useScreen defines if screen size must be used (or the current render target if any)
  53818. * @returns a number defining the current render width
  53819. */
  53820. getRenderWidth(useScreen?: boolean): number;
  53821. /**
  53822. * Gets the current render height
  53823. * @param useScreen defines if screen size must be used (or the current render target if any)
  53824. * @returns a number defining the current render height
  53825. */
  53826. getRenderHeight(useScreen?: boolean): number;
  53827. /**
  53828. * Set the WebGL's viewport
  53829. * @param viewport defines the viewport element to be used
  53830. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53831. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53832. */
  53833. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53834. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53835. /**
  53836. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53837. * @param pipelineContext defines the pipeline context to use
  53838. * @param uniformsNames defines the list of uniform names
  53839. * @returns an array of webGL uniform locations
  53840. */
  53841. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53842. /**
  53843. * Gets the lsit of active attributes for a given webGL program
  53844. * @param pipelineContext defines the pipeline context to use
  53845. * @param attributesNames defines the list of attribute names to get
  53846. * @returns an array of indices indicating the offset of each attribute
  53847. */
  53848. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53849. /**
  53850. * Binds an effect to the webGL context
  53851. * @param effect defines the effect to bind
  53852. */
  53853. bindSamplers(effect: Effect): void;
  53854. /**
  53855. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53856. * @param effect defines the effect to activate
  53857. */
  53858. enableEffect(effect: Effect): void;
  53859. /**
  53860. * Set various states to the webGL context
  53861. * @param culling defines backface culling state
  53862. * @param zOffset defines the value to apply to zOffset (0 by default)
  53863. * @param force defines if states must be applied even if cache is up to date
  53864. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53865. */
  53866. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53867. /**
  53868. * Set the value of an uniform to an array of int32
  53869. * @param uniform defines the webGL uniform location where to store the value
  53870. * @param array defines the array of int32 to store
  53871. */
  53872. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53873. /**
  53874. * Set the value of an uniform to an array of int32 (stored as vec2)
  53875. * @param uniform defines the webGL uniform location where to store the value
  53876. * @param array defines the array of int32 to store
  53877. */
  53878. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53879. /**
  53880. * Set the value of an uniform to an array of int32 (stored as vec3)
  53881. * @param uniform defines the webGL uniform location where to store the value
  53882. * @param array defines the array of int32 to store
  53883. */
  53884. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53885. /**
  53886. * Set the value of an uniform to an array of int32 (stored as vec4)
  53887. * @param uniform defines the webGL uniform location where to store the value
  53888. * @param array defines the array of int32 to store
  53889. */
  53890. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53891. /**
  53892. * Set the value of an uniform to an array of float32
  53893. * @param uniform defines the webGL uniform location where to store the value
  53894. * @param array defines the array of float32 to store
  53895. */
  53896. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53897. /**
  53898. * Set the value of an uniform to an array of float32 (stored as vec2)
  53899. * @param uniform defines the webGL uniform location where to store the value
  53900. * @param array defines the array of float32 to store
  53901. */
  53902. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53903. /**
  53904. * Set the value of an uniform to an array of float32 (stored as vec3)
  53905. * @param uniform defines the webGL uniform location where to store the value
  53906. * @param array defines the array of float32 to store
  53907. */
  53908. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53909. /**
  53910. * Set the value of an uniform to an array of float32 (stored as vec4)
  53911. * @param uniform defines the webGL uniform location where to store the value
  53912. * @param array defines the array of float32 to store
  53913. */
  53914. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53915. /**
  53916. * Set the value of an uniform to an array of number
  53917. * @param uniform defines the webGL uniform location where to store the value
  53918. * @param array defines the array of number to store
  53919. */
  53920. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  53921. /**
  53922. * Set the value of an uniform to an array of number (stored as vec2)
  53923. * @param uniform defines the webGL uniform location where to store the value
  53924. * @param array defines the array of number to store
  53925. */
  53926. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  53927. /**
  53928. * Set the value of an uniform to an array of number (stored as vec3)
  53929. * @param uniform defines the webGL uniform location where to store the value
  53930. * @param array defines the array of number to store
  53931. */
  53932. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  53933. /**
  53934. * Set the value of an uniform to an array of number (stored as vec4)
  53935. * @param uniform defines the webGL uniform location where to store the value
  53936. * @param array defines the array of number to store
  53937. */
  53938. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  53939. /**
  53940. * Set the value of an uniform to an array of float32 (stored as matrices)
  53941. * @param uniform defines the webGL uniform location where to store the value
  53942. * @param matrices defines the array of float32 to store
  53943. */
  53944. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  53945. /**
  53946. * Set the value of an uniform to a matrix (3x3)
  53947. * @param uniform defines the webGL uniform location where to store the value
  53948. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  53949. */
  53950. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53951. /**
  53952. * Set the value of an uniform to a matrix (2x2)
  53953. * @param uniform defines the webGL uniform location where to store the value
  53954. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  53955. */
  53956. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53957. /**
  53958. * Set the value of an uniform to a number (float)
  53959. * @param uniform defines the webGL uniform location where to store the value
  53960. * @param value defines the float number to store
  53961. */
  53962. setFloat(uniform: WebGLUniformLocation, value: number): void;
  53963. /**
  53964. * Set the value of an uniform to a vec2
  53965. * @param uniform defines the webGL uniform location where to store the value
  53966. * @param x defines the 1st component of the value
  53967. * @param y defines the 2nd component of the value
  53968. */
  53969. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  53970. /**
  53971. * Set the value of an uniform to a vec3
  53972. * @param uniform defines the webGL uniform location where to store the value
  53973. * @param x defines the 1st component of the value
  53974. * @param y defines the 2nd component of the value
  53975. * @param z defines the 3rd component of the value
  53976. */
  53977. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  53978. /**
  53979. * Set the value of an uniform to a boolean
  53980. * @param uniform defines the webGL uniform location where to store the value
  53981. * @param bool defines the boolean to store
  53982. */
  53983. setBool(uniform: WebGLUniformLocation, bool: number): void;
  53984. /**
  53985. * Set the value of an uniform to a vec4
  53986. * @param uniform defines the webGL uniform location where to store the value
  53987. * @param x defines the 1st component of the value
  53988. * @param y defines the 2nd component of the value
  53989. * @param z defines the 3rd component of the value
  53990. * @param w defines the 4th component of the value
  53991. */
  53992. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  53993. /**
  53994. * Sets the current alpha mode
  53995. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  53996. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  53997. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  53998. */
  53999. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54000. /**
  54001. * Bind webGl buffers directly to the webGL context
  54002. * @param vertexBuffers defines the vertex buffer to bind
  54003. * @param indexBuffer defines the index buffer to bind
  54004. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  54005. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  54006. * @param effect defines the effect associated with the vertex buffer
  54007. */
  54008. bindBuffers(vertexBuffers: {
  54009. [key: string]: VertexBuffer;
  54010. }, indexBuffer: DataBuffer, effect: Effect): void;
  54011. /**
  54012. * Force the entire cache to be cleared
  54013. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  54014. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  54015. */
  54016. wipeCaches(bruteForce?: boolean): void;
  54017. /**
  54018. * Send a draw order
  54019. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  54020. * @param indexStart defines the starting index
  54021. * @param indexCount defines the number of index to draw
  54022. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54023. */
  54024. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  54025. /**
  54026. * Draw a list of indexed primitives
  54027. * @param fillMode defines the primitive to use
  54028. * @param indexStart defines the starting index
  54029. * @param indexCount defines the number of index to draw
  54030. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54031. */
  54032. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54033. /**
  54034. * Draw a list of unindexed primitives
  54035. * @param fillMode defines the primitive to use
  54036. * @param verticesStart defines the index of first vertex to draw
  54037. * @param verticesCount defines the count of vertices to draw
  54038. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54039. */
  54040. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54041. /** @hidden */
  54042. _createTexture(): WebGLTexture;
  54043. /** @hidden */
  54044. _releaseTexture(texture: InternalTexture): void;
  54045. /**
  54046. * Usually called from Texture.ts.
  54047. * Passed information to create a WebGLTexture
  54048. * @param urlArg defines a value which contains one of the following:
  54049. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54050. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54051. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54052. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54053. * @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)
  54054. * @param scene needed for loading to the correct scene
  54055. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54056. * @param onLoad optional callback to be called upon successful completion
  54057. * @param onError optional callback to be called upon failure
  54058. * @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
  54059. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54060. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54061. * @param forcedExtension defines the extension to use to pick the right loader
  54062. * @param mimeType defines an optional mime type
  54063. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54064. */
  54065. 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;
  54066. /**
  54067. * Creates a new render target texture
  54068. * @param size defines the size of the texture
  54069. * @param options defines the options used to create the texture
  54070. * @returns a new render target texture stored in an InternalTexture
  54071. */
  54072. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54073. /**
  54074. * Update the sampling mode of a given texture
  54075. * @param samplingMode defines the required sampling mode
  54076. * @param texture defines the texture to update
  54077. */
  54078. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54079. /**
  54080. * Binds the frame buffer to the specified texture.
  54081. * @param texture The texture to render to or null for the default canvas
  54082. * @param faceIndex The face of the texture to render to in case of cube texture
  54083. * @param requiredWidth The width of the target to render to
  54084. * @param requiredHeight The height of the target to render to
  54085. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54086. * @param lodLevel defines le lod level to bind to the frame buffer
  54087. */
  54088. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54089. /**
  54090. * Unbind the current render target texture from the webGL context
  54091. * @param texture defines the render target texture to unbind
  54092. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54093. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54094. */
  54095. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54096. /**
  54097. * Creates a dynamic vertex buffer
  54098. * @param vertices the data for the dynamic vertex buffer
  54099. * @returns the new WebGL dynamic buffer
  54100. */
  54101. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54102. /**
  54103. * Update the content of a dynamic texture
  54104. * @param texture defines the texture to update
  54105. * @param canvas defines the canvas containing the source
  54106. * @param invertY defines if data must be stored with Y axis inverted
  54107. * @param premulAlpha defines if alpha is stored as premultiplied
  54108. * @param format defines the format of the data
  54109. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54110. */
  54111. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54112. /**
  54113. * Gets a boolean indicating if all created effects are ready
  54114. * @returns true if all effects are ready
  54115. */
  54116. areAllEffectsReady(): boolean;
  54117. /**
  54118. * @hidden
  54119. * Get the current error code of the webGL context
  54120. * @returns the error code
  54121. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54122. */
  54123. getError(): number;
  54124. /** @hidden */
  54125. _getUnpackAlignement(): number;
  54126. /** @hidden */
  54127. _unpackFlipY(value: boolean): void;
  54128. /**
  54129. * Update a dynamic index buffer
  54130. * @param indexBuffer defines the target index buffer
  54131. * @param indices defines the data to update
  54132. * @param offset defines the offset in the target index buffer where update should start
  54133. */
  54134. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54135. /**
  54136. * Updates a dynamic vertex buffer.
  54137. * @param vertexBuffer the vertex buffer to update
  54138. * @param vertices the data used to update the vertex buffer
  54139. * @param byteOffset the byte offset of the data (optional)
  54140. * @param byteLength the byte length of the data (optional)
  54141. */
  54142. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54143. /** @hidden */
  54144. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54145. /** @hidden */
  54146. _bindTexture(channel: number, texture: InternalTexture): void;
  54147. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54148. /**
  54149. * 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
  54150. */
  54151. releaseEffects(): void;
  54152. displayLoadingUI(): void;
  54153. hideLoadingUI(): void;
  54154. /** @hidden */
  54155. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54156. /** @hidden */
  54157. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54158. /** @hidden */
  54159. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54160. /** @hidden */
  54161. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54162. }
  54163. }
  54164. declare module "babylonjs/Instrumentation/timeToken" {
  54165. import { Nullable } from "babylonjs/types";
  54166. /**
  54167. * @hidden
  54168. **/
  54169. export class _TimeToken {
  54170. _startTimeQuery: Nullable<WebGLQuery>;
  54171. _endTimeQuery: Nullable<WebGLQuery>;
  54172. _timeElapsedQuery: Nullable<WebGLQuery>;
  54173. _timeElapsedQueryEnded: boolean;
  54174. }
  54175. }
  54176. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54177. import { Nullable, int } from "babylonjs/types";
  54178. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54179. /** @hidden */
  54180. export class _OcclusionDataStorage {
  54181. /** @hidden */
  54182. occlusionInternalRetryCounter: number;
  54183. /** @hidden */
  54184. isOcclusionQueryInProgress: boolean;
  54185. /** @hidden */
  54186. isOccluded: boolean;
  54187. /** @hidden */
  54188. occlusionRetryCount: number;
  54189. /** @hidden */
  54190. occlusionType: number;
  54191. /** @hidden */
  54192. occlusionQueryAlgorithmType: number;
  54193. }
  54194. module "babylonjs/Engines/engine" {
  54195. interface Engine {
  54196. /**
  54197. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54198. * @return the new query
  54199. */
  54200. createQuery(): WebGLQuery;
  54201. /**
  54202. * Delete and release a webGL query
  54203. * @param query defines the query to delete
  54204. * @return the current engine
  54205. */
  54206. deleteQuery(query: WebGLQuery): Engine;
  54207. /**
  54208. * Check if a given query has resolved and got its value
  54209. * @param query defines the query to check
  54210. * @returns true if the query got its value
  54211. */
  54212. isQueryResultAvailable(query: WebGLQuery): boolean;
  54213. /**
  54214. * Gets the value of a given query
  54215. * @param query defines the query to check
  54216. * @returns the value of the query
  54217. */
  54218. getQueryResult(query: WebGLQuery): number;
  54219. /**
  54220. * Initiates an occlusion query
  54221. * @param algorithmType defines the algorithm to use
  54222. * @param query defines the query to use
  54223. * @returns the current engine
  54224. * @see https://doc.babylonjs.com/features/occlusionquery
  54225. */
  54226. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54227. /**
  54228. * Ends an occlusion query
  54229. * @see https://doc.babylonjs.com/features/occlusionquery
  54230. * @param algorithmType defines the algorithm to use
  54231. * @returns the current engine
  54232. */
  54233. endOcclusionQuery(algorithmType: number): Engine;
  54234. /**
  54235. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54236. * Please note that only one query can be issued at a time
  54237. * @returns a time token used to track the time span
  54238. */
  54239. startTimeQuery(): Nullable<_TimeToken>;
  54240. /**
  54241. * Ends a time query
  54242. * @param token defines the token used to measure the time span
  54243. * @returns the time spent (in ns)
  54244. */
  54245. endTimeQuery(token: _TimeToken): int;
  54246. /** @hidden */
  54247. _currentNonTimestampToken: Nullable<_TimeToken>;
  54248. /** @hidden */
  54249. _createTimeQuery(): WebGLQuery;
  54250. /** @hidden */
  54251. _deleteTimeQuery(query: WebGLQuery): void;
  54252. /** @hidden */
  54253. _getGlAlgorithmType(algorithmType: number): number;
  54254. /** @hidden */
  54255. _getTimeQueryResult(query: WebGLQuery): any;
  54256. /** @hidden */
  54257. _getTimeQueryAvailability(query: WebGLQuery): any;
  54258. }
  54259. }
  54260. module "babylonjs/Meshes/abstractMesh" {
  54261. interface AbstractMesh {
  54262. /**
  54263. * Backing filed
  54264. * @hidden
  54265. */
  54266. __occlusionDataStorage: _OcclusionDataStorage;
  54267. /**
  54268. * Access property
  54269. * @hidden
  54270. */
  54271. _occlusionDataStorage: _OcclusionDataStorage;
  54272. /**
  54273. * 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.
  54274. * The default value is -1 which means don't break the query and wait till the result
  54275. * @see https://doc.babylonjs.com/features/occlusionquery
  54276. */
  54277. occlusionRetryCount: number;
  54278. /**
  54279. * 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:
  54280. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54281. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54282. * * 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.
  54283. * @see https://doc.babylonjs.com/features/occlusionquery
  54284. */
  54285. occlusionType: number;
  54286. /**
  54287. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54288. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54289. * * 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.
  54290. * @see https://doc.babylonjs.com/features/occlusionquery
  54291. */
  54292. occlusionQueryAlgorithmType: number;
  54293. /**
  54294. * 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
  54295. * @see https://doc.babylonjs.com/features/occlusionquery
  54296. */
  54297. isOccluded: boolean;
  54298. /**
  54299. * Flag to check the progress status of the query
  54300. * @see https://doc.babylonjs.com/features/occlusionquery
  54301. */
  54302. isOcclusionQueryInProgress: boolean;
  54303. }
  54304. }
  54305. }
  54306. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54307. import { Nullable } from "babylonjs/types";
  54308. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54309. /** @hidden */
  54310. export var _forceTransformFeedbackToBundle: boolean;
  54311. module "babylonjs/Engines/engine" {
  54312. interface Engine {
  54313. /**
  54314. * Creates a webGL transform feedback object
  54315. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54316. * @returns the webGL transform feedback object
  54317. */
  54318. createTransformFeedback(): WebGLTransformFeedback;
  54319. /**
  54320. * Delete a webGL transform feedback object
  54321. * @param value defines the webGL transform feedback object to delete
  54322. */
  54323. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54324. /**
  54325. * Bind a webGL transform feedback object to the webgl context
  54326. * @param value defines the webGL transform feedback object to bind
  54327. */
  54328. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54329. /**
  54330. * Begins a transform feedback operation
  54331. * @param usePoints defines if points or triangles must be used
  54332. */
  54333. beginTransformFeedback(usePoints: boolean): void;
  54334. /**
  54335. * Ends a transform feedback operation
  54336. */
  54337. endTransformFeedback(): void;
  54338. /**
  54339. * Specify the varyings to use with transform feedback
  54340. * @param program defines the associated webGL program
  54341. * @param value defines the list of strings representing the varying names
  54342. */
  54343. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54344. /**
  54345. * Bind a webGL buffer for a transform feedback operation
  54346. * @param value defines the webGL buffer to bind
  54347. */
  54348. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54349. }
  54350. }
  54351. }
  54352. declare module "babylonjs/Engines/Extensions/engine.views" {
  54353. import { Camera } from "babylonjs/Cameras/camera";
  54354. import { Nullable } from "babylonjs/types";
  54355. /**
  54356. * Class used to define an additional view for the engine
  54357. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54358. */
  54359. export class EngineView {
  54360. /** Defines the canvas where to render the view */
  54361. target: HTMLCanvasElement;
  54362. /** Defines an optional camera used to render the view (will use active camera else) */
  54363. camera?: Camera;
  54364. }
  54365. module "babylonjs/Engines/engine" {
  54366. interface Engine {
  54367. /**
  54368. * Gets or sets the HTML element to use for attaching events
  54369. */
  54370. inputElement: Nullable<HTMLElement>;
  54371. /**
  54372. * Gets the current engine view
  54373. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54374. */
  54375. activeView: Nullable<EngineView>;
  54376. /** Gets or sets the list of views */
  54377. views: EngineView[];
  54378. /**
  54379. * Register a new child canvas
  54380. * @param canvas defines the canvas to register
  54381. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54382. * @returns the associated view
  54383. */
  54384. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54385. /**
  54386. * Remove a registered child canvas
  54387. * @param canvas defines the canvas to remove
  54388. * @returns the current engine
  54389. */
  54390. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54391. }
  54392. }
  54393. }
  54394. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54395. import { Nullable } from "babylonjs/types";
  54396. module "babylonjs/Engines/engine" {
  54397. interface Engine {
  54398. /** @hidden */
  54399. _excludedCompressedTextures: string[];
  54400. /** @hidden */
  54401. _textureFormatInUse: string;
  54402. /**
  54403. * Gets the list of texture formats supported
  54404. */
  54405. readonly texturesSupported: Array<string>;
  54406. /**
  54407. * Gets the texture format in use
  54408. */
  54409. readonly textureFormatInUse: Nullable<string>;
  54410. /**
  54411. * Set the compressed texture extensions or file names to skip.
  54412. *
  54413. * @param skippedFiles defines the list of those texture files you want to skip
  54414. * Example: [".dds", ".env", "myfile.png"]
  54415. */
  54416. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54417. /**
  54418. * Set the compressed texture format to use, based on the formats you have, and the formats
  54419. * supported by the hardware / browser.
  54420. *
  54421. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54422. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54423. * to API arguments needed to compressed textures. This puts the burden on the container
  54424. * generator to house the arcane code for determining these for current & future formats.
  54425. *
  54426. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54427. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54428. *
  54429. * Note: The result of this call is not taken into account when a texture is base64.
  54430. *
  54431. * @param formatsAvailable defines the list of those format families you have created
  54432. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54433. *
  54434. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54435. * @returns The extension selected.
  54436. */
  54437. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54438. }
  54439. }
  54440. }
  54441. declare module "babylonjs/Engines/Extensions/index" {
  54442. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54443. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54444. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54445. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54446. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54447. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54448. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54449. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54450. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54451. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54452. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54453. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54454. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54455. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54456. export * from "babylonjs/Engines/Extensions/engine.views";
  54457. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54458. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54459. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54460. }
  54461. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54462. import { Nullable } from "babylonjs/types";
  54463. /**
  54464. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54465. */
  54466. export interface CubeMapInfo {
  54467. /**
  54468. * The pixel array for the front face.
  54469. * This is stored in format, left to right, up to down format.
  54470. */
  54471. front: Nullable<ArrayBufferView>;
  54472. /**
  54473. * The pixel array for the back face.
  54474. * This is stored in format, left to right, up to down format.
  54475. */
  54476. back: Nullable<ArrayBufferView>;
  54477. /**
  54478. * The pixel array for the left face.
  54479. * This is stored in format, left to right, up to down format.
  54480. */
  54481. left: Nullable<ArrayBufferView>;
  54482. /**
  54483. * The pixel array for the right face.
  54484. * This is stored in format, left to right, up to down format.
  54485. */
  54486. right: Nullable<ArrayBufferView>;
  54487. /**
  54488. * The pixel array for the up face.
  54489. * This is stored in format, left to right, up to down format.
  54490. */
  54491. up: Nullable<ArrayBufferView>;
  54492. /**
  54493. * The pixel array for the down face.
  54494. * This is stored in format, left to right, up to down format.
  54495. */
  54496. down: Nullable<ArrayBufferView>;
  54497. /**
  54498. * The size of the cubemap stored.
  54499. *
  54500. * Each faces will be size * size pixels.
  54501. */
  54502. size: number;
  54503. /**
  54504. * The format of the texture.
  54505. *
  54506. * RGBA, RGB.
  54507. */
  54508. format: number;
  54509. /**
  54510. * The type of the texture data.
  54511. *
  54512. * UNSIGNED_INT, FLOAT.
  54513. */
  54514. type: number;
  54515. /**
  54516. * Specifies whether the texture is in gamma space.
  54517. */
  54518. gammaSpace: boolean;
  54519. }
  54520. /**
  54521. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54522. */
  54523. export class PanoramaToCubeMapTools {
  54524. private static FACE_LEFT;
  54525. private static FACE_RIGHT;
  54526. private static FACE_FRONT;
  54527. private static FACE_BACK;
  54528. private static FACE_DOWN;
  54529. private static FACE_UP;
  54530. /**
  54531. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54532. *
  54533. * @param float32Array The source data.
  54534. * @param inputWidth The width of the input panorama.
  54535. * @param inputHeight The height of the input panorama.
  54536. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54537. * @return The cubemap data
  54538. */
  54539. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54540. private static CreateCubemapTexture;
  54541. private static CalcProjectionSpherical;
  54542. }
  54543. }
  54544. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54545. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54546. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54547. import { Nullable } from "babylonjs/types";
  54548. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54549. /**
  54550. * Helper class dealing with the extraction of spherical polynomial dataArray
  54551. * from a cube map.
  54552. */
  54553. export class CubeMapToSphericalPolynomialTools {
  54554. private static FileFaces;
  54555. /**
  54556. * Converts a texture to the according Spherical Polynomial data.
  54557. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54558. *
  54559. * @param texture The texture to extract the information from.
  54560. * @return The Spherical Polynomial data.
  54561. */
  54562. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54563. /**
  54564. * Converts a cubemap to the according Spherical Polynomial data.
  54565. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54566. *
  54567. * @param cubeInfo The Cube map to extract the information from.
  54568. * @return The Spherical Polynomial data.
  54569. */
  54570. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54571. }
  54572. }
  54573. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54574. import { Nullable } from "babylonjs/types";
  54575. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54576. module "babylonjs/Materials/Textures/baseTexture" {
  54577. interface BaseTexture {
  54578. /**
  54579. * Get the polynomial representation of the texture data.
  54580. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54581. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54582. */
  54583. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54584. }
  54585. }
  54586. }
  54587. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54588. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54589. /** @hidden */
  54590. export var rgbdEncodePixelShader: {
  54591. name: string;
  54592. shader: string;
  54593. };
  54594. }
  54595. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54596. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54597. /** @hidden */
  54598. export var rgbdDecodePixelShader: {
  54599. name: string;
  54600. shader: string;
  54601. };
  54602. }
  54603. declare module "babylonjs/Misc/environmentTextureTools" {
  54604. import { Nullable } from "babylonjs/types";
  54605. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54606. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54607. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54608. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54609. import "babylonjs/Engines/Extensions/engine.readTexture";
  54610. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54611. import "babylonjs/Shaders/rgbdEncode.fragment";
  54612. import "babylonjs/Shaders/rgbdDecode.fragment";
  54613. /**
  54614. * Raw texture data and descriptor sufficient for WebGL texture upload
  54615. */
  54616. export interface EnvironmentTextureInfo {
  54617. /**
  54618. * Version of the environment map
  54619. */
  54620. version: number;
  54621. /**
  54622. * Width of image
  54623. */
  54624. width: number;
  54625. /**
  54626. * Irradiance information stored in the file.
  54627. */
  54628. irradiance: any;
  54629. /**
  54630. * Specular information stored in the file.
  54631. */
  54632. specular: any;
  54633. }
  54634. /**
  54635. * Defines One Image in the file. It requires only the position in the file
  54636. * as well as the length.
  54637. */
  54638. interface BufferImageData {
  54639. /**
  54640. * Length of the image data.
  54641. */
  54642. length: number;
  54643. /**
  54644. * Position of the data from the null terminator delimiting the end of the JSON.
  54645. */
  54646. position: number;
  54647. }
  54648. /**
  54649. * Defines the specular data enclosed in the file.
  54650. * This corresponds to the version 1 of the data.
  54651. */
  54652. export interface EnvironmentTextureSpecularInfoV1 {
  54653. /**
  54654. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54655. */
  54656. specularDataPosition?: number;
  54657. /**
  54658. * This contains all the images data needed to reconstruct the cubemap.
  54659. */
  54660. mipmaps: Array<BufferImageData>;
  54661. /**
  54662. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54663. */
  54664. lodGenerationScale: number;
  54665. }
  54666. /**
  54667. * Sets of helpers addressing the serialization and deserialization of environment texture
  54668. * stored in a BabylonJS env file.
  54669. * Those files are usually stored as .env files.
  54670. */
  54671. export class EnvironmentTextureTools {
  54672. /**
  54673. * Magic number identifying the env file.
  54674. */
  54675. private static _MagicBytes;
  54676. /**
  54677. * Gets the environment info from an env file.
  54678. * @param data The array buffer containing the .env bytes.
  54679. * @returns the environment file info (the json header) if successfully parsed.
  54680. */
  54681. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54682. /**
  54683. * Creates an environment texture from a loaded cube texture.
  54684. * @param texture defines the cube texture to convert in env file
  54685. * @return a promise containing the environment data if succesfull.
  54686. */
  54687. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54688. /**
  54689. * Creates a JSON representation of the spherical data.
  54690. * @param texture defines the texture containing the polynomials
  54691. * @return the JSON representation of the spherical info
  54692. */
  54693. private static _CreateEnvTextureIrradiance;
  54694. /**
  54695. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54696. * @param data the image data
  54697. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54698. * @return the views described by info providing access to the underlying buffer
  54699. */
  54700. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54701. /**
  54702. * Uploads the texture info contained in the env file to the GPU.
  54703. * @param texture defines the internal texture to upload to
  54704. * @param data defines the data to load
  54705. * @param info defines the texture info retrieved through the GetEnvInfo method
  54706. * @returns a promise
  54707. */
  54708. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54709. private static _OnImageReadyAsync;
  54710. /**
  54711. * Uploads the levels of image data to the GPU.
  54712. * @param texture defines the internal texture to upload to
  54713. * @param imageData defines the array buffer views of image data [mipmap][face]
  54714. * @returns a promise
  54715. */
  54716. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54717. /**
  54718. * Uploads spherical polynomials information to the texture.
  54719. * @param texture defines the texture we are trying to upload the information to
  54720. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54721. */
  54722. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54723. /** @hidden */
  54724. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54725. }
  54726. }
  54727. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54728. /**
  54729. * Class used to inline functions in shader code
  54730. */
  54731. export class ShaderCodeInliner {
  54732. private static readonly _RegexpFindFunctionNameAndType;
  54733. private _sourceCode;
  54734. private _functionDescr;
  54735. private _numMaxIterations;
  54736. /** Gets or sets the token used to mark the functions to inline */
  54737. inlineToken: string;
  54738. /** Gets or sets the debug mode */
  54739. debug: boolean;
  54740. /** Gets the code after the inlining process */
  54741. get code(): string;
  54742. /**
  54743. * Initializes the inliner
  54744. * @param sourceCode shader code source to inline
  54745. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54746. */
  54747. constructor(sourceCode: string, numMaxIterations?: number);
  54748. /**
  54749. * Start the processing of the shader code
  54750. */
  54751. processCode(): void;
  54752. private _collectFunctions;
  54753. private _processInlining;
  54754. private _extractBetweenMarkers;
  54755. private _skipWhitespaces;
  54756. private _removeComments;
  54757. private _replaceFunctionCallsByCode;
  54758. private _findBackward;
  54759. private _escapeRegExp;
  54760. private _replaceNames;
  54761. }
  54762. }
  54763. declare module "babylonjs/Engines/nativeEngine" {
  54764. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54765. import { Engine } from "babylonjs/Engines/engine";
  54766. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54767. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54768. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54769. import { Effect } from "babylonjs/Materials/effect";
  54770. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54771. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54772. import { IColor4Like } from "babylonjs/Maths/math.like";
  54773. import { Scene } from "babylonjs/scene";
  54774. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54775. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54776. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54777. /**
  54778. * Container for accessors for natively-stored mesh data buffers.
  54779. */
  54780. class NativeDataBuffer extends DataBuffer {
  54781. /**
  54782. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54783. */
  54784. nativeIndexBuffer?: any;
  54785. /**
  54786. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54787. */
  54788. nativeVertexBuffer?: any;
  54789. }
  54790. /** @hidden */
  54791. class NativeTexture extends InternalTexture {
  54792. getInternalTexture(): InternalTexture;
  54793. getViewCount(): number;
  54794. }
  54795. /** @hidden */
  54796. export class NativeEngine extends Engine {
  54797. private readonly _native;
  54798. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54799. private readonly INVALID_HANDLE;
  54800. private _boundBuffersVertexArray;
  54801. getHardwareScalingLevel(): number;
  54802. constructor();
  54803. dispose(): void;
  54804. /**
  54805. * Can be used to override the current requestAnimationFrame requester.
  54806. * @hidden
  54807. */
  54808. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54809. /**
  54810. * Override default engine behavior.
  54811. * @param color
  54812. * @param backBuffer
  54813. * @param depth
  54814. * @param stencil
  54815. */
  54816. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54817. /**
  54818. * Gets host document
  54819. * @returns the host document object
  54820. */
  54821. getHostDocument(): Nullable<Document>;
  54822. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54823. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54824. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54825. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  54826. [key: string]: VertexBuffer;
  54827. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54828. bindBuffers(vertexBuffers: {
  54829. [key: string]: VertexBuffer;
  54830. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54831. recordVertexArrayObject(vertexBuffers: {
  54832. [key: string]: VertexBuffer;
  54833. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54834. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54835. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54836. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54837. /**
  54838. * Draw a list of indexed primitives
  54839. * @param fillMode defines the primitive to use
  54840. * @param indexStart defines the starting index
  54841. * @param indexCount defines the number of index to draw
  54842. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54843. */
  54844. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54845. /**
  54846. * Draw a list of unindexed primitives
  54847. * @param fillMode defines the primitive to use
  54848. * @param verticesStart defines the index of first vertex to draw
  54849. * @param verticesCount defines the count of vertices to draw
  54850. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54851. */
  54852. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54853. createPipelineContext(): IPipelineContext;
  54854. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54855. /** @hidden */
  54856. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54857. /** @hidden */
  54858. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54859. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54860. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54861. protected _setProgram(program: WebGLProgram): void;
  54862. _releaseEffect(effect: Effect): void;
  54863. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54864. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54865. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54866. bindSamplers(effect: Effect): void;
  54867. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54868. getRenderWidth(useScreen?: boolean): number;
  54869. getRenderHeight(useScreen?: boolean): number;
  54870. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54871. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54872. /**
  54873. * Set the z offset to apply to current rendering
  54874. * @param value defines the offset to apply
  54875. */
  54876. setZOffset(value: number): void;
  54877. /**
  54878. * Gets the current value of the zOffset
  54879. * @returns the current zOffset state
  54880. */
  54881. getZOffset(): number;
  54882. /**
  54883. * Enable or disable depth buffering
  54884. * @param enable defines the state to set
  54885. */
  54886. setDepthBuffer(enable: boolean): void;
  54887. /**
  54888. * Gets a boolean indicating if depth writing is enabled
  54889. * @returns the current depth writing state
  54890. */
  54891. getDepthWrite(): boolean;
  54892. /**
  54893. * Enable or disable depth writing
  54894. * @param enable defines the state to set
  54895. */
  54896. setDepthWrite(enable: boolean): void;
  54897. /**
  54898. * Enable or disable color writing
  54899. * @param enable defines the state to set
  54900. */
  54901. setColorWrite(enable: boolean): void;
  54902. /**
  54903. * Gets a boolean indicating if color writing is enabled
  54904. * @returns the current color writing state
  54905. */
  54906. getColorWrite(): boolean;
  54907. /**
  54908. * Sets alpha constants used by some alpha blending modes
  54909. * @param r defines the red component
  54910. * @param g defines the green component
  54911. * @param b defines the blue component
  54912. * @param a defines the alpha component
  54913. */
  54914. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  54915. /**
  54916. * Sets the current alpha mode
  54917. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  54918. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54919. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54920. */
  54921. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54922. /**
  54923. * Gets the current alpha mode
  54924. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54925. * @returns the current alpha mode
  54926. */
  54927. getAlphaMode(): number;
  54928. setInt(uniform: WebGLUniformLocation, int: number): void;
  54929. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  54930. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  54931. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  54932. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  54933. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  54934. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  54935. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  54936. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  54937. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54938. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54939. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54940. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54941. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54942. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54943. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54944. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54945. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54946. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54947. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54948. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  54949. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  54950. wipeCaches(bruteForce?: boolean): void;
  54951. _createTexture(): WebGLTexture;
  54952. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  54953. /**
  54954. * Usually called from Texture.ts.
  54955. * Passed information to create a WebGLTexture
  54956. * @param url defines a value which contains one of the following:
  54957. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54958. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54959. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54960. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54961. * @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)
  54962. * @param scene needed for loading to the correct scene
  54963. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54964. * @param onLoad optional callback to be called upon successful completion
  54965. * @param onError optional callback to be called upon failure
  54966. * @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
  54967. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54968. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54969. * @param forcedExtension defines the extension to use to pick the right loader
  54970. * @param mimeType defines an optional mime type
  54971. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54972. */
  54973. 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;
  54974. /**
  54975. * Creates a cube texture
  54976. * @param rootUrl defines the url where the files to load is located
  54977. * @param scene defines the current scene
  54978. * @param files defines the list of files to load (1 per face)
  54979. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  54980. * @param onLoad defines an optional callback raised when the texture is loaded
  54981. * @param onError defines an optional callback raised if there is an issue to load the texture
  54982. * @param format defines the format of the data
  54983. * @param forcedExtension defines the extension to use to pick the right loader
  54984. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  54985. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  54986. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  54987. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  54988. * @returns the cube texture as an InternalTexture
  54989. */
  54990. 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;
  54991. private _getSamplingFilter;
  54992. private static _GetNativeTextureFormat;
  54993. createRenderTargetTexture(size: number | {
  54994. width: number;
  54995. height: number;
  54996. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  54997. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54998. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54999. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  55000. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  55001. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  55002. /**
  55003. * Updates a dynamic vertex buffer.
  55004. * @param vertexBuffer the vertex buffer to update
  55005. * @param data the data used to update the vertex buffer
  55006. * @param byteOffset the byte offset of the data (optional)
  55007. * @param byteLength the byte length of the data (optional)
  55008. */
  55009. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  55010. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  55011. private _updateAnisotropicLevel;
  55012. private _getAddressMode;
  55013. /** @hidden */
  55014. _bindTexture(channel: number, texture: InternalTexture): void;
  55015. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  55016. releaseEffects(): void;
  55017. /** @hidden */
  55018. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55019. /** @hidden */
  55020. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55021. /** @hidden */
  55022. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55023. /** @hidden */
  55024. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  55025. }
  55026. }
  55027. declare module "babylonjs/Engines/index" {
  55028. export * from "babylonjs/Engines/constants";
  55029. export * from "babylonjs/Engines/engineCapabilities";
  55030. export * from "babylonjs/Engines/instancingAttributeInfo";
  55031. export * from "babylonjs/Engines/thinEngine";
  55032. export * from "babylonjs/Engines/engine";
  55033. export * from "babylonjs/Engines/engineStore";
  55034. export * from "babylonjs/Engines/nullEngine";
  55035. export * from "babylonjs/Engines/Extensions/index";
  55036. export * from "babylonjs/Engines/IPipelineContext";
  55037. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  55038. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  55039. export * from "babylonjs/Engines/nativeEngine";
  55040. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  55041. export * from "babylonjs/Engines/performanceConfigurator";
  55042. }
  55043. declare module "babylonjs/Events/clipboardEvents" {
  55044. /**
  55045. * Gather the list of clipboard event types as constants.
  55046. */
  55047. export class ClipboardEventTypes {
  55048. /**
  55049. * The clipboard event is fired when a copy command is active (pressed).
  55050. */
  55051. static readonly COPY: number;
  55052. /**
  55053. * The clipboard event is fired when a cut command is active (pressed).
  55054. */
  55055. static readonly CUT: number;
  55056. /**
  55057. * The clipboard event is fired when a paste command is active (pressed).
  55058. */
  55059. static readonly PASTE: number;
  55060. }
  55061. /**
  55062. * This class is used to store clipboard related info for the onClipboardObservable event.
  55063. */
  55064. export class ClipboardInfo {
  55065. /**
  55066. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55067. */
  55068. type: number;
  55069. /**
  55070. * Defines the related dom event
  55071. */
  55072. event: ClipboardEvent;
  55073. /**
  55074. *Creates an instance of ClipboardInfo.
  55075. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55076. * @param event Defines the related dom event
  55077. */
  55078. constructor(
  55079. /**
  55080. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55081. */
  55082. type: number,
  55083. /**
  55084. * Defines the related dom event
  55085. */
  55086. event: ClipboardEvent);
  55087. /**
  55088. * Get the clipboard event's type from the keycode.
  55089. * @param keyCode Defines the keyCode for the current keyboard event.
  55090. * @return {number}
  55091. */
  55092. static GetTypeFromCharacter(keyCode: number): number;
  55093. }
  55094. }
  55095. declare module "babylonjs/Events/index" {
  55096. export * from "babylonjs/Events/keyboardEvents";
  55097. export * from "babylonjs/Events/pointerEvents";
  55098. export * from "babylonjs/Events/clipboardEvents";
  55099. }
  55100. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55101. import { Scene } from "babylonjs/scene";
  55102. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55103. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55104. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55105. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55106. /**
  55107. * Google Daydream controller
  55108. */
  55109. export class DaydreamController extends WebVRController {
  55110. /**
  55111. * Base Url for the controller model.
  55112. */
  55113. static MODEL_BASE_URL: string;
  55114. /**
  55115. * File name for the controller model.
  55116. */
  55117. static MODEL_FILENAME: string;
  55118. /**
  55119. * Gamepad Id prefix used to identify Daydream Controller.
  55120. */
  55121. static readonly GAMEPAD_ID_PREFIX: string;
  55122. /**
  55123. * Creates a new DaydreamController from a gamepad
  55124. * @param vrGamepad the gamepad that the controller should be created from
  55125. */
  55126. constructor(vrGamepad: any);
  55127. /**
  55128. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55129. * @param scene scene in which to add meshes
  55130. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55131. */
  55132. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55133. /**
  55134. * Called once for each button that changed state since the last frame
  55135. * @param buttonIdx Which button index changed
  55136. * @param state New state of the button
  55137. * @param changes Which properties on the state changed since last frame
  55138. */
  55139. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55140. }
  55141. }
  55142. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55143. import { Scene } from "babylonjs/scene";
  55144. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55145. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55146. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55147. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55148. /**
  55149. * Gear VR Controller
  55150. */
  55151. export class GearVRController extends WebVRController {
  55152. /**
  55153. * Base Url for the controller model.
  55154. */
  55155. static MODEL_BASE_URL: string;
  55156. /**
  55157. * File name for the controller model.
  55158. */
  55159. static MODEL_FILENAME: string;
  55160. /**
  55161. * Gamepad Id prefix used to identify this controller.
  55162. */
  55163. static readonly GAMEPAD_ID_PREFIX: string;
  55164. private readonly _buttonIndexToObservableNameMap;
  55165. /**
  55166. * Creates a new GearVRController from a gamepad
  55167. * @param vrGamepad the gamepad that the controller should be created from
  55168. */
  55169. constructor(vrGamepad: any);
  55170. /**
  55171. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55172. * @param scene scene in which to add meshes
  55173. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55174. */
  55175. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55176. /**
  55177. * Called once for each button that changed state since the last frame
  55178. * @param buttonIdx Which button index changed
  55179. * @param state New state of the button
  55180. * @param changes Which properties on the state changed since last frame
  55181. */
  55182. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55183. }
  55184. }
  55185. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55186. import { Scene } from "babylonjs/scene";
  55187. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55188. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55189. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55190. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55191. /**
  55192. * Generic Controller
  55193. */
  55194. export class GenericController extends WebVRController {
  55195. /**
  55196. * Base Url for the controller model.
  55197. */
  55198. static readonly MODEL_BASE_URL: string;
  55199. /**
  55200. * File name for the controller model.
  55201. */
  55202. static readonly MODEL_FILENAME: string;
  55203. /**
  55204. * Creates a new GenericController from a gamepad
  55205. * @param vrGamepad the gamepad that the controller should be created from
  55206. */
  55207. constructor(vrGamepad: any);
  55208. /**
  55209. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55210. * @param scene scene in which to add meshes
  55211. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55212. */
  55213. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55214. /**
  55215. * Called once for each button that changed state since the last frame
  55216. * @param buttonIdx Which button index changed
  55217. * @param state New state of the button
  55218. * @param changes Which properties on the state changed since last frame
  55219. */
  55220. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55221. }
  55222. }
  55223. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55224. import { Observable } from "babylonjs/Misc/observable";
  55225. import { Scene } from "babylonjs/scene";
  55226. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55227. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55228. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55229. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55230. /**
  55231. * Oculus Touch Controller
  55232. */
  55233. export class OculusTouchController extends WebVRController {
  55234. /**
  55235. * Base Url for the controller model.
  55236. */
  55237. static MODEL_BASE_URL: string;
  55238. /**
  55239. * File name for the left controller model.
  55240. */
  55241. static MODEL_LEFT_FILENAME: string;
  55242. /**
  55243. * File name for the right controller model.
  55244. */
  55245. static MODEL_RIGHT_FILENAME: string;
  55246. /**
  55247. * Base Url for the Quest controller model.
  55248. */
  55249. static QUEST_MODEL_BASE_URL: string;
  55250. /**
  55251. * @hidden
  55252. * If the controllers are running on a device that needs the updated Quest controller models
  55253. */
  55254. static _IsQuest: boolean;
  55255. /**
  55256. * Fired when the secondary trigger on this controller is modified
  55257. */
  55258. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55259. /**
  55260. * Fired when the thumb rest on this controller is modified
  55261. */
  55262. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55263. /**
  55264. * Creates a new OculusTouchController from a gamepad
  55265. * @param vrGamepad the gamepad that the controller should be created from
  55266. */
  55267. constructor(vrGamepad: any);
  55268. /**
  55269. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55270. * @param scene scene in which to add meshes
  55271. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55272. */
  55273. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55274. /**
  55275. * Fired when the A button on this controller is modified
  55276. */
  55277. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55278. /**
  55279. * Fired when the B button on this controller is modified
  55280. */
  55281. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55282. /**
  55283. * Fired when the X button on this controller is modified
  55284. */
  55285. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55286. /**
  55287. * Fired when the Y button on this controller is modified
  55288. */
  55289. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55290. /**
  55291. * Called once for each button that changed state since the last frame
  55292. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55293. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55294. * 2) secondary trigger (same)
  55295. * 3) A (right) X (left), touch, pressed = value
  55296. * 4) B / Y
  55297. * 5) thumb rest
  55298. * @param buttonIdx Which button index changed
  55299. * @param state New state of the button
  55300. * @param changes Which properties on the state changed since last frame
  55301. */
  55302. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55303. }
  55304. }
  55305. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55306. import { Scene } from "babylonjs/scene";
  55307. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55308. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55309. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55310. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55311. import { Observable } from "babylonjs/Misc/observable";
  55312. /**
  55313. * Vive Controller
  55314. */
  55315. export class ViveController extends WebVRController {
  55316. /**
  55317. * Base Url for the controller model.
  55318. */
  55319. static MODEL_BASE_URL: string;
  55320. /**
  55321. * File name for the controller model.
  55322. */
  55323. static MODEL_FILENAME: string;
  55324. /**
  55325. * Creates a new ViveController from a gamepad
  55326. * @param vrGamepad the gamepad that the controller should be created from
  55327. */
  55328. constructor(vrGamepad: any);
  55329. /**
  55330. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55331. * @param scene scene in which to add meshes
  55332. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55333. */
  55334. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55335. /**
  55336. * Fired when the left button on this controller is modified
  55337. */
  55338. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55339. /**
  55340. * Fired when the right button on this controller is modified
  55341. */
  55342. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55343. /**
  55344. * Fired when the menu button on this controller is modified
  55345. */
  55346. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55347. /**
  55348. * Called once for each button that changed state since the last frame
  55349. * Vive mapping:
  55350. * 0: touchpad
  55351. * 1: trigger
  55352. * 2: left AND right buttons
  55353. * 3: menu button
  55354. * @param buttonIdx Which button index changed
  55355. * @param state New state of the button
  55356. * @param changes Which properties on the state changed since last frame
  55357. */
  55358. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55359. }
  55360. }
  55361. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55362. import { Observable } from "babylonjs/Misc/observable";
  55363. import { Scene } from "babylonjs/scene";
  55364. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55365. import { Ray } from "babylonjs/Culling/ray";
  55366. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55367. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55368. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55369. /**
  55370. * Defines the WindowsMotionController object that the state of the windows motion controller
  55371. */
  55372. export class WindowsMotionController extends WebVRController {
  55373. /**
  55374. * The base url used to load the left and right controller models
  55375. */
  55376. static MODEL_BASE_URL: string;
  55377. /**
  55378. * The name of the left controller model file
  55379. */
  55380. static MODEL_LEFT_FILENAME: string;
  55381. /**
  55382. * The name of the right controller model file
  55383. */
  55384. static MODEL_RIGHT_FILENAME: string;
  55385. /**
  55386. * The controller name prefix for this controller type
  55387. */
  55388. static readonly GAMEPAD_ID_PREFIX: string;
  55389. /**
  55390. * The controller id pattern for this controller type
  55391. */
  55392. private static readonly GAMEPAD_ID_PATTERN;
  55393. private _loadedMeshInfo;
  55394. protected readonly _mapping: {
  55395. buttons: string[];
  55396. buttonMeshNames: {
  55397. trigger: string;
  55398. menu: string;
  55399. grip: string;
  55400. thumbstick: string;
  55401. trackpad: string;
  55402. };
  55403. buttonObservableNames: {
  55404. trigger: string;
  55405. menu: string;
  55406. grip: string;
  55407. thumbstick: string;
  55408. trackpad: string;
  55409. };
  55410. axisMeshNames: string[];
  55411. pointingPoseMeshName: string;
  55412. };
  55413. /**
  55414. * Fired when the trackpad on this controller is clicked
  55415. */
  55416. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55417. /**
  55418. * Fired when the trackpad on this controller is modified
  55419. */
  55420. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55421. /**
  55422. * The current x and y values of this controller's trackpad
  55423. */
  55424. trackpad: StickValues;
  55425. /**
  55426. * Creates a new WindowsMotionController from a gamepad
  55427. * @param vrGamepad the gamepad that the controller should be created from
  55428. */
  55429. constructor(vrGamepad: any);
  55430. /**
  55431. * Fired when the trigger on this controller is modified
  55432. */
  55433. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55434. /**
  55435. * Fired when the menu button on this controller is modified
  55436. */
  55437. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55438. /**
  55439. * Fired when the grip button on this controller is modified
  55440. */
  55441. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55442. /**
  55443. * Fired when the thumbstick button on this controller is modified
  55444. */
  55445. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55446. /**
  55447. * Fired when the touchpad button on this controller is modified
  55448. */
  55449. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55450. /**
  55451. * Fired when the touchpad values on this controller are modified
  55452. */
  55453. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55454. protected _updateTrackpad(): void;
  55455. /**
  55456. * Called once per frame by the engine.
  55457. */
  55458. update(): void;
  55459. /**
  55460. * Called once for each button that changed state since the last frame
  55461. * @param buttonIdx Which button index changed
  55462. * @param state New state of the button
  55463. * @param changes Which properties on the state changed since last frame
  55464. */
  55465. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55466. /**
  55467. * Moves the buttons on the controller mesh based on their current state
  55468. * @param buttonName the name of the button to move
  55469. * @param buttonValue the value of the button which determines the buttons new position
  55470. */
  55471. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55472. /**
  55473. * Moves the axis on the controller mesh based on its current state
  55474. * @param axis the index of the axis
  55475. * @param axisValue the value of the axis which determines the meshes new position
  55476. * @hidden
  55477. */
  55478. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55479. /**
  55480. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55481. * @param scene scene in which to add meshes
  55482. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55483. */
  55484. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55485. /**
  55486. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55487. * can be transformed by button presses and axes values, based on this._mapping.
  55488. *
  55489. * @param scene scene in which the meshes exist
  55490. * @param meshes list of meshes that make up the controller model to process
  55491. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55492. */
  55493. private processModel;
  55494. private createMeshInfo;
  55495. /**
  55496. * Gets the ray of the controller in the direction the controller is pointing
  55497. * @param length the length the resulting ray should be
  55498. * @returns a ray in the direction the controller is pointing
  55499. */
  55500. getForwardRay(length?: number): Ray;
  55501. /**
  55502. * Disposes of the controller
  55503. */
  55504. dispose(): void;
  55505. }
  55506. /**
  55507. * This class represents a new windows motion controller in XR.
  55508. */
  55509. export class XRWindowsMotionController extends WindowsMotionController {
  55510. /**
  55511. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55512. */
  55513. protected readonly _mapping: {
  55514. buttons: string[];
  55515. buttonMeshNames: {
  55516. trigger: string;
  55517. menu: string;
  55518. grip: string;
  55519. thumbstick: string;
  55520. trackpad: string;
  55521. };
  55522. buttonObservableNames: {
  55523. trigger: string;
  55524. menu: string;
  55525. grip: string;
  55526. thumbstick: string;
  55527. trackpad: string;
  55528. };
  55529. axisMeshNames: string[];
  55530. pointingPoseMeshName: string;
  55531. };
  55532. /**
  55533. * Construct a new XR-Based windows motion controller
  55534. *
  55535. * @param gamepadInfo the gamepad object from the browser
  55536. */
  55537. constructor(gamepadInfo: any);
  55538. /**
  55539. * holds the thumbstick values (X,Y)
  55540. */
  55541. thumbstickValues: StickValues;
  55542. /**
  55543. * Fired when the thumbstick on this controller is clicked
  55544. */
  55545. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55546. /**
  55547. * Fired when the thumbstick on this controller is modified
  55548. */
  55549. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55550. /**
  55551. * Fired when the touchpad button on this controller is modified
  55552. */
  55553. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55554. /**
  55555. * Fired when the touchpad values on this controller are modified
  55556. */
  55557. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55558. /**
  55559. * Fired when the thumbstick button on this controller is modified
  55560. * here to prevent breaking changes
  55561. */
  55562. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55563. /**
  55564. * updating the thumbstick(!) and not the trackpad.
  55565. * This is named this way due to the difference between WebVR and XR and to avoid
  55566. * changing the parent class.
  55567. */
  55568. protected _updateTrackpad(): void;
  55569. /**
  55570. * Disposes the class with joy
  55571. */
  55572. dispose(): void;
  55573. }
  55574. }
  55575. declare module "babylonjs/Gamepads/Controllers/index" {
  55576. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55577. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55578. export * from "babylonjs/Gamepads/Controllers/genericController";
  55579. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55580. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55581. export * from "babylonjs/Gamepads/Controllers/viveController";
  55582. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55583. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55584. }
  55585. declare module "babylonjs/Gamepads/index" {
  55586. export * from "babylonjs/Gamepads/Controllers/index";
  55587. export * from "babylonjs/Gamepads/gamepad";
  55588. export * from "babylonjs/Gamepads/gamepadManager";
  55589. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55590. export * from "babylonjs/Gamepads/xboxGamepad";
  55591. export * from "babylonjs/Gamepads/dualShockGamepad";
  55592. }
  55593. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55594. import { Scene } from "babylonjs/scene";
  55595. import { Vector4 } from "babylonjs/Maths/math.vector";
  55596. import { Color4 } from "babylonjs/Maths/math.color";
  55597. import { Mesh } from "babylonjs/Meshes/mesh";
  55598. import { Nullable } from "babylonjs/types";
  55599. /**
  55600. * Class containing static functions to help procedurally build meshes
  55601. */
  55602. export class PolyhedronBuilder {
  55603. /**
  55604. * Creates a polyhedron mesh
  55605. * * 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
  55606. * * The parameter `size` (positive float, default 1) sets the polygon size
  55607. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55608. * * 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`
  55609. * * 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
  55610. * * 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)`)
  55611. * * 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
  55612. * * 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
  55613. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55614. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55615. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55616. * @param name defines the name of the mesh
  55617. * @param options defines the options used to create the mesh
  55618. * @param scene defines the hosting scene
  55619. * @returns the polyhedron mesh
  55620. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55621. */
  55622. static CreatePolyhedron(name: string, options: {
  55623. type?: number;
  55624. size?: number;
  55625. sizeX?: number;
  55626. sizeY?: number;
  55627. sizeZ?: number;
  55628. custom?: any;
  55629. faceUV?: Vector4[];
  55630. faceColors?: Color4[];
  55631. flat?: boolean;
  55632. updatable?: boolean;
  55633. sideOrientation?: number;
  55634. frontUVs?: Vector4;
  55635. backUVs?: Vector4;
  55636. }, scene?: Nullable<Scene>): Mesh;
  55637. }
  55638. }
  55639. declare module "babylonjs/Gizmos/scaleGizmo" {
  55640. import { Observable } from "babylonjs/Misc/observable";
  55641. import { Nullable } from "babylonjs/types";
  55642. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55643. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55644. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55645. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55646. import { Node } from "babylonjs/node";
  55647. /**
  55648. * Gizmo that enables scaling a mesh along 3 axis
  55649. */
  55650. export class ScaleGizmo extends Gizmo {
  55651. /**
  55652. * Internal gizmo used for interactions on the x axis
  55653. */
  55654. xGizmo: AxisScaleGizmo;
  55655. /**
  55656. * Internal gizmo used for interactions on the y axis
  55657. */
  55658. yGizmo: AxisScaleGizmo;
  55659. /**
  55660. * Internal gizmo used for interactions on the z axis
  55661. */
  55662. zGizmo: AxisScaleGizmo;
  55663. /**
  55664. * Internal gizmo used to scale all axis equally
  55665. */
  55666. uniformScaleGizmo: AxisScaleGizmo;
  55667. private _meshAttached;
  55668. private _nodeAttached;
  55669. private _snapDistance;
  55670. private _uniformScalingMesh;
  55671. private _octahedron;
  55672. private _sensitivity;
  55673. /** Fires an event when any of it's sub gizmos are dragged */
  55674. onDragStartObservable: Observable<unknown>;
  55675. /** Fires an event when any of it's sub gizmos are released from dragging */
  55676. onDragEndObservable: Observable<unknown>;
  55677. get attachedMesh(): Nullable<AbstractMesh>;
  55678. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55679. get attachedNode(): Nullable<Node>;
  55680. set attachedNode(node: Nullable<Node>);
  55681. /**
  55682. * Creates a ScaleGizmo
  55683. * @param gizmoLayer The utility layer the gizmo will be added to
  55684. * @param thickness display gizmo axis thickness
  55685. */
  55686. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55687. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55688. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55689. /**
  55690. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55691. */
  55692. set snapDistance(value: number);
  55693. get snapDistance(): number;
  55694. /**
  55695. * Ratio for the scale of the gizmo (Default: 1)
  55696. */
  55697. set scaleRatio(value: number);
  55698. get scaleRatio(): number;
  55699. /**
  55700. * Sensitivity factor for dragging (Default: 1)
  55701. */
  55702. set sensitivity(value: number);
  55703. get sensitivity(): number;
  55704. /**
  55705. * Disposes of the gizmo
  55706. */
  55707. dispose(): void;
  55708. }
  55709. }
  55710. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55711. import { Observable } from "babylonjs/Misc/observable";
  55712. import { Nullable } from "babylonjs/types";
  55713. import { Vector3 } from "babylonjs/Maths/math.vector";
  55714. import { Node } from "babylonjs/node";
  55715. import { Mesh } from "babylonjs/Meshes/mesh";
  55716. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55717. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55718. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55719. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55720. import { Color3 } from "babylonjs/Maths/math.color";
  55721. /**
  55722. * Single axis scale gizmo
  55723. */
  55724. export class AxisScaleGizmo extends Gizmo {
  55725. /**
  55726. * Drag behavior responsible for the gizmos dragging interactions
  55727. */
  55728. dragBehavior: PointerDragBehavior;
  55729. private _pointerObserver;
  55730. /**
  55731. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55732. */
  55733. snapDistance: number;
  55734. /**
  55735. * Event that fires each time the gizmo snaps to a new location.
  55736. * * snapDistance is the the change in distance
  55737. */
  55738. onSnapObservable: Observable<{
  55739. snapDistance: number;
  55740. }>;
  55741. /**
  55742. * If the scaling operation should be done on all axis (default: false)
  55743. */
  55744. uniformScaling: boolean;
  55745. /**
  55746. * Custom sensitivity value for the drag strength
  55747. */
  55748. sensitivity: number;
  55749. private _isEnabled;
  55750. private _parent;
  55751. private _arrow;
  55752. private _coloredMaterial;
  55753. private _hoverMaterial;
  55754. /**
  55755. * Creates an AxisScaleGizmo
  55756. * @param gizmoLayer The utility layer the gizmo will be added to
  55757. * @param dragAxis The axis which the gizmo will be able to scale on
  55758. * @param color The color of the gizmo
  55759. * @param thickness display gizmo axis thickness
  55760. */
  55761. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55762. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55763. /**
  55764. * If the gizmo is enabled
  55765. */
  55766. set isEnabled(value: boolean);
  55767. get isEnabled(): boolean;
  55768. /**
  55769. * Disposes of the gizmo
  55770. */
  55771. dispose(): void;
  55772. /**
  55773. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55774. * @param mesh The mesh to replace the default mesh of the gizmo
  55775. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55776. */
  55777. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55778. }
  55779. }
  55780. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55781. import { Observable } from "babylonjs/Misc/observable";
  55782. import { Nullable } from "babylonjs/types";
  55783. import { Vector3 } from "babylonjs/Maths/math.vector";
  55784. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55785. import { Mesh } from "babylonjs/Meshes/mesh";
  55786. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55787. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55788. import { Color3 } from "babylonjs/Maths/math.color";
  55789. import "babylonjs/Meshes/Builders/boxBuilder";
  55790. /**
  55791. * Bounding box gizmo
  55792. */
  55793. export class BoundingBoxGizmo extends Gizmo {
  55794. private _lineBoundingBox;
  55795. private _rotateSpheresParent;
  55796. private _scaleBoxesParent;
  55797. private _boundingDimensions;
  55798. private _renderObserver;
  55799. private _pointerObserver;
  55800. private _scaleDragSpeed;
  55801. private _tmpQuaternion;
  55802. private _tmpVector;
  55803. private _tmpRotationMatrix;
  55804. /**
  55805. * 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)
  55806. */
  55807. ignoreChildren: boolean;
  55808. /**
  55809. * 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)
  55810. */
  55811. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55812. /**
  55813. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55814. */
  55815. rotationSphereSize: number;
  55816. /**
  55817. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55818. */
  55819. scaleBoxSize: number;
  55820. /**
  55821. * 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)
  55822. */
  55823. fixedDragMeshScreenSize: boolean;
  55824. /**
  55825. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55826. */
  55827. fixedDragMeshScreenSizeDistanceFactor: number;
  55828. /**
  55829. * Fired when a rotation sphere or scale box is dragged
  55830. */
  55831. onDragStartObservable: Observable<{}>;
  55832. /**
  55833. * Fired when a scale box is dragged
  55834. */
  55835. onScaleBoxDragObservable: Observable<{}>;
  55836. /**
  55837. * Fired when a scale box drag is ended
  55838. */
  55839. onScaleBoxDragEndObservable: Observable<{}>;
  55840. /**
  55841. * Fired when a rotation sphere is dragged
  55842. */
  55843. onRotationSphereDragObservable: Observable<{}>;
  55844. /**
  55845. * Fired when a rotation sphere drag is ended
  55846. */
  55847. onRotationSphereDragEndObservable: Observable<{}>;
  55848. /**
  55849. * 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)
  55850. */
  55851. scalePivot: Nullable<Vector3>;
  55852. /**
  55853. * Mesh used as a pivot to rotate the attached node
  55854. */
  55855. private _anchorMesh;
  55856. private _existingMeshScale;
  55857. private _dragMesh;
  55858. private pointerDragBehavior;
  55859. private coloredMaterial;
  55860. private hoverColoredMaterial;
  55861. /**
  55862. * Sets the color of the bounding box gizmo
  55863. * @param color the color to set
  55864. */
  55865. setColor(color: Color3): void;
  55866. /**
  55867. * Creates an BoundingBoxGizmo
  55868. * @param gizmoLayer The utility layer the gizmo will be added to
  55869. * @param color The color of the gizmo
  55870. */
  55871. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55872. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55873. private _selectNode;
  55874. /**
  55875. * Updates the bounding box information for the Gizmo
  55876. */
  55877. updateBoundingBox(): void;
  55878. private _updateRotationSpheres;
  55879. private _updateScaleBoxes;
  55880. /**
  55881. * Enables rotation on the specified axis and disables rotation on the others
  55882. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55883. */
  55884. setEnabledRotationAxis(axis: string): void;
  55885. /**
  55886. * Enables/disables scaling
  55887. * @param enable if scaling should be enabled
  55888. * @param homogeneousScaling defines if scaling should only be homogeneous
  55889. */
  55890. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55891. private _updateDummy;
  55892. /**
  55893. * Enables a pointer drag behavior on the bounding box of the gizmo
  55894. */
  55895. enableDragBehavior(): void;
  55896. /**
  55897. * Disposes of the gizmo
  55898. */
  55899. dispose(): void;
  55900. /**
  55901. * 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)
  55902. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55903. * @returns the bounding box mesh with the passed in mesh as a child
  55904. */
  55905. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55906. /**
  55907. * CustomMeshes are not supported by this gizmo
  55908. * @param mesh The mesh to replace the default mesh of the gizmo
  55909. */
  55910. setCustomMesh(mesh: Mesh): void;
  55911. }
  55912. }
  55913. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  55914. import { Observable } from "babylonjs/Misc/observable";
  55915. import { Nullable } from "babylonjs/types";
  55916. import { Vector3 } from "babylonjs/Maths/math.vector";
  55917. import { Color3 } from "babylonjs/Maths/math.color";
  55918. import { Node } from "babylonjs/node";
  55919. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55920. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55921. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55922. import "babylonjs/Meshes/Builders/linesBuilder";
  55923. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55924. /**
  55925. * Single plane rotation gizmo
  55926. */
  55927. export class PlaneRotationGizmo extends Gizmo {
  55928. /**
  55929. * Drag behavior responsible for the gizmos dragging interactions
  55930. */
  55931. dragBehavior: PointerDragBehavior;
  55932. private _pointerObserver;
  55933. /**
  55934. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  55935. */
  55936. snapDistance: number;
  55937. /**
  55938. * Event that fires each time the gizmo snaps to a new location.
  55939. * * snapDistance is the the change in distance
  55940. */
  55941. onSnapObservable: Observable<{
  55942. snapDistance: number;
  55943. }>;
  55944. private _isEnabled;
  55945. private _parent;
  55946. /**
  55947. * Creates a PlaneRotationGizmo
  55948. * @param gizmoLayer The utility layer the gizmo will be added to
  55949. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  55950. * @param color The color of the gizmo
  55951. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55952. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55953. * @param thickness display gizmo axis thickness
  55954. */
  55955. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  55956. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55957. /**
  55958. * If the gizmo is enabled
  55959. */
  55960. set isEnabled(value: boolean);
  55961. get isEnabled(): boolean;
  55962. /**
  55963. * Disposes of the gizmo
  55964. */
  55965. dispose(): void;
  55966. }
  55967. }
  55968. declare module "babylonjs/Gizmos/rotationGizmo" {
  55969. import { Observable } from "babylonjs/Misc/observable";
  55970. import { Nullable } from "babylonjs/types";
  55971. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55972. import { Mesh } from "babylonjs/Meshes/mesh";
  55973. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55974. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  55975. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55976. import { Node } from "babylonjs/node";
  55977. /**
  55978. * Gizmo that enables rotating a mesh along 3 axis
  55979. */
  55980. export class RotationGizmo extends Gizmo {
  55981. /**
  55982. * Internal gizmo used for interactions on the x axis
  55983. */
  55984. xGizmo: PlaneRotationGizmo;
  55985. /**
  55986. * Internal gizmo used for interactions on the y axis
  55987. */
  55988. yGizmo: PlaneRotationGizmo;
  55989. /**
  55990. * Internal gizmo used for interactions on the z axis
  55991. */
  55992. zGizmo: PlaneRotationGizmo;
  55993. /** Fires an event when any of it's sub gizmos are dragged */
  55994. onDragStartObservable: Observable<unknown>;
  55995. /** Fires an event when any of it's sub gizmos are released from dragging */
  55996. onDragEndObservable: Observable<unknown>;
  55997. private _meshAttached;
  55998. private _nodeAttached;
  55999. get attachedMesh(): Nullable<AbstractMesh>;
  56000. set attachedMesh(mesh: Nullable<AbstractMesh>);
  56001. get attachedNode(): Nullable<Node>;
  56002. set attachedNode(node: Nullable<Node>);
  56003. /**
  56004. * Creates a RotationGizmo
  56005. * @param gizmoLayer The utility layer the gizmo will be added to
  56006. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56007. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56008. * @param thickness display gizmo axis thickness
  56009. */
  56010. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  56011. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  56012. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  56013. /**
  56014. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  56015. */
  56016. set snapDistance(value: number);
  56017. get snapDistance(): number;
  56018. /**
  56019. * Ratio for the scale of the gizmo (Default: 1)
  56020. */
  56021. set scaleRatio(value: number);
  56022. get scaleRatio(): number;
  56023. /**
  56024. * Disposes of the gizmo
  56025. */
  56026. dispose(): void;
  56027. /**
  56028. * CustomMeshes are not supported by this gizmo
  56029. * @param mesh The mesh to replace the default mesh of the gizmo
  56030. */
  56031. setCustomMesh(mesh: Mesh): void;
  56032. }
  56033. }
  56034. declare module "babylonjs/Gizmos/gizmoManager" {
  56035. import { Observable } from "babylonjs/Misc/observable";
  56036. import { Nullable } from "babylonjs/types";
  56037. import { Scene, IDisposable } from "babylonjs/scene";
  56038. import { Node } from "babylonjs/node";
  56039. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56040. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56041. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  56042. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56043. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  56044. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56045. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56046. /**
  56047. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56048. */
  56049. export class GizmoManager implements IDisposable {
  56050. private scene;
  56051. /**
  56052. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56053. */
  56054. gizmos: {
  56055. positionGizmo: Nullable<PositionGizmo>;
  56056. rotationGizmo: Nullable<RotationGizmo>;
  56057. scaleGizmo: Nullable<ScaleGizmo>;
  56058. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56059. };
  56060. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56061. clearGizmoOnEmptyPointerEvent: boolean;
  56062. /** Fires an event when the manager is attached to a mesh */
  56063. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56064. /** Fires an event when the manager is attached to a node */
  56065. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56066. private _gizmosEnabled;
  56067. private _pointerObserver;
  56068. private _attachedMesh;
  56069. private _attachedNode;
  56070. private _boundingBoxColor;
  56071. private _defaultUtilityLayer;
  56072. private _defaultKeepDepthUtilityLayer;
  56073. private _thickness;
  56074. /**
  56075. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56076. */
  56077. boundingBoxDragBehavior: SixDofDragBehavior;
  56078. /**
  56079. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56080. */
  56081. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56082. /**
  56083. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56084. */
  56085. attachableNodes: Nullable<Array<Node>>;
  56086. /**
  56087. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56088. */
  56089. usePointerToAttachGizmos: boolean;
  56090. /**
  56091. * Utility layer that the bounding box gizmo belongs to
  56092. */
  56093. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56094. /**
  56095. * Utility layer that all gizmos besides bounding box belong to
  56096. */
  56097. get utilityLayer(): UtilityLayerRenderer;
  56098. /**
  56099. * Instatiates a gizmo manager
  56100. * @param scene the scene to overlay the gizmos on top of
  56101. * @param thickness display gizmo axis thickness
  56102. */
  56103. constructor(scene: Scene, thickness?: number);
  56104. /**
  56105. * Attaches a set of gizmos to the specified mesh
  56106. * @param mesh The mesh the gizmo's should be attached to
  56107. */
  56108. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56109. /**
  56110. * Attaches a set of gizmos to the specified node
  56111. * @param node The node the gizmo's should be attached to
  56112. */
  56113. attachToNode(node: Nullable<Node>): void;
  56114. /**
  56115. * If the position gizmo is enabled
  56116. */
  56117. set positionGizmoEnabled(value: boolean);
  56118. get positionGizmoEnabled(): boolean;
  56119. /**
  56120. * If the rotation gizmo is enabled
  56121. */
  56122. set rotationGizmoEnabled(value: boolean);
  56123. get rotationGizmoEnabled(): boolean;
  56124. /**
  56125. * If the scale gizmo is enabled
  56126. */
  56127. set scaleGizmoEnabled(value: boolean);
  56128. get scaleGizmoEnabled(): boolean;
  56129. /**
  56130. * If the boundingBox gizmo is enabled
  56131. */
  56132. set boundingBoxGizmoEnabled(value: boolean);
  56133. get boundingBoxGizmoEnabled(): boolean;
  56134. /**
  56135. * Disposes of the gizmo manager
  56136. */
  56137. dispose(): void;
  56138. }
  56139. }
  56140. declare module "babylonjs/Lights/directionalLight" {
  56141. import { Camera } from "babylonjs/Cameras/camera";
  56142. import { Scene } from "babylonjs/scene";
  56143. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56144. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56145. import { Light } from "babylonjs/Lights/light";
  56146. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56147. import { Effect } from "babylonjs/Materials/effect";
  56148. /**
  56149. * A directional light is defined by a direction (what a surprise!).
  56150. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56151. * 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.
  56152. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56153. */
  56154. export class DirectionalLight extends ShadowLight {
  56155. private _shadowFrustumSize;
  56156. /**
  56157. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56158. */
  56159. get shadowFrustumSize(): number;
  56160. /**
  56161. * Specifies a fix frustum size for the shadow generation.
  56162. */
  56163. set shadowFrustumSize(value: number);
  56164. private _shadowOrthoScale;
  56165. /**
  56166. * Gets the shadow projection scale against the optimal computed one.
  56167. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56168. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56169. */
  56170. get shadowOrthoScale(): number;
  56171. /**
  56172. * Sets the shadow projection scale against the optimal computed one.
  56173. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56174. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56175. */
  56176. set shadowOrthoScale(value: number);
  56177. /**
  56178. * Automatically compute the projection matrix to best fit (including all the casters)
  56179. * on each frame.
  56180. */
  56181. autoUpdateExtends: boolean;
  56182. /**
  56183. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56184. * on each frame. autoUpdateExtends must be set to true for this to work
  56185. */
  56186. autoCalcShadowZBounds: boolean;
  56187. private _orthoLeft;
  56188. private _orthoRight;
  56189. private _orthoTop;
  56190. private _orthoBottom;
  56191. /**
  56192. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56193. * The directional light is emitted from everywhere in the given direction.
  56194. * It can cast shadows.
  56195. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56196. * @param name The friendly name of the light
  56197. * @param direction The direction of the light
  56198. * @param scene The scene the light belongs to
  56199. */
  56200. constructor(name: string, direction: Vector3, scene: Scene);
  56201. /**
  56202. * Returns the string "DirectionalLight".
  56203. * @return The class name
  56204. */
  56205. getClassName(): string;
  56206. /**
  56207. * Returns the integer 1.
  56208. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56209. */
  56210. getTypeID(): number;
  56211. /**
  56212. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56213. * Returns the DirectionalLight Shadow projection matrix.
  56214. */
  56215. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56216. /**
  56217. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56218. * Returns the DirectionalLight Shadow projection matrix.
  56219. */
  56220. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56221. /**
  56222. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56223. * Returns the DirectionalLight Shadow projection matrix.
  56224. */
  56225. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56226. protected _buildUniformLayout(): void;
  56227. /**
  56228. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56229. * @param effect The effect to update
  56230. * @param lightIndex The index of the light in the effect to update
  56231. * @returns The directional light
  56232. */
  56233. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56234. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56235. /**
  56236. * Gets the minZ used for shadow according to both the scene and the light.
  56237. *
  56238. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56239. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56240. * @param activeCamera The camera we are returning the min for
  56241. * @returns the depth min z
  56242. */
  56243. getDepthMinZ(activeCamera: Camera): number;
  56244. /**
  56245. * Gets the maxZ used for shadow according to both the scene and the light.
  56246. *
  56247. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56248. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56249. * @param activeCamera The camera we are returning the max for
  56250. * @returns the depth max z
  56251. */
  56252. getDepthMaxZ(activeCamera: Camera): number;
  56253. /**
  56254. * Prepares the list of defines specific to the light type.
  56255. * @param defines the list of defines
  56256. * @param lightIndex defines the index of the light for the effect
  56257. */
  56258. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56259. }
  56260. }
  56261. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56262. import { Mesh } from "babylonjs/Meshes/mesh";
  56263. /**
  56264. * Class containing static functions to help procedurally build meshes
  56265. */
  56266. export class HemisphereBuilder {
  56267. /**
  56268. * Creates a hemisphere mesh
  56269. * @param name defines the name of the mesh
  56270. * @param options defines the options used to create the mesh
  56271. * @param scene defines the hosting scene
  56272. * @returns the hemisphere mesh
  56273. */
  56274. static CreateHemisphere(name: string, options: {
  56275. segments?: number;
  56276. diameter?: number;
  56277. sideOrientation?: number;
  56278. }, scene: any): Mesh;
  56279. }
  56280. }
  56281. declare module "babylonjs/Lights/spotLight" {
  56282. import { Nullable } from "babylonjs/types";
  56283. import { Scene } from "babylonjs/scene";
  56284. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56285. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56286. import { Effect } from "babylonjs/Materials/effect";
  56287. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56288. import { Light } from "babylonjs/Lights/light";
  56289. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56290. /**
  56291. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56292. * These values define a cone of light starting from the position, emitting toward the direction.
  56293. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56294. * and the exponent defines the speed of the decay of the light with distance (reach).
  56295. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56296. */
  56297. export class SpotLight extends ShadowLight {
  56298. private _angle;
  56299. private _innerAngle;
  56300. private _cosHalfAngle;
  56301. private _lightAngleScale;
  56302. private _lightAngleOffset;
  56303. /**
  56304. * Gets the cone angle of the spot light in Radians.
  56305. */
  56306. get angle(): number;
  56307. /**
  56308. * Sets the cone angle of the spot light in Radians.
  56309. */
  56310. set angle(value: number);
  56311. /**
  56312. * Only used in gltf falloff mode, this defines the angle where
  56313. * the directional falloff will start before cutting at angle which could be seen
  56314. * as outer angle.
  56315. */
  56316. get innerAngle(): number;
  56317. /**
  56318. * Only used in gltf falloff mode, this defines the angle where
  56319. * the directional falloff will start before cutting at angle which could be seen
  56320. * as outer angle.
  56321. */
  56322. set innerAngle(value: number);
  56323. private _shadowAngleScale;
  56324. /**
  56325. * Allows scaling the angle of the light for shadow generation only.
  56326. */
  56327. get shadowAngleScale(): number;
  56328. /**
  56329. * Allows scaling the angle of the light for shadow generation only.
  56330. */
  56331. set shadowAngleScale(value: number);
  56332. /**
  56333. * The light decay speed with the distance from the emission spot.
  56334. */
  56335. exponent: number;
  56336. private _projectionTextureMatrix;
  56337. /**
  56338. * Allows reading the projecton texture
  56339. */
  56340. get projectionTextureMatrix(): Matrix;
  56341. protected _projectionTextureLightNear: number;
  56342. /**
  56343. * Gets the near clip of the Spotlight for texture projection.
  56344. */
  56345. get projectionTextureLightNear(): number;
  56346. /**
  56347. * Sets the near clip of the Spotlight for texture projection.
  56348. */
  56349. set projectionTextureLightNear(value: number);
  56350. protected _projectionTextureLightFar: number;
  56351. /**
  56352. * Gets the far clip of the Spotlight for texture projection.
  56353. */
  56354. get projectionTextureLightFar(): number;
  56355. /**
  56356. * Sets the far clip of the Spotlight for texture projection.
  56357. */
  56358. set projectionTextureLightFar(value: number);
  56359. protected _projectionTextureUpDirection: Vector3;
  56360. /**
  56361. * Gets the Up vector of the Spotlight for texture projection.
  56362. */
  56363. get projectionTextureUpDirection(): Vector3;
  56364. /**
  56365. * Sets the Up vector of the Spotlight for texture projection.
  56366. */
  56367. set projectionTextureUpDirection(value: Vector3);
  56368. private _projectionTexture;
  56369. /**
  56370. * Gets the projection texture of the light.
  56371. */
  56372. get projectionTexture(): Nullable<BaseTexture>;
  56373. /**
  56374. * Sets the projection texture of the light.
  56375. */
  56376. set projectionTexture(value: Nullable<BaseTexture>);
  56377. private _projectionTextureViewLightDirty;
  56378. private _projectionTextureProjectionLightDirty;
  56379. private _projectionTextureDirty;
  56380. private _projectionTextureViewTargetVector;
  56381. private _projectionTextureViewLightMatrix;
  56382. private _projectionTextureProjectionLightMatrix;
  56383. private _projectionTextureScalingMatrix;
  56384. /**
  56385. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56386. * It can cast shadows.
  56387. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56388. * @param name The light friendly name
  56389. * @param position The position of the spot light in the scene
  56390. * @param direction The direction of the light in the scene
  56391. * @param angle The cone angle of the light in Radians
  56392. * @param exponent The light decay speed with the distance from the emission spot
  56393. * @param scene The scene the lights belongs to
  56394. */
  56395. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56396. /**
  56397. * Returns the string "SpotLight".
  56398. * @returns the class name
  56399. */
  56400. getClassName(): string;
  56401. /**
  56402. * Returns the integer 2.
  56403. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56404. */
  56405. getTypeID(): number;
  56406. /**
  56407. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56408. */
  56409. protected _setDirection(value: Vector3): void;
  56410. /**
  56411. * Overrides the position setter to recompute the projection texture view light Matrix.
  56412. */
  56413. protected _setPosition(value: Vector3): void;
  56414. /**
  56415. * 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.
  56416. * Returns the SpotLight.
  56417. */
  56418. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56419. protected _computeProjectionTextureViewLightMatrix(): void;
  56420. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56421. /**
  56422. * Main function for light texture projection matrix computing.
  56423. */
  56424. protected _computeProjectionTextureMatrix(): void;
  56425. protected _buildUniformLayout(): void;
  56426. private _computeAngleValues;
  56427. /**
  56428. * Sets the passed Effect "effect" with the Light textures.
  56429. * @param effect The effect to update
  56430. * @param lightIndex The index of the light in the effect to update
  56431. * @returns The light
  56432. */
  56433. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56434. /**
  56435. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56436. * @param effect The effect to update
  56437. * @param lightIndex The index of the light in the effect to update
  56438. * @returns The spot light
  56439. */
  56440. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56441. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56442. /**
  56443. * Disposes the light and the associated resources.
  56444. */
  56445. dispose(): void;
  56446. /**
  56447. * Prepares the list of defines specific to the light type.
  56448. * @param defines the list of defines
  56449. * @param lightIndex defines the index of the light for the effect
  56450. */
  56451. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56452. }
  56453. }
  56454. declare module "babylonjs/Gizmos/lightGizmo" {
  56455. import { Nullable } from "babylonjs/types";
  56456. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56457. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56458. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56459. import { Light } from "babylonjs/Lights/light";
  56460. /**
  56461. * Gizmo that enables viewing a light
  56462. */
  56463. export class LightGizmo extends Gizmo {
  56464. private _lightMesh;
  56465. private _material;
  56466. private _cachedPosition;
  56467. private _cachedForward;
  56468. private _attachedMeshParent;
  56469. /**
  56470. * Creates a LightGizmo
  56471. * @param gizmoLayer The utility layer the gizmo will be added to
  56472. */
  56473. constructor(gizmoLayer?: UtilityLayerRenderer);
  56474. private _light;
  56475. /**
  56476. * The light that the gizmo is attached to
  56477. */
  56478. set light(light: Nullable<Light>);
  56479. get light(): Nullable<Light>;
  56480. /**
  56481. * Gets the material used to render the light gizmo
  56482. */
  56483. get material(): StandardMaterial;
  56484. /**
  56485. * @hidden
  56486. * Updates the gizmo to match the attached mesh's position/rotation
  56487. */
  56488. protected _update(): void;
  56489. private static _Scale;
  56490. /**
  56491. * Creates the lines for a light mesh
  56492. */
  56493. private static _CreateLightLines;
  56494. /**
  56495. * Disposes of the light gizmo
  56496. */
  56497. dispose(): void;
  56498. private static _CreateHemisphericLightMesh;
  56499. private static _CreatePointLightMesh;
  56500. private static _CreateSpotLightMesh;
  56501. private static _CreateDirectionalLightMesh;
  56502. }
  56503. }
  56504. declare module "babylonjs/Gizmos/cameraGizmo" {
  56505. import { Nullable } from "babylonjs/types";
  56506. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56507. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56508. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56509. import { Camera } from "babylonjs/Cameras/camera";
  56510. /**
  56511. * Gizmo that enables viewing a camera
  56512. */
  56513. export class CameraGizmo extends Gizmo {
  56514. private _cameraMesh;
  56515. private _cameraLinesMesh;
  56516. private _material;
  56517. /**
  56518. * Creates a CameraGizmo
  56519. * @param gizmoLayer The utility layer the gizmo will be added to
  56520. */
  56521. constructor(gizmoLayer?: UtilityLayerRenderer);
  56522. private _camera;
  56523. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56524. get displayFrustum(): boolean;
  56525. set displayFrustum(value: boolean);
  56526. /**
  56527. * The camera that the gizmo is attached to
  56528. */
  56529. set camera(camera: Nullable<Camera>);
  56530. get camera(): Nullable<Camera>;
  56531. /**
  56532. * Gets the material used to render the camera gizmo
  56533. */
  56534. get material(): StandardMaterial;
  56535. /**
  56536. * @hidden
  56537. * Updates the gizmo to match the attached mesh's position/rotation
  56538. */
  56539. protected _update(): void;
  56540. private static _Scale;
  56541. private _invProjection;
  56542. /**
  56543. * Disposes of the camera gizmo
  56544. */
  56545. dispose(): void;
  56546. private static _CreateCameraMesh;
  56547. private static _CreateCameraFrustum;
  56548. }
  56549. }
  56550. declare module "babylonjs/Gizmos/index" {
  56551. export * from "babylonjs/Gizmos/axisDragGizmo";
  56552. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56553. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56554. export * from "babylonjs/Gizmos/gizmo";
  56555. export * from "babylonjs/Gizmos/gizmoManager";
  56556. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56557. export * from "babylonjs/Gizmos/positionGizmo";
  56558. export * from "babylonjs/Gizmos/rotationGizmo";
  56559. export * from "babylonjs/Gizmos/scaleGizmo";
  56560. export * from "babylonjs/Gizmos/lightGizmo";
  56561. export * from "babylonjs/Gizmos/cameraGizmo";
  56562. export * from "babylonjs/Gizmos/planeDragGizmo";
  56563. }
  56564. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56565. /** @hidden */
  56566. export var backgroundFragmentDeclaration: {
  56567. name: string;
  56568. shader: string;
  56569. };
  56570. }
  56571. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56572. /** @hidden */
  56573. export var backgroundUboDeclaration: {
  56574. name: string;
  56575. shader: string;
  56576. };
  56577. }
  56578. declare module "babylonjs/Shaders/background.fragment" {
  56579. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56580. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56581. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56582. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56583. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56584. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56585. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56586. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56587. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56588. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56589. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56590. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56591. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56592. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56593. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56594. /** @hidden */
  56595. export var backgroundPixelShader: {
  56596. name: string;
  56597. shader: string;
  56598. };
  56599. }
  56600. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56601. /** @hidden */
  56602. export var backgroundVertexDeclaration: {
  56603. name: string;
  56604. shader: string;
  56605. };
  56606. }
  56607. declare module "babylonjs/Shaders/background.vertex" {
  56608. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56609. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56610. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56611. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56612. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56613. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56614. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56615. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56616. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56617. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56618. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56619. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56620. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56621. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56622. /** @hidden */
  56623. export var backgroundVertexShader: {
  56624. name: string;
  56625. shader: string;
  56626. };
  56627. }
  56628. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56629. import { Nullable, int, float } from "babylonjs/types";
  56630. import { Scene } from "babylonjs/scene";
  56631. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56632. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56633. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56634. import { Mesh } from "babylonjs/Meshes/mesh";
  56635. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56636. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56637. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56638. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56639. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56640. import { Color3 } from "babylonjs/Maths/math.color";
  56641. import "babylonjs/Shaders/background.fragment";
  56642. import "babylonjs/Shaders/background.vertex";
  56643. /**
  56644. * Background material used to create an efficient environement around your scene.
  56645. */
  56646. export class BackgroundMaterial extends PushMaterial {
  56647. /**
  56648. * Standard reflectance value at parallel view angle.
  56649. */
  56650. static StandardReflectance0: number;
  56651. /**
  56652. * Standard reflectance value at grazing angle.
  56653. */
  56654. static StandardReflectance90: number;
  56655. protected _primaryColor: Color3;
  56656. /**
  56657. * Key light Color (multiply against the environement texture)
  56658. */
  56659. primaryColor: Color3;
  56660. protected __perceptualColor: Nullable<Color3>;
  56661. /**
  56662. * Experimental Internal Use Only.
  56663. *
  56664. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56665. * This acts as a helper to set the primary color to a more "human friendly" value.
  56666. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56667. * output color as close as possible from the chosen value.
  56668. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56669. * part of lighting setup.)
  56670. */
  56671. get _perceptualColor(): Nullable<Color3>;
  56672. set _perceptualColor(value: Nullable<Color3>);
  56673. protected _primaryColorShadowLevel: float;
  56674. /**
  56675. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56676. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56677. */
  56678. get primaryColorShadowLevel(): float;
  56679. set primaryColorShadowLevel(value: float);
  56680. protected _primaryColorHighlightLevel: float;
  56681. /**
  56682. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56683. * The primary color is used at the level chosen to define what the white area would look.
  56684. */
  56685. get primaryColorHighlightLevel(): float;
  56686. set primaryColorHighlightLevel(value: float);
  56687. protected _reflectionTexture: Nullable<BaseTexture>;
  56688. /**
  56689. * Reflection Texture used in the material.
  56690. * Should be author in a specific way for the best result (refer to the documentation).
  56691. */
  56692. reflectionTexture: Nullable<BaseTexture>;
  56693. protected _reflectionBlur: float;
  56694. /**
  56695. * Reflection Texture level of blur.
  56696. *
  56697. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56698. * texture twice.
  56699. */
  56700. reflectionBlur: float;
  56701. protected _diffuseTexture: Nullable<BaseTexture>;
  56702. /**
  56703. * Diffuse Texture used in the material.
  56704. * Should be author in a specific way for the best result (refer to the documentation).
  56705. */
  56706. diffuseTexture: Nullable<BaseTexture>;
  56707. protected _shadowLights: Nullable<IShadowLight[]>;
  56708. /**
  56709. * Specify the list of lights casting shadow on the material.
  56710. * All scene shadow lights will be included if null.
  56711. */
  56712. shadowLights: Nullable<IShadowLight[]>;
  56713. protected _shadowLevel: float;
  56714. /**
  56715. * Helps adjusting the shadow to a softer level if required.
  56716. * 0 means black shadows and 1 means no shadows.
  56717. */
  56718. shadowLevel: float;
  56719. protected _sceneCenter: Vector3;
  56720. /**
  56721. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56722. * It is usually zero but might be interesting to modify according to your setup.
  56723. */
  56724. sceneCenter: Vector3;
  56725. protected _opacityFresnel: boolean;
  56726. /**
  56727. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56728. * This helps ensuring a nice transition when the camera goes under the ground.
  56729. */
  56730. opacityFresnel: boolean;
  56731. protected _reflectionFresnel: boolean;
  56732. /**
  56733. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56734. * This helps adding a mirror texture on the ground.
  56735. */
  56736. reflectionFresnel: boolean;
  56737. protected _reflectionFalloffDistance: number;
  56738. /**
  56739. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56740. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56741. */
  56742. reflectionFalloffDistance: number;
  56743. protected _reflectionAmount: number;
  56744. /**
  56745. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56746. */
  56747. reflectionAmount: number;
  56748. protected _reflectionReflectance0: number;
  56749. /**
  56750. * This specifies the weight of the reflection at grazing angle.
  56751. */
  56752. reflectionReflectance0: number;
  56753. protected _reflectionReflectance90: number;
  56754. /**
  56755. * This specifies the weight of the reflection at a perpendicular point of view.
  56756. */
  56757. reflectionReflectance90: number;
  56758. /**
  56759. * Sets the reflection reflectance fresnel values according to the default standard
  56760. * empirically know to work well :-)
  56761. */
  56762. set reflectionStandardFresnelWeight(value: number);
  56763. protected _useRGBColor: boolean;
  56764. /**
  56765. * Helps to directly use the maps channels instead of their level.
  56766. */
  56767. useRGBColor: boolean;
  56768. protected _enableNoise: boolean;
  56769. /**
  56770. * This helps reducing the banding effect that could occur on the background.
  56771. */
  56772. enableNoise: boolean;
  56773. /**
  56774. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56775. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56776. * Recommended to be keep at 1.0 except for special cases.
  56777. */
  56778. get fovMultiplier(): number;
  56779. set fovMultiplier(value: number);
  56780. private _fovMultiplier;
  56781. /**
  56782. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56783. */
  56784. useEquirectangularFOV: boolean;
  56785. private _maxSimultaneousLights;
  56786. /**
  56787. * Number of Simultaneous lights allowed on the material.
  56788. */
  56789. maxSimultaneousLights: int;
  56790. private _shadowOnly;
  56791. /**
  56792. * Make the material only render shadows
  56793. */
  56794. shadowOnly: boolean;
  56795. /**
  56796. * Default configuration related to image processing available in the Background Material.
  56797. */
  56798. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56799. /**
  56800. * Keep track of the image processing observer to allow dispose and replace.
  56801. */
  56802. private _imageProcessingObserver;
  56803. /**
  56804. * Attaches a new image processing configuration to the PBR Material.
  56805. * @param configuration (if null the scene configuration will be use)
  56806. */
  56807. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56808. /**
  56809. * Gets the image processing configuration used either in this material.
  56810. */
  56811. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56812. /**
  56813. * Sets the Default image processing configuration used either in the this material.
  56814. *
  56815. * If sets to null, the scene one is in use.
  56816. */
  56817. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56818. /**
  56819. * Gets wether the color curves effect is enabled.
  56820. */
  56821. get cameraColorCurvesEnabled(): boolean;
  56822. /**
  56823. * Sets wether the color curves effect is enabled.
  56824. */
  56825. set cameraColorCurvesEnabled(value: boolean);
  56826. /**
  56827. * Gets wether the color grading effect is enabled.
  56828. */
  56829. get cameraColorGradingEnabled(): boolean;
  56830. /**
  56831. * Gets wether the color grading effect is enabled.
  56832. */
  56833. set cameraColorGradingEnabled(value: boolean);
  56834. /**
  56835. * Gets wether tonemapping is enabled or not.
  56836. */
  56837. get cameraToneMappingEnabled(): boolean;
  56838. /**
  56839. * Sets wether tonemapping is enabled or not
  56840. */
  56841. set cameraToneMappingEnabled(value: boolean);
  56842. /**
  56843. * The camera exposure used on this material.
  56844. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56845. * This corresponds to a photographic exposure.
  56846. */
  56847. get cameraExposure(): float;
  56848. /**
  56849. * The camera exposure used on this material.
  56850. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56851. * This corresponds to a photographic exposure.
  56852. */
  56853. set cameraExposure(value: float);
  56854. /**
  56855. * Gets The camera contrast used on this material.
  56856. */
  56857. get cameraContrast(): float;
  56858. /**
  56859. * Sets The camera contrast used on this material.
  56860. */
  56861. set cameraContrast(value: float);
  56862. /**
  56863. * Gets the Color Grading 2D Lookup Texture.
  56864. */
  56865. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56866. /**
  56867. * Sets the Color Grading 2D Lookup Texture.
  56868. */
  56869. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56870. /**
  56871. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56872. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56873. * 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;
  56874. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56875. */
  56876. get cameraColorCurves(): Nullable<ColorCurves>;
  56877. /**
  56878. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56879. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56880. * 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;
  56881. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56882. */
  56883. set cameraColorCurves(value: Nullable<ColorCurves>);
  56884. /**
  56885. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56886. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56887. */
  56888. switchToBGR: boolean;
  56889. private _renderTargets;
  56890. private _reflectionControls;
  56891. private _white;
  56892. private _primaryShadowColor;
  56893. private _primaryHighlightColor;
  56894. /**
  56895. * Instantiates a Background Material in the given scene
  56896. * @param name The friendly name of the material
  56897. * @param scene The scene to add the material to
  56898. */
  56899. constructor(name: string, scene: Scene);
  56900. /**
  56901. * Gets a boolean indicating that current material needs to register RTT
  56902. */
  56903. get hasRenderTargetTextures(): boolean;
  56904. /**
  56905. * The entire material has been created in order to prevent overdraw.
  56906. * @returns false
  56907. */
  56908. needAlphaTesting(): boolean;
  56909. /**
  56910. * The entire material has been created in order to prevent overdraw.
  56911. * @returns true if blending is enable
  56912. */
  56913. needAlphaBlending(): boolean;
  56914. /**
  56915. * Checks wether the material is ready to be rendered for a given mesh.
  56916. * @param mesh The mesh to render
  56917. * @param subMesh The submesh to check against
  56918. * @param useInstances Specify wether or not the material is used with instances
  56919. * @returns true if all the dependencies are ready (Textures, Effects...)
  56920. */
  56921. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56922. /**
  56923. * Compute the primary color according to the chosen perceptual color.
  56924. */
  56925. private _computePrimaryColorFromPerceptualColor;
  56926. /**
  56927. * Compute the highlights and shadow colors according to their chosen levels.
  56928. */
  56929. private _computePrimaryColors;
  56930. /**
  56931. * Build the uniform buffer used in the material.
  56932. */
  56933. buildUniformLayout(): void;
  56934. /**
  56935. * Unbind the material.
  56936. */
  56937. unbind(): void;
  56938. /**
  56939. * Bind only the world matrix to the material.
  56940. * @param world The world matrix to bind.
  56941. */
  56942. bindOnlyWorldMatrix(world: Matrix): void;
  56943. /**
  56944. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  56945. * @param world The world matrix to bind.
  56946. * @param subMesh The submesh to bind for.
  56947. */
  56948. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56949. /**
  56950. * Checks to see if a texture is used in the material.
  56951. * @param texture - Base texture to use.
  56952. * @returns - Boolean specifying if a texture is used in the material.
  56953. */
  56954. hasTexture(texture: BaseTexture): boolean;
  56955. /**
  56956. * Dispose the material.
  56957. * @param forceDisposeEffect Force disposal of the associated effect.
  56958. * @param forceDisposeTextures Force disposal of the associated textures.
  56959. */
  56960. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  56961. /**
  56962. * Clones the material.
  56963. * @param name The cloned name.
  56964. * @returns The cloned material.
  56965. */
  56966. clone(name: string): BackgroundMaterial;
  56967. /**
  56968. * Serializes the current material to its JSON representation.
  56969. * @returns The JSON representation.
  56970. */
  56971. serialize(): any;
  56972. /**
  56973. * Gets the class name of the material
  56974. * @returns "BackgroundMaterial"
  56975. */
  56976. getClassName(): string;
  56977. /**
  56978. * Parse a JSON input to create back a background material.
  56979. * @param source The JSON data to parse
  56980. * @param scene The scene to create the parsed material in
  56981. * @param rootUrl The root url of the assets the material depends upon
  56982. * @returns the instantiated BackgroundMaterial.
  56983. */
  56984. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  56985. }
  56986. }
  56987. declare module "babylonjs/Helpers/environmentHelper" {
  56988. import { Observable } from "babylonjs/Misc/observable";
  56989. import { Nullable } from "babylonjs/types";
  56990. import { Scene } from "babylonjs/scene";
  56991. import { Vector3 } from "babylonjs/Maths/math.vector";
  56992. import { Color3 } from "babylonjs/Maths/math.color";
  56993. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56994. import { Mesh } from "babylonjs/Meshes/mesh";
  56995. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56996. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  56997. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  56998. import "babylonjs/Meshes/Builders/planeBuilder";
  56999. import "babylonjs/Meshes/Builders/boxBuilder";
  57000. /**
  57001. * Represents the different options available during the creation of
  57002. * a Environment helper.
  57003. *
  57004. * This can control the default ground, skybox and image processing setup of your scene.
  57005. */
  57006. export interface IEnvironmentHelperOptions {
  57007. /**
  57008. * Specifies whether or not to create a ground.
  57009. * True by default.
  57010. */
  57011. createGround: boolean;
  57012. /**
  57013. * Specifies the ground size.
  57014. * 15 by default.
  57015. */
  57016. groundSize: number;
  57017. /**
  57018. * The texture used on the ground for the main color.
  57019. * Comes from the BabylonJS CDN by default.
  57020. *
  57021. * Remarks: Can be either a texture or a url.
  57022. */
  57023. groundTexture: string | BaseTexture;
  57024. /**
  57025. * The color mixed in the ground texture by default.
  57026. * BabylonJS clearColor by default.
  57027. */
  57028. groundColor: Color3;
  57029. /**
  57030. * Specifies the ground opacity.
  57031. * 1 by default.
  57032. */
  57033. groundOpacity: number;
  57034. /**
  57035. * Enables the ground to receive shadows.
  57036. * True by default.
  57037. */
  57038. enableGroundShadow: boolean;
  57039. /**
  57040. * Helps preventing the shadow to be fully black on the ground.
  57041. * 0.5 by default.
  57042. */
  57043. groundShadowLevel: number;
  57044. /**
  57045. * Creates a mirror texture attach to the ground.
  57046. * false by default.
  57047. */
  57048. enableGroundMirror: boolean;
  57049. /**
  57050. * Specifies the ground mirror size ratio.
  57051. * 0.3 by default as the default kernel is 64.
  57052. */
  57053. groundMirrorSizeRatio: number;
  57054. /**
  57055. * Specifies the ground mirror blur kernel size.
  57056. * 64 by default.
  57057. */
  57058. groundMirrorBlurKernel: number;
  57059. /**
  57060. * Specifies the ground mirror visibility amount.
  57061. * 1 by default
  57062. */
  57063. groundMirrorAmount: number;
  57064. /**
  57065. * Specifies the ground mirror reflectance weight.
  57066. * This uses the standard weight of the background material to setup the fresnel effect
  57067. * of the mirror.
  57068. * 1 by default.
  57069. */
  57070. groundMirrorFresnelWeight: number;
  57071. /**
  57072. * Specifies the ground mirror Falloff distance.
  57073. * This can helps reducing the size of the reflection.
  57074. * 0 by Default.
  57075. */
  57076. groundMirrorFallOffDistance: number;
  57077. /**
  57078. * Specifies the ground mirror texture type.
  57079. * Unsigned Int by Default.
  57080. */
  57081. groundMirrorTextureType: number;
  57082. /**
  57083. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57084. * the shown objects.
  57085. */
  57086. groundYBias: number;
  57087. /**
  57088. * Specifies whether or not to create a skybox.
  57089. * True by default.
  57090. */
  57091. createSkybox: boolean;
  57092. /**
  57093. * Specifies the skybox size.
  57094. * 20 by default.
  57095. */
  57096. skyboxSize: number;
  57097. /**
  57098. * The texture used on the skybox for the main color.
  57099. * Comes from the BabylonJS CDN by default.
  57100. *
  57101. * Remarks: Can be either a texture or a url.
  57102. */
  57103. skyboxTexture: string | BaseTexture;
  57104. /**
  57105. * The color mixed in the skybox texture by default.
  57106. * BabylonJS clearColor by default.
  57107. */
  57108. skyboxColor: Color3;
  57109. /**
  57110. * The background rotation around the Y axis of the scene.
  57111. * This helps aligning the key lights of your scene with the background.
  57112. * 0 by default.
  57113. */
  57114. backgroundYRotation: number;
  57115. /**
  57116. * Compute automatically the size of the elements to best fit with the scene.
  57117. */
  57118. sizeAuto: boolean;
  57119. /**
  57120. * Default position of the rootMesh if autoSize is not true.
  57121. */
  57122. rootPosition: Vector3;
  57123. /**
  57124. * Sets up the image processing in the scene.
  57125. * true by default.
  57126. */
  57127. setupImageProcessing: boolean;
  57128. /**
  57129. * The texture used as your environment texture in the scene.
  57130. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57131. *
  57132. * Remarks: Can be either a texture or a url.
  57133. */
  57134. environmentTexture: string | BaseTexture;
  57135. /**
  57136. * The value of the exposure to apply to the scene.
  57137. * 0.6 by default if setupImageProcessing is true.
  57138. */
  57139. cameraExposure: number;
  57140. /**
  57141. * The value of the contrast to apply to the scene.
  57142. * 1.6 by default if setupImageProcessing is true.
  57143. */
  57144. cameraContrast: number;
  57145. /**
  57146. * Specifies whether or not tonemapping should be enabled in the scene.
  57147. * true by default if setupImageProcessing is true.
  57148. */
  57149. toneMappingEnabled: boolean;
  57150. }
  57151. /**
  57152. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57153. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57154. * It also helps with the default setup of your imageProcessing configuration.
  57155. */
  57156. export class EnvironmentHelper {
  57157. /**
  57158. * Default ground texture URL.
  57159. */
  57160. private static _groundTextureCDNUrl;
  57161. /**
  57162. * Default skybox texture URL.
  57163. */
  57164. private static _skyboxTextureCDNUrl;
  57165. /**
  57166. * Default environment texture URL.
  57167. */
  57168. private static _environmentTextureCDNUrl;
  57169. /**
  57170. * Creates the default options for the helper.
  57171. */
  57172. private static _getDefaultOptions;
  57173. private _rootMesh;
  57174. /**
  57175. * Gets the root mesh created by the helper.
  57176. */
  57177. get rootMesh(): Mesh;
  57178. private _skybox;
  57179. /**
  57180. * Gets the skybox created by the helper.
  57181. */
  57182. get skybox(): Nullable<Mesh>;
  57183. private _skyboxTexture;
  57184. /**
  57185. * Gets the skybox texture created by the helper.
  57186. */
  57187. get skyboxTexture(): Nullable<BaseTexture>;
  57188. private _skyboxMaterial;
  57189. /**
  57190. * Gets the skybox material created by the helper.
  57191. */
  57192. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57193. private _ground;
  57194. /**
  57195. * Gets the ground mesh created by the helper.
  57196. */
  57197. get ground(): Nullable<Mesh>;
  57198. private _groundTexture;
  57199. /**
  57200. * Gets the ground texture created by the helper.
  57201. */
  57202. get groundTexture(): Nullable<BaseTexture>;
  57203. private _groundMirror;
  57204. /**
  57205. * Gets the ground mirror created by the helper.
  57206. */
  57207. get groundMirror(): Nullable<MirrorTexture>;
  57208. /**
  57209. * Gets the ground mirror render list to helps pushing the meshes
  57210. * you wish in the ground reflection.
  57211. */
  57212. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57213. private _groundMaterial;
  57214. /**
  57215. * Gets the ground material created by the helper.
  57216. */
  57217. get groundMaterial(): Nullable<BackgroundMaterial>;
  57218. /**
  57219. * Stores the creation options.
  57220. */
  57221. private readonly _scene;
  57222. private _options;
  57223. /**
  57224. * This observable will be notified with any error during the creation of the environment,
  57225. * mainly texture creation errors.
  57226. */
  57227. onErrorObservable: Observable<{
  57228. message?: string;
  57229. exception?: any;
  57230. }>;
  57231. /**
  57232. * constructor
  57233. * @param options Defines the options we want to customize the helper
  57234. * @param scene The scene to add the material to
  57235. */
  57236. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57237. /**
  57238. * Updates the background according to the new options
  57239. * @param options
  57240. */
  57241. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57242. /**
  57243. * Sets the primary color of all the available elements.
  57244. * @param color the main color to affect to the ground and the background
  57245. */
  57246. setMainColor(color: Color3): void;
  57247. /**
  57248. * Setup the image processing according to the specified options.
  57249. */
  57250. private _setupImageProcessing;
  57251. /**
  57252. * Setup the environment texture according to the specified options.
  57253. */
  57254. private _setupEnvironmentTexture;
  57255. /**
  57256. * Setup the background according to the specified options.
  57257. */
  57258. private _setupBackground;
  57259. /**
  57260. * Get the scene sizes according to the setup.
  57261. */
  57262. private _getSceneSize;
  57263. /**
  57264. * Setup the ground according to the specified options.
  57265. */
  57266. private _setupGround;
  57267. /**
  57268. * Setup the ground material according to the specified options.
  57269. */
  57270. private _setupGroundMaterial;
  57271. /**
  57272. * Setup the ground diffuse texture according to the specified options.
  57273. */
  57274. private _setupGroundDiffuseTexture;
  57275. /**
  57276. * Setup the ground mirror texture according to the specified options.
  57277. */
  57278. private _setupGroundMirrorTexture;
  57279. /**
  57280. * Setup the ground to receive the mirror texture.
  57281. */
  57282. private _setupMirrorInGroundMaterial;
  57283. /**
  57284. * Setup the skybox according to the specified options.
  57285. */
  57286. private _setupSkybox;
  57287. /**
  57288. * Setup the skybox material according to the specified options.
  57289. */
  57290. private _setupSkyboxMaterial;
  57291. /**
  57292. * Setup the skybox reflection texture according to the specified options.
  57293. */
  57294. private _setupSkyboxReflectionTexture;
  57295. private _errorHandler;
  57296. /**
  57297. * Dispose all the elements created by the Helper.
  57298. */
  57299. dispose(): void;
  57300. }
  57301. }
  57302. declare module "babylonjs/Helpers/textureDome" {
  57303. import { Scene } from "babylonjs/scene";
  57304. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57305. import { Mesh } from "babylonjs/Meshes/mesh";
  57306. import { Texture } from "babylonjs/Materials/Textures/texture";
  57307. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57308. import "babylonjs/Meshes/Builders/sphereBuilder";
  57309. import { Nullable } from "babylonjs/types";
  57310. import { Observable } from "babylonjs/Misc/observable";
  57311. /**
  57312. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  57313. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  57314. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57315. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57316. */
  57317. export abstract class TextureDome<T extends Texture> extends TransformNode {
  57318. protected onError: Nullable<(message?: string, exception?: any) => void>;
  57319. /**
  57320. * Define the source as a Monoscopic panoramic 360/180.
  57321. */
  57322. static readonly MODE_MONOSCOPIC: number;
  57323. /**
  57324. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  57325. */
  57326. static readonly MODE_TOPBOTTOM: number;
  57327. /**
  57328. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  57329. */
  57330. static readonly MODE_SIDEBYSIDE: number;
  57331. private _halfDome;
  57332. protected _useDirectMapping: boolean;
  57333. /**
  57334. * The texture being displayed on the sphere
  57335. */
  57336. protected _texture: T;
  57337. /**
  57338. * Gets the texture being displayed on the sphere
  57339. */
  57340. get texture(): T;
  57341. /**
  57342. * Sets the texture being displayed on the sphere
  57343. */
  57344. set texture(newTexture: T);
  57345. /**
  57346. * The skybox material
  57347. */
  57348. protected _material: BackgroundMaterial;
  57349. /**
  57350. * The surface used for the dome
  57351. */
  57352. protected _mesh: Mesh;
  57353. /**
  57354. * Gets the mesh used for the dome.
  57355. */
  57356. get mesh(): Mesh;
  57357. /**
  57358. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  57359. */
  57360. private _halfDomeMask;
  57361. /**
  57362. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57363. * Also see the options.resolution property.
  57364. */
  57365. get fovMultiplier(): number;
  57366. set fovMultiplier(value: number);
  57367. protected _textureMode: number;
  57368. /**
  57369. * Gets or set the current texture mode for the texture. It can be:
  57370. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57371. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57372. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57373. */
  57374. get textureMode(): number;
  57375. /**
  57376. * Sets the current texture mode for the texture. It can be:
  57377. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57378. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57379. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57380. */
  57381. set textureMode(value: number);
  57382. /**
  57383. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  57384. */
  57385. get halfDome(): boolean;
  57386. /**
  57387. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  57388. */
  57389. set halfDome(enabled: boolean);
  57390. /**
  57391. * Oberserver used in Stereoscopic VR Mode.
  57392. */
  57393. private _onBeforeCameraRenderObserver;
  57394. /**
  57395. * Observable raised when an error occured while loading the 360 image
  57396. */
  57397. onLoadErrorObservable: Observable<string>;
  57398. /**
  57399. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  57400. * @param name Element's name, child elements will append suffixes for their own names.
  57401. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  57402. * @param options An object containing optional or exposed sub element properties
  57403. */
  57404. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  57405. resolution?: number;
  57406. clickToPlay?: boolean;
  57407. autoPlay?: boolean;
  57408. loop?: boolean;
  57409. size?: number;
  57410. poster?: string;
  57411. faceForward?: boolean;
  57412. useDirectMapping?: boolean;
  57413. halfDomeMode?: boolean;
  57414. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57415. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  57416. protected _changeTextureMode(value: number): void;
  57417. /**
  57418. * Releases resources associated with this node.
  57419. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57420. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57421. */
  57422. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57423. }
  57424. }
  57425. declare module "babylonjs/Helpers/photoDome" {
  57426. import { Scene } from "babylonjs/scene";
  57427. import { Texture } from "babylonjs/Materials/Textures/texture";
  57428. import { TextureDome } from "babylonjs/Helpers/textureDome";
  57429. /**
  57430. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57431. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57432. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57433. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57434. */
  57435. export class PhotoDome extends TextureDome<Texture> {
  57436. /**
  57437. * Define the image as a Monoscopic panoramic 360 image.
  57438. */
  57439. static readonly MODE_MONOSCOPIC: number;
  57440. /**
  57441. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57442. */
  57443. static readonly MODE_TOPBOTTOM: number;
  57444. /**
  57445. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57446. */
  57447. static readonly MODE_SIDEBYSIDE: number;
  57448. /**
  57449. * Gets or sets the texture being displayed on the sphere
  57450. */
  57451. get photoTexture(): Texture;
  57452. /**
  57453. * sets the texture being displayed on the sphere
  57454. */
  57455. set photoTexture(value: Texture);
  57456. /**
  57457. * Gets the current video mode for the video. It can be:
  57458. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57459. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57460. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57461. */
  57462. get imageMode(): number;
  57463. /**
  57464. * Sets the current video mode for the video. It can be:
  57465. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57466. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57467. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57468. */
  57469. set imageMode(value: number);
  57470. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  57471. }
  57472. }
  57473. declare module "babylonjs/Misc/rgbdTextureTools" {
  57474. import "babylonjs/Shaders/rgbdDecode.fragment";
  57475. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57476. import { Texture } from "babylonjs/Materials/Textures/texture";
  57477. /**
  57478. * Class used to host RGBD texture specific utilities
  57479. */
  57480. export class RGBDTextureTools {
  57481. /**
  57482. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57483. * @param texture the texture to expand.
  57484. */
  57485. static ExpandRGBDTexture(texture: Texture): void;
  57486. }
  57487. }
  57488. declare module "babylonjs/Misc/brdfTextureTools" {
  57489. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57490. import { Scene } from "babylonjs/scene";
  57491. /**
  57492. * Class used to host texture specific utilities
  57493. */
  57494. export class BRDFTextureTools {
  57495. /**
  57496. * Prevents texture cache collision
  57497. */
  57498. private static _instanceNumber;
  57499. /**
  57500. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57501. * @param scene defines the hosting scene
  57502. * @returns the environment BRDF texture
  57503. */
  57504. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57505. private static _environmentBRDFBase64Texture;
  57506. }
  57507. }
  57508. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57509. import { Nullable } from "babylonjs/types";
  57510. import { Color3 } from "babylonjs/Maths/math.color";
  57511. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57512. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57513. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57514. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57515. import { Engine } from "babylonjs/Engines/engine";
  57516. import { Scene } from "babylonjs/scene";
  57517. /**
  57518. * @hidden
  57519. */
  57520. export interface IMaterialClearCoatDefines {
  57521. CLEARCOAT: boolean;
  57522. CLEARCOAT_DEFAULTIOR: boolean;
  57523. CLEARCOAT_TEXTURE: boolean;
  57524. CLEARCOAT_TEXTUREDIRECTUV: number;
  57525. CLEARCOAT_BUMP: boolean;
  57526. CLEARCOAT_BUMPDIRECTUV: number;
  57527. CLEARCOAT_TINT: boolean;
  57528. CLEARCOAT_TINT_TEXTURE: boolean;
  57529. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57530. /** @hidden */
  57531. _areTexturesDirty: boolean;
  57532. }
  57533. /**
  57534. * Define the code related to the clear coat parameters of the pbr material.
  57535. */
  57536. export class PBRClearCoatConfiguration {
  57537. /**
  57538. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57539. * The default fits with a polyurethane material.
  57540. */
  57541. private static readonly _DefaultIndexOfRefraction;
  57542. private _isEnabled;
  57543. /**
  57544. * Defines if the clear coat is enabled in the material.
  57545. */
  57546. isEnabled: boolean;
  57547. /**
  57548. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57549. */
  57550. intensity: number;
  57551. /**
  57552. * Defines the clear coat layer roughness.
  57553. */
  57554. roughness: number;
  57555. private _indexOfRefraction;
  57556. /**
  57557. * Defines the index of refraction of the clear coat.
  57558. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57559. * The default fits with a polyurethane material.
  57560. * Changing the default value is more performance intensive.
  57561. */
  57562. indexOfRefraction: number;
  57563. private _texture;
  57564. /**
  57565. * Stores the clear coat values in a texture.
  57566. */
  57567. texture: Nullable<BaseTexture>;
  57568. private _bumpTexture;
  57569. /**
  57570. * Define the clear coat specific bump texture.
  57571. */
  57572. bumpTexture: Nullable<BaseTexture>;
  57573. private _isTintEnabled;
  57574. /**
  57575. * Defines if the clear coat tint is enabled in the material.
  57576. */
  57577. isTintEnabled: boolean;
  57578. /**
  57579. * Defines the clear coat tint of the material.
  57580. * This is only use if tint is enabled
  57581. */
  57582. tintColor: Color3;
  57583. /**
  57584. * Defines the distance at which the tint color should be found in the
  57585. * clear coat media.
  57586. * This is only use if tint is enabled
  57587. */
  57588. tintColorAtDistance: number;
  57589. /**
  57590. * Defines the clear coat layer thickness.
  57591. * This is only use if tint is enabled
  57592. */
  57593. tintThickness: number;
  57594. private _tintTexture;
  57595. /**
  57596. * Stores the clear tint values in a texture.
  57597. * rgb is tint
  57598. * a is a thickness factor
  57599. */
  57600. tintTexture: Nullable<BaseTexture>;
  57601. /** @hidden */
  57602. private _internalMarkAllSubMeshesAsTexturesDirty;
  57603. /** @hidden */
  57604. _markAllSubMeshesAsTexturesDirty(): void;
  57605. /**
  57606. * Instantiate a new istance of clear coat configuration.
  57607. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57608. */
  57609. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57610. /**
  57611. * Gets wehter the submesh is ready to be used or not.
  57612. * @param defines the list of "defines" to update.
  57613. * @param scene defines the scene the material belongs to.
  57614. * @param engine defines the engine the material belongs to.
  57615. * @param disableBumpMap defines wether the material disables bump or not.
  57616. * @returns - boolean indicating that the submesh is ready or not.
  57617. */
  57618. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57619. /**
  57620. * Checks to see if a texture is used in the material.
  57621. * @param defines the list of "defines" to update.
  57622. * @param scene defines the scene to the material belongs to.
  57623. */
  57624. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57625. /**
  57626. * Binds the material data.
  57627. * @param uniformBuffer defines the Uniform buffer to fill in.
  57628. * @param scene defines the scene the material belongs to.
  57629. * @param engine defines the engine the material belongs to.
  57630. * @param disableBumpMap defines wether the material disables bump or not.
  57631. * @param isFrozen defines wether the material is frozen or not.
  57632. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57633. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57634. */
  57635. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57636. /**
  57637. * Checks to see if a texture is used in the material.
  57638. * @param texture - Base texture to use.
  57639. * @returns - Boolean specifying if a texture is used in the material.
  57640. */
  57641. hasTexture(texture: BaseTexture): boolean;
  57642. /**
  57643. * Returns an array of the actively used textures.
  57644. * @param activeTextures Array of BaseTextures
  57645. */
  57646. getActiveTextures(activeTextures: BaseTexture[]): void;
  57647. /**
  57648. * Returns the animatable textures.
  57649. * @param animatables Array of animatable textures.
  57650. */
  57651. getAnimatables(animatables: IAnimatable[]): void;
  57652. /**
  57653. * Disposes the resources of the material.
  57654. * @param forceDisposeTextures - Forces the disposal of all textures.
  57655. */
  57656. dispose(forceDisposeTextures?: boolean): void;
  57657. /**
  57658. * Get the current class name of the texture useful for serialization or dynamic coding.
  57659. * @returns "PBRClearCoatConfiguration"
  57660. */
  57661. getClassName(): string;
  57662. /**
  57663. * Add fallbacks to the effect fallbacks list.
  57664. * @param defines defines the Base texture to use.
  57665. * @param fallbacks defines the current fallback list.
  57666. * @param currentRank defines the current fallback rank.
  57667. * @returns the new fallback rank.
  57668. */
  57669. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57670. /**
  57671. * Add the required uniforms to the current list.
  57672. * @param uniforms defines the current uniform list.
  57673. */
  57674. static AddUniforms(uniforms: string[]): void;
  57675. /**
  57676. * Add the required samplers to the current list.
  57677. * @param samplers defines the current sampler list.
  57678. */
  57679. static AddSamplers(samplers: string[]): void;
  57680. /**
  57681. * Add the required uniforms to the current buffer.
  57682. * @param uniformBuffer defines the current uniform buffer.
  57683. */
  57684. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57685. /**
  57686. * Makes a duplicate of the current configuration into another one.
  57687. * @param clearCoatConfiguration define the config where to copy the info
  57688. */
  57689. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57690. /**
  57691. * Serializes this clear coat configuration.
  57692. * @returns - An object with the serialized config.
  57693. */
  57694. serialize(): any;
  57695. /**
  57696. * Parses a anisotropy Configuration from a serialized object.
  57697. * @param source - Serialized object.
  57698. * @param scene Defines the scene we are parsing for
  57699. * @param rootUrl Defines the rootUrl to load from
  57700. */
  57701. parse(source: any, scene: Scene, rootUrl: string): void;
  57702. }
  57703. }
  57704. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57705. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57706. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57707. import { Vector2 } from "babylonjs/Maths/math.vector";
  57708. import { Scene } from "babylonjs/scene";
  57709. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57710. import { Nullable } from "babylonjs/types";
  57711. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57712. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57713. /**
  57714. * @hidden
  57715. */
  57716. export interface IMaterialAnisotropicDefines {
  57717. ANISOTROPIC: boolean;
  57718. ANISOTROPIC_TEXTURE: boolean;
  57719. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57720. MAINUV1: boolean;
  57721. _areTexturesDirty: boolean;
  57722. _needUVs: boolean;
  57723. }
  57724. /**
  57725. * Define the code related to the anisotropic parameters of the pbr material.
  57726. */
  57727. export class PBRAnisotropicConfiguration {
  57728. private _isEnabled;
  57729. /**
  57730. * Defines if the anisotropy is enabled in the material.
  57731. */
  57732. isEnabled: boolean;
  57733. /**
  57734. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  57735. */
  57736. intensity: number;
  57737. /**
  57738. * Defines if the effect is along the tangents, bitangents or in between.
  57739. * By default, the effect is "strectching" the highlights along the tangents.
  57740. */
  57741. direction: Vector2;
  57742. private _texture;
  57743. /**
  57744. * Stores the anisotropy values in a texture.
  57745. * rg is direction (like normal from -1 to 1)
  57746. * b is a intensity
  57747. */
  57748. texture: Nullable<BaseTexture>;
  57749. /** @hidden */
  57750. private _internalMarkAllSubMeshesAsTexturesDirty;
  57751. /** @hidden */
  57752. _markAllSubMeshesAsTexturesDirty(): void;
  57753. /**
  57754. * Instantiate a new istance of anisotropy configuration.
  57755. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57756. */
  57757. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57758. /**
  57759. * Specifies that the submesh is ready to be used.
  57760. * @param defines the list of "defines" to update.
  57761. * @param scene defines the scene the material belongs to.
  57762. * @returns - boolean indicating that the submesh is ready or not.
  57763. */
  57764. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57765. /**
  57766. * Checks to see if a texture is used in the material.
  57767. * @param defines the list of "defines" to update.
  57768. * @param mesh the mesh we are preparing the defines for.
  57769. * @param scene defines the scene the material belongs to.
  57770. */
  57771. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57772. /**
  57773. * Binds the material data.
  57774. * @param uniformBuffer defines the Uniform buffer to fill in.
  57775. * @param scene defines the scene the material belongs to.
  57776. * @param isFrozen defines wether the material is frozen or not.
  57777. */
  57778. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57779. /**
  57780. * Checks to see if a texture is used in the material.
  57781. * @param texture - Base texture to use.
  57782. * @returns - Boolean specifying if a texture is used in the material.
  57783. */
  57784. hasTexture(texture: BaseTexture): boolean;
  57785. /**
  57786. * Returns an array of the actively used textures.
  57787. * @param activeTextures Array of BaseTextures
  57788. */
  57789. getActiveTextures(activeTextures: BaseTexture[]): void;
  57790. /**
  57791. * Returns the animatable textures.
  57792. * @param animatables Array of animatable textures.
  57793. */
  57794. getAnimatables(animatables: IAnimatable[]): void;
  57795. /**
  57796. * Disposes the resources of the material.
  57797. * @param forceDisposeTextures - Forces the disposal of all textures.
  57798. */
  57799. dispose(forceDisposeTextures?: boolean): void;
  57800. /**
  57801. * Get the current class name of the texture useful for serialization or dynamic coding.
  57802. * @returns "PBRAnisotropicConfiguration"
  57803. */
  57804. getClassName(): string;
  57805. /**
  57806. * Add fallbacks to the effect fallbacks list.
  57807. * @param defines defines the Base texture to use.
  57808. * @param fallbacks defines the current fallback list.
  57809. * @param currentRank defines the current fallback rank.
  57810. * @returns the new fallback rank.
  57811. */
  57812. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57813. /**
  57814. * Add the required uniforms to the current list.
  57815. * @param uniforms defines the current uniform list.
  57816. */
  57817. static AddUniforms(uniforms: string[]): void;
  57818. /**
  57819. * Add the required uniforms to the current buffer.
  57820. * @param uniformBuffer defines the current uniform buffer.
  57821. */
  57822. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57823. /**
  57824. * Add the required samplers to the current list.
  57825. * @param samplers defines the current sampler list.
  57826. */
  57827. static AddSamplers(samplers: string[]): void;
  57828. /**
  57829. * Makes a duplicate of the current configuration into another one.
  57830. * @param anisotropicConfiguration define the config where to copy the info
  57831. */
  57832. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57833. /**
  57834. * Serializes this anisotropy configuration.
  57835. * @returns - An object with the serialized config.
  57836. */
  57837. serialize(): any;
  57838. /**
  57839. * Parses a anisotropy Configuration from a serialized object.
  57840. * @param source - Serialized object.
  57841. * @param scene Defines the scene we are parsing for
  57842. * @param rootUrl Defines the rootUrl to load from
  57843. */
  57844. parse(source: any, scene: Scene, rootUrl: string): void;
  57845. }
  57846. }
  57847. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57848. import { Scene } from "babylonjs/scene";
  57849. /**
  57850. * @hidden
  57851. */
  57852. export interface IMaterialBRDFDefines {
  57853. BRDF_V_HEIGHT_CORRELATED: boolean;
  57854. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57855. SPHERICAL_HARMONICS: boolean;
  57856. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57857. /** @hidden */
  57858. _areMiscDirty: boolean;
  57859. }
  57860. /**
  57861. * Define the code related to the BRDF parameters of the pbr material.
  57862. */
  57863. export class PBRBRDFConfiguration {
  57864. /**
  57865. * Default value used for the energy conservation.
  57866. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57867. */
  57868. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57869. /**
  57870. * Default value used for the Smith Visibility Height Correlated mode.
  57871. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57872. */
  57873. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57874. /**
  57875. * Default value used for the IBL diffuse part.
  57876. * This can help switching back to the polynomials mode globally which is a tiny bit
  57877. * less GPU intensive at the drawback of a lower quality.
  57878. */
  57879. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57880. /**
  57881. * Default value used for activating energy conservation for the specular workflow.
  57882. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57883. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57884. */
  57885. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57886. private _useEnergyConservation;
  57887. /**
  57888. * Defines if the material uses energy conservation.
  57889. */
  57890. useEnergyConservation: boolean;
  57891. private _useSmithVisibilityHeightCorrelated;
  57892. /**
  57893. * LEGACY Mode set to false
  57894. * Defines if the material uses height smith correlated visibility term.
  57895. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57896. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57897. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57898. * Not relying on height correlated will also disable energy conservation.
  57899. */
  57900. useSmithVisibilityHeightCorrelated: boolean;
  57901. private _useSphericalHarmonics;
  57902. /**
  57903. * LEGACY Mode set to false
  57904. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  57905. * diffuse part of the IBL.
  57906. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  57907. * to the ground truth.
  57908. */
  57909. useSphericalHarmonics: boolean;
  57910. private _useSpecularGlossinessInputEnergyConservation;
  57911. /**
  57912. * Defines if the material uses energy conservation, when the specular workflow is active.
  57913. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57914. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57915. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  57916. */
  57917. useSpecularGlossinessInputEnergyConservation: boolean;
  57918. /** @hidden */
  57919. private _internalMarkAllSubMeshesAsMiscDirty;
  57920. /** @hidden */
  57921. _markAllSubMeshesAsMiscDirty(): void;
  57922. /**
  57923. * Instantiate a new istance of clear coat configuration.
  57924. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  57925. */
  57926. constructor(markAllSubMeshesAsMiscDirty: () => void);
  57927. /**
  57928. * Checks to see if a texture is used in the material.
  57929. * @param defines the list of "defines" to update.
  57930. */
  57931. prepareDefines(defines: IMaterialBRDFDefines): 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. * Makes a duplicate of the current configuration into another one.
  57939. * @param brdfConfiguration define the config where to copy the info
  57940. */
  57941. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  57942. /**
  57943. * Serializes this BRDF configuration.
  57944. * @returns - An object with the serialized config.
  57945. */
  57946. serialize(): any;
  57947. /**
  57948. * Parses a anisotropy Configuration from a serialized object.
  57949. * @param source - Serialized object.
  57950. * @param scene Defines the scene we are parsing for
  57951. * @param rootUrl Defines the rootUrl to load from
  57952. */
  57953. parse(source: any, scene: Scene, rootUrl: string): void;
  57954. }
  57955. }
  57956. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  57957. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57958. import { Color3 } from "babylonjs/Maths/math.color";
  57959. import { Scene } from "babylonjs/scene";
  57960. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57961. import { Nullable } from "babylonjs/types";
  57962. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57963. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57964. /**
  57965. * @hidden
  57966. */
  57967. export interface IMaterialSheenDefines {
  57968. SHEEN: boolean;
  57969. SHEEN_TEXTURE: boolean;
  57970. SHEEN_TEXTUREDIRECTUV: number;
  57971. SHEEN_LINKWITHALBEDO: boolean;
  57972. SHEEN_ROUGHNESS: boolean;
  57973. SHEEN_ALBEDOSCALING: boolean;
  57974. /** @hidden */
  57975. _areTexturesDirty: boolean;
  57976. }
  57977. /**
  57978. * Define the code related to the Sheen parameters of the pbr material.
  57979. */
  57980. export class PBRSheenConfiguration {
  57981. private _isEnabled;
  57982. /**
  57983. * Defines if the material uses sheen.
  57984. */
  57985. isEnabled: boolean;
  57986. private _linkSheenWithAlbedo;
  57987. /**
  57988. * Defines if the sheen is linked to the sheen color.
  57989. */
  57990. linkSheenWithAlbedo: boolean;
  57991. /**
  57992. * Defines the sheen intensity.
  57993. */
  57994. intensity: number;
  57995. /**
  57996. * Defines the sheen color.
  57997. */
  57998. color: Color3;
  57999. private _texture;
  58000. /**
  58001. * Stores the sheen tint values in a texture.
  58002. * rgb is tint
  58003. * a is a intensity or roughness if roughness has been defined
  58004. */
  58005. texture: Nullable<BaseTexture>;
  58006. private _roughness;
  58007. /**
  58008. * Defines the sheen roughness.
  58009. * It is not taken into account if linkSheenWithAlbedo is true.
  58010. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  58011. */
  58012. roughness: Nullable<number>;
  58013. private _albedoScaling;
  58014. /**
  58015. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  58016. * It allows the strength of the sheen effect to not depend on the base color of the material,
  58017. * making it easier to setup and tweak the effect
  58018. */
  58019. albedoScaling: boolean;
  58020. /** @hidden */
  58021. private _internalMarkAllSubMeshesAsTexturesDirty;
  58022. /** @hidden */
  58023. _markAllSubMeshesAsTexturesDirty(): void;
  58024. /**
  58025. * Instantiate a new istance of clear coat configuration.
  58026. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58027. */
  58028. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58029. /**
  58030. * Specifies that the submesh is ready to be used.
  58031. * @param defines the list of "defines" to update.
  58032. * @param scene defines the scene the material belongs to.
  58033. * @returns - boolean indicating that the submesh is ready or not.
  58034. */
  58035. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  58036. /**
  58037. * Checks to see if a texture is used in the material.
  58038. * @param defines the list of "defines" to update.
  58039. * @param scene defines the scene the material belongs to.
  58040. */
  58041. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  58042. /**
  58043. * Binds the material data.
  58044. * @param uniformBuffer defines the Uniform buffer to fill in.
  58045. * @param scene defines the scene the material belongs to.
  58046. * @param isFrozen defines wether the material is frozen or not.
  58047. */
  58048. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58049. /**
  58050. * Checks to see if a texture is used in the material.
  58051. * @param texture - Base texture to use.
  58052. * @returns - Boolean specifying if a texture is used in the material.
  58053. */
  58054. hasTexture(texture: BaseTexture): boolean;
  58055. /**
  58056. * Returns an array of the actively used textures.
  58057. * @param activeTextures Array of BaseTextures
  58058. */
  58059. getActiveTextures(activeTextures: BaseTexture[]): void;
  58060. /**
  58061. * Returns the animatable textures.
  58062. * @param animatables Array of animatable textures.
  58063. */
  58064. getAnimatables(animatables: IAnimatable[]): void;
  58065. /**
  58066. * Disposes the resources of the material.
  58067. * @param forceDisposeTextures - Forces the disposal of all textures.
  58068. */
  58069. dispose(forceDisposeTextures?: boolean): void;
  58070. /**
  58071. * Get the current class name of the texture useful for serialization or dynamic coding.
  58072. * @returns "PBRSheenConfiguration"
  58073. */
  58074. getClassName(): string;
  58075. /**
  58076. * Add fallbacks to the effect fallbacks list.
  58077. * @param defines defines the Base texture to use.
  58078. * @param fallbacks defines the current fallback list.
  58079. * @param currentRank defines the current fallback rank.
  58080. * @returns the new fallback rank.
  58081. */
  58082. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58083. /**
  58084. * Add the required uniforms to the current list.
  58085. * @param uniforms defines the current uniform list.
  58086. */
  58087. static AddUniforms(uniforms: string[]): void;
  58088. /**
  58089. * Add the required uniforms to the current buffer.
  58090. * @param uniformBuffer defines the current uniform buffer.
  58091. */
  58092. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58093. /**
  58094. * Add the required samplers to the current list.
  58095. * @param samplers defines the current sampler list.
  58096. */
  58097. static AddSamplers(samplers: string[]): void;
  58098. /**
  58099. * Makes a duplicate of the current configuration into another one.
  58100. * @param sheenConfiguration define the config where to copy the info
  58101. */
  58102. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  58103. /**
  58104. * Serializes this BRDF configuration.
  58105. * @returns - An object with the serialized config.
  58106. */
  58107. serialize(): any;
  58108. /**
  58109. * Parses a anisotropy Configuration from a serialized object.
  58110. * @param source - Serialized object.
  58111. * @param scene Defines the scene we are parsing for
  58112. * @param rootUrl Defines the rootUrl to load from
  58113. */
  58114. parse(source: any, scene: Scene, rootUrl: string): void;
  58115. }
  58116. }
  58117. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  58118. import { Nullable } from "babylonjs/types";
  58119. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58120. import { Color3 } from "babylonjs/Maths/math.color";
  58121. import { SmartArray } from "babylonjs/Misc/smartArray";
  58122. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58123. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58124. import { Effect } from "babylonjs/Materials/effect";
  58125. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58126. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58127. import { Engine } from "babylonjs/Engines/engine";
  58128. import { Scene } from "babylonjs/scene";
  58129. /**
  58130. * @hidden
  58131. */
  58132. export interface IMaterialSubSurfaceDefines {
  58133. SUBSURFACE: boolean;
  58134. SS_REFRACTION: boolean;
  58135. SS_TRANSLUCENCY: boolean;
  58136. SS_SCATTERING: boolean;
  58137. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58138. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58139. SS_REFRACTIONMAP_3D: boolean;
  58140. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58141. SS_LODINREFRACTIONALPHA: boolean;
  58142. SS_GAMMAREFRACTION: boolean;
  58143. SS_RGBDREFRACTION: boolean;
  58144. SS_LINEARSPECULARREFRACTION: boolean;
  58145. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58146. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58147. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58148. /** @hidden */
  58149. _areTexturesDirty: boolean;
  58150. }
  58151. /**
  58152. * Define the code related to the sub surface parameters of the pbr material.
  58153. */
  58154. export class PBRSubSurfaceConfiguration {
  58155. private _isRefractionEnabled;
  58156. /**
  58157. * Defines if the refraction is enabled in the material.
  58158. */
  58159. isRefractionEnabled: boolean;
  58160. private _isTranslucencyEnabled;
  58161. /**
  58162. * Defines if the translucency is enabled in the material.
  58163. */
  58164. isTranslucencyEnabled: boolean;
  58165. private _isScatteringEnabled;
  58166. /**
  58167. * Defines if the sub surface scattering is enabled in the material.
  58168. */
  58169. isScatteringEnabled: boolean;
  58170. private _scatteringDiffusionProfileIndex;
  58171. /**
  58172. * Diffusion profile for subsurface scattering.
  58173. * Useful for better scattering in the skins or foliages.
  58174. */
  58175. get scatteringDiffusionProfile(): Nullable<Color3>;
  58176. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58177. /**
  58178. * Defines the refraction intensity of the material.
  58179. * The refraction when enabled replaces the Diffuse part of the material.
  58180. * The intensity helps transitionning between diffuse and refraction.
  58181. */
  58182. refractionIntensity: number;
  58183. /**
  58184. * Defines the translucency intensity of the material.
  58185. * When translucency has been enabled, this defines how much of the "translucency"
  58186. * is addded to the diffuse part of the material.
  58187. */
  58188. translucencyIntensity: number;
  58189. /**
  58190. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58191. */
  58192. useAlbedoToTintRefraction: boolean;
  58193. private _thicknessTexture;
  58194. /**
  58195. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58196. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58197. * 0 would mean minimumThickness
  58198. * 1 would mean maximumThickness
  58199. * The other channels might be use as a mask to vary the different effects intensity.
  58200. */
  58201. thicknessTexture: Nullable<BaseTexture>;
  58202. private _refractionTexture;
  58203. /**
  58204. * Defines the texture to use for refraction.
  58205. */
  58206. refractionTexture: Nullable<BaseTexture>;
  58207. private _indexOfRefraction;
  58208. /**
  58209. * Index of refraction of the material base layer.
  58210. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58211. *
  58212. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58213. *
  58214. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58215. */
  58216. indexOfRefraction: number;
  58217. private _volumeIndexOfRefraction;
  58218. /**
  58219. * Index of refraction of the material's volume.
  58220. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58221. *
  58222. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58223. * the volume will use the same IOR as the surface.
  58224. */
  58225. get volumeIndexOfRefraction(): number;
  58226. set volumeIndexOfRefraction(value: number);
  58227. private _invertRefractionY;
  58228. /**
  58229. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58230. */
  58231. invertRefractionY: boolean;
  58232. private _linkRefractionWithTransparency;
  58233. /**
  58234. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58235. * Materials half opaque for instance using refraction could benefit from this control.
  58236. */
  58237. linkRefractionWithTransparency: boolean;
  58238. /**
  58239. * Defines the minimum thickness stored in the thickness map.
  58240. * If no thickness map is defined, this value will be used to simulate thickness.
  58241. */
  58242. minimumThickness: number;
  58243. /**
  58244. * Defines the maximum thickness stored in the thickness map.
  58245. */
  58246. maximumThickness: number;
  58247. /**
  58248. * Defines the volume tint of the material.
  58249. * This is used for both translucency and scattering.
  58250. */
  58251. tintColor: Color3;
  58252. /**
  58253. * Defines the distance at which the tint color should be found in the media.
  58254. * This is used for refraction only.
  58255. */
  58256. tintColorAtDistance: number;
  58257. /**
  58258. * Defines how far each channel transmit through the media.
  58259. * It is defined as a color to simplify it selection.
  58260. */
  58261. diffusionDistance: Color3;
  58262. private _useMaskFromThicknessTexture;
  58263. /**
  58264. * Stores the intensity of the different subsurface effects in the thickness texture.
  58265. * * the green channel is the translucency intensity.
  58266. * * the blue channel is the scattering intensity.
  58267. * * the alpha channel is the refraction intensity.
  58268. */
  58269. useMaskFromThicknessTexture: boolean;
  58270. private _scene;
  58271. /** @hidden */
  58272. private _internalMarkAllSubMeshesAsTexturesDirty;
  58273. private _internalMarkScenePrePassDirty;
  58274. /** @hidden */
  58275. _markAllSubMeshesAsTexturesDirty(): void;
  58276. /** @hidden */
  58277. _markScenePrePassDirty(): void;
  58278. /**
  58279. * Instantiate a new istance of sub surface configuration.
  58280. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58281. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58282. * @param scene The scene
  58283. */
  58284. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58285. /**
  58286. * Gets wehter the submesh is ready to be used or not.
  58287. * @param defines the list of "defines" to update.
  58288. * @param scene defines the scene the material belongs to.
  58289. * @returns - boolean indicating that the submesh is ready or not.
  58290. */
  58291. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58292. /**
  58293. * Checks to see if a texture is used in the material.
  58294. * @param defines the list of "defines" to update.
  58295. * @param scene defines the scene to the material belongs to.
  58296. */
  58297. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58298. /**
  58299. * Binds the material data.
  58300. * @param uniformBuffer defines the Uniform buffer to fill in.
  58301. * @param scene defines the scene the material belongs to.
  58302. * @param engine defines the engine the material belongs to.
  58303. * @param isFrozen defines whether the material is frozen or not.
  58304. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58305. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58306. */
  58307. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58308. /**
  58309. * Unbinds the material from the mesh.
  58310. * @param activeEffect defines the effect that should be unbound from.
  58311. * @returns true if unbound, otherwise false
  58312. */
  58313. unbind(activeEffect: Effect): boolean;
  58314. /**
  58315. * Returns the texture used for refraction or null if none is used.
  58316. * @param scene defines the scene the material belongs to.
  58317. * @returns - Refraction texture if present. If no refraction texture and refraction
  58318. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58319. */
  58320. private _getRefractionTexture;
  58321. /**
  58322. * Returns true if alpha blending should be disabled.
  58323. */
  58324. get disableAlphaBlending(): boolean;
  58325. /**
  58326. * Fills the list of render target textures.
  58327. * @param renderTargets the list of render targets to update
  58328. */
  58329. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58330. /**
  58331. * Checks to see if a texture is used in the material.
  58332. * @param texture - Base texture to use.
  58333. * @returns - Boolean specifying if a texture is used in the material.
  58334. */
  58335. hasTexture(texture: BaseTexture): boolean;
  58336. /**
  58337. * Gets a boolean indicating that current material needs to register RTT
  58338. * @returns true if this uses a render target otherwise false.
  58339. */
  58340. hasRenderTargetTextures(): boolean;
  58341. /**
  58342. * Returns an array of the actively used textures.
  58343. * @param activeTextures Array of BaseTextures
  58344. */
  58345. getActiveTextures(activeTextures: BaseTexture[]): void;
  58346. /**
  58347. * Returns the animatable textures.
  58348. * @param animatables Array of animatable textures.
  58349. */
  58350. getAnimatables(animatables: IAnimatable[]): void;
  58351. /**
  58352. * Disposes the resources of the material.
  58353. * @param forceDisposeTextures - Forces the disposal of all textures.
  58354. */
  58355. dispose(forceDisposeTextures?: boolean): void;
  58356. /**
  58357. * Get the current class name of the texture useful for serialization or dynamic coding.
  58358. * @returns "PBRSubSurfaceConfiguration"
  58359. */
  58360. getClassName(): string;
  58361. /**
  58362. * Add fallbacks to the effect fallbacks list.
  58363. * @param defines defines the Base texture to use.
  58364. * @param fallbacks defines the current fallback list.
  58365. * @param currentRank defines the current fallback rank.
  58366. * @returns the new fallback rank.
  58367. */
  58368. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58369. /**
  58370. * Add the required uniforms to the current list.
  58371. * @param uniforms defines the current uniform list.
  58372. */
  58373. static AddUniforms(uniforms: string[]): void;
  58374. /**
  58375. * Add the required samplers to the current list.
  58376. * @param samplers defines the current sampler list.
  58377. */
  58378. static AddSamplers(samplers: string[]): void;
  58379. /**
  58380. * Add the required uniforms to the current buffer.
  58381. * @param uniformBuffer defines the current uniform buffer.
  58382. */
  58383. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58384. /**
  58385. * Makes a duplicate of the current configuration into another one.
  58386. * @param configuration define the config where to copy the info
  58387. */
  58388. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58389. /**
  58390. * Serializes this Sub Surface configuration.
  58391. * @returns - An object with the serialized config.
  58392. */
  58393. serialize(): any;
  58394. /**
  58395. * Parses a anisotropy Configuration from a serialized object.
  58396. * @param source - Serialized object.
  58397. * @param scene Defines the scene we are parsing for
  58398. * @param rootUrl Defines the rootUrl to load from
  58399. */
  58400. parse(source: any, scene: Scene, rootUrl: string): void;
  58401. }
  58402. }
  58403. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58404. /** @hidden */
  58405. export var pbrFragmentDeclaration: {
  58406. name: string;
  58407. shader: string;
  58408. };
  58409. }
  58410. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58411. /** @hidden */
  58412. export var pbrUboDeclaration: {
  58413. name: string;
  58414. shader: string;
  58415. };
  58416. }
  58417. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58418. /** @hidden */
  58419. export var pbrFragmentExtraDeclaration: {
  58420. name: string;
  58421. shader: string;
  58422. };
  58423. }
  58424. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58425. /** @hidden */
  58426. export var pbrFragmentSamplersDeclaration: {
  58427. name: string;
  58428. shader: string;
  58429. };
  58430. }
  58431. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58432. /** @hidden */
  58433. export var importanceSampling: {
  58434. name: string;
  58435. shader: string;
  58436. };
  58437. }
  58438. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58439. /** @hidden */
  58440. export var pbrHelperFunctions: {
  58441. name: string;
  58442. shader: string;
  58443. };
  58444. }
  58445. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58446. /** @hidden */
  58447. export var harmonicsFunctions: {
  58448. name: string;
  58449. shader: string;
  58450. };
  58451. }
  58452. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58453. /** @hidden */
  58454. export var pbrDirectLightingSetupFunctions: {
  58455. name: string;
  58456. shader: string;
  58457. };
  58458. }
  58459. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58460. /** @hidden */
  58461. export var pbrDirectLightingFalloffFunctions: {
  58462. name: string;
  58463. shader: string;
  58464. };
  58465. }
  58466. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58467. /** @hidden */
  58468. export var pbrBRDFFunctions: {
  58469. name: string;
  58470. shader: string;
  58471. };
  58472. }
  58473. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58474. /** @hidden */
  58475. export var hdrFilteringFunctions: {
  58476. name: string;
  58477. shader: string;
  58478. };
  58479. }
  58480. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58481. /** @hidden */
  58482. export var pbrDirectLightingFunctions: {
  58483. name: string;
  58484. shader: string;
  58485. };
  58486. }
  58487. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58488. /** @hidden */
  58489. export var pbrIBLFunctions: {
  58490. name: string;
  58491. shader: string;
  58492. };
  58493. }
  58494. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58495. /** @hidden */
  58496. export var pbrBlockAlbedoOpacity: {
  58497. name: string;
  58498. shader: string;
  58499. };
  58500. }
  58501. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58502. /** @hidden */
  58503. export var pbrBlockReflectivity: {
  58504. name: string;
  58505. shader: string;
  58506. };
  58507. }
  58508. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58509. /** @hidden */
  58510. export var pbrBlockAmbientOcclusion: {
  58511. name: string;
  58512. shader: string;
  58513. };
  58514. }
  58515. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58516. /** @hidden */
  58517. export var pbrBlockAlphaFresnel: {
  58518. name: string;
  58519. shader: string;
  58520. };
  58521. }
  58522. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58523. /** @hidden */
  58524. export var pbrBlockAnisotropic: {
  58525. name: string;
  58526. shader: string;
  58527. };
  58528. }
  58529. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58530. /** @hidden */
  58531. export var pbrBlockReflection: {
  58532. name: string;
  58533. shader: string;
  58534. };
  58535. }
  58536. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58537. /** @hidden */
  58538. export var pbrBlockSheen: {
  58539. name: string;
  58540. shader: string;
  58541. };
  58542. }
  58543. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58544. /** @hidden */
  58545. export var pbrBlockClearcoat: {
  58546. name: string;
  58547. shader: string;
  58548. };
  58549. }
  58550. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58551. /** @hidden */
  58552. export var pbrBlockSubSurface: {
  58553. name: string;
  58554. shader: string;
  58555. };
  58556. }
  58557. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58558. /** @hidden */
  58559. export var pbrBlockNormalGeometric: {
  58560. name: string;
  58561. shader: string;
  58562. };
  58563. }
  58564. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58565. /** @hidden */
  58566. export var pbrBlockNormalFinal: {
  58567. name: string;
  58568. shader: string;
  58569. };
  58570. }
  58571. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58572. /** @hidden */
  58573. export var pbrBlockLightmapInit: {
  58574. name: string;
  58575. shader: string;
  58576. };
  58577. }
  58578. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58579. /** @hidden */
  58580. export var pbrBlockGeometryInfo: {
  58581. name: string;
  58582. shader: string;
  58583. };
  58584. }
  58585. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58586. /** @hidden */
  58587. export var pbrBlockReflectance0: {
  58588. name: string;
  58589. shader: string;
  58590. };
  58591. }
  58592. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58593. /** @hidden */
  58594. export var pbrBlockReflectance: {
  58595. name: string;
  58596. shader: string;
  58597. };
  58598. }
  58599. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58600. /** @hidden */
  58601. export var pbrBlockDirectLighting: {
  58602. name: string;
  58603. shader: string;
  58604. };
  58605. }
  58606. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58607. /** @hidden */
  58608. export var pbrBlockFinalLitComponents: {
  58609. name: string;
  58610. shader: string;
  58611. };
  58612. }
  58613. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58614. /** @hidden */
  58615. export var pbrBlockFinalUnlitComponents: {
  58616. name: string;
  58617. shader: string;
  58618. };
  58619. }
  58620. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58621. /** @hidden */
  58622. export var pbrBlockFinalColorComposition: {
  58623. name: string;
  58624. shader: string;
  58625. };
  58626. }
  58627. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58628. /** @hidden */
  58629. export var pbrBlockImageProcessing: {
  58630. name: string;
  58631. shader: string;
  58632. };
  58633. }
  58634. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58635. /** @hidden */
  58636. export var pbrDebug: {
  58637. name: string;
  58638. shader: string;
  58639. };
  58640. }
  58641. declare module "babylonjs/Shaders/pbr.fragment" {
  58642. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58643. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58644. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58645. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58646. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58647. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58648. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58649. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58650. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58651. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58652. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58653. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58654. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58655. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58656. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58657. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58658. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58659. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58660. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58661. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58662. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58663. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58664. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58665. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58666. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58667. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58668. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58669. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58670. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58671. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58672. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58673. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58674. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58675. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58676. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58677. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58678. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58679. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58680. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58681. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58682. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58683. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58684. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58685. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58686. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58687. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58688. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58689. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58690. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58691. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58692. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58693. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58694. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58695. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58696. /** @hidden */
  58697. export var pbrPixelShader: {
  58698. name: string;
  58699. shader: string;
  58700. };
  58701. }
  58702. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58703. /** @hidden */
  58704. export var pbrVertexDeclaration: {
  58705. name: string;
  58706. shader: string;
  58707. };
  58708. }
  58709. declare module "babylonjs/Shaders/pbr.vertex" {
  58710. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58711. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58712. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58713. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58714. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58715. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58716. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58717. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  58718. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  58719. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58720. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58721. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  58722. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  58723. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58724. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  58725. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  58726. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  58727. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  58728. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58729. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  58730. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  58731. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  58732. /** @hidden */
  58733. export var pbrVertexShader: {
  58734. name: string;
  58735. shader: string;
  58736. };
  58737. }
  58738. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  58739. import { Nullable } from "babylonjs/types";
  58740. import { Scene } from "babylonjs/scene";
  58741. import { Matrix } from "babylonjs/Maths/math.vector";
  58742. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58743. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58744. import { Mesh } from "babylonjs/Meshes/mesh";
  58745. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58746. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58747. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58748. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58749. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58750. import { Color3 } from "babylonjs/Maths/math.color";
  58751. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58752. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58753. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58754. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58755. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58756. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58757. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58758. import "babylonjs/Shaders/pbr.fragment";
  58759. import "babylonjs/Shaders/pbr.vertex";
  58760. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58761. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58762. /**
  58763. * Manages the defines for the PBR Material.
  58764. * @hidden
  58765. */
  58766. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58767. PBR: boolean;
  58768. NUM_SAMPLES: string;
  58769. REALTIME_FILTERING: boolean;
  58770. MAINUV1: boolean;
  58771. MAINUV2: boolean;
  58772. UV1: boolean;
  58773. UV2: boolean;
  58774. ALBEDO: boolean;
  58775. GAMMAALBEDO: boolean;
  58776. ALBEDODIRECTUV: number;
  58777. VERTEXCOLOR: boolean;
  58778. DETAIL: boolean;
  58779. DETAILDIRECTUV: number;
  58780. DETAIL_NORMALBLENDMETHOD: number;
  58781. AMBIENT: boolean;
  58782. AMBIENTDIRECTUV: number;
  58783. AMBIENTINGRAYSCALE: boolean;
  58784. OPACITY: boolean;
  58785. VERTEXALPHA: boolean;
  58786. OPACITYDIRECTUV: number;
  58787. OPACITYRGB: boolean;
  58788. ALPHATEST: boolean;
  58789. DEPTHPREPASS: boolean;
  58790. ALPHABLEND: boolean;
  58791. ALPHAFROMALBEDO: boolean;
  58792. ALPHATESTVALUE: string;
  58793. SPECULAROVERALPHA: boolean;
  58794. RADIANCEOVERALPHA: boolean;
  58795. ALPHAFRESNEL: boolean;
  58796. LINEARALPHAFRESNEL: boolean;
  58797. PREMULTIPLYALPHA: boolean;
  58798. EMISSIVE: boolean;
  58799. EMISSIVEDIRECTUV: number;
  58800. REFLECTIVITY: boolean;
  58801. REFLECTIVITYDIRECTUV: number;
  58802. SPECULARTERM: boolean;
  58803. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58804. MICROSURFACEAUTOMATIC: boolean;
  58805. LODBASEDMICROSFURACE: boolean;
  58806. MICROSURFACEMAP: boolean;
  58807. MICROSURFACEMAPDIRECTUV: number;
  58808. METALLICWORKFLOW: boolean;
  58809. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58810. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58811. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58812. AOSTOREINMETALMAPRED: boolean;
  58813. METALLIC_REFLECTANCE: boolean;
  58814. METALLIC_REFLECTANCEDIRECTUV: number;
  58815. ENVIRONMENTBRDF: boolean;
  58816. ENVIRONMENTBRDF_RGBD: boolean;
  58817. NORMAL: boolean;
  58818. TANGENT: boolean;
  58819. BUMP: boolean;
  58820. BUMPDIRECTUV: number;
  58821. OBJECTSPACE_NORMALMAP: boolean;
  58822. PARALLAX: boolean;
  58823. PARALLAXOCCLUSION: boolean;
  58824. NORMALXYSCALE: boolean;
  58825. LIGHTMAP: boolean;
  58826. LIGHTMAPDIRECTUV: number;
  58827. USELIGHTMAPASSHADOWMAP: boolean;
  58828. GAMMALIGHTMAP: boolean;
  58829. RGBDLIGHTMAP: boolean;
  58830. REFLECTION: boolean;
  58831. REFLECTIONMAP_3D: boolean;
  58832. REFLECTIONMAP_SPHERICAL: boolean;
  58833. REFLECTIONMAP_PLANAR: boolean;
  58834. REFLECTIONMAP_CUBIC: boolean;
  58835. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58836. REFLECTIONMAP_PROJECTION: boolean;
  58837. REFLECTIONMAP_SKYBOX: boolean;
  58838. REFLECTIONMAP_EXPLICIT: boolean;
  58839. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58840. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58841. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58842. INVERTCUBICMAP: boolean;
  58843. USESPHERICALFROMREFLECTIONMAP: boolean;
  58844. USEIRRADIANCEMAP: boolean;
  58845. SPHERICAL_HARMONICS: boolean;
  58846. USESPHERICALINVERTEX: boolean;
  58847. REFLECTIONMAP_OPPOSITEZ: boolean;
  58848. LODINREFLECTIONALPHA: boolean;
  58849. GAMMAREFLECTION: boolean;
  58850. RGBDREFLECTION: boolean;
  58851. LINEARSPECULARREFLECTION: boolean;
  58852. RADIANCEOCCLUSION: boolean;
  58853. HORIZONOCCLUSION: boolean;
  58854. INSTANCES: boolean;
  58855. THIN_INSTANCES: boolean;
  58856. PREPASS: boolean;
  58857. SCENE_MRT_COUNT: number;
  58858. NUM_BONE_INFLUENCERS: number;
  58859. BonesPerMesh: number;
  58860. BONETEXTURE: boolean;
  58861. NONUNIFORMSCALING: boolean;
  58862. MORPHTARGETS: boolean;
  58863. MORPHTARGETS_NORMAL: boolean;
  58864. MORPHTARGETS_TANGENT: boolean;
  58865. MORPHTARGETS_UV: boolean;
  58866. NUM_MORPH_INFLUENCERS: number;
  58867. IMAGEPROCESSING: boolean;
  58868. VIGNETTE: boolean;
  58869. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58870. VIGNETTEBLENDMODEOPAQUE: boolean;
  58871. TONEMAPPING: boolean;
  58872. TONEMAPPING_ACES: boolean;
  58873. CONTRAST: boolean;
  58874. COLORCURVES: boolean;
  58875. COLORGRADING: boolean;
  58876. COLORGRADING3D: boolean;
  58877. SAMPLER3DGREENDEPTH: boolean;
  58878. SAMPLER3DBGRMAP: boolean;
  58879. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58880. EXPOSURE: boolean;
  58881. MULTIVIEW: boolean;
  58882. USEPHYSICALLIGHTFALLOFF: boolean;
  58883. USEGLTFLIGHTFALLOFF: boolean;
  58884. TWOSIDEDLIGHTING: boolean;
  58885. SHADOWFLOAT: boolean;
  58886. CLIPPLANE: boolean;
  58887. CLIPPLANE2: boolean;
  58888. CLIPPLANE3: boolean;
  58889. CLIPPLANE4: boolean;
  58890. CLIPPLANE5: boolean;
  58891. CLIPPLANE6: boolean;
  58892. POINTSIZE: boolean;
  58893. FOG: boolean;
  58894. LOGARITHMICDEPTH: boolean;
  58895. FORCENORMALFORWARD: boolean;
  58896. SPECULARAA: boolean;
  58897. CLEARCOAT: boolean;
  58898. CLEARCOAT_DEFAULTIOR: boolean;
  58899. CLEARCOAT_TEXTURE: boolean;
  58900. CLEARCOAT_TEXTUREDIRECTUV: number;
  58901. CLEARCOAT_BUMP: boolean;
  58902. CLEARCOAT_BUMPDIRECTUV: number;
  58903. CLEARCOAT_TINT: boolean;
  58904. CLEARCOAT_TINT_TEXTURE: boolean;
  58905. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  58906. ANISOTROPIC: boolean;
  58907. ANISOTROPIC_TEXTURE: boolean;
  58908. ANISOTROPIC_TEXTUREDIRECTUV: number;
  58909. BRDF_V_HEIGHT_CORRELATED: boolean;
  58910. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58911. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58912. SHEEN: boolean;
  58913. SHEEN_TEXTURE: boolean;
  58914. SHEEN_TEXTUREDIRECTUV: number;
  58915. SHEEN_LINKWITHALBEDO: boolean;
  58916. SHEEN_ROUGHNESS: boolean;
  58917. SHEEN_ALBEDOSCALING: boolean;
  58918. SUBSURFACE: boolean;
  58919. SS_REFRACTION: boolean;
  58920. SS_TRANSLUCENCY: boolean;
  58921. SS_SCATTERING: boolean;
  58922. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58923. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58924. SS_REFRACTIONMAP_3D: boolean;
  58925. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58926. SS_LODINREFRACTIONALPHA: boolean;
  58927. SS_GAMMAREFRACTION: boolean;
  58928. SS_RGBDREFRACTION: boolean;
  58929. SS_LINEARSPECULARREFRACTION: boolean;
  58930. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58931. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58932. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58933. UNLIT: boolean;
  58934. DEBUGMODE: number;
  58935. /**
  58936. * Initializes the PBR Material defines.
  58937. */
  58938. constructor();
  58939. /**
  58940. * Resets the PBR Material defines.
  58941. */
  58942. reset(): void;
  58943. }
  58944. /**
  58945. * The Physically based material base class of BJS.
  58946. *
  58947. * This offers the main features of a standard PBR material.
  58948. * For more information, please refer to the documentation :
  58949. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58950. */
  58951. export abstract class PBRBaseMaterial extends PushMaterial {
  58952. /**
  58953. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58954. */
  58955. static readonly PBRMATERIAL_OPAQUE: number;
  58956. /**
  58957. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58958. */
  58959. static readonly PBRMATERIAL_ALPHATEST: number;
  58960. /**
  58961. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58962. */
  58963. static readonly PBRMATERIAL_ALPHABLEND: number;
  58964. /**
  58965. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58966. * They are also discarded below the alpha cutoff threshold to improve performances.
  58967. */
  58968. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58969. /**
  58970. * Defines the default value of how much AO map is occluding the analytical lights
  58971. * (point spot...).
  58972. */
  58973. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58974. /**
  58975. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  58976. */
  58977. static readonly LIGHTFALLOFF_PHYSICAL: number;
  58978. /**
  58979. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  58980. * to enhance interoperability with other engines.
  58981. */
  58982. static readonly LIGHTFALLOFF_GLTF: number;
  58983. /**
  58984. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  58985. * to enhance interoperability with other materials.
  58986. */
  58987. static readonly LIGHTFALLOFF_STANDARD: number;
  58988. /**
  58989. * Intensity of the direct lights e.g. the four lights available in your scene.
  58990. * This impacts both the direct diffuse and specular highlights.
  58991. */
  58992. protected _directIntensity: number;
  58993. /**
  58994. * Intensity of the emissive part of the material.
  58995. * This helps controlling the emissive effect without modifying the emissive color.
  58996. */
  58997. protected _emissiveIntensity: number;
  58998. /**
  58999. * Intensity of the environment e.g. how much the environment will light the object
  59000. * either through harmonics for rough material or through the refelction for shiny ones.
  59001. */
  59002. protected _environmentIntensity: number;
  59003. /**
  59004. * This is a special control allowing the reduction of the specular highlights coming from the
  59005. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59006. */
  59007. protected _specularIntensity: number;
  59008. /**
  59009. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  59010. */
  59011. private _lightingInfos;
  59012. /**
  59013. * Debug Control allowing disabling the bump map on this material.
  59014. */
  59015. protected _disableBumpMap: boolean;
  59016. /**
  59017. * AKA Diffuse Texture in standard nomenclature.
  59018. */
  59019. protected _albedoTexture: Nullable<BaseTexture>;
  59020. /**
  59021. * AKA Occlusion Texture in other nomenclature.
  59022. */
  59023. protected _ambientTexture: Nullable<BaseTexture>;
  59024. /**
  59025. * AKA Occlusion Texture Intensity in other nomenclature.
  59026. */
  59027. protected _ambientTextureStrength: number;
  59028. /**
  59029. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59030. * 1 means it completely occludes it
  59031. * 0 mean it has no impact
  59032. */
  59033. protected _ambientTextureImpactOnAnalyticalLights: number;
  59034. /**
  59035. * Stores the alpha values in a texture.
  59036. */
  59037. protected _opacityTexture: Nullable<BaseTexture>;
  59038. /**
  59039. * Stores the reflection values in a texture.
  59040. */
  59041. protected _reflectionTexture: Nullable<BaseTexture>;
  59042. /**
  59043. * Stores the emissive values in a texture.
  59044. */
  59045. protected _emissiveTexture: Nullable<BaseTexture>;
  59046. /**
  59047. * AKA Specular texture in other nomenclature.
  59048. */
  59049. protected _reflectivityTexture: Nullable<BaseTexture>;
  59050. /**
  59051. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59052. */
  59053. protected _metallicTexture: Nullable<BaseTexture>;
  59054. /**
  59055. * Specifies the metallic scalar of the metallic/roughness workflow.
  59056. * Can also be used to scale the metalness values of the metallic texture.
  59057. */
  59058. protected _metallic: Nullable<number>;
  59059. /**
  59060. * Specifies the roughness scalar of the metallic/roughness workflow.
  59061. * Can also be used to scale the roughness values of the metallic texture.
  59062. */
  59063. protected _roughness: Nullable<number>;
  59064. /**
  59065. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59066. * By default the indexOfrefraction is used to compute F0;
  59067. *
  59068. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59069. *
  59070. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59071. * F90 = metallicReflectanceColor;
  59072. */
  59073. protected _metallicF0Factor: number;
  59074. /**
  59075. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59076. * By default the F90 is always 1;
  59077. *
  59078. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59079. *
  59080. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59081. * F90 = metallicReflectanceColor;
  59082. */
  59083. protected _metallicReflectanceColor: Color3;
  59084. /**
  59085. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59086. * This is multiply against the scalar values defined in the material.
  59087. */
  59088. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  59089. /**
  59090. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59091. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59092. */
  59093. protected _microSurfaceTexture: Nullable<BaseTexture>;
  59094. /**
  59095. * Stores surface normal data used to displace a mesh in a texture.
  59096. */
  59097. protected _bumpTexture: Nullable<BaseTexture>;
  59098. /**
  59099. * Stores the pre-calculated light information of a mesh in a texture.
  59100. */
  59101. protected _lightmapTexture: Nullable<BaseTexture>;
  59102. /**
  59103. * The color of a material in ambient lighting.
  59104. */
  59105. protected _ambientColor: Color3;
  59106. /**
  59107. * AKA Diffuse Color in other nomenclature.
  59108. */
  59109. protected _albedoColor: Color3;
  59110. /**
  59111. * AKA Specular Color in other nomenclature.
  59112. */
  59113. protected _reflectivityColor: Color3;
  59114. /**
  59115. * The color applied when light is reflected from a material.
  59116. */
  59117. protected _reflectionColor: Color3;
  59118. /**
  59119. * The color applied when light is emitted from a material.
  59120. */
  59121. protected _emissiveColor: Color3;
  59122. /**
  59123. * AKA Glossiness in other nomenclature.
  59124. */
  59125. protected _microSurface: number;
  59126. /**
  59127. * Specifies that the material will use the light map as a show map.
  59128. */
  59129. protected _useLightmapAsShadowmap: boolean;
  59130. /**
  59131. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59132. * makes the reflect vector face the model (under horizon).
  59133. */
  59134. protected _useHorizonOcclusion: boolean;
  59135. /**
  59136. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59137. * too much the area relying on ambient texture to define their ambient occlusion.
  59138. */
  59139. protected _useRadianceOcclusion: boolean;
  59140. /**
  59141. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59142. */
  59143. protected _useAlphaFromAlbedoTexture: boolean;
  59144. /**
  59145. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59146. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59147. */
  59148. protected _useSpecularOverAlpha: boolean;
  59149. /**
  59150. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59151. */
  59152. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59153. /**
  59154. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59155. */
  59156. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59157. /**
  59158. * Specifies if the metallic texture contains the roughness information in its green channel.
  59159. */
  59160. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59161. /**
  59162. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59163. */
  59164. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59165. /**
  59166. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59167. */
  59168. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59169. /**
  59170. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59171. */
  59172. protected _useAmbientInGrayScale: boolean;
  59173. /**
  59174. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59175. * The material will try to infer what glossiness each pixel should be.
  59176. */
  59177. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59178. /**
  59179. * Defines the falloff type used in this material.
  59180. * It by default is Physical.
  59181. */
  59182. protected _lightFalloff: number;
  59183. /**
  59184. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59185. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59186. */
  59187. protected _useRadianceOverAlpha: boolean;
  59188. /**
  59189. * Allows using an object space normal map (instead of tangent space).
  59190. */
  59191. protected _useObjectSpaceNormalMap: boolean;
  59192. /**
  59193. * Allows using the bump map in parallax mode.
  59194. */
  59195. protected _useParallax: boolean;
  59196. /**
  59197. * Allows using the bump map in parallax occlusion mode.
  59198. */
  59199. protected _useParallaxOcclusion: boolean;
  59200. /**
  59201. * Controls the scale bias of the parallax mode.
  59202. */
  59203. protected _parallaxScaleBias: number;
  59204. /**
  59205. * If sets to true, disables all the lights affecting the material.
  59206. */
  59207. protected _disableLighting: boolean;
  59208. /**
  59209. * Number of Simultaneous lights allowed on the material.
  59210. */
  59211. protected _maxSimultaneousLights: number;
  59212. /**
  59213. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59214. */
  59215. protected _invertNormalMapX: boolean;
  59216. /**
  59217. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59218. */
  59219. protected _invertNormalMapY: boolean;
  59220. /**
  59221. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59222. */
  59223. protected _twoSidedLighting: boolean;
  59224. /**
  59225. * Defines the alpha limits in alpha test mode.
  59226. */
  59227. protected _alphaCutOff: number;
  59228. /**
  59229. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59230. */
  59231. protected _forceAlphaTest: boolean;
  59232. /**
  59233. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59234. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59235. */
  59236. protected _useAlphaFresnel: boolean;
  59237. /**
  59238. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59239. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59240. */
  59241. protected _useLinearAlphaFresnel: boolean;
  59242. /**
  59243. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59244. * from cos thetav and roughness:
  59245. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59246. */
  59247. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59248. /**
  59249. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59250. */
  59251. protected _forceIrradianceInFragment: boolean;
  59252. private _realTimeFiltering;
  59253. /**
  59254. * Enables realtime filtering on the texture.
  59255. */
  59256. get realTimeFiltering(): boolean;
  59257. set realTimeFiltering(b: boolean);
  59258. private _realTimeFilteringQuality;
  59259. /**
  59260. * Quality switch for realtime filtering
  59261. */
  59262. get realTimeFilteringQuality(): number;
  59263. set realTimeFilteringQuality(n: number);
  59264. /**
  59265. * Can this material render to several textures at once
  59266. */
  59267. get canRenderToMRT(): boolean;
  59268. /**
  59269. * Force normal to face away from face.
  59270. */
  59271. protected _forceNormalForward: boolean;
  59272. /**
  59273. * Enables specular anti aliasing in the PBR shader.
  59274. * It will both interacts on the Geometry for analytical and IBL lighting.
  59275. * It also prefilter the roughness map based on the bump values.
  59276. */
  59277. protected _enableSpecularAntiAliasing: boolean;
  59278. /**
  59279. * Default configuration related to image processing available in the PBR Material.
  59280. */
  59281. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59282. /**
  59283. * Keep track of the image processing observer to allow dispose and replace.
  59284. */
  59285. private _imageProcessingObserver;
  59286. /**
  59287. * Attaches a new image processing configuration to the PBR Material.
  59288. * @param configuration
  59289. */
  59290. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59291. /**
  59292. * Stores the available render targets.
  59293. */
  59294. private _renderTargets;
  59295. /**
  59296. * Sets the global ambient color for the material used in lighting calculations.
  59297. */
  59298. private _globalAmbientColor;
  59299. /**
  59300. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59301. */
  59302. private _useLogarithmicDepth;
  59303. /**
  59304. * If set to true, no lighting calculations will be applied.
  59305. */
  59306. private _unlit;
  59307. private _debugMode;
  59308. /**
  59309. * @hidden
  59310. * This is reserved for the inspector.
  59311. * Defines the material debug mode.
  59312. * It helps seeing only some components of the material while troubleshooting.
  59313. */
  59314. debugMode: number;
  59315. /**
  59316. * @hidden
  59317. * This is reserved for the inspector.
  59318. * Specify from where on screen the debug mode should start.
  59319. * The value goes from -1 (full screen) to 1 (not visible)
  59320. * It helps with side by side comparison against the final render
  59321. * This defaults to -1
  59322. */
  59323. private debugLimit;
  59324. /**
  59325. * @hidden
  59326. * This is reserved for the inspector.
  59327. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59328. * You can use the factor to better multiply the final value.
  59329. */
  59330. private debugFactor;
  59331. /**
  59332. * Defines the clear coat layer parameters for the material.
  59333. */
  59334. readonly clearCoat: PBRClearCoatConfiguration;
  59335. /**
  59336. * Defines the anisotropic parameters for the material.
  59337. */
  59338. readonly anisotropy: PBRAnisotropicConfiguration;
  59339. /**
  59340. * Defines the BRDF parameters for the material.
  59341. */
  59342. readonly brdf: PBRBRDFConfiguration;
  59343. /**
  59344. * Defines the Sheen parameters for the material.
  59345. */
  59346. readonly sheen: PBRSheenConfiguration;
  59347. /**
  59348. * Defines the SubSurface parameters for the material.
  59349. */
  59350. readonly subSurface: PBRSubSurfaceConfiguration;
  59351. /**
  59352. * Defines the detail map parameters for the material.
  59353. */
  59354. readonly detailMap: DetailMapConfiguration;
  59355. protected _rebuildInParallel: boolean;
  59356. /**
  59357. * Instantiates a new PBRMaterial instance.
  59358. *
  59359. * @param name The material name
  59360. * @param scene The scene the material will be use in.
  59361. */
  59362. constructor(name: string, scene: Scene);
  59363. /**
  59364. * Gets a boolean indicating that current material needs to register RTT
  59365. */
  59366. get hasRenderTargetTextures(): boolean;
  59367. /**
  59368. * Gets the name of the material class.
  59369. */
  59370. getClassName(): string;
  59371. /**
  59372. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59373. */
  59374. get useLogarithmicDepth(): boolean;
  59375. /**
  59376. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59377. */
  59378. set useLogarithmicDepth(value: boolean);
  59379. /**
  59380. * Returns true if alpha blending should be disabled.
  59381. */
  59382. protected get _disableAlphaBlending(): boolean;
  59383. /**
  59384. * Specifies whether or not this material should be rendered in alpha blend mode.
  59385. */
  59386. needAlphaBlending(): boolean;
  59387. /**
  59388. * Specifies whether or not this material should be rendered in alpha test mode.
  59389. */
  59390. needAlphaTesting(): boolean;
  59391. /**
  59392. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59393. */
  59394. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59395. /**
  59396. * Gets the texture used for the alpha test.
  59397. */
  59398. getAlphaTestTexture(): Nullable<BaseTexture>;
  59399. /**
  59400. * Specifies that the submesh is ready to be used.
  59401. * @param mesh - BJS mesh.
  59402. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59403. * @param useInstances - Specifies that instances should be used.
  59404. * @returns - boolean indicating that the submesh is ready or not.
  59405. */
  59406. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59407. /**
  59408. * Specifies if the material uses metallic roughness workflow.
  59409. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59410. */
  59411. isMetallicWorkflow(): boolean;
  59412. private _prepareEffect;
  59413. private _prepareDefines;
  59414. /**
  59415. * Force shader compilation
  59416. */
  59417. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59418. /**
  59419. * Initializes the uniform buffer layout for the shader.
  59420. */
  59421. buildUniformLayout(): void;
  59422. /**
  59423. * Unbinds the material from the mesh
  59424. */
  59425. unbind(): void;
  59426. /**
  59427. * Binds the submesh data.
  59428. * @param world - The world matrix.
  59429. * @param mesh - The BJS mesh.
  59430. * @param subMesh - A submesh of the BJS mesh.
  59431. */
  59432. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59433. /**
  59434. * Returns the animatable textures.
  59435. * @returns - Array of animatable textures.
  59436. */
  59437. getAnimatables(): IAnimatable[];
  59438. /**
  59439. * Returns the texture used for reflections.
  59440. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59441. */
  59442. private _getReflectionTexture;
  59443. /**
  59444. * Returns an array of the actively used textures.
  59445. * @returns - Array of BaseTextures
  59446. */
  59447. getActiveTextures(): BaseTexture[];
  59448. /**
  59449. * Checks to see if a texture is used in the material.
  59450. * @param texture - Base texture to use.
  59451. * @returns - Boolean specifying if a texture is used in the material.
  59452. */
  59453. hasTexture(texture: BaseTexture): boolean;
  59454. /**
  59455. * Sets the required values to the prepass renderer.
  59456. * @param prePassRenderer defines the prepass renderer to setup
  59457. */
  59458. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59459. /**
  59460. * Disposes the resources of the material.
  59461. * @param forceDisposeEffect - Forces the disposal of effects.
  59462. * @param forceDisposeTextures - Forces the disposal of all textures.
  59463. */
  59464. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59465. }
  59466. }
  59467. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59468. import { Nullable } from "babylonjs/types";
  59469. import { Scene } from "babylonjs/scene";
  59470. import { Color3 } from "babylonjs/Maths/math.color";
  59471. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59472. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59473. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59474. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59475. /**
  59476. * The Physically based material of BJS.
  59477. *
  59478. * This offers the main features of a standard PBR material.
  59479. * For more information, please refer to the documentation :
  59480. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59481. */
  59482. export class PBRMaterial extends PBRBaseMaterial {
  59483. /**
  59484. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59485. */
  59486. static readonly PBRMATERIAL_OPAQUE: number;
  59487. /**
  59488. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59489. */
  59490. static readonly PBRMATERIAL_ALPHATEST: number;
  59491. /**
  59492. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59493. */
  59494. static readonly PBRMATERIAL_ALPHABLEND: number;
  59495. /**
  59496. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59497. * They are also discarded below the alpha cutoff threshold to improve performances.
  59498. */
  59499. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59500. /**
  59501. * Defines the default value of how much AO map is occluding the analytical lights
  59502. * (point spot...).
  59503. */
  59504. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59505. /**
  59506. * Intensity of the direct lights e.g. the four lights available in your scene.
  59507. * This impacts both the direct diffuse and specular highlights.
  59508. */
  59509. directIntensity: number;
  59510. /**
  59511. * Intensity of the emissive part of the material.
  59512. * This helps controlling the emissive effect without modifying the emissive color.
  59513. */
  59514. emissiveIntensity: number;
  59515. /**
  59516. * Intensity of the environment e.g. how much the environment will light the object
  59517. * either through harmonics for rough material or through the refelction for shiny ones.
  59518. */
  59519. environmentIntensity: number;
  59520. /**
  59521. * This is a special control allowing the reduction of the specular highlights coming from the
  59522. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59523. */
  59524. specularIntensity: number;
  59525. /**
  59526. * Debug Control allowing disabling the bump map on this material.
  59527. */
  59528. disableBumpMap: boolean;
  59529. /**
  59530. * AKA Diffuse Texture in standard nomenclature.
  59531. */
  59532. albedoTexture: BaseTexture;
  59533. /**
  59534. * AKA Occlusion Texture in other nomenclature.
  59535. */
  59536. ambientTexture: BaseTexture;
  59537. /**
  59538. * AKA Occlusion Texture Intensity in other nomenclature.
  59539. */
  59540. ambientTextureStrength: number;
  59541. /**
  59542. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59543. * 1 means it completely occludes it
  59544. * 0 mean it has no impact
  59545. */
  59546. ambientTextureImpactOnAnalyticalLights: number;
  59547. /**
  59548. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59549. */
  59550. opacityTexture: BaseTexture;
  59551. /**
  59552. * Stores the reflection values in a texture.
  59553. */
  59554. reflectionTexture: Nullable<BaseTexture>;
  59555. /**
  59556. * Stores the emissive values in a texture.
  59557. */
  59558. emissiveTexture: BaseTexture;
  59559. /**
  59560. * AKA Specular texture in other nomenclature.
  59561. */
  59562. reflectivityTexture: BaseTexture;
  59563. /**
  59564. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59565. */
  59566. metallicTexture: BaseTexture;
  59567. /**
  59568. * Specifies the metallic scalar of the metallic/roughness workflow.
  59569. * Can also be used to scale the metalness values of the metallic texture.
  59570. */
  59571. metallic: Nullable<number>;
  59572. /**
  59573. * Specifies the roughness scalar of the metallic/roughness workflow.
  59574. * Can also be used to scale the roughness values of the metallic texture.
  59575. */
  59576. roughness: Nullable<number>;
  59577. /**
  59578. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59579. * By default the indexOfrefraction is used to compute F0;
  59580. *
  59581. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59582. *
  59583. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59584. * F90 = metallicReflectanceColor;
  59585. */
  59586. metallicF0Factor: number;
  59587. /**
  59588. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59589. * By default the F90 is always 1;
  59590. *
  59591. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59592. *
  59593. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59594. * F90 = metallicReflectanceColor;
  59595. */
  59596. metallicReflectanceColor: Color3;
  59597. /**
  59598. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59599. * This is multiply against the scalar values defined in the material.
  59600. */
  59601. metallicReflectanceTexture: Nullable<BaseTexture>;
  59602. /**
  59603. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59604. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59605. */
  59606. microSurfaceTexture: BaseTexture;
  59607. /**
  59608. * Stores surface normal data used to displace a mesh in a texture.
  59609. */
  59610. bumpTexture: BaseTexture;
  59611. /**
  59612. * Stores the pre-calculated light information of a mesh in a texture.
  59613. */
  59614. lightmapTexture: BaseTexture;
  59615. /**
  59616. * Stores the refracted light information in a texture.
  59617. */
  59618. get refractionTexture(): Nullable<BaseTexture>;
  59619. set refractionTexture(value: Nullable<BaseTexture>);
  59620. /**
  59621. * The color of a material in ambient lighting.
  59622. */
  59623. ambientColor: Color3;
  59624. /**
  59625. * AKA Diffuse Color in other nomenclature.
  59626. */
  59627. albedoColor: Color3;
  59628. /**
  59629. * AKA Specular Color in other nomenclature.
  59630. */
  59631. reflectivityColor: Color3;
  59632. /**
  59633. * The color reflected from the material.
  59634. */
  59635. reflectionColor: Color3;
  59636. /**
  59637. * The color emitted from the material.
  59638. */
  59639. emissiveColor: Color3;
  59640. /**
  59641. * AKA Glossiness in other nomenclature.
  59642. */
  59643. microSurface: number;
  59644. /**
  59645. * Index of refraction of the material base layer.
  59646. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59647. *
  59648. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59649. *
  59650. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59651. */
  59652. get indexOfRefraction(): number;
  59653. set indexOfRefraction(value: number);
  59654. /**
  59655. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59656. */
  59657. get invertRefractionY(): boolean;
  59658. set invertRefractionY(value: boolean);
  59659. /**
  59660. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59661. * Materials half opaque for instance using refraction could benefit from this control.
  59662. */
  59663. get linkRefractionWithTransparency(): boolean;
  59664. set linkRefractionWithTransparency(value: boolean);
  59665. /**
  59666. * If true, the light map contains occlusion information instead of lighting info.
  59667. */
  59668. useLightmapAsShadowmap: boolean;
  59669. /**
  59670. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59671. */
  59672. useAlphaFromAlbedoTexture: boolean;
  59673. /**
  59674. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59675. */
  59676. forceAlphaTest: boolean;
  59677. /**
  59678. * Defines the alpha limits in alpha test mode.
  59679. */
  59680. alphaCutOff: number;
  59681. /**
  59682. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59683. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59684. */
  59685. useSpecularOverAlpha: boolean;
  59686. /**
  59687. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59688. */
  59689. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59690. /**
  59691. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59692. */
  59693. useRoughnessFromMetallicTextureAlpha: boolean;
  59694. /**
  59695. * Specifies if the metallic texture contains the roughness information in its green channel.
  59696. */
  59697. useRoughnessFromMetallicTextureGreen: boolean;
  59698. /**
  59699. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59700. */
  59701. useMetallnessFromMetallicTextureBlue: boolean;
  59702. /**
  59703. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59704. */
  59705. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59706. /**
  59707. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59708. */
  59709. useAmbientInGrayScale: boolean;
  59710. /**
  59711. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59712. * The material will try to infer what glossiness each pixel should be.
  59713. */
  59714. useAutoMicroSurfaceFromReflectivityMap: boolean;
  59715. /**
  59716. * BJS is using an harcoded light falloff based on a manually sets up range.
  59717. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59718. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59719. */
  59720. get usePhysicalLightFalloff(): boolean;
  59721. /**
  59722. * BJS is using an harcoded light falloff based on a manually sets up range.
  59723. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59724. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59725. */
  59726. set usePhysicalLightFalloff(value: boolean);
  59727. /**
  59728. * In order to support the falloff compatibility with gltf, a special mode has been added
  59729. * to reproduce the gltf light falloff.
  59730. */
  59731. get useGLTFLightFalloff(): boolean;
  59732. /**
  59733. * In order to support the falloff compatibility with gltf, a special mode has been added
  59734. * to reproduce the gltf light falloff.
  59735. */
  59736. set useGLTFLightFalloff(value: boolean);
  59737. /**
  59738. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59739. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59740. */
  59741. useRadianceOverAlpha: boolean;
  59742. /**
  59743. * Allows using an object space normal map (instead of tangent space).
  59744. */
  59745. useObjectSpaceNormalMap: boolean;
  59746. /**
  59747. * Allows using the bump map in parallax mode.
  59748. */
  59749. useParallax: boolean;
  59750. /**
  59751. * Allows using the bump map in parallax occlusion mode.
  59752. */
  59753. useParallaxOcclusion: boolean;
  59754. /**
  59755. * Controls the scale bias of the parallax mode.
  59756. */
  59757. parallaxScaleBias: number;
  59758. /**
  59759. * If sets to true, disables all the lights affecting the material.
  59760. */
  59761. disableLighting: boolean;
  59762. /**
  59763. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59764. */
  59765. forceIrradianceInFragment: boolean;
  59766. /**
  59767. * Number of Simultaneous lights allowed on the material.
  59768. */
  59769. maxSimultaneousLights: number;
  59770. /**
  59771. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59772. */
  59773. invertNormalMapX: boolean;
  59774. /**
  59775. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59776. */
  59777. invertNormalMapY: boolean;
  59778. /**
  59779. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59780. */
  59781. twoSidedLighting: boolean;
  59782. /**
  59783. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59784. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59785. */
  59786. useAlphaFresnel: boolean;
  59787. /**
  59788. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59789. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59790. */
  59791. useLinearAlphaFresnel: boolean;
  59792. /**
  59793. * Let user defines the brdf lookup texture used for IBL.
  59794. * A default 8bit version is embedded but you could point at :
  59795. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59796. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59797. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59798. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59799. */
  59800. environmentBRDFTexture: Nullable<BaseTexture>;
  59801. /**
  59802. * Force normal to face away from face.
  59803. */
  59804. forceNormalForward: boolean;
  59805. /**
  59806. * Enables specular anti aliasing in the PBR shader.
  59807. * It will both interacts on the Geometry for analytical and IBL lighting.
  59808. * It also prefilter the roughness map based on the bump values.
  59809. */
  59810. enableSpecularAntiAliasing: boolean;
  59811. /**
  59812. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59813. * makes the reflect vector face the model (under horizon).
  59814. */
  59815. useHorizonOcclusion: boolean;
  59816. /**
  59817. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59818. * too much the area relying on ambient texture to define their ambient occlusion.
  59819. */
  59820. useRadianceOcclusion: boolean;
  59821. /**
  59822. * If set to true, no lighting calculations will be applied.
  59823. */
  59824. unlit: boolean;
  59825. /**
  59826. * Gets the image processing configuration used either in this material.
  59827. */
  59828. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59829. /**
  59830. * Sets the Default image processing configuration used either in the this material.
  59831. *
  59832. * If sets to null, the scene one is in use.
  59833. */
  59834. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59835. /**
  59836. * Gets wether the color curves effect is enabled.
  59837. */
  59838. get cameraColorCurvesEnabled(): boolean;
  59839. /**
  59840. * Sets wether the color curves effect is enabled.
  59841. */
  59842. set cameraColorCurvesEnabled(value: boolean);
  59843. /**
  59844. * Gets wether the color grading effect is enabled.
  59845. */
  59846. get cameraColorGradingEnabled(): boolean;
  59847. /**
  59848. * Gets wether the color grading effect is enabled.
  59849. */
  59850. set cameraColorGradingEnabled(value: boolean);
  59851. /**
  59852. * Gets wether tonemapping is enabled or not.
  59853. */
  59854. get cameraToneMappingEnabled(): boolean;
  59855. /**
  59856. * Sets wether tonemapping is enabled or not
  59857. */
  59858. set cameraToneMappingEnabled(value: boolean);
  59859. /**
  59860. * The camera exposure used on this material.
  59861. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59862. * This corresponds to a photographic exposure.
  59863. */
  59864. get cameraExposure(): number;
  59865. /**
  59866. * The camera exposure used on this material.
  59867. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59868. * This corresponds to a photographic exposure.
  59869. */
  59870. set cameraExposure(value: number);
  59871. /**
  59872. * Gets The camera contrast used on this material.
  59873. */
  59874. get cameraContrast(): number;
  59875. /**
  59876. * Sets The camera contrast used on this material.
  59877. */
  59878. set cameraContrast(value: number);
  59879. /**
  59880. * Gets the Color Grading 2D Lookup Texture.
  59881. */
  59882. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59883. /**
  59884. * Sets the Color Grading 2D Lookup Texture.
  59885. */
  59886. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59887. /**
  59888. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59889. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59890. * 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;
  59891. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59892. */
  59893. get cameraColorCurves(): Nullable<ColorCurves>;
  59894. /**
  59895. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59896. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59897. * 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;
  59898. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59899. */
  59900. set cameraColorCurves(value: Nullable<ColorCurves>);
  59901. /**
  59902. * Instantiates a new PBRMaterial instance.
  59903. *
  59904. * @param name The material name
  59905. * @param scene The scene the material will be use in.
  59906. */
  59907. constructor(name: string, scene: Scene);
  59908. /**
  59909. * Returns the name of this material class.
  59910. */
  59911. getClassName(): string;
  59912. /**
  59913. * Makes a duplicate of the current material.
  59914. * @param name - name to use for the new material.
  59915. */
  59916. clone(name: string): PBRMaterial;
  59917. /**
  59918. * Serializes this PBR Material.
  59919. * @returns - An object with the serialized material.
  59920. */
  59921. serialize(): any;
  59922. /**
  59923. * Parses a PBR Material from a serialized object.
  59924. * @param source - Serialized object.
  59925. * @param scene - BJS scene instance.
  59926. * @param rootUrl - url for the scene object
  59927. * @returns - PBRMaterial
  59928. */
  59929. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  59930. }
  59931. }
  59932. declare module "babylonjs/Misc/dds" {
  59933. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  59934. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59935. import { Nullable } from "babylonjs/types";
  59936. import { Scene } from "babylonjs/scene";
  59937. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  59938. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59939. /**
  59940. * Direct draw surface info
  59941. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  59942. */
  59943. export interface DDSInfo {
  59944. /**
  59945. * Width of the texture
  59946. */
  59947. width: number;
  59948. /**
  59949. * Width of the texture
  59950. */
  59951. height: number;
  59952. /**
  59953. * Number of Mipmaps for the texture
  59954. * @see https://en.wikipedia.org/wiki/Mipmap
  59955. */
  59956. mipmapCount: number;
  59957. /**
  59958. * If the textures format is a known fourCC format
  59959. * @see https://www.fourcc.org/
  59960. */
  59961. isFourCC: boolean;
  59962. /**
  59963. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  59964. */
  59965. isRGB: boolean;
  59966. /**
  59967. * If the texture is a lumincance format
  59968. */
  59969. isLuminance: boolean;
  59970. /**
  59971. * If this is a cube texture
  59972. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  59973. */
  59974. isCube: boolean;
  59975. /**
  59976. * If the texture is a compressed format eg. FOURCC_DXT1
  59977. */
  59978. isCompressed: boolean;
  59979. /**
  59980. * The dxgiFormat of the texture
  59981. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  59982. */
  59983. dxgiFormat: number;
  59984. /**
  59985. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  59986. */
  59987. textureType: number;
  59988. /**
  59989. * Sphericle polynomial created for the dds texture
  59990. */
  59991. sphericalPolynomial?: SphericalPolynomial;
  59992. }
  59993. /**
  59994. * Class used to provide DDS decompression tools
  59995. */
  59996. export class DDSTools {
  59997. /**
  59998. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  59999. */
  60000. static StoreLODInAlphaChannel: boolean;
  60001. /**
  60002. * Gets DDS information from an array buffer
  60003. * @param data defines the array buffer view to read data from
  60004. * @returns the DDS information
  60005. */
  60006. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  60007. private static _FloatView;
  60008. private static _Int32View;
  60009. private static _ToHalfFloat;
  60010. private static _FromHalfFloat;
  60011. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  60012. private static _GetHalfFloatRGBAArrayBuffer;
  60013. private static _GetFloatRGBAArrayBuffer;
  60014. private static _GetFloatAsUIntRGBAArrayBuffer;
  60015. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  60016. private static _GetRGBAArrayBuffer;
  60017. private static _ExtractLongWordOrder;
  60018. private static _GetRGBArrayBuffer;
  60019. private static _GetLuminanceArrayBuffer;
  60020. /**
  60021. * Uploads DDS Levels to a Babylon Texture
  60022. * @hidden
  60023. */
  60024. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  60025. }
  60026. module "babylonjs/Engines/thinEngine" {
  60027. interface ThinEngine {
  60028. /**
  60029. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  60030. * @param rootUrl defines the url where the file to load is located
  60031. * @param scene defines the current scene
  60032. * @param lodScale defines scale to apply to the mip map selection
  60033. * @param lodOffset defines offset to apply to the mip map selection
  60034. * @param onLoad defines an optional callback raised when the texture is loaded
  60035. * @param onError defines an optional callback raised if there is an issue to load the texture
  60036. * @param format defines the format of the data
  60037. * @param forcedExtension defines the extension to use to pick the right loader
  60038. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  60039. * @returns the cube texture as an InternalTexture
  60040. */
  60041. 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;
  60042. }
  60043. }
  60044. }
  60045. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  60046. import { Nullable } from "babylonjs/types";
  60047. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60048. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60049. /**
  60050. * Implementation of the DDS Texture Loader.
  60051. * @hidden
  60052. */
  60053. export class _DDSTextureLoader implements IInternalTextureLoader {
  60054. /**
  60055. * Defines wether the loader supports cascade loading the different faces.
  60056. */
  60057. readonly supportCascades: boolean;
  60058. /**
  60059. * This returns if the loader support the current file information.
  60060. * @param extension defines the file extension of the file being loaded
  60061. * @returns true if the loader can load the specified file
  60062. */
  60063. canLoad(extension: string): boolean;
  60064. /**
  60065. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60066. * @param data contains the texture data
  60067. * @param texture defines the BabylonJS internal texture
  60068. * @param createPolynomials will be true if polynomials have been requested
  60069. * @param onLoad defines the callback to trigger once the texture is ready
  60070. * @param onError defines the callback to trigger in case of error
  60071. */
  60072. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60073. /**
  60074. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60075. * @param data contains the texture data
  60076. * @param texture defines the BabylonJS internal texture
  60077. * @param callback defines the method to call once ready to upload
  60078. */
  60079. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60080. }
  60081. }
  60082. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  60083. import { Nullable } from "babylonjs/types";
  60084. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60085. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60086. /**
  60087. * Implementation of the ENV Texture Loader.
  60088. * @hidden
  60089. */
  60090. export class _ENVTextureLoader implements IInternalTextureLoader {
  60091. /**
  60092. * Defines wether the loader supports cascade loading the different faces.
  60093. */
  60094. readonly supportCascades: boolean;
  60095. /**
  60096. * This returns if the loader support the current file information.
  60097. * @param extension defines the file extension of the file being loaded
  60098. * @returns true if the loader can load the specified file
  60099. */
  60100. canLoad(extension: string): boolean;
  60101. /**
  60102. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60103. * @param data contains the texture data
  60104. * @param texture defines the BabylonJS internal texture
  60105. * @param createPolynomials will be true if polynomials have been requested
  60106. * @param onLoad defines the callback to trigger once the texture is ready
  60107. * @param onError defines the callback to trigger in case of error
  60108. */
  60109. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60110. /**
  60111. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60112. * @param data contains the texture data
  60113. * @param texture defines the BabylonJS internal texture
  60114. * @param callback defines the method to call once ready to upload
  60115. */
  60116. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60117. }
  60118. }
  60119. declare module "babylonjs/Misc/khronosTextureContainer" {
  60120. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60121. /**
  60122. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  60123. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60124. */
  60125. export class KhronosTextureContainer {
  60126. /** contents of the KTX container file */
  60127. data: ArrayBufferView;
  60128. private static HEADER_LEN;
  60129. private static COMPRESSED_2D;
  60130. private static COMPRESSED_3D;
  60131. private static TEX_2D;
  60132. private static TEX_3D;
  60133. /**
  60134. * Gets the openGL type
  60135. */
  60136. glType: number;
  60137. /**
  60138. * Gets the openGL type size
  60139. */
  60140. glTypeSize: number;
  60141. /**
  60142. * Gets the openGL format
  60143. */
  60144. glFormat: number;
  60145. /**
  60146. * Gets the openGL internal format
  60147. */
  60148. glInternalFormat: number;
  60149. /**
  60150. * Gets the base internal format
  60151. */
  60152. glBaseInternalFormat: number;
  60153. /**
  60154. * Gets image width in pixel
  60155. */
  60156. pixelWidth: number;
  60157. /**
  60158. * Gets image height in pixel
  60159. */
  60160. pixelHeight: number;
  60161. /**
  60162. * Gets image depth in pixels
  60163. */
  60164. pixelDepth: number;
  60165. /**
  60166. * Gets the number of array elements
  60167. */
  60168. numberOfArrayElements: number;
  60169. /**
  60170. * Gets the number of faces
  60171. */
  60172. numberOfFaces: number;
  60173. /**
  60174. * Gets the number of mipmap levels
  60175. */
  60176. numberOfMipmapLevels: number;
  60177. /**
  60178. * Gets the bytes of key value data
  60179. */
  60180. bytesOfKeyValueData: number;
  60181. /**
  60182. * Gets the load type
  60183. */
  60184. loadType: number;
  60185. /**
  60186. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60187. */
  60188. isInvalid: boolean;
  60189. /**
  60190. * Creates a new KhronosTextureContainer
  60191. * @param data contents of the KTX container file
  60192. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60193. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60194. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60195. */
  60196. constructor(
  60197. /** contents of the KTX container file */
  60198. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60199. /**
  60200. * Uploads KTX content to a Babylon Texture.
  60201. * It is assumed that the texture has already been created & is currently bound
  60202. * @hidden
  60203. */
  60204. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60205. private _upload2DCompressedLevels;
  60206. /**
  60207. * Checks if the given data starts with a KTX file identifier.
  60208. * @param data the data to check
  60209. * @returns true if the data is a KTX file or false otherwise
  60210. */
  60211. static IsValid(data: ArrayBufferView): boolean;
  60212. }
  60213. }
  60214. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60215. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60216. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60217. /**
  60218. * Class for loading KTX2 files
  60219. * !!! Experimental Extension Subject to Changes !!!
  60220. * @hidden
  60221. */
  60222. export class KhronosTextureContainer2 {
  60223. private static _ModulePromise;
  60224. private static _TranscodeFormat;
  60225. constructor(engine: ThinEngine);
  60226. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60227. private _determineTranscodeFormat;
  60228. /**
  60229. * Checks if the given data starts with a KTX2 file identifier.
  60230. * @param data the data to check
  60231. * @returns true if the data is a KTX2 file or false otherwise
  60232. */
  60233. static IsValid(data: ArrayBufferView): boolean;
  60234. }
  60235. }
  60236. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60237. import { Nullable } from "babylonjs/types";
  60238. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60239. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60240. /**
  60241. * Implementation of the KTX Texture Loader.
  60242. * @hidden
  60243. */
  60244. export class _KTXTextureLoader implements IInternalTextureLoader {
  60245. /**
  60246. * Defines wether the loader supports cascade loading the different faces.
  60247. */
  60248. readonly supportCascades: boolean;
  60249. /**
  60250. * This returns if the loader support the current file information.
  60251. * @param extension defines the file extension of the file being loaded
  60252. * @param mimeType defines the optional mime type of the file being loaded
  60253. * @returns true if the loader can load the specified file
  60254. */
  60255. canLoad(extension: string, mimeType?: string): boolean;
  60256. /**
  60257. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60258. * @param data contains the texture data
  60259. * @param texture defines the BabylonJS internal texture
  60260. * @param createPolynomials will be true if polynomials have been requested
  60261. * @param onLoad defines the callback to trigger once the texture is ready
  60262. * @param onError defines the callback to trigger in case of error
  60263. */
  60264. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60265. /**
  60266. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60267. * @param data contains the texture data
  60268. * @param texture defines the BabylonJS internal texture
  60269. * @param callback defines the method to call once ready to upload
  60270. */
  60271. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60272. }
  60273. }
  60274. declare module "babylonjs/Helpers/sceneHelpers" {
  60275. import { Nullable } from "babylonjs/types";
  60276. import { Mesh } from "babylonjs/Meshes/mesh";
  60277. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60278. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60279. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60280. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60281. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60282. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60283. import "babylonjs/Meshes/Builders/boxBuilder";
  60284. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60285. /** @hidden */
  60286. export var _forceSceneHelpersToBundle: boolean;
  60287. module "babylonjs/scene" {
  60288. interface Scene {
  60289. /**
  60290. * Creates a default light for the scene.
  60291. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60292. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60293. */
  60294. createDefaultLight(replace?: boolean): void;
  60295. /**
  60296. * Creates a default camera for the scene.
  60297. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60298. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60299. * @param replace has default false, when true replaces the active camera in the scene
  60300. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60301. */
  60302. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60303. /**
  60304. * Creates a default camera and a default light.
  60305. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60306. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60307. * @param replace has the default false, when true replaces the active camera/light in the scene
  60308. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60309. */
  60310. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60311. /**
  60312. * Creates a new sky box
  60313. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60314. * @param environmentTexture defines the texture to use as environment texture
  60315. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60316. * @param scale defines the overall scale of the skybox
  60317. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60318. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60319. * @returns a new mesh holding the sky box
  60320. */
  60321. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60322. /**
  60323. * Creates a new environment
  60324. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60325. * @param options defines the options you can use to configure the environment
  60326. * @returns the new EnvironmentHelper
  60327. */
  60328. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60329. /**
  60330. * Creates a new VREXperienceHelper
  60331. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60332. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60333. * @returns a new VREXperienceHelper
  60334. */
  60335. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60336. /**
  60337. * Creates a new WebXRDefaultExperience
  60338. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60339. * @param options experience options
  60340. * @returns a promise for a new WebXRDefaultExperience
  60341. */
  60342. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60343. }
  60344. }
  60345. }
  60346. declare module "babylonjs/Helpers/videoDome" {
  60347. import { Scene } from "babylonjs/scene";
  60348. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60349. import { TextureDome } from "babylonjs/Helpers/textureDome";
  60350. /**
  60351. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60352. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60353. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60354. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60355. */
  60356. export class VideoDome extends TextureDome<VideoTexture> {
  60357. /**
  60358. * Define the video source as a Monoscopic panoramic 360 video.
  60359. */
  60360. static readonly MODE_MONOSCOPIC: number;
  60361. /**
  60362. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60363. */
  60364. static readonly MODE_TOPBOTTOM: number;
  60365. /**
  60366. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60367. */
  60368. static readonly MODE_SIDEBYSIDE: number;
  60369. /**
  60370. * Get the video texture associated with this video dome
  60371. */
  60372. get videoTexture(): VideoTexture;
  60373. /**
  60374. * Get the video mode of this dome
  60375. */
  60376. get videoMode(): number;
  60377. /**
  60378. * Set the video mode of this dome.
  60379. * @see textureMode
  60380. */
  60381. set videoMode(value: number);
  60382. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  60383. }
  60384. }
  60385. declare module "babylonjs/Helpers/index" {
  60386. export * from "babylonjs/Helpers/environmentHelper";
  60387. export * from "babylonjs/Helpers/photoDome";
  60388. export * from "babylonjs/Helpers/sceneHelpers";
  60389. export * from "babylonjs/Helpers/videoDome";
  60390. }
  60391. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60392. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60393. import { IDisposable } from "babylonjs/scene";
  60394. import { Engine } from "babylonjs/Engines/engine";
  60395. /**
  60396. * This class can be used to get instrumentation data from a Babylon engine
  60397. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60398. */
  60399. export class EngineInstrumentation implements IDisposable {
  60400. /**
  60401. * Define the instrumented engine.
  60402. */
  60403. engine: Engine;
  60404. private _captureGPUFrameTime;
  60405. private _gpuFrameTimeToken;
  60406. private _gpuFrameTime;
  60407. private _captureShaderCompilationTime;
  60408. private _shaderCompilationTime;
  60409. private _onBeginFrameObserver;
  60410. private _onEndFrameObserver;
  60411. private _onBeforeShaderCompilationObserver;
  60412. private _onAfterShaderCompilationObserver;
  60413. /**
  60414. * Gets the perf counter used for GPU frame time
  60415. */
  60416. get gpuFrameTimeCounter(): PerfCounter;
  60417. /**
  60418. * Gets the GPU frame time capture status
  60419. */
  60420. get captureGPUFrameTime(): boolean;
  60421. /**
  60422. * Enable or disable the GPU frame time capture
  60423. */
  60424. set captureGPUFrameTime(value: boolean);
  60425. /**
  60426. * Gets the perf counter used for shader compilation time
  60427. */
  60428. get shaderCompilationTimeCounter(): PerfCounter;
  60429. /**
  60430. * Gets the shader compilation time capture status
  60431. */
  60432. get captureShaderCompilationTime(): boolean;
  60433. /**
  60434. * Enable or disable the shader compilation time capture
  60435. */
  60436. set captureShaderCompilationTime(value: boolean);
  60437. /**
  60438. * Instantiates a new engine instrumentation.
  60439. * This class can be used to get instrumentation data from a Babylon engine
  60440. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60441. * @param engine Defines the engine to instrument
  60442. */
  60443. constructor(
  60444. /**
  60445. * Define the instrumented engine.
  60446. */
  60447. engine: Engine);
  60448. /**
  60449. * Dispose and release associated resources.
  60450. */
  60451. dispose(): void;
  60452. }
  60453. }
  60454. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60455. import { Scene, IDisposable } from "babylonjs/scene";
  60456. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60457. /**
  60458. * This class can be used to get instrumentation data from a Babylon engine
  60459. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60460. */
  60461. export class SceneInstrumentation implements IDisposable {
  60462. /**
  60463. * Defines the scene to instrument
  60464. */
  60465. scene: Scene;
  60466. private _captureActiveMeshesEvaluationTime;
  60467. private _activeMeshesEvaluationTime;
  60468. private _captureRenderTargetsRenderTime;
  60469. private _renderTargetsRenderTime;
  60470. private _captureFrameTime;
  60471. private _frameTime;
  60472. private _captureRenderTime;
  60473. private _renderTime;
  60474. private _captureInterFrameTime;
  60475. private _interFrameTime;
  60476. private _captureParticlesRenderTime;
  60477. private _particlesRenderTime;
  60478. private _captureSpritesRenderTime;
  60479. private _spritesRenderTime;
  60480. private _capturePhysicsTime;
  60481. private _physicsTime;
  60482. private _captureAnimationsTime;
  60483. private _animationsTime;
  60484. private _captureCameraRenderTime;
  60485. private _cameraRenderTime;
  60486. private _onBeforeActiveMeshesEvaluationObserver;
  60487. private _onAfterActiveMeshesEvaluationObserver;
  60488. private _onBeforeRenderTargetsRenderObserver;
  60489. private _onAfterRenderTargetsRenderObserver;
  60490. private _onAfterRenderObserver;
  60491. private _onBeforeDrawPhaseObserver;
  60492. private _onAfterDrawPhaseObserver;
  60493. private _onBeforeAnimationsObserver;
  60494. private _onBeforeParticlesRenderingObserver;
  60495. private _onAfterParticlesRenderingObserver;
  60496. private _onBeforeSpritesRenderingObserver;
  60497. private _onAfterSpritesRenderingObserver;
  60498. private _onBeforePhysicsObserver;
  60499. private _onAfterPhysicsObserver;
  60500. private _onAfterAnimationsObserver;
  60501. private _onBeforeCameraRenderObserver;
  60502. private _onAfterCameraRenderObserver;
  60503. /**
  60504. * Gets the perf counter used for active meshes evaluation time
  60505. */
  60506. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60507. /**
  60508. * Gets the active meshes evaluation time capture status
  60509. */
  60510. get captureActiveMeshesEvaluationTime(): boolean;
  60511. /**
  60512. * Enable or disable the active meshes evaluation time capture
  60513. */
  60514. set captureActiveMeshesEvaluationTime(value: boolean);
  60515. /**
  60516. * Gets the perf counter used for render targets render time
  60517. */
  60518. get renderTargetsRenderTimeCounter(): PerfCounter;
  60519. /**
  60520. * Gets the render targets render time capture status
  60521. */
  60522. get captureRenderTargetsRenderTime(): boolean;
  60523. /**
  60524. * Enable or disable the render targets render time capture
  60525. */
  60526. set captureRenderTargetsRenderTime(value: boolean);
  60527. /**
  60528. * Gets the perf counter used for particles render time
  60529. */
  60530. get particlesRenderTimeCounter(): PerfCounter;
  60531. /**
  60532. * Gets the particles render time capture status
  60533. */
  60534. get captureParticlesRenderTime(): boolean;
  60535. /**
  60536. * Enable or disable the particles render time capture
  60537. */
  60538. set captureParticlesRenderTime(value: boolean);
  60539. /**
  60540. * Gets the perf counter used for sprites render time
  60541. */
  60542. get spritesRenderTimeCounter(): PerfCounter;
  60543. /**
  60544. * Gets the sprites render time capture status
  60545. */
  60546. get captureSpritesRenderTime(): boolean;
  60547. /**
  60548. * Enable or disable the sprites render time capture
  60549. */
  60550. set captureSpritesRenderTime(value: boolean);
  60551. /**
  60552. * Gets the perf counter used for physics time
  60553. */
  60554. get physicsTimeCounter(): PerfCounter;
  60555. /**
  60556. * Gets the physics time capture status
  60557. */
  60558. get capturePhysicsTime(): boolean;
  60559. /**
  60560. * Enable or disable the physics time capture
  60561. */
  60562. set capturePhysicsTime(value: boolean);
  60563. /**
  60564. * Gets the perf counter used for animations time
  60565. */
  60566. get animationsTimeCounter(): PerfCounter;
  60567. /**
  60568. * Gets the animations time capture status
  60569. */
  60570. get captureAnimationsTime(): boolean;
  60571. /**
  60572. * Enable or disable the animations time capture
  60573. */
  60574. set captureAnimationsTime(value: boolean);
  60575. /**
  60576. * Gets the perf counter used for frame time capture
  60577. */
  60578. get frameTimeCounter(): PerfCounter;
  60579. /**
  60580. * Gets the frame time capture status
  60581. */
  60582. get captureFrameTime(): boolean;
  60583. /**
  60584. * Enable or disable the frame time capture
  60585. */
  60586. set captureFrameTime(value: boolean);
  60587. /**
  60588. * Gets the perf counter used for inter-frames time capture
  60589. */
  60590. get interFrameTimeCounter(): PerfCounter;
  60591. /**
  60592. * Gets the inter-frames time capture status
  60593. */
  60594. get captureInterFrameTime(): boolean;
  60595. /**
  60596. * Enable or disable the inter-frames time capture
  60597. */
  60598. set captureInterFrameTime(value: boolean);
  60599. /**
  60600. * Gets the perf counter used for render time capture
  60601. */
  60602. get renderTimeCounter(): PerfCounter;
  60603. /**
  60604. * Gets the render time capture status
  60605. */
  60606. get captureRenderTime(): boolean;
  60607. /**
  60608. * Enable or disable the render time capture
  60609. */
  60610. set captureRenderTime(value: boolean);
  60611. /**
  60612. * Gets the perf counter used for camera render time capture
  60613. */
  60614. get cameraRenderTimeCounter(): PerfCounter;
  60615. /**
  60616. * Gets the camera render time capture status
  60617. */
  60618. get captureCameraRenderTime(): boolean;
  60619. /**
  60620. * Enable or disable the camera render time capture
  60621. */
  60622. set captureCameraRenderTime(value: boolean);
  60623. /**
  60624. * Gets the perf counter used for draw calls
  60625. */
  60626. get drawCallsCounter(): PerfCounter;
  60627. /**
  60628. * Instantiates a new scene instrumentation.
  60629. * This class can be used to get instrumentation data from a Babylon engine
  60630. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60631. * @param scene Defines the scene to instrument
  60632. */
  60633. constructor(
  60634. /**
  60635. * Defines the scene to instrument
  60636. */
  60637. scene: Scene);
  60638. /**
  60639. * Dispose and release associated resources.
  60640. */
  60641. dispose(): void;
  60642. }
  60643. }
  60644. declare module "babylonjs/Instrumentation/index" {
  60645. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60646. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60647. export * from "babylonjs/Instrumentation/timeToken";
  60648. }
  60649. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60650. /** @hidden */
  60651. export var glowMapGenerationPixelShader: {
  60652. name: string;
  60653. shader: string;
  60654. };
  60655. }
  60656. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60657. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60658. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60659. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60660. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60661. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60662. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60663. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60664. /** @hidden */
  60665. export var glowMapGenerationVertexShader: {
  60666. name: string;
  60667. shader: string;
  60668. };
  60669. }
  60670. declare module "babylonjs/Layers/effectLayer" {
  60671. import { Observable } from "babylonjs/Misc/observable";
  60672. import { Nullable } from "babylonjs/types";
  60673. import { Camera } from "babylonjs/Cameras/camera";
  60674. import { Scene } from "babylonjs/scene";
  60675. import { ISize } from "babylonjs/Maths/math.size";
  60676. import { Color4 } from "babylonjs/Maths/math.color";
  60677. import { Engine } from "babylonjs/Engines/engine";
  60678. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60679. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60680. import { Mesh } from "babylonjs/Meshes/mesh";
  60681. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60682. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60683. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60684. import { Effect } from "babylonjs/Materials/effect";
  60685. import { Material } from "babylonjs/Materials/material";
  60686. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60687. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60688. /**
  60689. * Effect layer options. This helps customizing the behaviour
  60690. * of the effect layer.
  60691. */
  60692. export interface IEffectLayerOptions {
  60693. /**
  60694. * Multiplication factor apply to the canvas size to compute the render target size
  60695. * used to generated the objects (the smaller the faster).
  60696. */
  60697. mainTextureRatio: number;
  60698. /**
  60699. * Enforces a fixed size texture to ensure effect stability across devices.
  60700. */
  60701. mainTextureFixedSize?: number;
  60702. /**
  60703. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60704. */
  60705. alphaBlendingMode: number;
  60706. /**
  60707. * The camera attached to the layer.
  60708. */
  60709. camera: Nullable<Camera>;
  60710. /**
  60711. * The rendering group to draw the layer in.
  60712. */
  60713. renderingGroupId: number;
  60714. }
  60715. /**
  60716. * The effect layer Helps adding post process effect blended with the main pass.
  60717. *
  60718. * This can be for instance use to generate glow or higlight effects on the scene.
  60719. *
  60720. * The effect layer class can not be used directly and is intented to inherited from to be
  60721. * customized per effects.
  60722. */
  60723. export abstract class EffectLayer {
  60724. private _vertexBuffers;
  60725. private _indexBuffer;
  60726. private _cachedDefines;
  60727. private _effectLayerMapGenerationEffect;
  60728. private _effectLayerOptions;
  60729. private _mergeEffect;
  60730. protected _scene: Scene;
  60731. protected _engine: Engine;
  60732. protected _maxSize: number;
  60733. protected _mainTextureDesiredSize: ISize;
  60734. protected _mainTexture: RenderTargetTexture;
  60735. protected _shouldRender: boolean;
  60736. protected _postProcesses: PostProcess[];
  60737. protected _textures: BaseTexture[];
  60738. protected _emissiveTextureAndColor: {
  60739. texture: Nullable<BaseTexture>;
  60740. color: Color4;
  60741. };
  60742. /**
  60743. * The name of the layer
  60744. */
  60745. name: string;
  60746. /**
  60747. * The clear color of the texture used to generate the glow map.
  60748. */
  60749. neutralColor: Color4;
  60750. /**
  60751. * Specifies whether the highlight layer is enabled or not.
  60752. */
  60753. isEnabled: boolean;
  60754. /**
  60755. * Gets the camera attached to the layer.
  60756. */
  60757. get camera(): Nullable<Camera>;
  60758. /**
  60759. * Gets the rendering group id the layer should render in.
  60760. */
  60761. get renderingGroupId(): number;
  60762. set renderingGroupId(renderingGroupId: number);
  60763. /**
  60764. * An event triggered when the effect layer has been disposed.
  60765. */
  60766. onDisposeObservable: Observable<EffectLayer>;
  60767. /**
  60768. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60769. */
  60770. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60771. /**
  60772. * An event triggered when the generated texture is being merged in the scene.
  60773. */
  60774. onBeforeComposeObservable: Observable<EffectLayer>;
  60775. /**
  60776. * An event triggered when the mesh is rendered into the effect render target.
  60777. */
  60778. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60779. /**
  60780. * An event triggered after the mesh has been rendered into the effect render target.
  60781. */
  60782. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60783. /**
  60784. * An event triggered when the generated texture has been merged in the scene.
  60785. */
  60786. onAfterComposeObservable: Observable<EffectLayer>;
  60787. /**
  60788. * An event triggered when the efffect layer changes its size.
  60789. */
  60790. onSizeChangedObservable: Observable<EffectLayer>;
  60791. /** @hidden */
  60792. static _SceneComponentInitialization: (scene: Scene) => void;
  60793. /**
  60794. * Instantiates a new effect Layer and references it in the scene.
  60795. * @param name The name of the layer
  60796. * @param scene The scene to use the layer in
  60797. */
  60798. constructor(
  60799. /** The Friendly of the effect in the scene */
  60800. name: string, scene: Scene);
  60801. /**
  60802. * Get the effect name of the layer.
  60803. * @return The effect name
  60804. */
  60805. abstract getEffectName(): string;
  60806. /**
  60807. * Checks for the readiness of the element composing the layer.
  60808. * @param subMesh the mesh to check for
  60809. * @param useInstances specify whether or not to use instances to render the mesh
  60810. * @return true if ready otherwise, false
  60811. */
  60812. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60813. /**
  60814. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60815. * @returns true if the effect requires stencil during the main canvas render pass.
  60816. */
  60817. abstract needStencil(): boolean;
  60818. /**
  60819. * Create the merge effect. This is the shader use to blit the information back
  60820. * to the main canvas at the end of the scene rendering.
  60821. * @returns The effect containing the shader used to merge the effect on the main canvas
  60822. */
  60823. protected abstract _createMergeEffect(): Effect;
  60824. /**
  60825. * Creates the render target textures and post processes used in the effect layer.
  60826. */
  60827. protected abstract _createTextureAndPostProcesses(): void;
  60828. /**
  60829. * Implementation specific of rendering the generating effect on the main canvas.
  60830. * @param effect The effect used to render through
  60831. */
  60832. protected abstract _internalRender(effect: Effect): void;
  60833. /**
  60834. * Sets the required values for both the emissive texture and and the main color.
  60835. */
  60836. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60837. /**
  60838. * Free any resources and references associated to a mesh.
  60839. * Internal use
  60840. * @param mesh The mesh to free.
  60841. */
  60842. abstract _disposeMesh(mesh: Mesh): void;
  60843. /**
  60844. * Serializes this layer (Glow or Highlight for example)
  60845. * @returns a serialized layer object
  60846. */
  60847. abstract serialize?(): any;
  60848. /**
  60849. * Initializes the effect layer with the required options.
  60850. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60851. */
  60852. protected _init(options: Partial<IEffectLayerOptions>): void;
  60853. /**
  60854. * Generates the index buffer of the full screen quad blending to the main canvas.
  60855. */
  60856. private _generateIndexBuffer;
  60857. /**
  60858. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  60859. */
  60860. private _generateVertexBuffer;
  60861. /**
  60862. * Sets the main texture desired size which is the closest power of two
  60863. * of the engine canvas size.
  60864. */
  60865. private _setMainTextureSize;
  60866. /**
  60867. * Creates the main texture for the effect layer.
  60868. */
  60869. protected _createMainTexture(): void;
  60870. /**
  60871. * Adds specific effects defines.
  60872. * @param defines The defines to add specifics to.
  60873. */
  60874. protected _addCustomEffectDefines(defines: string[]): void;
  60875. /**
  60876. * Checks for the readiness of the element composing the layer.
  60877. * @param subMesh the mesh to check for
  60878. * @param useInstances specify whether or not to use instances to render the mesh
  60879. * @param emissiveTexture the associated emissive texture used to generate the glow
  60880. * @return true if ready otherwise, false
  60881. */
  60882. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  60883. /**
  60884. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  60885. */
  60886. render(): void;
  60887. /**
  60888. * Determine if a given mesh will be used in the current effect.
  60889. * @param mesh mesh to test
  60890. * @returns true if the mesh will be used
  60891. */
  60892. hasMesh(mesh: AbstractMesh): boolean;
  60893. /**
  60894. * Returns true if the layer contains information to display, otherwise false.
  60895. * @returns true if the glow layer should be rendered
  60896. */
  60897. shouldRender(): boolean;
  60898. /**
  60899. * Returns true if the mesh should render, otherwise false.
  60900. * @param mesh The mesh to render
  60901. * @returns true if it should render otherwise false
  60902. */
  60903. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  60904. /**
  60905. * Returns true if the mesh can be rendered, otherwise false.
  60906. * @param mesh The mesh to render
  60907. * @param material The material used on the mesh
  60908. * @returns true if it can be rendered otherwise false
  60909. */
  60910. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60911. /**
  60912. * Returns true if the mesh should render, otherwise false.
  60913. * @param mesh The mesh to render
  60914. * @returns true if it should render otherwise false
  60915. */
  60916. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  60917. /**
  60918. * Renders the submesh passed in parameter to the generation map.
  60919. */
  60920. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  60921. /**
  60922. * Defines whether the current material of the mesh should be use to render the effect.
  60923. * @param mesh defines the current mesh to render
  60924. */
  60925. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60926. /**
  60927. * Rebuild the required buffers.
  60928. * @hidden Internal use only.
  60929. */
  60930. _rebuild(): void;
  60931. /**
  60932. * Dispose only the render target textures and post process.
  60933. */
  60934. private _disposeTextureAndPostProcesses;
  60935. /**
  60936. * Dispose the highlight layer and free resources.
  60937. */
  60938. dispose(): void;
  60939. /**
  60940. * Gets the class name of the effect layer
  60941. * @returns the string with the class name of the effect layer
  60942. */
  60943. getClassName(): string;
  60944. /**
  60945. * Creates an effect layer from parsed effect layer data
  60946. * @param parsedEffectLayer defines effect layer data
  60947. * @param scene defines the current scene
  60948. * @param rootUrl defines the root URL containing the effect layer information
  60949. * @returns a parsed effect Layer
  60950. */
  60951. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  60952. }
  60953. }
  60954. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  60955. import { Scene } from "babylonjs/scene";
  60956. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  60957. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60958. import { AbstractScene } from "babylonjs/abstractScene";
  60959. module "babylonjs/abstractScene" {
  60960. interface AbstractScene {
  60961. /**
  60962. * The list of effect layers (highlights/glow) added to the scene
  60963. * @see https://doc.babylonjs.com/how_to/highlight_layer
  60964. * @see https://doc.babylonjs.com/how_to/glow_layer
  60965. */
  60966. effectLayers: Array<EffectLayer>;
  60967. /**
  60968. * Removes the given effect layer from this scene.
  60969. * @param toRemove defines the effect layer to remove
  60970. * @returns the index of the removed effect layer
  60971. */
  60972. removeEffectLayer(toRemove: EffectLayer): number;
  60973. /**
  60974. * Adds the given effect layer to this scene
  60975. * @param newEffectLayer defines the effect layer to add
  60976. */
  60977. addEffectLayer(newEffectLayer: EffectLayer): void;
  60978. }
  60979. }
  60980. /**
  60981. * Defines the layer scene component responsible to manage any effect layers
  60982. * in a given scene.
  60983. */
  60984. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  60985. /**
  60986. * The component name helpfull to identify the component in the list of scene components.
  60987. */
  60988. readonly name: string;
  60989. /**
  60990. * The scene the component belongs to.
  60991. */
  60992. scene: Scene;
  60993. private _engine;
  60994. private _renderEffects;
  60995. private _needStencil;
  60996. private _previousStencilState;
  60997. /**
  60998. * Creates a new instance of the component for the given scene
  60999. * @param scene Defines the scene to register the component in
  61000. */
  61001. constructor(scene: Scene);
  61002. /**
  61003. * Registers the component in a given scene
  61004. */
  61005. register(): void;
  61006. /**
  61007. * Rebuilds the elements related to this component in case of
  61008. * context lost for instance.
  61009. */
  61010. rebuild(): void;
  61011. /**
  61012. * Serializes the component data to the specified json object
  61013. * @param serializationObject The object to serialize to
  61014. */
  61015. serialize(serializationObject: any): void;
  61016. /**
  61017. * Adds all the elements from the container to the scene
  61018. * @param container the container holding the elements
  61019. */
  61020. addFromContainer(container: AbstractScene): void;
  61021. /**
  61022. * Removes all the elements in the container from the scene
  61023. * @param container contains the elements to remove
  61024. * @param dispose if the removed element should be disposed (default: false)
  61025. */
  61026. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61027. /**
  61028. * Disposes the component and the associated ressources.
  61029. */
  61030. dispose(): void;
  61031. private _isReadyForMesh;
  61032. private _renderMainTexture;
  61033. private _setStencil;
  61034. private _setStencilBack;
  61035. private _draw;
  61036. private _drawCamera;
  61037. private _drawRenderingGroup;
  61038. }
  61039. }
  61040. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  61041. /** @hidden */
  61042. export var glowMapMergePixelShader: {
  61043. name: string;
  61044. shader: string;
  61045. };
  61046. }
  61047. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  61048. /** @hidden */
  61049. export var glowMapMergeVertexShader: {
  61050. name: string;
  61051. shader: string;
  61052. };
  61053. }
  61054. declare module "babylonjs/Layers/glowLayer" {
  61055. import { Nullable } from "babylonjs/types";
  61056. import { Camera } from "babylonjs/Cameras/camera";
  61057. import { Scene } from "babylonjs/scene";
  61058. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61059. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61060. import { Mesh } from "babylonjs/Meshes/mesh";
  61061. import { Texture } from "babylonjs/Materials/Textures/texture";
  61062. import { Effect } from "babylonjs/Materials/effect";
  61063. import { Material } from "babylonjs/Materials/material";
  61064. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61065. import { Color4 } from "babylonjs/Maths/math.color";
  61066. import "babylonjs/Shaders/glowMapMerge.fragment";
  61067. import "babylonjs/Shaders/glowMapMerge.vertex";
  61068. import "babylonjs/Layers/effectLayerSceneComponent";
  61069. module "babylonjs/abstractScene" {
  61070. interface AbstractScene {
  61071. /**
  61072. * Return a the first highlight layer of the scene with a given name.
  61073. * @param name The name of the highlight layer to look for.
  61074. * @return The highlight layer if found otherwise null.
  61075. */
  61076. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61077. }
  61078. }
  61079. /**
  61080. * Glow layer options. This helps customizing the behaviour
  61081. * of the glow layer.
  61082. */
  61083. export interface IGlowLayerOptions {
  61084. /**
  61085. * Multiplication factor apply to the canvas size to compute the render target size
  61086. * used to generated the glowing objects (the smaller the faster).
  61087. */
  61088. mainTextureRatio: number;
  61089. /**
  61090. * Enforces a fixed size texture to ensure resize independant blur.
  61091. */
  61092. mainTextureFixedSize?: number;
  61093. /**
  61094. * How big is the kernel of the blur texture.
  61095. */
  61096. blurKernelSize: number;
  61097. /**
  61098. * The camera attached to the layer.
  61099. */
  61100. camera: Nullable<Camera>;
  61101. /**
  61102. * Enable MSAA by chosing the number of samples.
  61103. */
  61104. mainTextureSamples?: number;
  61105. /**
  61106. * The rendering group to draw the layer in.
  61107. */
  61108. renderingGroupId: number;
  61109. }
  61110. /**
  61111. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61112. *
  61113. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61114. *
  61115. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61116. */
  61117. export class GlowLayer extends EffectLayer {
  61118. /**
  61119. * Effect Name of the layer.
  61120. */
  61121. static readonly EffectName: string;
  61122. /**
  61123. * The default blur kernel size used for the glow.
  61124. */
  61125. static DefaultBlurKernelSize: number;
  61126. /**
  61127. * The default texture size ratio used for the glow.
  61128. */
  61129. static DefaultTextureRatio: number;
  61130. /**
  61131. * Sets the kernel size of the blur.
  61132. */
  61133. set blurKernelSize(value: number);
  61134. /**
  61135. * Gets the kernel size of the blur.
  61136. */
  61137. get blurKernelSize(): number;
  61138. /**
  61139. * Sets the glow intensity.
  61140. */
  61141. set intensity(value: number);
  61142. /**
  61143. * Gets the glow intensity.
  61144. */
  61145. get intensity(): number;
  61146. private _options;
  61147. private _intensity;
  61148. private _horizontalBlurPostprocess1;
  61149. private _verticalBlurPostprocess1;
  61150. private _horizontalBlurPostprocess2;
  61151. private _verticalBlurPostprocess2;
  61152. private _blurTexture1;
  61153. private _blurTexture2;
  61154. private _postProcesses1;
  61155. private _postProcesses2;
  61156. private _includedOnlyMeshes;
  61157. private _excludedMeshes;
  61158. private _meshesUsingTheirOwnMaterials;
  61159. /**
  61160. * Callback used to let the user override the color selection on a per mesh basis
  61161. */
  61162. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61163. /**
  61164. * Callback used to let the user override the texture selection on a per mesh basis
  61165. */
  61166. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61167. /**
  61168. * Instantiates a new glow Layer and references it to the scene.
  61169. * @param name The name of the layer
  61170. * @param scene The scene to use the layer in
  61171. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61172. */
  61173. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61174. /**
  61175. * Get the effect name of the layer.
  61176. * @return The effect name
  61177. */
  61178. getEffectName(): string;
  61179. /**
  61180. * Create the merge effect. This is the shader use to blit the information back
  61181. * to the main canvas at the end of the scene rendering.
  61182. */
  61183. protected _createMergeEffect(): Effect;
  61184. /**
  61185. * Creates the render target textures and post processes used in the glow layer.
  61186. */
  61187. protected _createTextureAndPostProcesses(): void;
  61188. /**
  61189. * Checks for the readiness of the element composing the layer.
  61190. * @param subMesh the mesh to check for
  61191. * @param useInstances specify wether or not to use instances to render the mesh
  61192. * @param emissiveTexture the associated emissive texture used to generate the glow
  61193. * @return true if ready otherwise, false
  61194. */
  61195. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61196. /**
  61197. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61198. */
  61199. needStencil(): boolean;
  61200. /**
  61201. * Returns true if the mesh can be rendered, otherwise false.
  61202. * @param mesh The mesh to render
  61203. * @param material The material used on the mesh
  61204. * @returns true if it can be rendered otherwise false
  61205. */
  61206. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61207. /**
  61208. * Implementation specific of rendering the generating effect on the main canvas.
  61209. * @param effect The effect used to render through
  61210. */
  61211. protected _internalRender(effect: Effect): void;
  61212. /**
  61213. * Sets the required values for both the emissive texture and and the main color.
  61214. */
  61215. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61216. /**
  61217. * Returns true if the mesh should render, otherwise false.
  61218. * @param mesh The mesh to render
  61219. * @returns true if it should render otherwise false
  61220. */
  61221. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61222. /**
  61223. * Adds specific effects defines.
  61224. * @param defines The defines to add specifics to.
  61225. */
  61226. protected _addCustomEffectDefines(defines: string[]): void;
  61227. /**
  61228. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61229. * @param mesh The mesh to exclude from the glow layer
  61230. */
  61231. addExcludedMesh(mesh: Mesh): void;
  61232. /**
  61233. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61234. * @param mesh The mesh to remove
  61235. */
  61236. removeExcludedMesh(mesh: Mesh): void;
  61237. /**
  61238. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61239. * @param mesh The mesh to include in the glow layer
  61240. */
  61241. addIncludedOnlyMesh(mesh: Mesh): void;
  61242. /**
  61243. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61244. * @param mesh The mesh to remove
  61245. */
  61246. removeIncludedOnlyMesh(mesh: Mesh): void;
  61247. /**
  61248. * Determine if a given mesh will be used in the glow layer
  61249. * @param mesh The mesh to test
  61250. * @returns true if the mesh will be highlighted by the current glow layer
  61251. */
  61252. hasMesh(mesh: AbstractMesh): boolean;
  61253. /**
  61254. * Defines whether the current material of the mesh should be use to render the effect.
  61255. * @param mesh defines the current mesh to render
  61256. */
  61257. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61258. /**
  61259. * Add a mesh to be rendered through its own material and not with emissive only.
  61260. * @param mesh The mesh for which we need to use its material
  61261. */
  61262. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61263. /**
  61264. * Remove a mesh from being rendered through its own material and not with emissive only.
  61265. * @param mesh The mesh for which we need to not use its material
  61266. */
  61267. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61268. /**
  61269. * Free any resources and references associated to a mesh.
  61270. * Internal use
  61271. * @param mesh The mesh to free.
  61272. * @hidden
  61273. */
  61274. _disposeMesh(mesh: Mesh): void;
  61275. /**
  61276. * Gets the class name of the effect layer
  61277. * @returns the string with the class name of the effect layer
  61278. */
  61279. getClassName(): string;
  61280. /**
  61281. * Serializes this glow layer
  61282. * @returns a serialized glow layer object
  61283. */
  61284. serialize(): any;
  61285. /**
  61286. * Creates a Glow Layer from parsed glow layer data
  61287. * @param parsedGlowLayer defines glow layer data
  61288. * @param scene defines the current scene
  61289. * @param rootUrl defines the root URL containing the glow layer information
  61290. * @returns a parsed Glow Layer
  61291. */
  61292. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61293. }
  61294. }
  61295. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61296. /** @hidden */
  61297. export var glowBlurPostProcessPixelShader: {
  61298. name: string;
  61299. shader: string;
  61300. };
  61301. }
  61302. declare module "babylonjs/Layers/highlightLayer" {
  61303. import { Observable } from "babylonjs/Misc/observable";
  61304. import { Nullable } from "babylonjs/types";
  61305. import { Camera } from "babylonjs/Cameras/camera";
  61306. import { Scene } from "babylonjs/scene";
  61307. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61308. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61309. import { Mesh } from "babylonjs/Meshes/mesh";
  61310. import { Effect } from "babylonjs/Materials/effect";
  61311. import { Material } from "babylonjs/Materials/material";
  61312. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61313. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61314. import "babylonjs/Shaders/glowMapMerge.fragment";
  61315. import "babylonjs/Shaders/glowMapMerge.vertex";
  61316. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61317. module "babylonjs/abstractScene" {
  61318. interface AbstractScene {
  61319. /**
  61320. * Return a the first highlight layer of the scene with a given name.
  61321. * @param name The name of the highlight layer to look for.
  61322. * @return The highlight layer if found otherwise null.
  61323. */
  61324. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61325. }
  61326. }
  61327. /**
  61328. * Highlight layer options. This helps customizing the behaviour
  61329. * of the highlight layer.
  61330. */
  61331. export interface IHighlightLayerOptions {
  61332. /**
  61333. * Multiplication factor apply to the canvas size to compute the render target size
  61334. * used to generated the glowing objects (the smaller the faster).
  61335. */
  61336. mainTextureRatio: number;
  61337. /**
  61338. * Enforces a fixed size texture to ensure resize independant blur.
  61339. */
  61340. mainTextureFixedSize?: number;
  61341. /**
  61342. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61343. * of the picture to blur (the smaller the faster).
  61344. */
  61345. blurTextureSizeRatio: number;
  61346. /**
  61347. * How big in texel of the blur texture is the vertical blur.
  61348. */
  61349. blurVerticalSize: number;
  61350. /**
  61351. * How big in texel of the blur texture is the horizontal blur.
  61352. */
  61353. blurHorizontalSize: number;
  61354. /**
  61355. * Alpha blending mode used to apply the blur. Default is combine.
  61356. */
  61357. alphaBlendingMode: number;
  61358. /**
  61359. * The camera attached to the layer.
  61360. */
  61361. camera: Nullable<Camera>;
  61362. /**
  61363. * Should we display highlight as a solid stroke?
  61364. */
  61365. isStroke?: boolean;
  61366. /**
  61367. * The rendering group to draw the layer in.
  61368. */
  61369. renderingGroupId: number;
  61370. }
  61371. /**
  61372. * The highlight layer Helps adding a glow effect around a mesh.
  61373. *
  61374. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61375. * glowy meshes to your scene.
  61376. *
  61377. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61378. */
  61379. export class HighlightLayer extends EffectLayer {
  61380. name: string;
  61381. /**
  61382. * Effect Name of the highlight layer.
  61383. */
  61384. static readonly EffectName: string;
  61385. /**
  61386. * The neutral color used during the preparation of the glow effect.
  61387. * This is black by default as the blend operation is a blend operation.
  61388. */
  61389. static NeutralColor: Color4;
  61390. /**
  61391. * Stencil value used for glowing meshes.
  61392. */
  61393. static GlowingMeshStencilReference: number;
  61394. /**
  61395. * Stencil value used for the other meshes in the scene.
  61396. */
  61397. static NormalMeshStencilReference: number;
  61398. /**
  61399. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61400. */
  61401. innerGlow: boolean;
  61402. /**
  61403. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61404. */
  61405. outerGlow: boolean;
  61406. /**
  61407. * Specifies the horizontal size of the blur.
  61408. */
  61409. set blurHorizontalSize(value: number);
  61410. /**
  61411. * Specifies the vertical size of the blur.
  61412. */
  61413. set blurVerticalSize(value: number);
  61414. /**
  61415. * Gets the horizontal size of the blur.
  61416. */
  61417. get blurHorizontalSize(): number;
  61418. /**
  61419. * Gets the vertical size of the blur.
  61420. */
  61421. get blurVerticalSize(): number;
  61422. /**
  61423. * An event triggered when the highlight layer is being blurred.
  61424. */
  61425. onBeforeBlurObservable: Observable<HighlightLayer>;
  61426. /**
  61427. * An event triggered when the highlight layer has been blurred.
  61428. */
  61429. onAfterBlurObservable: Observable<HighlightLayer>;
  61430. private _instanceGlowingMeshStencilReference;
  61431. private _options;
  61432. private _downSamplePostprocess;
  61433. private _horizontalBlurPostprocess;
  61434. private _verticalBlurPostprocess;
  61435. private _blurTexture;
  61436. private _meshes;
  61437. private _excludedMeshes;
  61438. /**
  61439. * Instantiates a new highlight Layer and references it to the scene..
  61440. * @param name The name of the layer
  61441. * @param scene The scene to use the layer in
  61442. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61443. */
  61444. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61445. /**
  61446. * Get the effect name of the layer.
  61447. * @return The effect name
  61448. */
  61449. getEffectName(): string;
  61450. /**
  61451. * Create the merge effect. This is the shader use to blit the information back
  61452. * to the main canvas at the end of the scene rendering.
  61453. */
  61454. protected _createMergeEffect(): Effect;
  61455. /**
  61456. * Creates the render target textures and post processes used in the highlight layer.
  61457. */
  61458. protected _createTextureAndPostProcesses(): void;
  61459. /**
  61460. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61461. */
  61462. needStencil(): boolean;
  61463. /**
  61464. * Checks for the readiness of the element composing the layer.
  61465. * @param subMesh the mesh to check for
  61466. * @param useInstances specify wether or not to use instances to render the mesh
  61467. * @param emissiveTexture the associated emissive texture used to generate the glow
  61468. * @return true if ready otherwise, false
  61469. */
  61470. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61471. /**
  61472. * Implementation specific of rendering the generating effect on the main canvas.
  61473. * @param effect The effect used to render through
  61474. */
  61475. protected _internalRender(effect: Effect): void;
  61476. /**
  61477. * Returns true if the layer contains information to display, otherwise false.
  61478. */
  61479. shouldRender(): boolean;
  61480. /**
  61481. * Returns true if the mesh should render, otherwise false.
  61482. * @param mesh The mesh to render
  61483. * @returns true if it should render otherwise false
  61484. */
  61485. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61486. /**
  61487. * Returns true if the mesh can be rendered, otherwise false.
  61488. * @param mesh The mesh to render
  61489. * @param material The material used on the mesh
  61490. * @returns true if it can be rendered otherwise false
  61491. */
  61492. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61493. /**
  61494. * Adds specific effects defines.
  61495. * @param defines The defines to add specifics to.
  61496. */
  61497. protected _addCustomEffectDefines(defines: string[]): void;
  61498. /**
  61499. * Sets the required values for both the emissive texture and and the main color.
  61500. */
  61501. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61502. /**
  61503. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61504. * @param mesh The mesh to exclude from the highlight layer
  61505. */
  61506. addExcludedMesh(mesh: Mesh): void;
  61507. /**
  61508. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61509. * @param mesh The mesh to highlight
  61510. */
  61511. removeExcludedMesh(mesh: Mesh): void;
  61512. /**
  61513. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61514. * @param mesh mesh to test
  61515. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61516. */
  61517. hasMesh(mesh: AbstractMesh): boolean;
  61518. /**
  61519. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61520. * @param mesh The mesh to highlight
  61521. * @param color The color of the highlight
  61522. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61523. */
  61524. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61525. /**
  61526. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61527. * @param mesh The mesh to highlight
  61528. */
  61529. removeMesh(mesh: Mesh): void;
  61530. /**
  61531. * Remove all the meshes currently referenced in the highlight layer
  61532. */
  61533. removeAllMeshes(): void;
  61534. /**
  61535. * Force the stencil to the normal expected value for none glowing parts
  61536. */
  61537. private _defaultStencilReference;
  61538. /**
  61539. * Free any resources and references associated to a mesh.
  61540. * Internal use
  61541. * @param mesh The mesh to free.
  61542. * @hidden
  61543. */
  61544. _disposeMesh(mesh: Mesh): void;
  61545. /**
  61546. * Dispose the highlight layer and free resources.
  61547. */
  61548. dispose(): void;
  61549. /**
  61550. * Gets the class name of the effect layer
  61551. * @returns the string with the class name of the effect layer
  61552. */
  61553. getClassName(): string;
  61554. /**
  61555. * Serializes this Highlight layer
  61556. * @returns a serialized Highlight layer object
  61557. */
  61558. serialize(): any;
  61559. /**
  61560. * Creates a Highlight layer from parsed Highlight layer data
  61561. * @param parsedHightlightLayer defines the Highlight layer data
  61562. * @param scene defines the current scene
  61563. * @param rootUrl defines the root URL containing the Highlight layer information
  61564. * @returns a parsed Highlight layer
  61565. */
  61566. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61567. }
  61568. }
  61569. declare module "babylonjs/Layers/layerSceneComponent" {
  61570. import { Scene } from "babylonjs/scene";
  61571. import { ISceneComponent } from "babylonjs/sceneComponent";
  61572. import { Layer } from "babylonjs/Layers/layer";
  61573. import { AbstractScene } from "babylonjs/abstractScene";
  61574. module "babylonjs/abstractScene" {
  61575. interface AbstractScene {
  61576. /**
  61577. * The list of layers (background and foreground) of the scene
  61578. */
  61579. layers: Array<Layer>;
  61580. }
  61581. }
  61582. /**
  61583. * Defines the layer scene component responsible to manage any layers
  61584. * in a given scene.
  61585. */
  61586. export class LayerSceneComponent implements ISceneComponent {
  61587. /**
  61588. * The component name helpfull to identify the component in the list of scene components.
  61589. */
  61590. readonly name: string;
  61591. /**
  61592. * The scene the component belongs to.
  61593. */
  61594. scene: Scene;
  61595. private _engine;
  61596. /**
  61597. * Creates a new instance of the component for the given scene
  61598. * @param scene Defines the scene to register the component in
  61599. */
  61600. constructor(scene: Scene);
  61601. /**
  61602. * Registers the component in a given scene
  61603. */
  61604. register(): void;
  61605. /**
  61606. * Rebuilds the elements related to this component in case of
  61607. * context lost for instance.
  61608. */
  61609. rebuild(): void;
  61610. /**
  61611. * Disposes the component and the associated ressources.
  61612. */
  61613. dispose(): void;
  61614. private _draw;
  61615. private _drawCameraPredicate;
  61616. private _drawCameraBackground;
  61617. private _drawCameraForeground;
  61618. private _drawRenderTargetPredicate;
  61619. private _drawRenderTargetBackground;
  61620. private _drawRenderTargetForeground;
  61621. /**
  61622. * Adds all the elements from the container to the scene
  61623. * @param container the container holding the elements
  61624. */
  61625. addFromContainer(container: AbstractScene): void;
  61626. /**
  61627. * Removes all the elements in the container from the scene
  61628. * @param container contains the elements to remove
  61629. * @param dispose if the removed element should be disposed (default: false)
  61630. */
  61631. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61632. }
  61633. }
  61634. declare module "babylonjs/Shaders/layer.fragment" {
  61635. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61636. /** @hidden */
  61637. export var layerPixelShader: {
  61638. name: string;
  61639. shader: string;
  61640. };
  61641. }
  61642. declare module "babylonjs/Shaders/layer.vertex" {
  61643. /** @hidden */
  61644. export var layerVertexShader: {
  61645. name: string;
  61646. shader: string;
  61647. };
  61648. }
  61649. declare module "babylonjs/Layers/layer" {
  61650. import { Observable } from "babylonjs/Misc/observable";
  61651. import { Nullable } from "babylonjs/types";
  61652. import { Scene } from "babylonjs/scene";
  61653. import { Vector2 } from "babylonjs/Maths/math.vector";
  61654. import { Color4 } from "babylonjs/Maths/math.color";
  61655. import { Texture } from "babylonjs/Materials/Textures/texture";
  61656. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61657. import "babylonjs/Shaders/layer.fragment";
  61658. import "babylonjs/Shaders/layer.vertex";
  61659. /**
  61660. * This represents a full screen 2d layer.
  61661. * This can be useful to display a picture in the background of your scene for instance.
  61662. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61663. */
  61664. export class Layer {
  61665. /**
  61666. * Define the name of the layer.
  61667. */
  61668. name: string;
  61669. /**
  61670. * Define the texture the layer should display.
  61671. */
  61672. texture: Nullable<Texture>;
  61673. /**
  61674. * Is the layer in background or foreground.
  61675. */
  61676. isBackground: boolean;
  61677. /**
  61678. * Define the color of the layer (instead of texture).
  61679. */
  61680. color: Color4;
  61681. /**
  61682. * Define the scale of the layer in order to zoom in out of the texture.
  61683. */
  61684. scale: Vector2;
  61685. /**
  61686. * Define an offset for the layer in order to shift the texture.
  61687. */
  61688. offset: Vector2;
  61689. /**
  61690. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61691. */
  61692. alphaBlendingMode: number;
  61693. /**
  61694. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61695. * Alpha test will not mix with the background color in case of transparency.
  61696. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61697. */
  61698. alphaTest: boolean;
  61699. /**
  61700. * Define a mask to restrict the layer to only some of the scene cameras.
  61701. */
  61702. layerMask: number;
  61703. /**
  61704. * Define the list of render target the layer is visible into.
  61705. */
  61706. renderTargetTextures: RenderTargetTexture[];
  61707. /**
  61708. * Define if the layer is only used in renderTarget or if it also
  61709. * renders in the main frame buffer of the canvas.
  61710. */
  61711. renderOnlyInRenderTargetTextures: boolean;
  61712. private _scene;
  61713. private _vertexBuffers;
  61714. private _indexBuffer;
  61715. private _effect;
  61716. private _previousDefines;
  61717. /**
  61718. * An event triggered when the layer is disposed.
  61719. */
  61720. onDisposeObservable: Observable<Layer>;
  61721. private _onDisposeObserver;
  61722. /**
  61723. * Back compatibility with callback before the onDisposeObservable existed.
  61724. * The set callback will be triggered when the layer has been disposed.
  61725. */
  61726. set onDispose(callback: () => void);
  61727. /**
  61728. * An event triggered before rendering the scene
  61729. */
  61730. onBeforeRenderObservable: Observable<Layer>;
  61731. private _onBeforeRenderObserver;
  61732. /**
  61733. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61734. * The set callback will be triggered just before rendering the layer.
  61735. */
  61736. set onBeforeRender(callback: () => void);
  61737. /**
  61738. * An event triggered after rendering the scene
  61739. */
  61740. onAfterRenderObservable: Observable<Layer>;
  61741. private _onAfterRenderObserver;
  61742. /**
  61743. * Back compatibility with callback before the onAfterRenderObservable existed.
  61744. * The set callback will be triggered just after rendering the layer.
  61745. */
  61746. set onAfterRender(callback: () => void);
  61747. /**
  61748. * Instantiates a new layer.
  61749. * This represents a full screen 2d layer.
  61750. * This can be useful to display a picture in the background of your scene for instance.
  61751. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61752. * @param name Define the name of the layer in the scene
  61753. * @param imgUrl Define the url of the texture to display in the layer
  61754. * @param scene Define the scene the layer belongs to
  61755. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61756. * @param color Defines a color for the layer
  61757. */
  61758. constructor(
  61759. /**
  61760. * Define the name of the layer.
  61761. */
  61762. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61763. private _createIndexBuffer;
  61764. /** @hidden */
  61765. _rebuild(): void;
  61766. /**
  61767. * Renders the layer in the scene.
  61768. */
  61769. render(): void;
  61770. /**
  61771. * Disposes and releases the associated ressources.
  61772. */
  61773. dispose(): void;
  61774. }
  61775. }
  61776. declare module "babylonjs/Layers/index" {
  61777. export * from "babylonjs/Layers/effectLayer";
  61778. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61779. export * from "babylonjs/Layers/glowLayer";
  61780. export * from "babylonjs/Layers/highlightLayer";
  61781. export * from "babylonjs/Layers/layer";
  61782. export * from "babylonjs/Layers/layerSceneComponent";
  61783. }
  61784. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61785. /** @hidden */
  61786. export var lensFlarePixelShader: {
  61787. name: string;
  61788. shader: string;
  61789. };
  61790. }
  61791. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61792. /** @hidden */
  61793. export var lensFlareVertexShader: {
  61794. name: string;
  61795. shader: string;
  61796. };
  61797. }
  61798. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61799. import { Scene } from "babylonjs/scene";
  61800. import { Vector3 } from "babylonjs/Maths/math.vector";
  61801. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61802. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61803. import "babylonjs/Shaders/lensFlare.fragment";
  61804. import "babylonjs/Shaders/lensFlare.vertex";
  61805. import { Viewport } from "babylonjs/Maths/math.viewport";
  61806. /**
  61807. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61808. * It is usually composed of several `lensFlare`.
  61809. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61810. */
  61811. export class LensFlareSystem {
  61812. /**
  61813. * Define the name of the lens flare system
  61814. */
  61815. name: string;
  61816. /**
  61817. * List of lens flares used in this system.
  61818. */
  61819. lensFlares: LensFlare[];
  61820. /**
  61821. * Define a limit from the border the lens flare can be visible.
  61822. */
  61823. borderLimit: number;
  61824. /**
  61825. * Define a viewport border we do not want to see the lens flare in.
  61826. */
  61827. viewportBorder: number;
  61828. /**
  61829. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61830. */
  61831. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61832. /**
  61833. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61834. */
  61835. layerMask: number;
  61836. /**
  61837. * Define the id of the lens flare system in the scene.
  61838. * (equal to name by default)
  61839. */
  61840. id: string;
  61841. private _scene;
  61842. private _emitter;
  61843. private _vertexBuffers;
  61844. private _indexBuffer;
  61845. private _effect;
  61846. private _positionX;
  61847. private _positionY;
  61848. private _isEnabled;
  61849. /** @hidden */
  61850. static _SceneComponentInitialization: (scene: Scene) => void;
  61851. /**
  61852. * Instantiates a lens flare system.
  61853. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61854. * It is usually composed of several `lensFlare`.
  61855. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61856. * @param name Define the name of the lens flare system in the scene
  61857. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  61858. * @param scene Define the scene the lens flare system belongs to
  61859. */
  61860. constructor(
  61861. /**
  61862. * Define the name of the lens flare system
  61863. */
  61864. name: string, emitter: any, scene: Scene);
  61865. /**
  61866. * Define if the lens flare system is enabled.
  61867. */
  61868. get isEnabled(): boolean;
  61869. set isEnabled(value: boolean);
  61870. /**
  61871. * Get the scene the effects belongs to.
  61872. * @returns the scene holding the lens flare system
  61873. */
  61874. getScene(): Scene;
  61875. /**
  61876. * Get the emitter of the lens flare system.
  61877. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61878. * @returns the emitter of the lens flare system
  61879. */
  61880. getEmitter(): any;
  61881. /**
  61882. * Set the emitter of the lens flare system.
  61883. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61884. * @param newEmitter Define the new emitter of the system
  61885. */
  61886. setEmitter(newEmitter: any): void;
  61887. /**
  61888. * Get the lens flare system emitter position.
  61889. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  61890. * @returns the position
  61891. */
  61892. getEmitterPosition(): Vector3;
  61893. /**
  61894. * @hidden
  61895. */
  61896. computeEffectivePosition(globalViewport: Viewport): boolean;
  61897. /** @hidden */
  61898. _isVisible(): boolean;
  61899. /**
  61900. * @hidden
  61901. */
  61902. render(): boolean;
  61903. /**
  61904. * Dispose and release the lens flare with its associated resources.
  61905. */
  61906. dispose(): void;
  61907. /**
  61908. * Parse a lens flare system from a JSON repressentation
  61909. * @param parsedLensFlareSystem Define the JSON to parse
  61910. * @param scene Define the scene the parsed system should be instantiated in
  61911. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  61912. * @returns the parsed system
  61913. */
  61914. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  61915. /**
  61916. * Serialize the current Lens Flare System into a JSON representation.
  61917. * @returns the serialized JSON
  61918. */
  61919. serialize(): any;
  61920. }
  61921. }
  61922. declare module "babylonjs/LensFlares/lensFlare" {
  61923. import { Nullable } from "babylonjs/types";
  61924. import { Color3 } from "babylonjs/Maths/math.color";
  61925. import { Texture } from "babylonjs/Materials/Textures/texture";
  61926. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61927. /**
  61928. * This represents one of the lens effect in a `lensFlareSystem`.
  61929. * It controls one of the indiviual texture used in the effect.
  61930. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61931. */
  61932. export class LensFlare {
  61933. /**
  61934. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61935. */
  61936. size: number;
  61937. /**
  61938. * 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.
  61939. */
  61940. position: number;
  61941. /**
  61942. * Define the lens color.
  61943. */
  61944. color: Color3;
  61945. /**
  61946. * Define the lens texture.
  61947. */
  61948. texture: Nullable<Texture>;
  61949. /**
  61950. * Define the alpha mode to render this particular lens.
  61951. */
  61952. alphaMode: number;
  61953. private _system;
  61954. /**
  61955. * Creates a new Lens Flare.
  61956. * This represents one of the lens effect in a `lensFlareSystem`.
  61957. * It controls one of the indiviual texture used in the effect.
  61958. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61959. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  61960. * @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.
  61961. * @param color Define the lens color
  61962. * @param imgUrl Define the lens texture url
  61963. * @param system Define the `lensFlareSystem` this flare is part of
  61964. * @returns The newly created Lens Flare
  61965. */
  61966. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  61967. /**
  61968. * Instantiates a new Lens Flare.
  61969. * This represents one of the lens effect in a `lensFlareSystem`.
  61970. * It controls one of the indiviual texture used in the effect.
  61971. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61972. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  61973. * @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.
  61974. * @param color Define the lens color
  61975. * @param imgUrl Define the lens texture url
  61976. * @param system Define the `lensFlareSystem` this flare is part of
  61977. */
  61978. constructor(
  61979. /**
  61980. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61981. */
  61982. size: number,
  61983. /**
  61984. * 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.
  61985. */
  61986. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  61987. /**
  61988. * Dispose and release the lens flare with its associated resources.
  61989. */
  61990. dispose(): void;
  61991. }
  61992. }
  61993. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  61994. import { Nullable } from "babylonjs/types";
  61995. import { Scene } from "babylonjs/scene";
  61996. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61997. import { AbstractScene } from "babylonjs/abstractScene";
  61998. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61999. module "babylonjs/abstractScene" {
  62000. interface AbstractScene {
  62001. /**
  62002. * The list of lens flare system added to the scene
  62003. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62004. */
  62005. lensFlareSystems: Array<LensFlareSystem>;
  62006. /**
  62007. * Removes the given lens flare system from this scene.
  62008. * @param toRemove The lens flare system to remove
  62009. * @returns The index of the removed lens flare system
  62010. */
  62011. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  62012. /**
  62013. * Adds the given lens flare system to this scene
  62014. * @param newLensFlareSystem The lens flare system to add
  62015. */
  62016. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  62017. /**
  62018. * Gets a lens flare system using its name
  62019. * @param name defines the name to look for
  62020. * @returns the lens flare system or null if not found
  62021. */
  62022. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  62023. /**
  62024. * Gets a lens flare system using its id
  62025. * @param id defines the id to look for
  62026. * @returns the lens flare system or null if not found
  62027. */
  62028. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  62029. }
  62030. }
  62031. /**
  62032. * Defines the lens flare scene component responsible to manage any lens flares
  62033. * in a given scene.
  62034. */
  62035. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  62036. /**
  62037. * The component name helpfull to identify the component in the list of scene components.
  62038. */
  62039. readonly name: string;
  62040. /**
  62041. * The scene the component belongs to.
  62042. */
  62043. scene: Scene;
  62044. /**
  62045. * Creates a new instance of the component for the given scene
  62046. * @param scene Defines the scene to register the component in
  62047. */
  62048. constructor(scene: Scene);
  62049. /**
  62050. * Registers the component in a given scene
  62051. */
  62052. register(): void;
  62053. /**
  62054. * Rebuilds the elements related to this component in case of
  62055. * context lost for instance.
  62056. */
  62057. rebuild(): void;
  62058. /**
  62059. * Adds all the elements from the container to the scene
  62060. * @param container the container holding the elements
  62061. */
  62062. addFromContainer(container: AbstractScene): void;
  62063. /**
  62064. * Removes all the elements in the container from the scene
  62065. * @param container contains the elements to remove
  62066. * @param dispose if the removed element should be disposed (default: false)
  62067. */
  62068. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62069. /**
  62070. * Serializes the component data to the specified json object
  62071. * @param serializationObject The object to serialize to
  62072. */
  62073. serialize(serializationObject: any): void;
  62074. /**
  62075. * Disposes the component and the associated ressources.
  62076. */
  62077. dispose(): void;
  62078. private _draw;
  62079. }
  62080. }
  62081. declare module "babylonjs/LensFlares/index" {
  62082. export * from "babylonjs/LensFlares/lensFlare";
  62083. export * from "babylonjs/LensFlares/lensFlareSystem";
  62084. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62085. }
  62086. declare module "babylonjs/Shaders/depth.fragment" {
  62087. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62088. /** @hidden */
  62089. export var depthPixelShader: {
  62090. name: string;
  62091. shader: string;
  62092. };
  62093. }
  62094. declare module "babylonjs/Shaders/depth.vertex" {
  62095. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62096. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62097. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62098. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62099. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62100. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62101. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62102. /** @hidden */
  62103. export var depthVertexShader: {
  62104. name: string;
  62105. shader: string;
  62106. };
  62107. }
  62108. declare module "babylonjs/Rendering/depthRenderer" {
  62109. import { Nullable } from "babylonjs/types";
  62110. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62111. import { Scene } from "babylonjs/scene";
  62112. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62113. import { Camera } from "babylonjs/Cameras/camera";
  62114. import "babylonjs/Shaders/depth.fragment";
  62115. import "babylonjs/Shaders/depth.vertex";
  62116. /**
  62117. * This represents a depth renderer in Babylon.
  62118. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62119. */
  62120. export class DepthRenderer {
  62121. private _scene;
  62122. private _depthMap;
  62123. private _effect;
  62124. private readonly _storeNonLinearDepth;
  62125. private readonly _clearColor;
  62126. /** Get if the depth renderer is using packed depth or not */
  62127. readonly isPacked: boolean;
  62128. private _cachedDefines;
  62129. private _camera;
  62130. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62131. enabled: boolean;
  62132. /**
  62133. * Specifiess that the depth renderer will only be used within
  62134. * the camera it is created for.
  62135. * This can help forcing its rendering during the camera processing.
  62136. */
  62137. useOnlyInActiveCamera: boolean;
  62138. /** @hidden */
  62139. static _SceneComponentInitialization: (scene: Scene) => void;
  62140. /**
  62141. * Instantiates a depth renderer
  62142. * @param scene The scene the renderer belongs to
  62143. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62144. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62145. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62146. */
  62147. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62148. /**
  62149. * Creates the depth rendering effect and checks if the effect is ready.
  62150. * @param subMesh The submesh to be used to render the depth map of
  62151. * @param useInstances If multiple world instances should be used
  62152. * @returns if the depth renderer is ready to render the depth map
  62153. */
  62154. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62155. /**
  62156. * Gets the texture which the depth map will be written to.
  62157. * @returns The depth map texture
  62158. */
  62159. getDepthMap(): RenderTargetTexture;
  62160. /**
  62161. * Disposes of the depth renderer.
  62162. */
  62163. dispose(): void;
  62164. }
  62165. }
  62166. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62167. /** @hidden */
  62168. export var minmaxReduxPixelShader: {
  62169. name: string;
  62170. shader: string;
  62171. };
  62172. }
  62173. declare module "babylonjs/Misc/minMaxReducer" {
  62174. import { Nullable } from "babylonjs/types";
  62175. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62176. import { Camera } from "babylonjs/Cameras/camera";
  62177. import { Observer } from "babylonjs/Misc/observable";
  62178. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62179. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62180. import { Observable } from "babylonjs/Misc/observable";
  62181. import "babylonjs/Shaders/minmaxRedux.fragment";
  62182. /**
  62183. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62184. * and maximum values from all values of the texture.
  62185. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62186. * The source values are read from the red channel of the texture.
  62187. */
  62188. export class MinMaxReducer {
  62189. /**
  62190. * Observable triggered when the computation has been performed
  62191. */
  62192. onAfterReductionPerformed: Observable<{
  62193. min: number;
  62194. max: number;
  62195. }>;
  62196. protected _camera: Camera;
  62197. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62198. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62199. protected _postProcessManager: PostProcessManager;
  62200. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62201. protected _forceFullscreenViewport: boolean;
  62202. /**
  62203. * Creates a min/max reducer
  62204. * @param camera The camera to use for the post processes
  62205. */
  62206. constructor(camera: Camera);
  62207. /**
  62208. * Gets the texture used to read the values from.
  62209. */
  62210. get sourceTexture(): Nullable<RenderTargetTexture>;
  62211. /**
  62212. * Sets the source texture to read the values from.
  62213. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62214. * because in such textures '1' value must not be taken into account to compute the maximum
  62215. * as this value is used to clear the texture.
  62216. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62217. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62218. * @param depthRedux Indicates if the texture is a depth texture or not
  62219. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62220. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62221. */
  62222. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62223. /**
  62224. * Defines the refresh rate of the computation.
  62225. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62226. */
  62227. get refreshRate(): number;
  62228. set refreshRate(value: number);
  62229. protected _activated: boolean;
  62230. /**
  62231. * Gets the activation status of the reducer
  62232. */
  62233. get activated(): boolean;
  62234. /**
  62235. * Activates the reduction computation.
  62236. * When activated, the observers registered in onAfterReductionPerformed are
  62237. * called after the compuation is performed
  62238. */
  62239. activate(): void;
  62240. /**
  62241. * Deactivates the reduction computation.
  62242. */
  62243. deactivate(): void;
  62244. /**
  62245. * Disposes the min/max reducer
  62246. * @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.
  62247. */
  62248. dispose(disposeAll?: boolean): void;
  62249. }
  62250. }
  62251. declare module "babylonjs/Misc/depthReducer" {
  62252. import { Nullable } from "babylonjs/types";
  62253. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62254. import { Camera } from "babylonjs/Cameras/camera";
  62255. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62256. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62257. /**
  62258. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62259. */
  62260. export class DepthReducer extends MinMaxReducer {
  62261. private _depthRenderer;
  62262. private _depthRendererId;
  62263. /**
  62264. * Gets the depth renderer used for the computation.
  62265. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62266. */
  62267. get depthRenderer(): Nullable<DepthRenderer>;
  62268. /**
  62269. * Creates a depth reducer
  62270. * @param camera The camera used to render the depth texture
  62271. */
  62272. constructor(camera: Camera);
  62273. /**
  62274. * Sets the depth renderer to use to generate the depth map
  62275. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62276. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62277. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62278. */
  62279. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62280. /** @hidden */
  62281. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62282. /**
  62283. * Activates the reduction computation.
  62284. * When activated, the observers registered in onAfterReductionPerformed are
  62285. * called after the compuation is performed
  62286. */
  62287. activate(): void;
  62288. /**
  62289. * Deactivates the reduction computation.
  62290. */
  62291. deactivate(): void;
  62292. /**
  62293. * Disposes the depth reducer
  62294. * @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.
  62295. */
  62296. dispose(disposeAll?: boolean): void;
  62297. }
  62298. }
  62299. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62300. import { Nullable } from "babylonjs/types";
  62301. import { Scene } from "babylonjs/scene";
  62302. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62303. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62304. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62305. import { Effect } from "babylonjs/Materials/effect";
  62306. import "babylonjs/Shaders/shadowMap.fragment";
  62307. import "babylonjs/Shaders/shadowMap.vertex";
  62308. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62309. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62310. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62311. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62312. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62313. /**
  62314. * A CSM implementation allowing casting shadows on large scenes.
  62315. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62316. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62317. */
  62318. export class CascadedShadowGenerator extends ShadowGenerator {
  62319. private static readonly frustumCornersNDCSpace;
  62320. /**
  62321. * Name of the CSM class
  62322. */
  62323. static CLASSNAME: string;
  62324. /**
  62325. * Defines the default number of cascades used by the CSM.
  62326. */
  62327. static readonly DEFAULT_CASCADES_COUNT: number;
  62328. /**
  62329. * Defines the minimum number of cascades used by the CSM.
  62330. */
  62331. static readonly MIN_CASCADES_COUNT: number;
  62332. /**
  62333. * Defines the maximum number of cascades used by the CSM.
  62334. */
  62335. static readonly MAX_CASCADES_COUNT: number;
  62336. protected _validateFilter(filter: number): number;
  62337. /**
  62338. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62339. */
  62340. penumbraDarkness: number;
  62341. private _numCascades;
  62342. /**
  62343. * Gets or set the number of cascades used by the CSM.
  62344. */
  62345. get numCascades(): number;
  62346. set numCascades(value: number);
  62347. /**
  62348. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62349. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62350. */
  62351. stabilizeCascades: boolean;
  62352. private _freezeShadowCastersBoundingInfo;
  62353. private _freezeShadowCastersBoundingInfoObservable;
  62354. /**
  62355. * Enables or disables the shadow casters bounding info computation.
  62356. * If your shadow casters don't move, you can disable this feature.
  62357. * If it is enabled, the bounding box computation is done every frame.
  62358. */
  62359. get freezeShadowCastersBoundingInfo(): boolean;
  62360. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62361. private _scbiMin;
  62362. private _scbiMax;
  62363. protected _computeShadowCastersBoundingInfo(): void;
  62364. protected _shadowCastersBoundingInfo: BoundingInfo;
  62365. /**
  62366. * Gets or sets the shadow casters bounding info.
  62367. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62368. * so that the system won't overwrite the bounds you provide
  62369. */
  62370. get shadowCastersBoundingInfo(): BoundingInfo;
  62371. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62372. protected _breaksAreDirty: boolean;
  62373. protected _minDistance: number;
  62374. protected _maxDistance: number;
  62375. /**
  62376. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62377. *
  62378. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62379. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62380. * @param min minimal distance for the breaks (default to 0.)
  62381. * @param max maximal distance for the breaks (default to 1.)
  62382. */
  62383. setMinMaxDistance(min: number, max: number): void;
  62384. /** Gets the minimal distance used in the cascade break computation */
  62385. get minDistance(): number;
  62386. /** Gets the maximal distance used in the cascade break computation */
  62387. get maxDistance(): number;
  62388. /**
  62389. * Gets the class name of that object
  62390. * @returns "CascadedShadowGenerator"
  62391. */
  62392. getClassName(): string;
  62393. private _cascadeMinExtents;
  62394. private _cascadeMaxExtents;
  62395. /**
  62396. * Gets a cascade minimum extents
  62397. * @param cascadeIndex index of the cascade
  62398. * @returns the minimum cascade extents
  62399. */
  62400. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62401. /**
  62402. * Gets a cascade maximum extents
  62403. * @param cascadeIndex index of the cascade
  62404. * @returns the maximum cascade extents
  62405. */
  62406. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62407. private _cascades;
  62408. private _currentLayer;
  62409. private _viewSpaceFrustumsZ;
  62410. private _viewMatrices;
  62411. private _projectionMatrices;
  62412. private _transformMatrices;
  62413. private _transformMatricesAsArray;
  62414. private _frustumLengths;
  62415. private _lightSizeUVCorrection;
  62416. private _depthCorrection;
  62417. private _frustumCornersWorldSpace;
  62418. private _frustumCenter;
  62419. private _shadowCameraPos;
  62420. private _shadowMaxZ;
  62421. /**
  62422. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62423. * It defaults to camera.maxZ
  62424. */
  62425. get shadowMaxZ(): number;
  62426. /**
  62427. * Sets the shadow max z distance.
  62428. */
  62429. set shadowMaxZ(value: number);
  62430. protected _debug: boolean;
  62431. /**
  62432. * Gets or sets the debug flag.
  62433. * When enabled, the cascades are materialized by different colors on the screen.
  62434. */
  62435. get debug(): boolean;
  62436. set debug(dbg: boolean);
  62437. private _depthClamp;
  62438. /**
  62439. * Gets or sets the depth clamping value.
  62440. *
  62441. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62442. * to account for the shadow casters far away.
  62443. *
  62444. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62445. */
  62446. get depthClamp(): boolean;
  62447. set depthClamp(value: boolean);
  62448. private _cascadeBlendPercentage;
  62449. /**
  62450. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62451. * It defaults to 0.1 (10% blending).
  62452. */
  62453. get cascadeBlendPercentage(): number;
  62454. set cascadeBlendPercentage(value: number);
  62455. private _lambda;
  62456. /**
  62457. * Gets or set the lambda parameter.
  62458. * This parameter is used to split the camera frustum and create the cascades.
  62459. * 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.
  62460. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62461. */
  62462. get lambda(): number;
  62463. set lambda(value: number);
  62464. /**
  62465. * Gets the view matrix corresponding to a given cascade
  62466. * @param cascadeNum cascade to retrieve the view matrix from
  62467. * @returns the cascade view matrix
  62468. */
  62469. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62470. /**
  62471. * Gets the projection matrix corresponding to a given cascade
  62472. * @param cascadeNum cascade to retrieve the projection matrix from
  62473. * @returns the cascade projection matrix
  62474. */
  62475. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62476. /**
  62477. * Gets the transformation matrix corresponding to a given cascade
  62478. * @param cascadeNum cascade to retrieve the transformation matrix from
  62479. * @returns the cascade transformation matrix
  62480. */
  62481. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62482. private _depthRenderer;
  62483. /**
  62484. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62485. *
  62486. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62487. *
  62488. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62489. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62490. * @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
  62491. */
  62492. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62493. private _depthReducer;
  62494. private _autoCalcDepthBounds;
  62495. /**
  62496. * Gets or sets the autoCalcDepthBounds property.
  62497. *
  62498. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62499. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62500. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62501. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62502. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62503. */
  62504. get autoCalcDepthBounds(): boolean;
  62505. set autoCalcDepthBounds(value: boolean);
  62506. /**
  62507. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62508. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62509. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62510. * for setting the refresh rate on the renderer yourself!
  62511. */
  62512. get autoCalcDepthBoundsRefreshRate(): number;
  62513. set autoCalcDepthBoundsRefreshRate(value: number);
  62514. /**
  62515. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62516. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62517. * you change the camera near/far planes!
  62518. */
  62519. splitFrustum(): void;
  62520. private _splitFrustum;
  62521. private _computeMatrices;
  62522. private _computeFrustumInWorldSpace;
  62523. private _computeCascadeFrustum;
  62524. /**
  62525. * Support test.
  62526. */
  62527. static get IsSupported(): boolean;
  62528. /** @hidden */
  62529. static _SceneComponentInitialization: (scene: Scene) => void;
  62530. /**
  62531. * Creates a Cascaded Shadow Generator object.
  62532. * A ShadowGenerator is the required tool to use the shadows.
  62533. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62534. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62535. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62536. * @param light The directional light object generating the shadows.
  62537. * @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.
  62538. */
  62539. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62540. protected _initializeGenerator(): void;
  62541. protected _createTargetRenderTexture(): void;
  62542. protected _initializeShadowMap(): void;
  62543. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62544. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62545. /**
  62546. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62547. * @param defines Defines of the material we want to update
  62548. * @param lightIndex Index of the light in the enabled light list of the material
  62549. */
  62550. prepareDefines(defines: any, lightIndex: number): void;
  62551. /**
  62552. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62553. * defined in the generator but impacting the effect).
  62554. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62555. * @param effect The effect we are binfing the information for
  62556. */
  62557. bindShadowLight(lightIndex: string, effect: Effect): void;
  62558. /**
  62559. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62560. * (eq to view projection * shadow projection matrices)
  62561. * @returns The transform matrix used to create the shadow map
  62562. */
  62563. getTransformMatrix(): Matrix;
  62564. /**
  62565. * Disposes the ShadowGenerator.
  62566. * Returns nothing.
  62567. */
  62568. dispose(): void;
  62569. /**
  62570. * Serializes the shadow generator setup to a json object.
  62571. * @returns The serialized JSON object
  62572. */
  62573. serialize(): any;
  62574. /**
  62575. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62576. * @param parsedShadowGenerator The JSON object to parse
  62577. * @param scene The scene to create the shadow map for
  62578. * @returns The parsed shadow generator
  62579. */
  62580. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62581. }
  62582. }
  62583. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62584. import { Scene } from "babylonjs/scene";
  62585. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62586. import { AbstractScene } from "babylonjs/abstractScene";
  62587. /**
  62588. * Defines the shadow generator component responsible to manage any shadow generators
  62589. * in a given scene.
  62590. */
  62591. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62592. /**
  62593. * The component name helpfull to identify the component in the list of scene components.
  62594. */
  62595. readonly name: string;
  62596. /**
  62597. * The scene the component belongs to.
  62598. */
  62599. scene: Scene;
  62600. /**
  62601. * Creates a new instance of the component for the given scene
  62602. * @param scene Defines the scene to register the component in
  62603. */
  62604. constructor(scene: Scene);
  62605. /**
  62606. * Registers the component in a given scene
  62607. */
  62608. register(): void;
  62609. /**
  62610. * Rebuilds the elements related to this component in case of
  62611. * context lost for instance.
  62612. */
  62613. rebuild(): void;
  62614. /**
  62615. * Serializes the component data to the specified json object
  62616. * @param serializationObject The object to serialize to
  62617. */
  62618. serialize(serializationObject: any): void;
  62619. /**
  62620. * Adds all the elements from the container to the scene
  62621. * @param container the container holding the elements
  62622. */
  62623. addFromContainer(container: AbstractScene): void;
  62624. /**
  62625. * Removes all the elements in the container from the scene
  62626. * @param container contains the elements to remove
  62627. * @param dispose if the removed element should be disposed (default: false)
  62628. */
  62629. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62630. /**
  62631. * Rebuilds the elements related to this component in case of
  62632. * context lost for instance.
  62633. */
  62634. dispose(): void;
  62635. private _gatherRenderTargets;
  62636. }
  62637. }
  62638. declare module "babylonjs/Lights/Shadows/index" {
  62639. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62640. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62641. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62642. }
  62643. declare module "babylonjs/Lights/pointLight" {
  62644. import { Scene } from "babylonjs/scene";
  62645. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62646. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62647. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62648. import { Effect } from "babylonjs/Materials/effect";
  62649. /**
  62650. * A point light is a light defined by an unique point in world space.
  62651. * The light is emitted in every direction from this point.
  62652. * A good example of a point light is a standard light bulb.
  62653. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62654. */
  62655. export class PointLight extends ShadowLight {
  62656. private _shadowAngle;
  62657. /**
  62658. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62659. * This specifies what angle the shadow will use to be created.
  62660. *
  62661. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62662. */
  62663. get shadowAngle(): number;
  62664. /**
  62665. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62666. * This specifies what angle the shadow will use to be created.
  62667. *
  62668. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62669. */
  62670. set shadowAngle(value: number);
  62671. /**
  62672. * Gets the direction if it has been set.
  62673. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62674. */
  62675. get direction(): Vector3;
  62676. /**
  62677. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62678. */
  62679. set direction(value: Vector3);
  62680. /**
  62681. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62682. * A PointLight emits the light in every direction.
  62683. * It can cast shadows.
  62684. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62685. * ```javascript
  62686. * var pointLight = new PointLight("pl", camera.position, scene);
  62687. * ```
  62688. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62689. * @param name The light friendly name
  62690. * @param position The position of the point light in the scene
  62691. * @param scene The scene the lights belongs to
  62692. */
  62693. constructor(name: string, position: Vector3, scene: Scene);
  62694. /**
  62695. * Returns the string "PointLight"
  62696. * @returns the class name
  62697. */
  62698. getClassName(): string;
  62699. /**
  62700. * Returns the integer 0.
  62701. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62702. */
  62703. getTypeID(): number;
  62704. /**
  62705. * Specifies wether or not the shadowmap should be a cube texture.
  62706. * @returns true if the shadowmap needs to be a cube texture.
  62707. */
  62708. needCube(): boolean;
  62709. /**
  62710. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62711. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62712. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62713. */
  62714. getShadowDirection(faceIndex?: number): Vector3;
  62715. /**
  62716. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62717. * - fov = PI / 2
  62718. * - aspect ratio : 1.0
  62719. * - z-near and far equal to the active camera minZ and maxZ.
  62720. * Returns the PointLight.
  62721. */
  62722. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62723. protected _buildUniformLayout(): void;
  62724. /**
  62725. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62726. * @param effect The effect to update
  62727. * @param lightIndex The index of the light in the effect to update
  62728. * @returns The point light
  62729. */
  62730. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62731. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62732. /**
  62733. * Prepares the list of defines specific to the light type.
  62734. * @param defines the list of defines
  62735. * @param lightIndex defines the index of the light for the effect
  62736. */
  62737. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62738. }
  62739. }
  62740. declare module "babylonjs/Lights/index" {
  62741. export * from "babylonjs/Lights/light";
  62742. export * from "babylonjs/Lights/shadowLight";
  62743. export * from "babylonjs/Lights/Shadows/index";
  62744. export * from "babylonjs/Lights/directionalLight";
  62745. export * from "babylonjs/Lights/hemisphericLight";
  62746. export * from "babylonjs/Lights/pointLight";
  62747. export * from "babylonjs/Lights/spotLight";
  62748. }
  62749. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62750. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62751. /**
  62752. * Header information of HDR texture files.
  62753. */
  62754. export interface HDRInfo {
  62755. /**
  62756. * The height of the texture in pixels.
  62757. */
  62758. height: number;
  62759. /**
  62760. * The width of the texture in pixels.
  62761. */
  62762. width: number;
  62763. /**
  62764. * The index of the beginning of the data in the binary file.
  62765. */
  62766. dataPosition: number;
  62767. }
  62768. /**
  62769. * This groups tools to convert HDR texture to native colors array.
  62770. */
  62771. export class HDRTools {
  62772. private static Ldexp;
  62773. private static Rgbe2float;
  62774. private static readStringLine;
  62775. /**
  62776. * Reads header information from an RGBE texture stored in a native array.
  62777. * More information on this format are available here:
  62778. * https://en.wikipedia.org/wiki/RGBE_image_format
  62779. *
  62780. * @param uint8array The binary file stored in native array.
  62781. * @return The header information.
  62782. */
  62783. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62784. /**
  62785. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62786. * This RGBE texture needs to store the information as a panorama.
  62787. *
  62788. * More information on this format are available here:
  62789. * https://en.wikipedia.org/wiki/RGBE_image_format
  62790. *
  62791. * @param buffer The binary file stored in an array buffer.
  62792. * @param size The expected size of the extracted cubemap.
  62793. * @return The Cube Map information.
  62794. */
  62795. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62796. /**
  62797. * Returns the pixels data extracted from an RGBE texture.
  62798. * This pixels will be stored left to right up to down in the R G B order in one array.
  62799. *
  62800. * More information on this format are available here:
  62801. * https://en.wikipedia.org/wiki/RGBE_image_format
  62802. *
  62803. * @param uint8array The binary file stored in an array buffer.
  62804. * @param hdrInfo The header information of the file.
  62805. * @return The pixels data in RGB right to left up to down order.
  62806. */
  62807. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62808. private static RGBE_ReadPixels_RLE;
  62809. private static RGBE_ReadPixels_NOT_RLE;
  62810. }
  62811. }
  62812. declare module "babylonjs/Materials/effectRenderer" {
  62813. import { Nullable } from "babylonjs/types";
  62814. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62815. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62816. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62817. import { Viewport } from "babylonjs/Maths/math.viewport";
  62818. import { Observable } from "babylonjs/Misc/observable";
  62819. import { Effect } from "babylonjs/Materials/effect";
  62820. import "babylonjs/Shaders/postprocess.vertex";
  62821. /**
  62822. * Effect Render Options
  62823. */
  62824. export interface IEffectRendererOptions {
  62825. /**
  62826. * Defines the vertices positions.
  62827. */
  62828. positions?: number[];
  62829. /**
  62830. * Defines the indices.
  62831. */
  62832. indices?: number[];
  62833. }
  62834. /**
  62835. * Helper class to render one or more effects.
  62836. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62837. */
  62838. export class EffectRenderer {
  62839. private engine;
  62840. private static _DefaultOptions;
  62841. private _vertexBuffers;
  62842. private _indexBuffer;
  62843. private _fullscreenViewport;
  62844. /**
  62845. * Creates an effect renderer
  62846. * @param engine the engine to use for rendering
  62847. * @param options defines the options of the effect renderer
  62848. */
  62849. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62850. /**
  62851. * Sets the current viewport in normalized coordinates 0-1
  62852. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  62853. */
  62854. setViewport(viewport?: Viewport): void;
  62855. /**
  62856. * Binds the embedded attributes buffer to the effect.
  62857. * @param effect Defines the effect to bind the attributes for
  62858. */
  62859. bindBuffers(effect: Effect): void;
  62860. /**
  62861. * Sets the current effect wrapper to use during draw.
  62862. * The effect needs to be ready before calling this api.
  62863. * This also sets the default full screen position attribute.
  62864. * @param effectWrapper Defines the effect to draw with
  62865. */
  62866. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  62867. /**
  62868. * Restores engine states
  62869. */
  62870. restoreStates(): void;
  62871. /**
  62872. * Draws a full screen quad.
  62873. */
  62874. draw(): void;
  62875. private isRenderTargetTexture;
  62876. /**
  62877. * renders one or more effects to a specified texture
  62878. * @param effectWrapper the effect to renderer
  62879. * @param outputTexture texture to draw to, if null it will render to the screen.
  62880. */
  62881. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  62882. /**
  62883. * Disposes of the effect renderer
  62884. */
  62885. dispose(): void;
  62886. }
  62887. /**
  62888. * Options to create an EffectWrapper
  62889. */
  62890. interface EffectWrapperCreationOptions {
  62891. /**
  62892. * Engine to use to create the effect
  62893. */
  62894. engine: ThinEngine;
  62895. /**
  62896. * Fragment shader for the effect
  62897. */
  62898. fragmentShader: string;
  62899. /**
  62900. * Use the shader store instead of direct source code
  62901. */
  62902. useShaderStore?: boolean;
  62903. /**
  62904. * Vertex shader for the effect
  62905. */
  62906. vertexShader?: string;
  62907. /**
  62908. * Attributes to use in the shader
  62909. */
  62910. attributeNames?: Array<string>;
  62911. /**
  62912. * Uniforms to use in the shader
  62913. */
  62914. uniformNames?: Array<string>;
  62915. /**
  62916. * Texture sampler names to use in the shader
  62917. */
  62918. samplerNames?: Array<string>;
  62919. /**
  62920. * Defines to use in the shader
  62921. */
  62922. defines?: Array<string>;
  62923. /**
  62924. * Callback when effect is compiled
  62925. */
  62926. onCompiled?: Nullable<(effect: Effect) => void>;
  62927. /**
  62928. * The friendly name of the effect displayed in Spector.
  62929. */
  62930. name?: string;
  62931. }
  62932. /**
  62933. * Wraps an effect to be used for rendering
  62934. */
  62935. export class EffectWrapper {
  62936. /**
  62937. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  62938. */
  62939. onApplyObservable: Observable<{}>;
  62940. /**
  62941. * The underlying effect
  62942. */
  62943. effect: Effect;
  62944. /**
  62945. * Creates an effect to be renderer
  62946. * @param creationOptions options to create the effect
  62947. */
  62948. constructor(creationOptions: EffectWrapperCreationOptions);
  62949. /**
  62950. * Disposes of the effect wrapper
  62951. */
  62952. dispose(): void;
  62953. }
  62954. }
  62955. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  62956. /** @hidden */
  62957. export var hdrFilteringVertexShader: {
  62958. name: string;
  62959. shader: string;
  62960. };
  62961. }
  62962. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  62963. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62964. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  62965. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  62966. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  62967. /** @hidden */
  62968. export var hdrFilteringPixelShader: {
  62969. name: string;
  62970. shader: string;
  62971. };
  62972. }
  62973. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  62974. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62975. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62976. import { Nullable } from "babylonjs/types";
  62977. import "babylonjs/Shaders/hdrFiltering.vertex";
  62978. import "babylonjs/Shaders/hdrFiltering.fragment";
  62979. /**
  62980. * Options for texture filtering
  62981. */
  62982. interface IHDRFilteringOptions {
  62983. /**
  62984. * Scales pixel intensity for the input HDR map.
  62985. */
  62986. hdrScale?: number;
  62987. /**
  62988. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  62989. */
  62990. quality?: number;
  62991. }
  62992. /**
  62993. * Filters HDR maps to get correct renderings of PBR reflections
  62994. */
  62995. export class HDRFiltering {
  62996. private _engine;
  62997. private _effectRenderer;
  62998. private _effectWrapper;
  62999. private _lodGenerationOffset;
  63000. private _lodGenerationScale;
  63001. /**
  63002. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  63003. * you care about baking speed.
  63004. */
  63005. quality: number;
  63006. /**
  63007. * Scales pixel intensity for the input HDR map.
  63008. */
  63009. hdrScale: number;
  63010. /**
  63011. * Instantiates HDR filter for reflection maps
  63012. *
  63013. * @param engine Thin engine
  63014. * @param options Options
  63015. */
  63016. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  63017. private _createRenderTarget;
  63018. private _prefilterInternal;
  63019. private _createEffect;
  63020. /**
  63021. * Get a value indicating if the filter is ready to be used
  63022. * @param texture Texture to filter
  63023. * @returns true if the filter is ready
  63024. */
  63025. isReady(texture: BaseTexture): boolean;
  63026. /**
  63027. * Prefilters a cube texture to have mipmap levels representing roughness values.
  63028. * Prefiltering will be invoked at the end of next rendering pass.
  63029. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  63030. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  63031. * @param texture Texture to filter
  63032. * @param onFinished Callback when filtering is done
  63033. * @return Promise called when prefiltering is done
  63034. */
  63035. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  63036. }
  63037. }
  63038. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  63039. import { Nullable } from "babylonjs/types";
  63040. import { Scene } from "babylonjs/scene";
  63041. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63042. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63043. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63044. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63045. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  63046. /**
  63047. * This represents a texture coming from an HDR input.
  63048. *
  63049. * The only supported format is currently panorama picture stored in RGBE format.
  63050. * Example of such files can be found on HDRLib: http://hdrlib.com/
  63051. */
  63052. export class HDRCubeTexture extends BaseTexture {
  63053. private static _facesMapping;
  63054. private _generateHarmonics;
  63055. private _noMipmap;
  63056. private _prefilterOnLoad;
  63057. private _textureMatrix;
  63058. private _size;
  63059. private _onLoad;
  63060. private _onError;
  63061. /**
  63062. * The texture URL.
  63063. */
  63064. url: string;
  63065. protected _isBlocking: boolean;
  63066. /**
  63067. * Sets wether or not the texture is blocking during loading.
  63068. */
  63069. set isBlocking(value: boolean);
  63070. /**
  63071. * Gets wether or not the texture is blocking during loading.
  63072. */
  63073. get isBlocking(): boolean;
  63074. protected _rotationY: number;
  63075. /**
  63076. * Sets texture matrix rotation angle around Y axis in radians.
  63077. */
  63078. set rotationY(value: number);
  63079. /**
  63080. * Gets texture matrix rotation angle around Y axis radians.
  63081. */
  63082. get rotationY(): number;
  63083. /**
  63084. * Gets or sets the center of the bounding box associated with the cube texture
  63085. * It must define where the camera used to render the texture was set
  63086. */
  63087. boundingBoxPosition: Vector3;
  63088. private _boundingBoxSize;
  63089. /**
  63090. * Gets or sets the size of the bounding box associated with the cube texture
  63091. * When defined, the cubemap will switch to local mode
  63092. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63093. * @example https://www.babylonjs-playground.com/#RNASML
  63094. */
  63095. set boundingBoxSize(value: Vector3);
  63096. get boundingBoxSize(): Vector3;
  63097. /**
  63098. * Instantiates an HDRTexture from the following parameters.
  63099. *
  63100. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63101. * @param sceneOrEngine The scene or engine the texture will be used in
  63102. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63103. * @param noMipmap Forces to not generate the mipmap if true
  63104. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63105. * @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)
  63106. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63107. */
  63108. 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>);
  63109. /**
  63110. * Get the current class name of the texture useful for serialization or dynamic coding.
  63111. * @returns "HDRCubeTexture"
  63112. */
  63113. getClassName(): string;
  63114. /**
  63115. * Occurs when the file is raw .hdr file.
  63116. */
  63117. private loadTexture;
  63118. clone(): HDRCubeTexture;
  63119. delayLoad(): void;
  63120. /**
  63121. * Get the texture reflection matrix used to rotate/transform the reflection.
  63122. * @returns the reflection matrix
  63123. */
  63124. getReflectionTextureMatrix(): Matrix;
  63125. /**
  63126. * Set the texture reflection matrix used to rotate/transform the reflection.
  63127. * @param value Define the reflection matrix to set
  63128. */
  63129. setReflectionTextureMatrix(value: Matrix): void;
  63130. /**
  63131. * Parses a JSON representation of an HDR Texture in order to create the texture
  63132. * @param parsedTexture Define the JSON representation
  63133. * @param scene Define the scene the texture should be created in
  63134. * @param rootUrl Define the root url in case we need to load relative dependencies
  63135. * @returns the newly created texture after parsing
  63136. */
  63137. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63138. serialize(): any;
  63139. }
  63140. }
  63141. declare module "babylonjs/Physics/physicsEngine" {
  63142. import { Nullable } from "babylonjs/types";
  63143. import { Vector3 } from "babylonjs/Maths/math.vector";
  63144. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63145. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63146. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63147. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63148. /**
  63149. * Class used to control physics engine
  63150. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63151. */
  63152. export class PhysicsEngine implements IPhysicsEngine {
  63153. private _physicsPlugin;
  63154. /**
  63155. * Global value used to control the smallest number supported by the simulation
  63156. */
  63157. static Epsilon: number;
  63158. private _impostors;
  63159. private _joints;
  63160. private _subTimeStep;
  63161. /**
  63162. * Gets the gravity vector used by the simulation
  63163. */
  63164. gravity: Vector3;
  63165. /**
  63166. * Factory used to create the default physics plugin.
  63167. * @returns The default physics plugin
  63168. */
  63169. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63170. /**
  63171. * Creates a new Physics Engine
  63172. * @param gravity defines the gravity vector used by the simulation
  63173. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63174. */
  63175. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63176. /**
  63177. * Sets the gravity vector used by the simulation
  63178. * @param gravity defines the gravity vector to use
  63179. */
  63180. setGravity(gravity: Vector3): void;
  63181. /**
  63182. * Set the time step of the physics engine.
  63183. * Default is 1/60.
  63184. * To slow it down, enter 1/600 for example.
  63185. * To speed it up, 1/30
  63186. * @param newTimeStep defines the new timestep to apply to this world.
  63187. */
  63188. setTimeStep(newTimeStep?: number): void;
  63189. /**
  63190. * Get the time step of the physics engine.
  63191. * @returns the current time step
  63192. */
  63193. getTimeStep(): number;
  63194. /**
  63195. * Set the sub time step of the physics engine.
  63196. * Default is 0 meaning there is no sub steps
  63197. * To increase physics resolution precision, set a small value (like 1 ms)
  63198. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63199. */
  63200. setSubTimeStep(subTimeStep?: number): void;
  63201. /**
  63202. * Get the sub time step of the physics engine.
  63203. * @returns the current sub time step
  63204. */
  63205. getSubTimeStep(): number;
  63206. /**
  63207. * Release all resources
  63208. */
  63209. dispose(): void;
  63210. /**
  63211. * Gets the name of the current physics plugin
  63212. * @returns the name of the plugin
  63213. */
  63214. getPhysicsPluginName(): string;
  63215. /**
  63216. * Adding a new impostor for the impostor tracking.
  63217. * This will be done by the impostor itself.
  63218. * @param impostor the impostor to add
  63219. */
  63220. addImpostor(impostor: PhysicsImpostor): void;
  63221. /**
  63222. * Remove an impostor from the engine.
  63223. * This impostor and its mesh will not longer be updated by the physics engine.
  63224. * @param impostor the impostor to remove
  63225. */
  63226. removeImpostor(impostor: PhysicsImpostor): void;
  63227. /**
  63228. * Add a joint to the physics engine
  63229. * @param mainImpostor defines the main impostor to which the joint is added.
  63230. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63231. * @param joint defines the joint that will connect both impostors.
  63232. */
  63233. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63234. /**
  63235. * Removes a joint from the simulation
  63236. * @param mainImpostor defines the impostor used with the joint
  63237. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63238. * @param joint defines the joint to remove
  63239. */
  63240. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63241. /**
  63242. * Called by the scene. No need to call it.
  63243. * @param delta defines the timespam between frames
  63244. */
  63245. _step(delta: number): void;
  63246. /**
  63247. * Gets the current plugin used to run the simulation
  63248. * @returns current plugin
  63249. */
  63250. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63251. /**
  63252. * Gets the list of physic impostors
  63253. * @returns an array of PhysicsImpostor
  63254. */
  63255. getImpostors(): Array<PhysicsImpostor>;
  63256. /**
  63257. * Gets the impostor for a physics enabled object
  63258. * @param object defines the object impersonated by the impostor
  63259. * @returns the PhysicsImpostor or null if not found
  63260. */
  63261. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63262. /**
  63263. * Gets the impostor for a physics body object
  63264. * @param body defines physics body used by the impostor
  63265. * @returns the PhysicsImpostor or null if not found
  63266. */
  63267. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63268. /**
  63269. * Does a raycast in the physics world
  63270. * @param from when should the ray start?
  63271. * @param to when should the ray end?
  63272. * @returns PhysicsRaycastResult
  63273. */
  63274. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63275. }
  63276. }
  63277. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63278. import { Nullable } from "babylonjs/types";
  63279. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63280. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63281. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63282. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63283. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63284. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63285. /** @hidden */
  63286. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63287. private _useDeltaForWorldStep;
  63288. world: any;
  63289. name: string;
  63290. private _physicsMaterials;
  63291. private _fixedTimeStep;
  63292. private _cannonRaycastResult;
  63293. private _raycastResult;
  63294. private _physicsBodysToRemoveAfterStep;
  63295. private _firstFrame;
  63296. BJSCANNON: any;
  63297. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63298. setGravity(gravity: Vector3): void;
  63299. setTimeStep(timeStep: number): void;
  63300. getTimeStep(): number;
  63301. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63302. private _removeMarkedPhysicsBodiesFromWorld;
  63303. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63304. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63305. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63306. private _processChildMeshes;
  63307. removePhysicsBody(impostor: PhysicsImpostor): void;
  63308. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63309. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63310. private _addMaterial;
  63311. private _checkWithEpsilon;
  63312. private _createShape;
  63313. private _createHeightmap;
  63314. private _minus90X;
  63315. private _plus90X;
  63316. private _tmpPosition;
  63317. private _tmpDeltaPosition;
  63318. private _tmpUnityRotation;
  63319. private _updatePhysicsBodyTransformation;
  63320. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63321. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63322. isSupported(): boolean;
  63323. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63324. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63325. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63326. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63327. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63328. getBodyMass(impostor: PhysicsImpostor): number;
  63329. getBodyFriction(impostor: PhysicsImpostor): number;
  63330. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63331. getBodyRestitution(impostor: PhysicsImpostor): number;
  63332. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63333. sleepBody(impostor: PhysicsImpostor): void;
  63334. wakeUpBody(impostor: PhysicsImpostor): void;
  63335. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63336. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63337. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63338. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63339. getRadius(impostor: PhysicsImpostor): number;
  63340. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63341. dispose(): void;
  63342. private _extendNamespace;
  63343. /**
  63344. * Does a raycast in the physics world
  63345. * @param from when should the ray start?
  63346. * @param to when should the ray end?
  63347. * @returns PhysicsRaycastResult
  63348. */
  63349. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63350. }
  63351. }
  63352. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63353. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63354. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63355. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63356. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63357. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63358. import { Nullable } from "babylonjs/types";
  63359. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63360. /** @hidden */
  63361. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63362. private _useDeltaForWorldStep;
  63363. world: any;
  63364. name: string;
  63365. BJSOIMO: any;
  63366. private _raycastResult;
  63367. private _fixedTimeStep;
  63368. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63369. setGravity(gravity: Vector3): void;
  63370. setTimeStep(timeStep: number): void;
  63371. getTimeStep(): number;
  63372. private _tmpImpostorsArray;
  63373. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63374. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63375. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63376. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63377. private _tmpPositionVector;
  63378. removePhysicsBody(impostor: PhysicsImpostor): void;
  63379. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63380. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63381. isSupported(): boolean;
  63382. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63383. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63384. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63385. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63386. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63387. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63388. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63389. getBodyMass(impostor: PhysicsImpostor): number;
  63390. getBodyFriction(impostor: PhysicsImpostor): number;
  63391. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63392. getBodyRestitution(impostor: PhysicsImpostor): number;
  63393. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63394. sleepBody(impostor: PhysicsImpostor): void;
  63395. wakeUpBody(impostor: PhysicsImpostor): void;
  63396. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63397. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63398. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63399. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63400. getRadius(impostor: PhysicsImpostor): number;
  63401. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63402. dispose(): void;
  63403. /**
  63404. * Does a raycast in the physics world
  63405. * @param from when should the ray start?
  63406. * @param to when should the ray end?
  63407. * @returns PhysicsRaycastResult
  63408. */
  63409. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63410. }
  63411. }
  63412. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63413. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63414. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63415. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63416. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63417. import { Nullable } from "babylonjs/types";
  63418. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63419. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63420. /**
  63421. * AmmoJS Physics plugin
  63422. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63423. * @see https://github.com/kripken/ammo.js/
  63424. */
  63425. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63426. private _useDeltaForWorldStep;
  63427. /**
  63428. * Reference to the Ammo library
  63429. */
  63430. bjsAMMO: any;
  63431. /**
  63432. * Created ammoJS world which physics bodies are added to
  63433. */
  63434. world: any;
  63435. /**
  63436. * Name of the plugin
  63437. */
  63438. name: string;
  63439. private _timeStep;
  63440. private _fixedTimeStep;
  63441. private _maxSteps;
  63442. private _tmpQuaternion;
  63443. private _tmpAmmoTransform;
  63444. private _tmpAmmoQuaternion;
  63445. private _tmpAmmoConcreteContactResultCallback;
  63446. private _collisionConfiguration;
  63447. private _dispatcher;
  63448. private _overlappingPairCache;
  63449. private _solver;
  63450. private _softBodySolver;
  63451. private _tmpAmmoVectorA;
  63452. private _tmpAmmoVectorB;
  63453. private _tmpAmmoVectorC;
  63454. private _tmpAmmoVectorD;
  63455. private _tmpContactCallbackResult;
  63456. private _tmpAmmoVectorRCA;
  63457. private _tmpAmmoVectorRCB;
  63458. private _raycastResult;
  63459. private static readonly DISABLE_COLLISION_FLAG;
  63460. private static readonly KINEMATIC_FLAG;
  63461. private static readonly DISABLE_DEACTIVATION_FLAG;
  63462. /**
  63463. * Initializes the ammoJS plugin
  63464. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63465. * @param ammoInjection can be used to inject your own ammo reference
  63466. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63467. */
  63468. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63469. /**
  63470. * Sets the gravity of the physics world (m/(s^2))
  63471. * @param gravity Gravity to set
  63472. */
  63473. setGravity(gravity: Vector3): void;
  63474. /**
  63475. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63476. * @param timeStep timestep to use in seconds
  63477. */
  63478. setTimeStep(timeStep: number): void;
  63479. /**
  63480. * 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)
  63481. * @param fixedTimeStep fixedTimeStep to use in seconds
  63482. */
  63483. setFixedTimeStep(fixedTimeStep: number): void;
  63484. /**
  63485. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63486. * @param maxSteps the maximum number of steps by the physics engine per frame
  63487. */
  63488. setMaxSteps(maxSteps: number): void;
  63489. /**
  63490. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63491. * @returns the current timestep in seconds
  63492. */
  63493. getTimeStep(): number;
  63494. /**
  63495. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63496. */
  63497. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63498. private _isImpostorInContact;
  63499. private _isImpostorPairInContact;
  63500. private _stepSimulation;
  63501. /**
  63502. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63503. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63504. * After the step the babylon meshes are set to the position of the physics imposters
  63505. * @param delta amount of time to step forward
  63506. * @param impostors array of imposters to update before/after the step
  63507. */
  63508. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63509. /**
  63510. * Update babylon mesh to match physics world object
  63511. * @param impostor imposter to match
  63512. */
  63513. private _afterSoftStep;
  63514. /**
  63515. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63516. * @param impostor imposter to match
  63517. */
  63518. private _ropeStep;
  63519. /**
  63520. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63521. * @param impostor imposter to match
  63522. */
  63523. private _softbodyOrClothStep;
  63524. private _tmpMatrix;
  63525. /**
  63526. * Applies an impulse on the imposter
  63527. * @param impostor imposter to apply impulse to
  63528. * @param force amount of force to be applied to the imposter
  63529. * @param contactPoint the location to apply the impulse on the imposter
  63530. */
  63531. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63532. /**
  63533. * Applies a force on the imposter
  63534. * @param impostor imposter to apply force
  63535. * @param force amount of force to be applied to the imposter
  63536. * @param contactPoint the location to apply the force on the imposter
  63537. */
  63538. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63539. /**
  63540. * Creates a physics body using the plugin
  63541. * @param impostor the imposter to create the physics body on
  63542. */
  63543. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63544. /**
  63545. * Removes the physics body from the imposter and disposes of the body's memory
  63546. * @param impostor imposter to remove the physics body from
  63547. */
  63548. removePhysicsBody(impostor: PhysicsImpostor): void;
  63549. /**
  63550. * Generates a joint
  63551. * @param impostorJoint the imposter joint to create the joint with
  63552. */
  63553. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63554. /**
  63555. * Removes a joint
  63556. * @param impostorJoint the imposter joint to remove the joint from
  63557. */
  63558. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63559. private _addMeshVerts;
  63560. /**
  63561. * Initialise the soft body vertices to match its object's (mesh) vertices
  63562. * Softbody vertices (nodes) are in world space and to match this
  63563. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63564. * @param impostor to create the softbody for
  63565. */
  63566. private _softVertexData;
  63567. /**
  63568. * Create an impostor's soft body
  63569. * @param impostor to create the softbody for
  63570. */
  63571. private _createSoftbody;
  63572. /**
  63573. * Create cloth for an impostor
  63574. * @param impostor to create the softbody for
  63575. */
  63576. private _createCloth;
  63577. /**
  63578. * Create rope for an impostor
  63579. * @param impostor to create the softbody for
  63580. */
  63581. private _createRope;
  63582. /**
  63583. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63584. * @param impostor to create the custom physics shape for
  63585. */
  63586. private _createCustom;
  63587. private _addHullVerts;
  63588. private _createShape;
  63589. /**
  63590. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63591. * @param impostor imposter containing the physics body and babylon object
  63592. */
  63593. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63594. /**
  63595. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63596. * @param impostor imposter containing the physics body and babylon object
  63597. * @param newPosition new position
  63598. * @param newRotation new rotation
  63599. */
  63600. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63601. /**
  63602. * If this plugin is supported
  63603. * @returns true if its supported
  63604. */
  63605. isSupported(): boolean;
  63606. /**
  63607. * Sets the linear velocity of the physics body
  63608. * @param impostor imposter to set the velocity on
  63609. * @param velocity velocity to set
  63610. */
  63611. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63612. /**
  63613. * Sets the angular velocity of the physics body
  63614. * @param impostor imposter to set the velocity on
  63615. * @param velocity velocity to set
  63616. */
  63617. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63618. /**
  63619. * gets the linear velocity
  63620. * @param impostor imposter to get linear velocity from
  63621. * @returns linear velocity
  63622. */
  63623. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63624. /**
  63625. * gets the angular velocity
  63626. * @param impostor imposter to get angular velocity from
  63627. * @returns angular velocity
  63628. */
  63629. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63630. /**
  63631. * Sets the mass of physics body
  63632. * @param impostor imposter to set the mass on
  63633. * @param mass mass to set
  63634. */
  63635. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63636. /**
  63637. * Gets the mass of the physics body
  63638. * @param impostor imposter to get the mass from
  63639. * @returns mass
  63640. */
  63641. getBodyMass(impostor: PhysicsImpostor): number;
  63642. /**
  63643. * Gets friction of the impostor
  63644. * @param impostor impostor to get friction from
  63645. * @returns friction value
  63646. */
  63647. getBodyFriction(impostor: PhysicsImpostor): number;
  63648. /**
  63649. * Sets friction of the impostor
  63650. * @param impostor impostor to set friction on
  63651. * @param friction friction value
  63652. */
  63653. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63654. /**
  63655. * Gets restitution of the impostor
  63656. * @param impostor impostor to get restitution from
  63657. * @returns restitution value
  63658. */
  63659. getBodyRestitution(impostor: PhysicsImpostor): number;
  63660. /**
  63661. * Sets resitution of the impostor
  63662. * @param impostor impostor to set resitution on
  63663. * @param restitution resitution value
  63664. */
  63665. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63666. /**
  63667. * Gets pressure inside the impostor
  63668. * @param impostor impostor to get pressure from
  63669. * @returns pressure value
  63670. */
  63671. getBodyPressure(impostor: PhysicsImpostor): number;
  63672. /**
  63673. * Sets pressure inside a soft body impostor
  63674. * Cloth and rope must remain 0 pressure
  63675. * @param impostor impostor to set pressure on
  63676. * @param pressure pressure value
  63677. */
  63678. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63679. /**
  63680. * Gets stiffness of the impostor
  63681. * @param impostor impostor to get stiffness from
  63682. * @returns pressure value
  63683. */
  63684. getBodyStiffness(impostor: PhysicsImpostor): number;
  63685. /**
  63686. * Sets stiffness of the impostor
  63687. * @param impostor impostor to set stiffness on
  63688. * @param stiffness stiffness value from 0 to 1
  63689. */
  63690. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63691. /**
  63692. * Gets velocityIterations of the impostor
  63693. * @param impostor impostor to get velocity iterations from
  63694. * @returns velocityIterations value
  63695. */
  63696. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63697. /**
  63698. * Sets velocityIterations of the impostor
  63699. * @param impostor impostor to set velocity iterations on
  63700. * @param velocityIterations velocityIterations value
  63701. */
  63702. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63703. /**
  63704. * Gets positionIterations of the impostor
  63705. * @param impostor impostor to get position iterations from
  63706. * @returns positionIterations value
  63707. */
  63708. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63709. /**
  63710. * Sets positionIterations of the impostor
  63711. * @param impostor impostor to set position on
  63712. * @param positionIterations positionIterations value
  63713. */
  63714. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63715. /**
  63716. * Append an anchor to a cloth object
  63717. * @param impostor is the cloth impostor to add anchor to
  63718. * @param otherImpostor is the rigid impostor to anchor to
  63719. * @param width ratio across width from 0 to 1
  63720. * @param height ratio up height from 0 to 1
  63721. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63722. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63723. */
  63724. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63725. /**
  63726. * Append an hook to a rope object
  63727. * @param impostor is the rope impostor to add hook to
  63728. * @param otherImpostor is the rigid impostor to hook to
  63729. * @param length ratio along the rope from 0 to 1
  63730. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63731. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63732. */
  63733. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63734. /**
  63735. * Sleeps the physics body and stops it from being active
  63736. * @param impostor impostor to sleep
  63737. */
  63738. sleepBody(impostor: PhysicsImpostor): void;
  63739. /**
  63740. * Activates the physics body
  63741. * @param impostor impostor to activate
  63742. */
  63743. wakeUpBody(impostor: PhysicsImpostor): void;
  63744. /**
  63745. * Updates the distance parameters of the joint
  63746. * @param joint joint to update
  63747. * @param maxDistance maximum distance of the joint
  63748. * @param minDistance minimum distance of the joint
  63749. */
  63750. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63751. /**
  63752. * Sets a motor on the joint
  63753. * @param joint joint to set motor on
  63754. * @param speed speed of the motor
  63755. * @param maxForce maximum force of the motor
  63756. * @param motorIndex index of the motor
  63757. */
  63758. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63759. /**
  63760. * Sets the motors limit
  63761. * @param joint joint to set limit on
  63762. * @param upperLimit upper limit
  63763. * @param lowerLimit lower limit
  63764. */
  63765. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63766. /**
  63767. * Syncs the position and rotation of a mesh with the impostor
  63768. * @param mesh mesh to sync
  63769. * @param impostor impostor to update the mesh with
  63770. */
  63771. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63772. /**
  63773. * Gets the radius of the impostor
  63774. * @param impostor impostor to get radius from
  63775. * @returns the radius
  63776. */
  63777. getRadius(impostor: PhysicsImpostor): number;
  63778. /**
  63779. * Gets the box size of the impostor
  63780. * @param impostor impostor to get box size from
  63781. * @param result the resulting box size
  63782. */
  63783. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63784. /**
  63785. * Disposes of the impostor
  63786. */
  63787. dispose(): void;
  63788. /**
  63789. * Does a raycast in the physics world
  63790. * @param from when should the ray start?
  63791. * @param to when should the ray end?
  63792. * @returns PhysicsRaycastResult
  63793. */
  63794. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63795. }
  63796. }
  63797. declare module "babylonjs/Probes/reflectionProbe" {
  63798. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63799. import { Vector3 } from "babylonjs/Maths/math.vector";
  63800. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63801. import { Nullable } from "babylonjs/types";
  63802. import { Scene } from "babylonjs/scene";
  63803. module "babylonjs/abstractScene" {
  63804. interface AbstractScene {
  63805. /**
  63806. * The list of reflection probes added to the scene
  63807. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63808. */
  63809. reflectionProbes: Array<ReflectionProbe>;
  63810. /**
  63811. * Removes the given reflection probe from this scene.
  63812. * @param toRemove The reflection probe to remove
  63813. * @returns The index of the removed reflection probe
  63814. */
  63815. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63816. /**
  63817. * Adds the given reflection probe to this scene.
  63818. * @param newReflectionProbe The reflection probe to add
  63819. */
  63820. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63821. }
  63822. }
  63823. /**
  63824. * Class used to generate realtime reflection / refraction cube textures
  63825. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63826. */
  63827. export class ReflectionProbe {
  63828. /** defines the name of the probe */
  63829. name: string;
  63830. private _scene;
  63831. private _renderTargetTexture;
  63832. private _projectionMatrix;
  63833. private _viewMatrix;
  63834. private _target;
  63835. private _add;
  63836. private _attachedMesh;
  63837. private _invertYAxis;
  63838. /** Gets or sets probe position (center of the cube map) */
  63839. position: Vector3;
  63840. /**
  63841. * Creates a new reflection probe
  63842. * @param name defines the name of the probe
  63843. * @param size defines the texture resolution (for each face)
  63844. * @param scene defines the hosting scene
  63845. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63846. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63847. */
  63848. constructor(
  63849. /** defines the name of the probe */
  63850. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63851. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63852. get samples(): number;
  63853. set samples(value: number);
  63854. /** Gets or sets the refresh rate to use (on every frame by default) */
  63855. get refreshRate(): number;
  63856. set refreshRate(value: number);
  63857. /**
  63858. * Gets the hosting scene
  63859. * @returns a Scene
  63860. */
  63861. getScene(): Scene;
  63862. /** Gets the internal CubeTexture used to render to */
  63863. get cubeTexture(): RenderTargetTexture;
  63864. /** Gets the list of meshes to render */
  63865. get renderList(): Nullable<AbstractMesh[]>;
  63866. /**
  63867. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  63868. * @param mesh defines the mesh to attach to
  63869. */
  63870. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  63871. /**
  63872. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  63873. * @param renderingGroupId The rendering group id corresponding to its index
  63874. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  63875. */
  63876. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  63877. /**
  63878. * Clean all associated resources
  63879. */
  63880. dispose(): void;
  63881. /**
  63882. * Converts the reflection probe information to a readable string for debug purpose.
  63883. * @param fullDetails Supports for multiple levels of logging within scene loading
  63884. * @returns the human readable reflection probe info
  63885. */
  63886. toString(fullDetails?: boolean): string;
  63887. /**
  63888. * Get the class name of the relfection probe.
  63889. * @returns "ReflectionProbe"
  63890. */
  63891. getClassName(): string;
  63892. /**
  63893. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  63894. * @returns The JSON representation of the texture
  63895. */
  63896. serialize(): any;
  63897. /**
  63898. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  63899. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  63900. * @param scene Define the scene the parsed reflection probe should be instantiated in
  63901. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  63902. * @returns The parsed reflection probe if successful
  63903. */
  63904. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  63905. }
  63906. }
  63907. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  63908. /** @hidden */
  63909. export var _BabylonLoaderRegistered: boolean;
  63910. /**
  63911. * Helps setting up some configuration for the babylon file loader.
  63912. */
  63913. export class BabylonFileLoaderConfiguration {
  63914. /**
  63915. * The loader does not allow injecting custom physix engine into the plugins.
  63916. * Unfortunately in ES6, we need to manually inject them into the plugin.
  63917. * So you could set this variable to your engine import to make it work.
  63918. */
  63919. static LoaderInjectedPhysicsEngine: any;
  63920. }
  63921. }
  63922. declare module "babylonjs/Loading/Plugins/index" {
  63923. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  63924. }
  63925. declare module "babylonjs/Loading/index" {
  63926. export * from "babylonjs/Loading/loadingScreen";
  63927. export * from "babylonjs/Loading/Plugins/index";
  63928. export * from "babylonjs/Loading/sceneLoader";
  63929. export * from "babylonjs/Loading/sceneLoaderFlags";
  63930. }
  63931. declare module "babylonjs/Materials/Background/index" {
  63932. export * from "babylonjs/Materials/Background/backgroundMaterial";
  63933. }
  63934. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  63935. import { Scene } from "babylonjs/scene";
  63936. import { Color3 } from "babylonjs/Maths/math.color";
  63937. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63938. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63939. /**
  63940. * The Physically based simple base material of BJS.
  63941. *
  63942. * This enables better naming and convention enforcements on top of the pbrMaterial.
  63943. * It is used as the base class for both the specGloss and metalRough conventions.
  63944. */
  63945. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  63946. /**
  63947. * Number of Simultaneous lights allowed on the material.
  63948. */
  63949. maxSimultaneousLights: number;
  63950. /**
  63951. * If sets to true, disables all the lights affecting the material.
  63952. */
  63953. disableLighting: boolean;
  63954. /**
  63955. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  63956. */
  63957. environmentTexture: BaseTexture;
  63958. /**
  63959. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  63960. */
  63961. invertNormalMapX: boolean;
  63962. /**
  63963. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  63964. */
  63965. invertNormalMapY: boolean;
  63966. /**
  63967. * Normal map used in the model.
  63968. */
  63969. normalTexture: BaseTexture;
  63970. /**
  63971. * Emissivie color used to self-illuminate the model.
  63972. */
  63973. emissiveColor: Color3;
  63974. /**
  63975. * Emissivie texture used to self-illuminate the model.
  63976. */
  63977. emissiveTexture: BaseTexture;
  63978. /**
  63979. * Occlusion Channel Strenght.
  63980. */
  63981. occlusionStrength: number;
  63982. /**
  63983. * Occlusion Texture of the material (adding extra occlusion effects).
  63984. */
  63985. occlusionTexture: BaseTexture;
  63986. /**
  63987. * Defines the alpha limits in alpha test mode.
  63988. */
  63989. alphaCutOff: number;
  63990. /**
  63991. * Gets the current double sided mode.
  63992. */
  63993. get doubleSided(): boolean;
  63994. /**
  63995. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  63996. */
  63997. set doubleSided(value: boolean);
  63998. /**
  63999. * Stores the pre-calculated light information of a mesh in a texture.
  64000. */
  64001. lightmapTexture: BaseTexture;
  64002. /**
  64003. * If true, the light map contains occlusion information instead of lighting info.
  64004. */
  64005. useLightmapAsShadowmap: boolean;
  64006. /**
  64007. * Instantiates a new PBRMaterial instance.
  64008. *
  64009. * @param name The material name
  64010. * @param scene The scene the material will be use in.
  64011. */
  64012. constructor(name: string, scene: Scene);
  64013. getClassName(): string;
  64014. }
  64015. }
  64016. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  64017. import { Scene } from "babylonjs/scene";
  64018. import { Color3 } from "babylonjs/Maths/math.color";
  64019. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64020. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64021. /**
  64022. * The PBR material of BJS following the metal roughness convention.
  64023. *
  64024. * This fits to the PBR convention in the GLTF definition:
  64025. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  64026. */
  64027. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  64028. /**
  64029. * The base color has two different interpretations depending on the value of metalness.
  64030. * When the material is a metal, the base color is the specific measured reflectance value
  64031. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  64032. * of the material.
  64033. */
  64034. baseColor: Color3;
  64035. /**
  64036. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  64037. * well as opacity information in the alpha channel.
  64038. */
  64039. baseTexture: BaseTexture;
  64040. /**
  64041. * Specifies the metallic scalar value of the material.
  64042. * Can also be used to scale the metalness values of the metallic texture.
  64043. */
  64044. metallic: number;
  64045. /**
  64046. * Specifies the roughness scalar value of the material.
  64047. * Can also be used to scale the roughness values of the metallic texture.
  64048. */
  64049. roughness: number;
  64050. /**
  64051. * Texture containing both the metallic value in the B channel and the
  64052. * roughness value in the G channel to keep better precision.
  64053. */
  64054. metallicRoughnessTexture: BaseTexture;
  64055. /**
  64056. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64057. *
  64058. * @param name The material name
  64059. * @param scene The scene the material will be use in.
  64060. */
  64061. constructor(name: string, scene: Scene);
  64062. /**
  64063. * Return the currrent class name of the material.
  64064. */
  64065. getClassName(): string;
  64066. /**
  64067. * Makes a duplicate of the current material.
  64068. * @param name - name to use for the new material.
  64069. */
  64070. clone(name: string): PBRMetallicRoughnessMaterial;
  64071. /**
  64072. * Serialize the material to a parsable JSON object.
  64073. */
  64074. serialize(): any;
  64075. /**
  64076. * Parses a JSON object correponding to the serialize function.
  64077. */
  64078. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64079. }
  64080. }
  64081. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64082. import { Scene } from "babylonjs/scene";
  64083. import { Color3 } from "babylonjs/Maths/math.color";
  64084. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64085. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64086. /**
  64087. * The PBR material of BJS following the specular glossiness convention.
  64088. *
  64089. * This fits to the PBR convention in the GLTF definition:
  64090. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64091. */
  64092. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64093. /**
  64094. * Specifies the diffuse color of the material.
  64095. */
  64096. diffuseColor: Color3;
  64097. /**
  64098. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64099. * channel.
  64100. */
  64101. diffuseTexture: BaseTexture;
  64102. /**
  64103. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64104. */
  64105. specularColor: Color3;
  64106. /**
  64107. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64108. */
  64109. glossiness: number;
  64110. /**
  64111. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64112. */
  64113. specularGlossinessTexture: BaseTexture;
  64114. /**
  64115. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64116. *
  64117. * @param name The material name
  64118. * @param scene The scene the material will be use in.
  64119. */
  64120. constructor(name: string, scene: Scene);
  64121. /**
  64122. * Return the currrent class name of the material.
  64123. */
  64124. getClassName(): string;
  64125. /**
  64126. * Makes a duplicate of the current material.
  64127. * @param name - name to use for the new material.
  64128. */
  64129. clone(name: string): PBRSpecularGlossinessMaterial;
  64130. /**
  64131. * Serialize the material to a parsable JSON object.
  64132. */
  64133. serialize(): any;
  64134. /**
  64135. * Parses a JSON object correponding to the serialize function.
  64136. */
  64137. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64138. }
  64139. }
  64140. declare module "babylonjs/Materials/PBR/index" {
  64141. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64142. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64143. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64144. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64145. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64146. }
  64147. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64148. import { Nullable } from "babylonjs/types";
  64149. import { Scene } from "babylonjs/scene";
  64150. import { Matrix } from "babylonjs/Maths/math.vector";
  64151. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64152. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64153. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64154. /**
  64155. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64156. * It can help converting any input color in a desired output one. This can then be used to create effects
  64157. * from sepia, black and white to sixties or futuristic rendering...
  64158. *
  64159. * The only supported format is currently 3dl.
  64160. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64161. */
  64162. export class ColorGradingTexture extends BaseTexture {
  64163. /**
  64164. * The texture URL.
  64165. */
  64166. url: string;
  64167. /**
  64168. * Empty line regex stored for GC.
  64169. */
  64170. private static _noneEmptyLineRegex;
  64171. private _textureMatrix;
  64172. private _onLoad;
  64173. /**
  64174. * Instantiates a ColorGradingTexture from the following parameters.
  64175. *
  64176. * @param url The location of the color gradind data (currently only supporting 3dl)
  64177. * @param sceneOrEngine The scene or engine the texture will be used in
  64178. * @param onLoad defines a callback triggered when the texture has been loaded
  64179. */
  64180. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64181. /**
  64182. * Fires the onload event from the constructor if requested.
  64183. */
  64184. private _triggerOnLoad;
  64185. /**
  64186. * Returns the texture matrix used in most of the material.
  64187. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64188. */
  64189. getTextureMatrix(): Matrix;
  64190. /**
  64191. * Occurs when the file being loaded is a .3dl LUT file.
  64192. */
  64193. private load3dlTexture;
  64194. /**
  64195. * Starts the loading process of the texture.
  64196. */
  64197. private loadTexture;
  64198. /**
  64199. * Clones the color gradind texture.
  64200. */
  64201. clone(): ColorGradingTexture;
  64202. /**
  64203. * Called during delayed load for textures.
  64204. */
  64205. delayLoad(): void;
  64206. /**
  64207. * Parses a color grading texture serialized by Babylon.
  64208. * @param parsedTexture The texture information being parsedTexture
  64209. * @param scene The scene to load the texture in
  64210. * @param rootUrl The root url of the data assets to load
  64211. * @return A color gradind texture
  64212. */
  64213. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64214. /**
  64215. * Serializes the LUT texture to json format.
  64216. */
  64217. serialize(): any;
  64218. }
  64219. }
  64220. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64221. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64222. import { Scene } from "babylonjs/scene";
  64223. import { Nullable } from "babylonjs/types";
  64224. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64225. /**
  64226. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64227. */
  64228. export class EquiRectangularCubeTexture extends BaseTexture {
  64229. /** The six faces of the cube. */
  64230. private static _FacesMapping;
  64231. private _noMipmap;
  64232. private _onLoad;
  64233. private _onError;
  64234. /** The size of the cubemap. */
  64235. private _size;
  64236. /** The buffer of the image. */
  64237. private _buffer;
  64238. /** The width of the input image. */
  64239. private _width;
  64240. /** The height of the input image. */
  64241. private _height;
  64242. /** The URL to the image. */
  64243. url: string;
  64244. /**
  64245. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64246. * @param url The location of the image
  64247. * @param scene The scene the texture will be used in
  64248. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64249. * @param noMipmap Forces to not generate the mipmap if true
  64250. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64251. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64252. * @param onLoad — defines a callback called when texture is loaded
  64253. * @param onError — defines a callback called if there is an error
  64254. */
  64255. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64256. /**
  64257. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64258. */
  64259. private loadImage;
  64260. /**
  64261. * Convert the image buffer into a cubemap and create a CubeTexture.
  64262. */
  64263. private loadTexture;
  64264. /**
  64265. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64266. * @param buffer The ArrayBuffer that should be converted.
  64267. * @returns The buffer as Float32Array.
  64268. */
  64269. private getFloat32ArrayFromArrayBuffer;
  64270. /**
  64271. * Get the current class name of the texture useful for serialization or dynamic coding.
  64272. * @returns "EquiRectangularCubeTexture"
  64273. */
  64274. getClassName(): string;
  64275. /**
  64276. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64277. * @returns A clone of the current EquiRectangularCubeTexture.
  64278. */
  64279. clone(): EquiRectangularCubeTexture;
  64280. }
  64281. }
  64282. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64283. import { Nullable } from "babylonjs/types";
  64284. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64285. import { Matrix } from "babylonjs/Maths/math.vector";
  64286. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64287. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64288. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64289. import { Scene } from "babylonjs/scene";
  64290. /**
  64291. * Defines the options related to the creation of an HtmlElementTexture
  64292. */
  64293. export interface IHtmlElementTextureOptions {
  64294. /**
  64295. * Defines wether mip maps should be created or not.
  64296. */
  64297. generateMipMaps?: boolean;
  64298. /**
  64299. * Defines the sampling mode of the texture.
  64300. */
  64301. samplingMode?: number;
  64302. /**
  64303. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64304. */
  64305. engine: Nullable<ThinEngine>;
  64306. /**
  64307. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64308. */
  64309. scene: Nullable<Scene>;
  64310. }
  64311. /**
  64312. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64313. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64314. * is automatically managed.
  64315. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64316. * in your application.
  64317. *
  64318. * As the update is not automatic, you need to call them manually.
  64319. */
  64320. export class HtmlElementTexture extends BaseTexture {
  64321. /**
  64322. * The texture URL.
  64323. */
  64324. element: HTMLVideoElement | HTMLCanvasElement;
  64325. private static readonly DefaultOptions;
  64326. private _textureMatrix;
  64327. private _isVideo;
  64328. private _generateMipMaps;
  64329. private _samplingMode;
  64330. /**
  64331. * Instantiates a HtmlElementTexture from the following parameters.
  64332. *
  64333. * @param name Defines the name of the texture
  64334. * @param element Defines the video or canvas the texture is filled with
  64335. * @param options Defines the other none mandatory texture creation options
  64336. */
  64337. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64338. private _createInternalTexture;
  64339. /**
  64340. * Returns the texture matrix used in most of the material.
  64341. */
  64342. getTextureMatrix(): Matrix;
  64343. /**
  64344. * Updates the content of the texture.
  64345. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64346. */
  64347. update(invertY?: Nullable<boolean>): void;
  64348. }
  64349. }
  64350. declare module "babylonjs/Misc/tga" {
  64351. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64352. /**
  64353. * Based on jsTGALoader - Javascript loader for TGA file
  64354. * By Vincent Thibault
  64355. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64356. */
  64357. export class TGATools {
  64358. private static _TYPE_INDEXED;
  64359. private static _TYPE_RGB;
  64360. private static _TYPE_GREY;
  64361. private static _TYPE_RLE_INDEXED;
  64362. private static _TYPE_RLE_RGB;
  64363. private static _TYPE_RLE_GREY;
  64364. private static _ORIGIN_MASK;
  64365. private static _ORIGIN_SHIFT;
  64366. private static _ORIGIN_BL;
  64367. private static _ORIGIN_BR;
  64368. private static _ORIGIN_UL;
  64369. private static _ORIGIN_UR;
  64370. /**
  64371. * Gets the header of a TGA file
  64372. * @param data defines the TGA data
  64373. * @returns the header
  64374. */
  64375. static GetTGAHeader(data: Uint8Array): any;
  64376. /**
  64377. * Uploads TGA content to a Babylon Texture
  64378. * @hidden
  64379. */
  64380. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64381. /** @hidden */
  64382. 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;
  64383. /** @hidden */
  64384. 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;
  64385. /** @hidden */
  64386. 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;
  64387. /** @hidden */
  64388. 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;
  64389. /** @hidden */
  64390. 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;
  64391. /** @hidden */
  64392. 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;
  64393. }
  64394. }
  64395. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64396. import { Nullable } from "babylonjs/types";
  64397. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64398. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64399. /**
  64400. * Implementation of the TGA Texture Loader.
  64401. * @hidden
  64402. */
  64403. export class _TGATextureLoader implements IInternalTextureLoader {
  64404. /**
  64405. * Defines wether the loader supports cascade loading the different faces.
  64406. */
  64407. readonly supportCascades: boolean;
  64408. /**
  64409. * This returns if the loader support the current file information.
  64410. * @param extension defines the file extension of the file being loaded
  64411. * @returns true if the loader can load the specified file
  64412. */
  64413. canLoad(extension: string): boolean;
  64414. /**
  64415. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64416. * @param data contains the texture data
  64417. * @param texture defines the BabylonJS internal texture
  64418. * @param createPolynomials will be true if polynomials have been requested
  64419. * @param onLoad defines the callback to trigger once the texture is ready
  64420. * @param onError defines the callback to trigger in case of error
  64421. */
  64422. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64423. /**
  64424. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64425. * @param data contains the texture data
  64426. * @param texture defines the BabylonJS internal texture
  64427. * @param callback defines the method to call once ready to upload
  64428. */
  64429. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64430. }
  64431. }
  64432. declare module "babylonjs/Misc/basis" {
  64433. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64434. /**
  64435. * Info about the .basis files
  64436. */
  64437. class BasisFileInfo {
  64438. /**
  64439. * If the file has alpha
  64440. */
  64441. hasAlpha: boolean;
  64442. /**
  64443. * Info about each image of the basis file
  64444. */
  64445. images: Array<{
  64446. levels: Array<{
  64447. width: number;
  64448. height: number;
  64449. transcodedPixels: ArrayBufferView;
  64450. }>;
  64451. }>;
  64452. }
  64453. /**
  64454. * Result of transcoding a basis file
  64455. */
  64456. class TranscodeResult {
  64457. /**
  64458. * Info about the .basis file
  64459. */
  64460. fileInfo: BasisFileInfo;
  64461. /**
  64462. * Format to use when loading the file
  64463. */
  64464. format: number;
  64465. }
  64466. /**
  64467. * Configuration options for the Basis transcoder
  64468. */
  64469. export class BasisTranscodeConfiguration {
  64470. /**
  64471. * Supported compression formats used to determine the supported output format of the transcoder
  64472. */
  64473. supportedCompressionFormats?: {
  64474. /**
  64475. * etc1 compression format
  64476. */
  64477. etc1?: boolean;
  64478. /**
  64479. * s3tc compression format
  64480. */
  64481. s3tc?: boolean;
  64482. /**
  64483. * pvrtc compression format
  64484. */
  64485. pvrtc?: boolean;
  64486. /**
  64487. * etc2 compression format
  64488. */
  64489. etc2?: boolean;
  64490. };
  64491. /**
  64492. * If mipmap levels should be loaded for transcoded images (Default: true)
  64493. */
  64494. loadMipmapLevels?: boolean;
  64495. /**
  64496. * Index of a single image to load (Default: all images)
  64497. */
  64498. loadSingleImage?: number;
  64499. }
  64500. /**
  64501. * Used to load .Basis files
  64502. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64503. */
  64504. export class BasisTools {
  64505. private static _IgnoreSupportedFormats;
  64506. /**
  64507. * URL to use when loading the basis transcoder
  64508. */
  64509. static JSModuleURL: string;
  64510. /**
  64511. * URL to use when loading the wasm module for the transcoder
  64512. */
  64513. static WasmModuleURL: string;
  64514. /**
  64515. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64516. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64517. * @returns internal format corresponding to the Basis format
  64518. */
  64519. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64520. private static _WorkerPromise;
  64521. private static _Worker;
  64522. private static _actionId;
  64523. private static _CreateWorkerAsync;
  64524. /**
  64525. * Transcodes a loaded image file to compressed pixel data
  64526. * @param data image data to transcode
  64527. * @param config configuration options for the transcoding
  64528. * @returns a promise resulting in the transcoded image
  64529. */
  64530. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64531. /**
  64532. * Loads a texture from the transcode result
  64533. * @param texture texture load to
  64534. * @param transcodeResult the result of transcoding the basis file to load from
  64535. */
  64536. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64537. }
  64538. }
  64539. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64540. import { Nullable } from "babylonjs/types";
  64541. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64542. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64543. /**
  64544. * Loader for .basis file format
  64545. */
  64546. export class _BasisTextureLoader implements IInternalTextureLoader {
  64547. /**
  64548. * Defines whether the loader supports cascade loading the different faces.
  64549. */
  64550. readonly supportCascades: boolean;
  64551. /**
  64552. * This returns if the loader support the current file information.
  64553. * @param extension defines the file extension of the file being loaded
  64554. * @returns true if the loader can load the specified file
  64555. */
  64556. canLoad(extension: string): boolean;
  64557. /**
  64558. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64559. * @param data contains the texture data
  64560. * @param texture defines the BabylonJS internal texture
  64561. * @param createPolynomials will be true if polynomials have been requested
  64562. * @param onLoad defines the callback to trigger once the texture is ready
  64563. * @param onError defines the callback to trigger in case of error
  64564. */
  64565. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64566. /**
  64567. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64568. * @param data contains the texture data
  64569. * @param texture defines the BabylonJS internal texture
  64570. * @param callback defines the method to call once ready to upload
  64571. */
  64572. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64573. }
  64574. }
  64575. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64576. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64577. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64578. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64579. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64580. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64581. }
  64582. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64583. import { Vector2 } from "babylonjs/Maths/math.vector";
  64584. /**
  64585. * Defines the basic options interface of a TexturePacker Frame
  64586. */
  64587. export interface ITexturePackerFrame {
  64588. /**
  64589. * The frame ID
  64590. */
  64591. id: number;
  64592. /**
  64593. * The frames Scale
  64594. */
  64595. scale: Vector2;
  64596. /**
  64597. * The Frames offset
  64598. */
  64599. offset: Vector2;
  64600. }
  64601. /**
  64602. * This is a support class for frame Data on texture packer sets.
  64603. */
  64604. export class TexturePackerFrame implements ITexturePackerFrame {
  64605. /**
  64606. * The frame ID
  64607. */
  64608. id: number;
  64609. /**
  64610. * The frames Scale
  64611. */
  64612. scale: Vector2;
  64613. /**
  64614. * The Frames offset
  64615. */
  64616. offset: Vector2;
  64617. /**
  64618. * Initializes a texture package frame.
  64619. * @param id The numerical frame identifier
  64620. * @param scale Scalar Vector2 for UV frame
  64621. * @param offset Vector2 for the frame position in UV units.
  64622. * @returns TexturePackerFrame
  64623. */
  64624. constructor(id: number, scale: Vector2, offset: Vector2);
  64625. }
  64626. }
  64627. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64628. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64629. import { Scene } from "babylonjs/scene";
  64630. import { Nullable } from "babylonjs/types";
  64631. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64632. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64633. /**
  64634. * Defines the basic options interface of a TexturePacker
  64635. */
  64636. export interface ITexturePackerOptions {
  64637. /**
  64638. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64639. */
  64640. map?: string[];
  64641. /**
  64642. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64643. */
  64644. uvsIn?: string;
  64645. /**
  64646. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64647. */
  64648. uvsOut?: string;
  64649. /**
  64650. * number representing the layout style. Defaults to LAYOUT_STRIP
  64651. */
  64652. layout?: number;
  64653. /**
  64654. * number of columns if using custom column count layout(2). This defaults to 4.
  64655. */
  64656. colnum?: number;
  64657. /**
  64658. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64659. */
  64660. updateInputMeshes?: boolean;
  64661. /**
  64662. * boolean flag to dispose all the source textures. Defaults to true.
  64663. */
  64664. disposeSources?: boolean;
  64665. /**
  64666. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64667. */
  64668. fillBlanks?: boolean;
  64669. /**
  64670. * string value representing the context fill style color. Defaults to 'black'.
  64671. */
  64672. customFillColor?: string;
  64673. /**
  64674. * Width and Height Value of each Frame in the TexturePacker Sets
  64675. */
  64676. frameSize?: number;
  64677. /**
  64678. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64679. */
  64680. paddingRatio?: number;
  64681. /**
  64682. * Number that declares the fill method for the padding gutter.
  64683. */
  64684. paddingMode?: number;
  64685. /**
  64686. * If in SUBUV_COLOR padding mode what color to use.
  64687. */
  64688. paddingColor?: Color3 | Color4;
  64689. }
  64690. /**
  64691. * Defines the basic interface of a TexturePacker JSON File
  64692. */
  64693. export interface ITexturePackerJSON {
  64694. /**
  64695. * The frame ID
  64696. */
  64697. name: string;
  64698. /**
  64699. * The base64 channel data
  64700. */
  64701. sets: any;
  64702. /**
  64703. * The options of the Packer
  64704. */
  64705. options: ITexturePackerOptions;
  64706. /**
  64707. * The frame data of the Packer
  64708. */
  64709. frames: Array<number>;
  64710. }
  64711. /**
  64712. * This is a support class that generates a series of packed texture sets.
  64713. * @see https://doc.babylonjs.com/babylon101/materials
  64714. */
  64715. export class TexturePacker {
  64716. /** Packer Layout Constant 0 */
  64717. static readonly LAYOUT_STRIP: number;
  64718. /** Packer Layout Constant 1 */
  64719. static readonly LAYOUT_POWER2: number;
  64720. /** Packer Layout Constant 2 */
  64721. static readonly LAYOUT_COLNUM: number;
  64722. /** Packer Layout Constant 0 */
  64723. static readonly SUBUV_WRAP: number;
  64724. /** Packer Layout Constant 1 */
  64725. static readonly SUBUV_EXTEND: number;
  64726. /** Packer Layout Constant 2 */
  64727. static readonly SUBUV_COLOR: number;
  64728. /** The Name of the Texture Package */
  64729. name: string;
  64730. /** The scene scope of the TexturePacker */
  64731. scene: Scene;
  64732. /** The Meshes to target */
  64733. meshes: AbstractMesh[];
  64734. /** Arguments passed with the Constructor */
  64735. options: ITexturePackerOptions;
  64736. /** The promise that is started upon initialization */
  64737. promise: Nullable<Promise<TexturePacker | string>>;
  64738. /** The Container object for the channel sets that are generated */
  64739. sets: object;
  64740. /** The Container array for the frames that are generated */
  64741. frames: TexturePackerFrame[];
  64742. /** The expected number of textures the system is parsing. */
  64743. private _expecting;
  64744. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64745. private _paddingValue;
  64746. /**
  64747. * Initializes a texture package series from an array of meshes or a single mesh.
  64748. * @param name The name of the package
  64749. * @param meshes The target meshes to compose the package from
  64750. * @param options The arguments that texture packer should follow while building.
  64751. * @param scene The scene which the textures are scoped to.
  64752. * @returns TexturePacker
  64753. */
  64754. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64755. /**
  64756. * Starts the package process
  64757. * @param resolve The promises resolution function
  64758. * @returns TexturePacker
  64759. */
  64760. private _createFrames;
  64761. /**
  64762. * Calculates the Size of the Channel Sets
  64763. * @returns Vector2
  64764. */
  64765. private _calculateSize;
  64766. /**
  64767. * Calculates the UV data for the frames.
  64768. * @param baseSize the base frameSize
  64769. * @param padding the base frame padding
  64770. * @param dtSize size of the Dynamic Texture for that channel
  64771. * @param dtUnits is 1/dtSize
  64772. * @param update flag to update the input meshes
  64773. */
  64774. private _calculateMeshUVFrames;
  64775. /**
  64776. * Calculates the frames Offset.
  64777. * @param index of the frame
  64778. * @returns Vector2
  64779. */
  64780. private _getFrameOffset;
  64781. /**
  64782. * Updates a Mesh to the frame data
  64783. * @param mesh that is the target
  64784. * @param frameID or the frame index
  64785. */
  64786. private _updateMeshUV;
  64787. /**
  64788. * Updates a Meshes materials to use the texture packer channels
  64789. * @param m is the mesh to target
  64790. * @param force all channels on the packer to be set.
  64791. */
  64792. private _updateTextureReferences;
  64793. /**
  64794. * Public method to set a Mesh to a frame
  64795. * @param m that is the target
  64796. * @param frameID or the frame index
  64797. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64798. */
  64799. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64800. /**
  64801. * Starts the async promise to compile the texture packer.
  64802. * @returns Promise<void>
  64803. */
  64804. processAsync(): Promise<void>;
  64805. /**
  64806. * Disposes all textures associated with this packer
  64807. */
  64808. dispose(): void;
  64809. /**
  64810. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64811. * @param imageType is the image type to use.
  64812. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64813. */
  64814. download(imageType?: string, quality?: number): void;
  64815. /**
  64816. * Public method to load a texturePacker JSON file.
  64817. * @param data of the JSON file in string format.
  64818. */
  64819. updateFromJSON(data: string): void;
  64820. }
  64821. }
  64822. declare module "babylonjs/Materials/Textures/Packer/index" {
  64823. export * from "babylonjs/Materials/Textures/Packer/packer";
  64824. export * from "babylonjs/Materials/Textures/Packer/frame";
  64825. }
  64826. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64827. import { Scene } from "babylonjs/scene";
  64828. import { Texture } from "babylonjs/Materials/Textures/texture";
  64829. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64830. /**
  64831. * 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.
  64832. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64833. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64834. */
  64835. export class CustomProceduralTexture extends ProceduralTexture {
  64836. private _animate;
  64837. private _time;
  64838. private _config;
  64839. private _texturePath;
  64840. /**
  64841. * Instantiates a new Custom Procedural Texture.
  64842. * 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.
  64843. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64844. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64845. * @param name Define the name of the texture
  64846. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64847. * @param size Define the size of the texture to create
  64848. * @param scene Define the scene the texture belongs to
  64849. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64850. * @param generateMipMaps Define if the texture should creates mip maps or not
  64851. */
  64852. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64853. private _loadJson;
  64854. /**
  64855. * Is the texture ready to be used ? (rendered at least once)
  64856. * @returns true if ready, otherwise, false.
  64857. */
  64858. isReady(): boolean;
  64859. /**
  64860. * Render the texture to its associated render target.
  64861. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  64862. */
  64863. render(useCameraPostProcess?: boolean): void;
  64864. /**
  64865. * Update the list of dependant textures samplers in the shader.
  64866. */
  64867. updateTextures(): void;
  64868. /**
  64869. * Update the uniform values of the procedural texture in the shader.
  64870. */
  64871. updateShaderUniforms(): void;
  64872. /**
  64873. * Define if the texture animates or not.
  64874. */
  64875. get animate(): boolean;
  64876. set animate(value: boolean);
  64877. }
  64878. }
  64879. declare module "babylonjs/Shaders/noise.fragment" {
  64880. /** @hidden */
  64881. export var noisePixelShader: {
  64882. name: string;
  64883. shader: string;
  64884. };
  64885. }
  64886. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  64887. import { Nullable } from "babylonjs/types";
  64888. import { Scene } from "babylonjs/scene";
  64889. import { Texture } from "babylonjs/Materials/Textures/texture";
  64890. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64891. import "babylonjs/Shaders/noise.fragment";
  64892. /**
  64893. * Class used to generate noise procedural textures
  64894. */
  64895. export class NoiseProceduralTexture extends ProceduralTexture {
  64896. private _time;
  64897. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64898. brightness: number;
  64899. /** Defines the number of octaves to process */
  64900. octaves: number;
  64901. /** Defines the level of persistence (0.8 by default) */
  64902. persistence: number;
  64903. /** Gets or sets animation speed factor (default is 1) */
  64904. animationSpeedFactor: number;
  64905. /**
  64906. * Creates a new NoiseProceduralTexture
  64907. * @param name defines the name fo the texture
  64908. * @param size defines the size of the texture (default is 256)
  64909. * @param scene defines the hosting scene
  64910. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  64911. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  64912. */
  64913. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64914. private _updateShaderUniforms;
  64915. protected _getDefines(): string;
  64916. /** Generate the current state of the procedural texture */
  64917. render(useCameraPostProcess?: boolean): void;
  64918. /**
  64919. * Serializes this noise procedural texture
  64920. * @returns a serialized noise procedural texture object
  64921. */
  64922. serialize(): any;
  64923. /**
  64924. * Clone the texture.
  64925. * @returns the cloned texture
  64926. */
  64927. clone(): NoiseProceduralTexture;
  64928. /**
  64929. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  64930. * @param parsedTexture defines parsed texture data
  64931. * @param scene defines the current scene
  64932. * @param rootUrl defines the root URL containing noise procedural texture information
  64933. * @returns a parsed NoiseProceduralTexture
  64934. */
  64935. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  64936. }
  64937. }
  64938. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  64939. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  64940. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  64941. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64942. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  64943. }
  64944. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  64945. import { Nullable } from "babylonjs/types";
  64946. import { Scene } from "babylonjs/scene";
  64947. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  64948. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64949. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  64950. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64951. /**
  64952. * Raw cube texture where the raw buffers are passed in
  64953. */
  64954. export class RawCubeTexture extends CubeTexture {
  64955. /**
  64956. * Creates a cube texture where the raw buffers are passed in.
  64957. * @param scene defines the scene the texture is attached to
  64958. * @param data defines the array of data to use to create each face
  64959. * @param size defines the size of the textures
  64960. * @param format defines the format of the data
  64961. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  64962. * @param generateMipMaps defines if the engine should generate the mip levels
  64963. * @param invertY defines if data must be stored with Y axis inverted
  64964. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  64965. * @param compression defines the compression used (null by default)
  64966. */
  64967. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  64968. /**
  64969. * Updates the raw cube texture.
  64970. * @param data defines the data to store
  64971. * @param format defines the data format
  64972. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  64973. * @param invertY defines if data must be stored with Y axis inverted
  64974. * @param compression defines the compression used (null by default)
  64975. * @param level defines which level of the texture to update
  64976. */
  64977. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  64978. /**
  64979. * Updates a raw cube texture with RGBD encoded data.
  64980. * @param data defines the array of data [mipmap][face] to use to create each face
  64981. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  64982. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  64983. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  64984. * @returns a promsie that resolves when the operation is complete
  64985. */
  64986. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  64987. /**
  64988. * Clones the raw cube texture.
  64989. * @return a new cube texture
  64990. */
  64991. clone(): CubeTexture;
  64992. /** @hidden */
  64993. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  64994. }
  64995. }
  64996. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  64997. import { Scene } from "babylonjs/scene";
  64998. import { Texture } from "babylonjs/Materials/Textures/texture";
  64999. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65000. /**
  65001. * Class used to store 2D array textures containing user data
  65002. */
  65003. export class RawTexture2DArray extends Texture {
  65004. /** Gets or sets the texture format to use */
  65005. format: number;
  65006. /**
  65007. * Create a new RawTexture2DArray
  65008. * @param data defines the data of the texture
  65009. * @param width defines the width of the texture
  65010. * @param height defines the height of the texture
  65011. * @param depth defines the number of layers of the texture
  65012. * @param format defines the texture format to use
  65013. * @param scene defines the hosting scene
  65014. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65015. * @param invertY defines if texture must be stored with Y axis inverted
  65016. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65017. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65018. */
  65019. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65020. /** Gets or sets the texture format to use */
  65021. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65022. /**
  65023. * Update the texture with new data
  65024. * @param data defines the data to store in the texture
  65025. */
  65026. update(data: ArrayBufferView): void;
  65027. }
  65028. }
  65029. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  65030. import { Scene } from "babylonjs/scene";
  65031. import { Texture } from "babylonjs/Materials/Textures/texture";
  65032. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65033. /**
  65034. * Class used to store 3D textures containing user data
  65035. */
  65036. export class RawTexture3D extends Texture {
  65037. /** Gets or sets the texture format to use */
  65038. format: number;
  65039. /**
  65040. * Create a new RawTexture3D
  65041. * @param data defines the data of the texture
  65042. * @param width defines the width of the texture
  65043. * @param height defines the height of the texture
  65044. * @param depth defines the depth of the texture
  65045. * @param format defines the texture format to use
  65046. * @param scene defines the hosting scene
  65047. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65048. * @param invertY defines if texture must be stored with Y axis inverted
  65049. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65050. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65051. */
  65052. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65053. /** Gets or sets the texture format to use */
  65054. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65055. /**
  65056. * Update the texture with new data
  65057. * @param data defines the data to store in the texture
  65058. */
  65059. update(data: ArrayBufferView): void;
  65060. }
  65061. }
  65062. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65063. import { Scene } from "babylonjs/scene";
  65064. import { Plane } from "babylonjs/Maths/math.plane";
  65065. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65066. /**
  65067. * Creates a refraction texture used by refraction channel of the standard material.
  65068. * It is like a mirror but to see through a material.
  65069. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65070. */
  65071. export class RefractionTexture extends RenderTargetTexture {
  65072. /**
  65073. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65074. * 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.
  65075. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65076. */
  65077. refractionPlane: Plane;
  65078. /**
  65079. * Define how deep under the surface we should see.
  65080. */
  65081. depth: number;
  65082. /**
  65083. * Creates a refraction texture used by refraction channel of the standard material.
  65084. * It is like a mirror but to see through a material.
  65085. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65086. * @param name Define the texture name
  65087. * @param size Define the size of the underlying texture
  65088. * @param scene Define the scene the refraction belongs to
  65089. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65090. */
  65091. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65092. /**
  65093. * Clone the refraction texture.
  65094. * @returns the cloned texture
  65095. */
  65096. clone(): RefractionTexture;
  65097. /**
  65098. * Serialize the texture to a JSON representation you could use in Parse later on
  65099. * @returns the serialized JSON representation
  65100. */
  65101. serialize(): any;
  65102. }
  65103. }
  65104. declare module "babylonjs/Materials/Textures/index" {
  65105. export * from "babylonjs/Materials/Textures/baseTexture";
  65106. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65107. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65108. export * from "babylonjs/Materials/Textures/cubeTexture";
  65109. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65110. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65111. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65112. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65113. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65114. export * from "babylonjs/Materials/Textures/internalTexture";
  65115. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65116. export * from "babylonjs/Materials/Textures/Loaders/index";
  65117. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65118. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65119. export * from "babylonjs/Materials/Textures/Packer/index";
  65120. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65121. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65122. export * from "babylonjs/Materials/Textures/rawTexture";
  65123. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65124. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65125. export * from "babylonjs/Materials/Textures/refractionTexture";
  65126. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65127. export * from "babylonjs/Materials/Textures/texture";
  65128. export * from "babylonjs/Materials/Textures/videoTexture";
  65129. }
  65130. declare module "babylonjs/Materials/Node/Enums/index" {
  65131. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65132. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65133. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65134. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65135. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65136. }
  65137. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65138. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65139. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65140. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65141. import { Mesh } from "babylonjs/Meshes/mesh";
  65142. import { Effect } from "babylonjs/Materials/effect";
  65143. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65144. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65145. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65146. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65147. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65148. /**
  65149. * Block used to add support for vertex skinning (bones)
  65150. */
  65151. export class BonesBlock extends NodeMaterialBlock {
  65152. /**
  65153. * Creates a new BonesBlock
  65154. * @param name defines the block name
  65155. */
  65156. constructor(name: string);
  65157. /**
  65158. * Initialize the block and prepare the context for build
  65159. * @param state defines the state that will be used for the build
  65160. */
  65161. initialize(state: NodeMaterialBuildState): void;
  65162. /**
  65163. * Gets the current class name
  65164. * @returns the class name
  65165. */
  65166. getClassName(): string;
  65167. /**
  65168. * Gets the matrix indices input component
  65169. */
  65170. get matricesIndices(): NodeMaterialConnectionPoint;
  65171. /**
  65172. * Gets the matrix weights input component
  65173. */
  65174. get matricesWeights(): NodeMaterialConnectionPoint;
  65175. /**
  65176. * Gets the extra matrix indices input component
  65177. */
  65178. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65179. /**
  65180. * Gets the extra matrix weights input component
  65181. */
  65182. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65183. /**
  65184. * Gets the world input component
  65185. */
  65186. get world(): NodeMaterialConnectionPoint;
  65187. /**
  65188. * Gets the output component
  65189. */
  65190. get output(): NodeMaterialConnectionPoint;
  65191. autoConfigure(material: NodeMaterial): void;
  65192. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65193. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65194. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65195. protected _buildBlock(state: NodeMaterialBuildState): this;
  65196. }
  65197. }
  65198. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65199. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65200. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65201. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65202. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65203. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65204. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65205. /**
  65206. * Block used to add support for instances
  65207. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65208. */
  65209. export class InstancesBlock extends NodeMaterialBlock {
  65210. /**
  65211. * Creates a new InstancesBlock
  65212. * @param name defines the block name
  65213. */
  65214. constructor(name: string);
  65215. /**
  65216. * Gets the current class name
  65217. * @returns the class name
  65218. */
  65219. getClassName(): string;
  65220. /**
  65221. * Gets the first world row input component
  65222. */
  65223. get world0(): NodeMaterialConnectionPoint;
  65224. /**
  65225. * Gets the second world row input component
  65226. */
  65227. get world1(): NodeMaterialConnectionPoint;
  65228. /**
  65229. * Gets the third world row input component
  65230. */
  65231. get world2(): NodeMaterialConnectionPoint;
  65232. /**
  65233. * Gets the forth world row input component
  65234. */
  65235. get world3(): NodeMaterialConnectionPoint;
  65236. /**
  65237. * Gets the world input component
  65238. */
  65239. get world(): NodeMaterialConnectionPoint;
  65240. /**
  65241. * Gets the output component
  65242. */
  65243. get output(): NodeMaterialConnectionPoint;
  65244. /**
  65245. * Gets the isntanceID component
  65246. */
  65247. get instanceID(): NodeMaterialConnectionPoint;
  65248. autoConfigure(material: NodeMaterial): void;
  65249. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65250. protected _buildBlock(state: NodeMaterialBuildState): this;
  65251. }
  65252. }
  65253. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65254. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65255. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65256. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65257. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65258. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65259. import { Effect } from "babylonjs/Materials/effect";
  65260. import { Mesh } from "babylonjs/Meshes/mesh";
  65261. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65262. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65263. /**
  65264. * Block used to add morph targets support to vertex shader
  65265. */
  65266. export class MorphTargetsBlock extends NodeMaterialBlock {
  65267. private _repeatableContentAnchor;
  65268. /**
  65269. * Create a new MorphTargetsBlock
  65270. * @param name defines the block name
  65271. */
  65272. constructor(name: string);
  65273. /**
  65274. * Gets the current class name
  65275. * @returns the class name
  65276. */
  65277. getClassName(): string;
  65278. /**
  65279. * Gets the position input component
  65280. */
  65281. get position(): NodeMaterialConnectionPoint;
  65282. /**
  65283. * Gets the normal input component
  65284. */
  65285. get normal(): NodeMaterialConnectionPoint;
  65286. /**
  65287. * Gets the tangent input component
  65288. */
  65289. get tangent(): NodeMaterialConnectionPoint;
  65290. /**
  65291. * Gets the tangent input component
  65292. */
  65293. get uv(): NodeMaterialConnectionPoint;
  65294. /**
  65295. * Gets the position output component
  65296. */
  65297. get positionOutput(): NodeMaterialConnectionPoint;
  65298. /**
  65299. * Gets the normal output component
  65300. */
  65301. get normalOutput(): NodeMaterialConnectionPoint;
  65302. /**
  65303. * Gets the tangent output component
  65304. */
  65305. get tangentOutput(): NodeMaterialConnectionPoint;
  65306. /**
  65307. * Gets the tangent output component
  65308. */
  65309. get uvOutput(): NodeMaterialConnectionPoint;
  65310. initialize(state: NodeMaterialBuildState): void;
  65311. autoConfigure(material: NodeMaterial): void;
  65312. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65313. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65314. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65315. protected _buildBlock(state: NodeMaterialBuildState): this;
  65316. }
  65317. }
  65318. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65319. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65320. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65321. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65322. import { Nullable } from "babylonjs/types";
  65323. import { Scene } from "babylonjs/scene";
  65324. import { Effect } from "babylonjs/Materials/effect";
  65325. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65326. import { Mesh } from "babylonjs/Meshes/mesh";
  65327. import { Light } from "babylonjs/Lights/light";
  65328. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65329. /**
  65330. * Block used to get data information from a light
  65331. */
  65332. export class LightInformationBlock extends NodeMaterialBlock {
  65333. private _lightDataUniformName;
  65334. private _lightColorUniformName;
  65335. private _lightTypeDefineName;
  65336. /**
  65337. * Gets or sets the light associated with this block
  65338. */
  65339. light: Nullable<Light>;
  65340. /**
  65341. * Creates a new LightInformationBlock
  65342. * @param name defines the block name
  65343. */
  65344. constructor(name: string);
  65345. /**
  65346. * Gets the current class name
  65347. * @returns the class name
  65348. */
  65349. getClassName(): string;
  65350. /**
  65351. * Gets the world position input component
  65352. */
  65353. get worldPosition(): NodeMaterialConnectionPoint;
  65354. /**
  65355. * Gets the direction output component
  65356. */
  65357. get direction(): NodeMaterialConnectionPoint;
  65358. /**
  65359. * Gets the direction output component
  65360. */
  65361. get color(): NodeMaterialConnectionPoint;
  65362. /**
  65363. * Gets the direction output component
  65364. */
  65365. get intensity(): NodeMaterialConnectionPoint;
  65366. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65367. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65368. protected _buildBlock(state: NodeMaterialBuildState): this;
  65369. serialize(): any;
  65370. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65371. }
  65372. }
  65373. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65374. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65375. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65376. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65377. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65378. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65379. }
  65380. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65381. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65382. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65383. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65384. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65385. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65386. import { Effect } from "babylonjs/Materials/effect";
  65387. import { Mesh } from "babylonjs/Meshes/mesh";
  65388. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65389. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65390. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65391. /**
  65392. * Block used to add image processing support to fragment shader
  65393. */
  65394. export class ImageProcessingBlock extends NodeMaterialBlock {
  65395. /**
  65396. * Create a new ImageProcessingBlock
  65397. * @param name defines the block name
  65398. */
  65399. constructor(name: string);
  65400. /**
  65401. * Gets the current class name
  65402. * @returns the class name
  65403. */
  65404. getClassName(): string;
  65405. /**
  65406. * Gets the color input component
  65407. */
  65408. get color(): NodeMaterialConnectionPoint;
  65409. /**
  65410. * Gets the output component
  65411. */
  65412. get output(): NodeMaterialConnectionPoint;
  65413. /**
  65414. * Initialize the block and prepare the context for build
  65415. * @param state defines the state that will be used for the build
  65416. */
  65417. initialize(state: NodeMaterialBuildState): void;
  65418. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65419. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65420. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65421. protected _buildBlock(state: NodeMaterialBuildState): this;
  65422. }
  65423. }
  65424. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65425. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65426. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65427. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65428. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65429. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65430. import { Effect } from "babylonjs/Materials/effect";
  65431. import { Mesh } from "babylonjs/Meshes/mesh";
  65432. import { Scene } from "babylonjs/scene";
  65433. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65434. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65435. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65436. /**
  65437. * Block used to pertub normals based on a normal map
  65438. */
  65439. export class PerturbNormalBlock extends NodeMaterialBlock {
  65440. private _tangentSpaceParameterName;
  65441. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65442. invertX: boolean;
  65443. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65444. invertY: boolean;
  65445. /**
  65446. * Create a new PerturbNormalBlock
  65447. * @param name defines the block name
  65448. */
  65449. constructor(name: string);
  65450. /**
  65451. * Gets the current class name
  65452. * @returns the class name
  65453. */
  65454. getClassName(): string;
  65455. /**
  65456. * Gets the world position input component
  65457. */
  65458. get worldPosition(): NodeMaterialConnectionPoint;
  65459. /**
  65460. * Gets the world normal input component
  65461. */
  65462. get worldNormal(): NodeMaterialConnectionPoint;
  65463. /**
  65464. * Gets the world tangent input component
  65465. */
  65466. get worldTangent(): NodeMaterialConnectionPoint;
  65467. /**
  65468. * Gets the uv input component
  65469. */
  65470. get uv(): NodeMaterialConnectionPoint;
  65471. /**
  65472. * Gets the normal map color input component
  65473. */
  65474. get normalMapColor(): NodeMaterialConnectionPoint;
  65475. /**
  65476. * Gets the strength input component
  65477. */
  65478. get strength(): NodeMaterialConnectionPoint;
  65479. /**
  65480. * Gets the output component
  65481. */
  65482. get output(): NodeMaterialConnectionPoint;
  65483. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65484. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65485. autoConfigure(material: NodeMaterial): void;
  65486. protected _buildBlock(state: NodeMaterialBuildState): this;
  65487. protected _dumpPropertiesCode(): string;
  65488. serialize(): any;
  65489. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65490. }
  65491. }
  65492. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65493. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65494. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65495. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65496. /**
  65497. * Block used to discard a pixel if a value is smaller than a cutoff
  65498. */
  65499. export class DiscardBlock extends NodeMaterialBlock {
  65500. /**
  65501. * Create a new DiscardBlock
  65502. * @param name defines the block name
  65503. */
  65504. constructor(name: string);
  65505. /**
  65506. * Gets the current class name
  65507. * @returns the class name
  65508. */
  65509. getClassName(): string;
  65510. /**
  65511. * Gets the color input component
  65512. */
  65513. get value(): NodeMaterialConnectionPoint;
  65514. /**
  65515. * Gets the cutoff input component
  65516. */
  65517. get cutoff(): NodeMaterialConnectionPoint;
  65518. protected _buildBlock(state: NodeMaterialBuildState): this;
  65519. }
  65520. }
  65521. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65522. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65523. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65524. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65525. /**
  65526. * Block used to test if the fragment shader is front facing
  65527. */
  65528. export class FrontFacingBlock extends NodeMaterialBlock {
  65529. /**
  65530. * Creates a new FrontFacingBlock
  65531. * @param name defines the block name
  65532. */
  65533. constructor(name: string);
  65534. /**
  65535. * Gets the current class name
  65536. * @returns the class name
  65537. */
  65538. getClassName(): string;
  65539. /**
  65540. * Gets the output component
  65541. */
  65542. get output(): NodeMaterialConnectionPoint;
  65543. protected _buildBlock(state: NodeMaterialBuildState): this;
  65544. }
  65545. }
  65546. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65547. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65548. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65549. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65550. /**
  65551. * Block used to get the derivative value on x and y of a given input
  65552. */
  65553. export class DerivativeBlock extends NodeMaterialBlock {
  65554. /**
  65555. * Create a new DerivativeBlock
  65556. * @param name defines the block name
  65557. */
  65558. constructor(name: string);
  65559. /**
  65560. * Gets the current class name
  65561. * @returns the class name
  65562. */
  65563. getClassName(): string;
  65564. /**
  65565. * Gets the input component
  65566. */
  65567. get input(): NodeMaterialConnectionPoint;
  65568. /**
  65569. * Gets the derivative output on x
  65570. */
  65571. get dx(): NodeMaterialConnectionPoint;
  65572. /**
  65573. * Gets the derivative output on y
  65574. */
  65575. get dy(): NodeMaterialConnectionPoint;
  65576. protected _buildBlock(state: NodeMaterialBuildState): this;
  65577. }
  65578. }
  65579. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65580. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65581. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65582. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65583. /**
  65584. * Block used to make gl_FragCoord available
  65585. */
  65586. export class FragCoordBlock extends NodeMaterialBlock {
  65587. /**
  65588. * Creates a new FragCoordBlock
  65589. * @param name defines the block name
  65590. */
  65591. constructor(name: string);
  65592. /**
  65593. * Gets the current class name
  65594. * @returns the class name
  65595. */
  65596. getClassName(): string;
  65597. /**
  65598. * Gets the xy component
  65599. */
  65600. get xy(): NodeMaterialConnectionPoint;
  65601. /**
  65602. * Gets the xyz component
  65603. */
  65604. get xyz(): NodeMaterialConnectionPoint;
  65605. /**
  65606. * Gets the xyzw component
  65607. */
  65608. get xyzw(): NodeMaterialConnectionPoint;
  65609. /**
  65610. * Gets the x component
  65611. */
  65612. get x(): NodeMaterialConnectionPoint;
  65613. /**
  65614. * Gets the y component
  65615. */
  65616. get y(): NodeMaterialConnectionPoint;
  65617. /**
  65618. * Gets the z component
  65619. */
  65620. get z(): NodeMaterialConnectionPoint;
  65621. /**
  65622. * Gets the w component
  65623. */
  65624. get output(): NodeMaterialConnectionPoint;
  65625. protected writeOutputs(state: NodeMaterialBuildState): string;
  65626. protected _buildBlock(state: NodeMaterialBuildState): this;
  65627. }
  65628. }
  65629. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65630. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65631. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65632. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65633. import { Effect } from "babylonjs/Materials/effect";
  65634. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65635. import { Mesh } from "babylonjs/Meshes/mesh";
  65636. /**
  65637. * Block used to get the screen sizes
  65638. */
  65639. export class ScreenSizeBlock extends NodeMaterialBlock {
  65640. private _varName;
  65641. private _scene;
  65642. /**
  65643. * Creates a new ScreenSizeBlock
  65644. * @param name defines the block name
  65645. */
  65646. constructor(name: string);
  65647. /**
  65648. * Gets the current class name
  65649. * @returns the class name
  65650. */
  65651. getClassName(): string;
  65652. /**
  65653. * Gets the xy component
  65654. */
  65655. get xy(): NodeMaterialConnectionPoint;
  65656. /**
  65657. * Gets the x component
  65658. */
  65659. get x(): NodeMaterialConnectionPoint;
  65660. /**
  65661. * Gets the y component
  65662. */
  65663. get y(): NodeMaterialConnectionPoint;
  65664. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65665. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65666. protected _buildBlock(state: NodeMaterialBuildState): this;
  65667. }
  65668. }
  65669. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65670. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65671. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65672. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65673. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65674. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65675. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65676. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65677. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65678. }
  65679. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65680. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65681. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65682. import { Mesh } from "babylonjs/Meshes/mesh";
  65683. import { Effect } from "babylonjs/Materials/effect";
  65684. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65685. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65686. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65687. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65688. /**
  65689. * Block used to add support for scene fog
  65690. */
  65691. export class FogBlock extends NodeMaterialBlock {
  65692. private _fogDistanceName;
  65693. private _fogParameters;
  65694. /**
  65695. * Create a new FogBlock
  65696. * @param name defines the block name
  65697. */
  65698. constructor(name: string);
  65699. /**
  65700. * Gets the current class name
  65701. * @returns the class name
  65702. */
  65703. getClassName(): string;
  65704. /**
  65705. * Gets the world position input component
  65706. */
  65707. get worldPosition(): NodeMaterialConnectionPoint;
  65708. /**
  65709. * Gets the view input component
  65710. */
  65711. get view(): NodeMaterialConnectionPoint;
  65712. /**
  65713. * Gets the color input component
  65714. */
  65715. get input(): NodeMaterialConnectionPoint;
  65716. /**
  65717. * Gets the fog color input component
  65718. */
  65719. get fogColor(): NodeMaterialConnectionPoint;
  65720. /**
  65721. * Gets the output component
  65722. */
  65723. get output(): NodeMaterialConnectionPoint;
  65724. autoConfigure(material: NodeMaterial): void;
  65725. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65726. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65727. protected _buildBlock(state: NodeMaterialBuildState): this;
  65728. }
  65729. }
  65730. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65731. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65732. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65733. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65734. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65735. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65736. import { Effect } from "babylonjs/Materials/effect";
  65737. import { Mesh } from "babylonjs/Meshes/mesh";
  65738. import { Light } from "babylonjs/Lights/light";
  65739. import { Nullable } from "babylonjs/types";
  65740. import { Scene } from "babylonjs/scene";
  65741. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65742. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65743. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65744. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65745. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65746. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65747. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65748. /**
  65749. * Block used to add light in the fragment shader
  65750. */
  65751. export class LightBlock extends NodeMaterialBlock {
  65752. private _lightId;
  65753. /**
  65754. * Gets or sets the light associated with this block
  65755. */
  65756. light: Nullable<Light>;
  65757. /**
  65758. * Create a new LightBlock
  65759. * @param name defines the block name
  65760. */
  65761. constructor(name: string);
  65762. /**
  65763. * Gets the current class name
  65764. * @returns the class name
  65765. */
  65766. getClassName(): string;
  65767. /**
  65768. * Gets the world position input component
  65769. */
  65770. get worldPosition(): NodeMaterialConnectionPoint;
  65771. /**
  65772. * Gets the world normal input component
  65773. */
  65774. get worldNormal(): NodeMaterialConnectionPoint;
  65775. /**
  65776. * Gets the camera (or eye) position component
  65777. */
  65778. get cameraPosition(): NodeMaterialConnectionPoint;
  65779. /**
  65780. * Gets the glossiness component
  65781. */
  65782. get glossiness(): NodeMaterialConnectionPoint;
  65783. /**
  65784. * Gets the glossinness power component
  65785. */
  65786. get glossPower(): NodeMaterialConnectionPoint;
  65787. /**
  65788. * Gets the diffuse color component
  65789. */
  65790. get diffuseColor(): NodeMaterialConnectionPoint;
  65791. /**
  65792. * Gets the specular color component
  65793. */
  65794. get specularColor(): NodeMaterialConnectionPoint;
  65795. /**
  65796. * Gets the diffuse output component
  65797. */
  65798. get diffuseOutput(): NodeMaterialConnectionPoint;
  65799. /**
  65800. * Gets the specular output component
  65801. */
  65802. get specularOutput(): NodeMaterialConnectionPoint;
  65803. /**
  65804. * Gets the shadow output component
  65805. */
  65806. get shadow(): NodeMaterialConnectionPoint;
  65807. autoConfigure(material: NodeMaterial): void;
  65808. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65809. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65810. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65811. private _injectVertexCode;
  65812. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65813. serialize(): any;
  65814. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65815. }
  65816. }
  65817. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65818. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65819. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65820. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65821. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65822. /**
  65823. * Block used to read a reflection texture from a sampler
  65824. */
  65825. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65826. /**
  65827. * Create a new ReflectionTextureBlock
  65828. * @param name defines the block name
  65829. */
  65830. constructor(name: string);
  65831. /**
  65832. * Gets the current class name
  65833. * @returns the class name
  65834. */
  65835. getClassName(): string;
  65836. /**
  65837. * Gets the world position input component
  65838. */
  65839. get position(): NodeMaterialConnectionPoint;
  65840. /**
  65841. * Gets the world position input component
  65842. */
  65843. get worldPosition(): NodeMaterialConnectionPoint;
  65844. /**
  65845. * Gets the world normal input component
  65846. */
  65847. get worldNormal(): NodeMaterialConnectionPoint;
  65848. /**
  65849. * Gets the world input component
  65850. */
  65851. get world(): NodeMaterialConnectionPoint;
  65852. /**
  65853. * Gets the camera (or eye) position component
  65854. */
  65855. get cameraPosition(): NodeMaterialConnectionPoint;
  65856. /**
  65857. * Gets the view input component
  65858. */
  65859. get view(): NodeMaterialConnectionPoint;
  65860. /**
  65861. * Gets the rgb output component
  65862. */
  65863. get rgb(): NodeMaterialConnectionPoint;
  65864. /**
  65865. * Gets the rgba output component
  65866. */
  65867. get rgba(): NodeMaterialConnectionPoint;
  65868. /**
  65869. * Gets the r output component
  65870. */
  65871. get r(): NodeMaterialConnectionPoint;
  65872. /**
  65873. * Gets the g output component
  65874. */
  65875. get g(): NodeMaterialConnectionPoint;
  65876. /**
  65877. * Gets the b output component
  65878. */
  65879. get b(): NodeMaterialConnectionPoint;
  65880. /**
  65881. * Gets the a output component
  65882. */
  65883. get a(): NodeMaterialConnectionPoint;
  65884. autoConfigure(material: NodeMaterial): void;
  65885. protected _buildBlock(state: NodeMaterialBuildState): this;
  65886. }
  65887. }
  65888. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65889. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65890. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65891. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65892. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65893. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65894. }
  65895. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65896. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65897. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65898. }
  65899. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65900. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65901. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65902. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65903. /**
  65904. * Block used to add 2 vectors
  65905. */
  65906. export class AddBlock extends NodeMaterialBlock {
  65907. /**
  65908. * Creates a new AddBlock
  65909. * @param name defines the block name
  65910. */
  65911. constructor(name: string);
  65912. /**
  65913. * Gets the current class name
  65914. * @returns the class name
  65915. */
  65916. getClassName(): string;
  65917. /**
  65918. * Gets the left operand input component
  65919. */
  65920. get left(): NodeMaterialConnectionPoint;
  65921. /**
  65922. * Gets the right operand input component
  65923. */
  65924. get right(): NodeMaterialConnectionPoint;
  65925. /**
  65926. * Gets the output component
  65927. */
  65928. get output(): NodeMaterialConnectionPoint;
  65929. protected _buildBlock(state: NodeMaterialBuildState): this;
  65930. }
  65931. }
  65932. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  65933. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65934. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65935. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65936. /**
  65937. * Block used to scale a vector by a float
  65938. */
  65939. export class ScaleBlock extends NodeMaterialBlock {
  65940. /**
  65941. * Creates a new ScaleBlock
  65942. * @param name defines the block name
  65943. */
  65944. constructor(name: string);
  65945. /**
  65946. * Gets the current class name
  65947. * @returns the class name
  65948. */
  65949. getClassName(): string;
  65950. /**
  65951. * Gets the input component
  65952. */
  65953. get input(): NodeMaterialConnectionPoint;
  65954. /**
  65955. * Gets the factor input component
  65956. */
  65957. get factor(): NodeMaterialConnectionPoint;
  65958. /**
  65959. * Gets the output component
  65960. */
  65961. get output(): NodeMaterialConnectionPoint;
  65962. protected _buildBlock(state: NodeMaterialBuildState): this;
  65963. }
  65964. }
  65965. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  65966. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65967. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65968. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65969. import { Scene } from "babylonjs/scene";
  65970. /**
  65971. * Block used to clamp a float
  65972. */
  65973. export class ClampBlock extends NodeMaterialBlock {
  65974. /** Gets or sets the minimum range */
  65975. minimum: number;
  65976. /** Gets or sets the maximum range */
  65977. maximum: number;
  65978. /**
  65979. * Creates a new ClampBlock
  65980. * @param name defines the block name
  65981. */
  65982. constructor(name: string);
  65983. /**
  65984. * Gets the current class name
  65985. * @returns the class name
  65986. */
  65987. getClassName(): string;
  65988. /**
  65989. * Gets the value input component
  65990. */
  65991. get value(): NodeMaterialConnectionPoint;
  65992. /**
  65993. * Gets the output component
  65994. */
  65995. get output(): NodeMaterialConnectionPoint;
  65996. protected _buildBlock(state: NodeMaterialBuildState): this;
  65997. protected _dumpPropertiesCode(): string;
  65998. serialize(): any;
  65999. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66000. }
  66001. }
  66002. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  66003. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66004. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66005. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66006. /**
  66007. * Block used to apply a cross product between 2 vectors
  66008. */
  66009. export class CrossBlock extends NodeMaterialBlock {
  66010. /**
  66011. * Creates a new CrossBlock
  66012. * @param name defines the block name
  66013. */
  66014. constructor(name: string);
  66015. /**
  66016. * Gets the current class name
  66017. * @returns the class name
  66018. */
  66019. getClassName(): string;
  66020. /**
  66021. * Gets the left operand input component
  66022. */
  66023. get left(): NodeMaterialConnectionPoint;
  66024. /**
  66025. * Gets the right operand input component
  66026. */
  66027. get right(): NodeMaterialConnectionPoint;
  66028. /**
  66029. * Gets the output component
  66030. */
  66031. get output(): NodeMaterialConnectionPoint;
  66032. protected _buildBlock(state: NodeMaterialBuildState): this;
  66033. }
  66034. }
  66035. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  66036. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66037. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66038. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66039. /**
  66040. * Block used to apply a dot product between 2 vectors
  66041. */
  66042. export class DotBlock extends NodeMaterialBlock {
  66043. /**
  66044. * Creates a new DotBlock
  66045. * @param name defines the block name
  66046. */
  66047. constructor(name: string);
  66048. /**
  66049. * Gets the current class name
  66050. * @returns the class name
  66051. */
  66052. getClassName(): string;
  66053. /**
  66054. * Gets the left operand input component
  66055. */
  66056. get left(): NodeMaterialConnectionPoint;
  66057. /**
  66058. * Gets the right operand input component
  66059. */
  66060. get right(): NodeMaterialConnectionPoint;
  66061. /**
  66062. * Gets the output component
  66063. */
  66064. get output(): NodeMaterialConnectionPoint;
  66065. protected _buildBlock(state: NodeMaterialBuildState): this;
  66066. }
  66067. }
  66068. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66069. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66070. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66071. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66072. /**
  66073. * Block used to normalize a vector
  66074. */
  66075. export class NormalizeBlock extends NodeMaterialBlock {
  66076. /**
  66077. * Creates a new NormalizeBlock
  66078. * @param name defines the block name
  66079. */
  66080. constructor(name: string);
  66081. /**
  66082. * Gets the current class name
  66083. * @returns the class name
  66084. */
  66085. getClassName(): string;
  66086. /**
  66087. * Gets the input component
  66088. */
  66089. get input(): NodeMaterialConnectionPoint;
  66090. /**
  66091. * Gets the output component
  66092. */
  66093. get output(): NodeMaterialConnectionPoint;
  66094. protected _buildBlock(state: NodeMaterialBuildState): this;
  66095. }
  66096. }
  66097. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  66098. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66099. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66100. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66101. import { Scene } from "babylonjs/scene";
  66102. /**
  66103. * Operations supported by the Trigonometry block
  66104. */
  66105. export enum TrigonometryBlockOperations {
  66106. /** Cos */
  66107. Cos = 0,
  66108. /** Sin */
  66109. Sin = 1,
  66110. /** Abs */
  66111. Abs = 2,
  66112. /** Exp */
  66113. Exp = 3,
  66114. /** Exp2 */
  66115. Exp2 = 4,
  66116. /** Round */
  66117. Round = 5,
  66118. /** Floor */
  66119. Floor = 6,
  66120. /** Ceiling */
  66121. Ceiling = 7,
  66122. /** Square root */
  66123. Sqrt = 8,
  66124. /** Log */
  66125. Log = 9,
  66126. /** Tangent */
  66127. Tan = 10,
  66128. /** Arc tangent */
  66129. ArcTan = 11,
  66130. /** Arc cosinus */
  66131. ArcCos = 12,
  66132. /** Arc sinus */
  66133. ArcSin = 13,
  66134. /** Fraction */
  66135. Fract = 14,
  66136. /** Sign */
  66137. Sign = 15,
  66138. /** To radians (from degrees) */
  66139. Radians = 16,
  66140. /** To degrees (from radians) */
  66141. Degrees = 17
  66142. }
  66143. /**
  66144. * Block used to apply trigonometry operation to floats
  66145. */
  66146. export class TrigonometryBlock extends NodeMaterialBlock {
  66147. /**
  66148. * Gets or sets the operation applied by the block
  66149. */
  66150. operation: TrigonometryBlockOperations;
  66151. /**
  66152. * Creates a new TrigonometryBlock
  66153. * @param name defines the block name
  66154. */
  66155. constructor(name: string);
  66156. /**
  66157. * Gets the current class name
  66158. * @returns the class name
  66159. */
  66160. getClassName(): string;
  66161. /**
  66162. * Gets the input component
  66163. */
  66164. get input(): NodeMaterialConnectionPoint;
  66165. /**
  66166. * Gets the output component
  66167. */
  66168. get output(): NodeMaterialConnectionPoint;
  66169. protected _buildBlock(state: NodeMaterialBuildState): this;
  66170. serialize(): any;
  66171. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66172. protected _dumpPropertiesCode(): string;
  66173. }
  66174. }
  66175. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66176. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66177. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66178. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66179. /**
  66180. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66181. */
  66182. export class ColorMergerBlock extends NodeMaterialBlock {
  66183. /**
  66184. * Create a new ColorMergerBlock
  66185. * @param name defines the block name
  66186. */
  66187. constructor(name: string);
  66188. /**
  66189. * Gets the current class name
  66190. * @returns the class name
  66191. */
  66192. getClassName(): string;
  66193. /**
  66194. * Gets the rgb component (input)
  66195. */
  66196. get rgbIn(): NodeMaterialConnectionPoint;
  66197. /**
  66198. * Gets the r component (input)
  66199. */
  66200. get r(): NodeMaterialConnectionPoint;
  66201. /**
  66202. * Gets the g component (input)
  66203. */
  66204. get g(): NodeMaterialConnectionPoint;
  66205. /**
  66206. * Gets the b component (input)
  66207. */
  66208. get b(): NodeMaterialConnectionPoint;
  66209. /**
  66210. * Gets the a component (input)
  66211. */
  66212. get a(): NodeMaterialConnectionPoint;
  66213. /**
  66214. * Gets the rgba component (output)
  66215. */
  66216. get rgba(): NodeMaterialConnectionPoint;
  66217. /**
  66218. * Gets the rgb component (output)
  66219. */
  66220. get rgbOut(): NodeMaterialConnectionPoint;
  66221. /**
  66222. * Gets the rgb component (output)
  66223. * @deprecated Please use rgbOut instead.
  66224. */
  66225. get rgb(): NodeMaterialConnectionPoint;
  66226. protected _buildBlock(state: NodeMaterialBuildState): this;
  66227. }
  66228. }
  66229. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66230. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66231. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66232. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66233. /**
  66234. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66235. */
  66236. export class VectorSplitterBlock extends NodeMaterialBlock {
  66237. /**
  66238. * Create a new VectorSplitterBlock
  66239. * @param name defines the block name
  66240. */
  66241. constructor(name: string);
  66242. /**
  66243. * Gets the current class name
  66244. * @returns the class name
  66245. */
  66246. getClassName(): string;
  66247. /**
  66248. * Gets the xyzw component (input)
  66249. */
  66250. get xyzw(): NodeMaterialConnectionPoint;
  66251. /**
  66252. * Gets the xyz component (input)
  66253. */
  66254. get xyzIn(): NodeMaterialConnectionPoint;
  66255. /**
  66256. * Gets the xy component (input)
  66257. */
  66258. get xyIn(): NodeMaterialConnectionPoint;
  66259. /**
  66260. * Gets the xyz component (output)
  66261. */
  66262. get xyzOut(): NodeMaterialConnectionPoint;
  66263. /**
  66264. * Gets the xy component (output)
  66265. */
  66266. get xyOut(): NodeMaterialConnectionPoint;
  66267. /**
  66268. * Gets the x component (output)
  66269. */
  66270. get x(): NodeMaterialConnectionPoint;
  66271. /**
  66272. * Gets the y component (output)
  66273. */
  66274. get y(): NodeMaterialConnectionPoint;
  66275. /**
  66276. * Gets the z component (output)
  66277. */
  66278. get z(): NodeMaterialConnectionPoint;
  66279. /**
  66280. * Gets the w component (output)
  66281. */
  66282. get w(): NodeMaterialConnectionPoint;
  66283. protected _inputRename(name: string): string;
  66284. protected _outputRename(name: string): string;
  66285. protected _buildBlock(state: NodeMaterialBuildState): this;
  66286. }
  66287. }
  66288. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66289. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66290. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66291. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66292. /**
  66293. * Block used to lerp between 2 values
  66294. */
  66295. export class LerpBlock extends NodeMaterialBlock {
  66296. /**
  66297. * Creates a new LerpBlock
  66298. * @param name defines the block name
  66299. */
  66300. constructor(name: string);
  66301. /**
  66302. * Gets the current class name
  66303. * @returns the class name
  66304. */
  66305. getClassName(): string;
  66306. /**
  66307. * Gets the left operand input component
  66308. */
  66309. get left(): NodeMaterialConnectionPoint;
  66310. /**
  66311. * Gets the right operand input component
  66312. */
  66313. get right(): NodeMaterialConnectionPoint;
  66314. /**
  66315. * Gets the gradient operand input component
  66316. */
  66317. get gradient(): NodeMaterialConnectionPoint;
  66318. /**
  66319. * Gets the output component
  66320. */
  66321. get output(): NodeMaterialConnectionPoint;
  66322. protected _buildBlock(state: NodeMaterialBuildState): this;
  66323. }
  66324. }
  66325. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66326. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66327. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66328. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66329. /**
  66330. * Block used to divide 2 vectors
  66331. */
  66332. export class DivideBlock extends NodeMaterialBlock {
  66333. /**
  66334. * Creates a new DivideBlock
  66335. * @param name defines the block name
  66336. */
  66337. constructor(name: string);
  66338. /**
  66339. * Gets the current class name
  66340. * @returns the class name
  66341. */
  66342. getClassName(): string;
  66343. /**
  66344. * Gets the left operand input component
  66345. */
  66346. get left(): NodeMaterialConnectionPoint;
  66347. /**
  66348. * Gets the right operand input component
  66349. */
  66350. get right(): NodeMaterialConnectionPoint;
  66351. /**
  66352. * Gets the output component
  66353. */
  66354. get output(): NodeMaterialConnectionPoint;
  66355. protected _buildBlock(state: NodeMaterialBuildState): this;
  66356. }
  66357. }
  66358. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66359. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66360. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66361. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66362. /**
  66363. * Block used to subtract 2 vectors
  66364. */
  66365. export class SubtractBlock extends NodeMaterialBlock {
  66366. /**
  66367. * Creates a new SubtractBlock
  66368. * @param name defines the block name
  66369. */
  66370. constructor(name: string);
  66371. /**
  66372. * Gets the current class name
  66373. * @returns the class name
  66374. */
  66375. getClassName(): string;
  66376. /**
  66377. * Gets the left operand input component
  66378. */
  66379. get left(): NodeMaterialConnectionPoint;
  66380. /**
  66381. * Gets the right operand input component
  66382. */
  66383. get right(): NodeMaterialConnectionPoint;
  66384. /**
  66385. * Gets the output component
  66386. */
  66387. get output(): NodeMaterialConnectionPoint;
  66388. protected _buildBlock(state: NodeMaterialBuildState): this;
  66389. }
  66390. }
  66391. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66392. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66393. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66394. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66395. /**
  66396. * Block used to step a value
  66397. */
  66398. export class StepBlock extends NodeMaterialBlock {
  66399. /**
  66400. * Creates a new StepBlock
  66401. * @param name defines the block name
  66402. */
  66403. constructor(name: string);
  66404. /**
  66405. * Gets the current class name
  66406. * @returns the class name
  66407. */
  66408. getClassName(): string;
  66409. /**
  66410. * Gets the value operand input component
  66411. */
  66412. get value(): NodeMaterialConnectionPoint;
  66413. /**
  66414. * Gets the edge operand input component
  66415. */
  66416. get edge(): NodeMaterialConnectionPoint;
  66417. /**
  66418. * Gets the output component
  66419. */
  66420. get output(): NodeMaterialConnectionPoint;
  66421. protected _buildBlock(state: NodeMaterialBuildState): this;
  66422. }
  66423. }
  66424. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66425. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66426. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66427. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66428. /**
  66429. * Block used to get the opposite (1 - x) of a value
  66430. */
  66431. export class OneMinusBlock extends NodeMaterialBlock {
  66432. /**
  66433. * Creates a new OneMinusBlock
  66434. * @param name defines the block name
  66435. */
  66436. constructor(name: string);
  66437. /**
  66438. * Gets the current class name
  66439. * @returns the class name
  66440. */
  66441. getClassName(): string;
  66442. /**
  66443. * Gets the input component
  66444. */
  66445. get input(): NodeMaterialConnectionPoint;
  66446. /**
  66447. * Gets the output component
  66448. */
  66449. get output(): NodeMaterialConnectionPoint;
  66450. protected _buildBlock(state: NodeMaterialBuildState): this;
  66451. }
  66452. }
  66453. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66454. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66455. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66456. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66457. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66458. /**
  66459. * Block used to get the view direction
  66460. */
  66461. export class ViewDirectionBlock extends NodeMaterialBlock {
  66462. /**
  66463. * Creates a new ViewDirectionBlock
  66464. * @param name defines the block name
  66465. */
  66466. constructor(name: string);
  66467. /**
  66468. * Gets the current class name
  66469. * @returns the class name
  66470. */
  66471. getClassName(): string;
  66472. /**
  66473. * Gets the world position component
  66474. */
  66475. get worldPosition(): NodeMaterialConnectionPoint;
  66476. /**
  66477. * Gets the camera position component
  66478. */
  66479. get cameraPosition(): NodeMaterialConnectionPoint;
  66480. /**
  66481. * Gets the output component
  66482. */
  66483. get output(): NodeMaterialConnectionPoint;
  66484. autoConfigure(material: NodeMaterial): void;
  66485. protected _buildBlock(state: NodeMaterialBuildState): this;
  66486. }
  66487. }
  66488. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66489. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66490. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66491. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66492. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66493. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66494. /**
  66495. * Block used to compute fresnel value
  66496. */
  66497. export class FresnelBlock extends NodeMaterialBlock {
  66498. /**
  66499. * Create a new FresnelBlock
  66500. * @param name defines the block name
  66501. */
  66502. constructor(name: string);
  66503. /**
  66504. * Gets the current class name
  66505. * @returns the class name
  66506. */
  66507. getClassName(): string;
  66508. /**
  66509. * Gets the world normal input component
  66510. */
  66511. get worldNormal(): NodeMaterialConnectionPoint;
  66512. /**
  66513. * Gets the view direction input component
  66514. */
  66515. get viewDirection(): NodeMaterialConnectionPoint;
  66516. /**
  66517. * Gets the bias input component
  66518. */
  66519. get bias(): NodeMaterialConnectionPoint;
  66520. /**
  66521. * Gets the camera (or eye) position component
  66522. */
  66523. get power(): NodeMaterialConnectionPoint;
  66524. /**
  66525. * Gets the fresnel output component
  66526. */
  66527. get fresnel(): NodeMaterialConnectionPoint;
  66528. autoConfigure(material: NodeMaterial): void;
  66529. protected _buildBlock(state: NodeMaterialBuildState): this;
  66530. }
  66531. }
  66532. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66533. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66534. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66535. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66536. /**
  66537. * Block used to get the max of 2 values
  66538. */
  66539. export class MaxBlock extends NodeMaterialBlock {
  66540. /**
  66541. * Creates a new MaxBlock
  66542. * @param name defines the block name
  66543. */
  66544. constructor(name: string);
  66545. /**
  66546. * Gets the current class name
  66547. * @returns the class name
  66548. */
  66549. getClassName(): string;
  66550. /**
  66551. * Gets the left operand input component
  66552. */
  66553. get left(): NodeMaterialConnectionPoint;
  66554. /**
  66555. * Gets the right operand input component
  66556. */
  66557. get right(): NodeMaterialConnectionPoint;
  66558. /**
  66559. * Gets the output component
  66560. */
  66561. get output(): NodeMaterialConnectionPoint;
  66562. protected _buildBlock(state: NodeMaterialBuildState): this;
  66563. }
  66564. }
  66565. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66566. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66567. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66568. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66569. /**
  66570. * Block used to get the min of 2 values
  66571. */
  66572. export class MinBlock extends NodeMaterialBlock {
  66573. /**
  66574. * Creates a new MinBlock
  66575. * @param name defines the block name
  66576. */
  66577. constructor(name: string);
  66578. /**
  66579. * Gets the current class name
  66580. * @returns the class name
  66581. */
  66582. getClassName(): string;
  66583. /**
  66584. * Gets the left operand input component
  66585. */
  66586. get left(): NodeMaterialConnectionPoint;
  66587. /**
  66588. * Gets the right operand input component
  66589. */
  66590. get right(): NodeMaterialConnectionPoint;
  66591. /**
  66592. * Gets the output component
  66593. */
  66594. get output(): NodeMaterialConnectionPoint;
  66595. protected _buildBlock(state: NodeMaterialBuildState): this;
  66596. }
  66597. }
  66598. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66599. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66600. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66601. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66602. /**
  66603. * Block used to get the distance between 2 values
  66604. */
  66605. export class DistanceBlock extends NodeMaterialBlock {
  66606. /**
  66607. * Creates a new DistanceBlock
  66608. * @param name defines the block name
  66609. */
  66610. constructor(name: string);
  66611. /**
  66612. * Gets the current class name
  66613. * @returns the class name
  66614. */
  66615. getClassName(): string;
  66616. /**
  66617. * Gets the left operand input component
  66618. */
  66619. get left(): NodeMaterialConnectionPoint;
  66620. /**
  66621. * Gets the right operand input component
  66622. */
  66623. get right(): NodeMaterialConnectionPoint;
  66624. /**
  66625. * Gets the output component
  66626. */
  66627. get output(): NodeMaterialConnectionPoint;
  66628. protected _buildBlock(state: NodeMaterialBuildState): this;
  66629. }
  66630. }
  66631. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66632. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66633. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66634. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66635. /**
  66636. * Block used to get the length of a vector
  66637. */
  66638. export class LengthBlock extends NodeMaterialBlock {
  66639. /**
  66640. * Creates a new LengthBlock
  66641. * @param name defines the block name
  66642. */
  66643. constructor(name: string);
  66644. /**
  66645. * Gets the current class name
  66646. * @returns the class name
  66647. */
  66648. getClassName(): string;
  66649. /**
  66650. * Gets the value input component
  66651. */
  66652. get value(): NodeMaterialConnectionPoint;
  66653. /**
  66654. * Gets the output component
  66655. */
  66656. get output(): NodeMaterialConnectionPoint;
  66657. protected _buildBlock(state: NodeMaterialBuildState): this;
  66658. }
  66659. }
  66660. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66661. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66662. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66663. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66664. /**
  66665. * Block used to get negative version of a value (i.e. x * -1)
  66666. */
  66667. export class NegateBlock extends NodeMaterialBlock {
  66668. /**
  66669. * Creates a new NegateBlock
  66670. * @param name defines the block name
  66671. */
  66672. constructor(name: string);
  66673. /**
  66674. * Gets the current class name
  66675. * @returns the class name
  66676. */
  66677. getClassName(): string;
  66678. /**
  66679. * Gets the value input component
  66680. */
  66681. get value(): NodeMaterialConnectionPoint;
  66682. /**
  66683. * Gets the output component
  66684. */
  66685. get output(): NodeMaterialConnectionPoint;
  66686. protected _buildBlock(state: NodeMaterialBuildState): this;
  66687. }
  66688. }
  66689. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66690. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66691. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66692. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66693. /**
  66694. * Block used to get the value of the first parameter raised to the power of the second
  66695. */
  66696. export class PowBlock extends NodeMaterialBlock {
  66697. /**
  66698. * Creates a new PowBlock
  66699. * @param name defines the block name
  66700. */
  66701. constructor(name: string);
  66702. /**
  66703. * Gets the current class name
  66704. * @returns the class name
  66705. */
  66706. getClassName(): string;
  66707. /**
  66708. * Gets the value operand input component
  66709. */
  66710. get value(): NodeMaterialConnectionPoint;
  66711. /**
  66712. * Gets the power operand input component
  66713. */
  66714. get power(): NodeMaterialConnectionPoint;
  66715. /**
  66716. * Gets the output component
  66717. */
  66718. get output(): NodeMaterialConnectionPoint;
  66719. protected _buildBlock(state: NodeMaterialBuildState): this;
  66720. }
  66721. }
  66722. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66723. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66724. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66725. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66726. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66727. /**
  66728. * Block used to get a random number
  66729. */
  66730. export class RandomNumberBlock extends NodeMaterialBlock {
  66731. /**
  66732. * Creates a new RandomNumberBlock
  66733. * @param name defines the block name
  66734. */
  66735. constructor(name: string);
  66736. /**
  66737. * Gets the current class name
  66738. * @returns the class name
  66739. */
  66740. getClassName(): string;
  66741. /**
  66742. * Gets the seed input component
  66743. */
  66744. get seed(): NodeMaterialConnectionPoint;
  66745. /**
  66746. * Gets the output component
  66747. */
  66748. get output(): NodeMaterialConnectionPoint;
  66749. protected _buildBlock(state: NodeMaterialBuildState): this;
  66750. }
  66751. }
  66752. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66753. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66754. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66755. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66756. /**
  66757. * Block used to compute arc tangent of 2 values
  66758. */
  66759. export class ArcTan2Block extends NodeMaterialBlock {
  66760. /**
  66761. * Creates a new ArcTan2Block
  66762. * @param name defines the block name
  66763. */
  66764. constructor(name: string);
  66765. /**
  66766. * Gets the current class name
  66767. * @returns the class name
  66768. */
  66769. getClassName(): string;
  66770. /**
  66771. * Gets the x operand input component
  66772. */
  66773. get x(): NodeMaterialConnectionPoint;
  66774. /**
  66775. * Gets the y operand input component
  66776. */
  66777. get y(): NodeMaterialConnectionPoint;
  66778. /**
  66779. * Gets the output component
  66780. */
  66781. get output(): NodeMaterialConnectionPoint;
  66782. protected _buildBlock(state: NodeMaterialBuildState): this;
  66783. }
  66784. }
  66785. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66786. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66787. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66788. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66789. /**
  66790. * Block used to smooth step a value
  66791. */
  66792. export class SmoothStepBlock extends NodeMaterialBlock {
  66793. /**
  66794. * Creates a new SmoothStepBlock
  66795. * @param name defines the block name
  66796. */
  66797. constructor(name: string);
  66798. /**
  66799. * Gets the current class name
  66800. * @returns the class name
  66801. */
  66802. getClassName(): string;
  66803. /**
  66804. * Gets the value operand input component
  66805. */
  66806. get value(): NodeMaterialConnectionPoint;
  66807. /**
  66808. * Gets the first edge operand input component
  66809. */
  66810. get edge0(): NodeMaterialConnectionPoint;
  66811. /**
  66812. * Gets the second edge operand input component
  66813. */
  66814. get edge1(): 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/reciprocalBlock" {
  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 reciprocal (1 / x) of a value
  66828. */
  66829. export class ReciprocalBlock extends NodeMaterialBlock {
  66830. /**
  66831. * Creates a new ReciprocalBlock
  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 input component
  66842. */
  66843. get input(): NodeMaterialConnectionPoint;
  66844. /**
  66845. * Gets the output component
  66846. */
  66847. get output(): NodeMaterialConnectionPoint;
  66848. protected _buildBlock(state: NodeMaterialBuildState): this;
  66849. }
  66850. }
  66851. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66852. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66853. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66854. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66855. /**
  66856. * Block used to replace a color by another one
  66857. */
  66858. export class ReplaceColorBlock extends NodeMaterialBlock {
  66859. /**
  66860. * Creates a new ReplaceColorBlock
  66861. * @param name defines the block name
  66862. */
  66863. constructor(name: string);
  66864. /**
  66865. * Gets the current class name
  66866. * @returns the class name
  66867. */
  66868. getClassName(): string;
  66869. /**
  66870. * Gets the value input component
  66871. */
  66872. get value(): NodeMaterialConnectionPoint;
  66873. /**
  66874. * Gets the reference input component
  66875. */
  66876. get reference(): NodeMaterialConnectionPoint;
  66877. /**
  66878. * Gets the distance input component
  66879. */
  66880. get distance(): NodeMaterialConnectionPoint;
  66881. /**
  66882. * Gets the replacement input component
  66883. */
  66884. get replacement(): NodeMaterialConnectionPoint;
  66885. /**
  66886. * Gets the output component
  66887. */
  66888. get output(): NodeMaterialConnectionPoint;
  66889. protected _buildBlock(state: NodeMaterialBuildState): this;
  66890. }
  66891. }
  66892. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66893. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66894. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66895. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66896. /**
  66897. * Block used to posterize a value
  66898. * @see https://en.wikipedia.org/wiki/Posterization
  66899. */
  66900. export class PosterizeBlock extends NodeMaterialBlock {
  66901. /**
  66902. * Creates a new PosterizeBlock
  66903. * @param name defines the block name
  66904. */
  66905. constructor(name: string);
  66906. /**
  66907. * Gets the current class name
  66908. * @returns the class name
  66909. */
  66910. getClassName(): string;
  66911. /**
  66912. * Gets the value input component
  66913. */
  66914. get value(): NodeMaterialConnectionPoint;
  66915. /**
  66916. * Gets the steps input component
  66917. */
  66918. get steps(): NodeMaterialConnectionPoint;
  66919. /**
  66920. * Gets the output component
  66921. */
  66922. get output(): NodeMaterialConnectionPoint;
  66923. protected _buildBlock(state: NodeMaterialBuildState): this;
  66924. }
  66925. }
  66926. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  66927. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66928. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66929. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66930. import { Scene } from "babylonjs/scene";
  66931. /**
  66932. * Operations supported by the Wave block
  66933. */
  66934. export enum WaveBlockKind {
  66935. /** SawTooth */
  66936. SawTooth = 0,
  66937. /** Square */
  66938. Square = 1,
  66939. /** Triangle */
  66940. Triangle = 2
  66941. }
  66942. /**
  66943. * Block used to apply wave operation to floats
  66944. */
  66945. export class WaveBlock extends NodeMaterialBlock {
  66946. /**
  66947. * Gets or sets the kibnd of wave to be applied by the block
  66948. */
  66949. kind: WaveBlockKind;
  66950. /**
  66951. * Creates a new WaveBlock
  66952. * @param name defines the block name
  66953. */
  66954. constructor(name: string);
  66955. /**
  66956. * Gets the current class name
  66957. * @returns the class name
  66958. */
  66959. getClassName(): string;
  66960. /**
  66961. * Gets the input component
  66962. */
  66963. get input(): NodeMaterialConnectionPoint;
  66964. /**
  66965. * Gets the output component
  66966. */
  66967. get output(): NodeMaterialConnectionPoint;
  66968. protected _buildBlock(state: NodeMaterialBuildState): this;
  66969. serialize(): any;
  66970. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66971. }
  66972. }
  66973. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  66974. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66975. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66976. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66977. import { Color3 } from "babylonjs/Maths/math.color";
  66978. import { Scene } from "babylonjs/scene";
  66979. /**
  66980. * Class used to store a color step for the GradientBlock
  66981. */
  66982. export class GradientBlockColorStep {
  66983. /**
  66984. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66985. */
  66986. step: number;
  66987. /**
  66988. * Gets or sets the color associated with this step
  66989. */
  66990. color: Color3;
  66991. /**
  66992. * Creates a new GradientBlockColorStep
  66993. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  66994. * @param color defines the color associated with this step
  66995. */
  66996. constructor(
  66997. /**
  66998. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66999. */
  67000. step: number,
  67001. /**
  67002. * Gets or sets the color associated with this step
  67003. */
  67004. color: Color3);
  67005. }
  67006. /**
  67007. * Block used to return a color from a gradient based on an input value between 0 and 1
  67008. */
  67009. export class GradientBlock extends NodeMaterialBlock {
  67010. /**
  67011. * Gets or sets the list of color steps
  67012. */
  67013. colorSteps: GradientBlockColorStep[];
  67014. /**
  67015. * Creates a new GradientBlock
  67016. * @param name defines the block name
  67017. */
  67018. constructor(name: string);
  67019. /**
  67020. * Gets the current class name
  67021. * @returns the class name
  67022. */
  67023. getClassName(): string;
  67024. /**
  67025. * Gets the gradient input component
  67026. */
  67027. get gradient(): NodeMaterialConnectionPoint;
  67028. /**
  67029. * Gets the output component
  67030. */
  67031. get output(): NodeMaterialConnectionPoint;
  67032. private _writeColorConstant;
  67033. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67034. serialize(): any;
  67035. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67036. protected _dumpPropertiesCode(): string;
  67037. }
  67038. }
  67039. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  67040. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67041. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67042. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67043. /**
  67044. * Block used to normalize lerp between 2 values
  67045. */
  67046. export class NLerpBlock extends NodeMaterialBlock {
  67047. /**
  67048. * Creates a new NLerpBlock
  67049. * @param name defines the block name
  67050. */
  67051. constructor(name: string);
  67052. /**
  67053. * Gets the current class name
  67054. * @returns the class name
  67055. */
  67056. getClassName(): string;
  67057. /**
  67058. * Gets the left operand input component
  67059. */
  67060. get left(): NodeMaterialConnectionPoint;
  67061. /**
  67062. * Gets the right operand input component
  67063. */
  67064. get right(): NodeMaterialConnectionPoint;
  67065. /**
  67066. * Gets the gradient operand input component
  67067. */
  67068. get gradient(): NodeMaterialConnectionPoint;
  67069. /**
  67070. * Gets the output component
  67071. */
  67072. get output(): NodeMaterialConnectionPoint;
  67073. protected _buildBlock(state: NodeMaterialBuildState): this;
  67074. }
  67075. }
  67076. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67077. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67078. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67079. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67080. import { Scene } from "babylonjs/scene";
  67081. /**
  67082. * block used to Generate a Worley Noise 3D Noise Pattern
  67083. */
  67084. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67085. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67086. manhattanDistance: boolean;
  67087. /**
  67088. * Creates a new WorleyNoise3DBlock
  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 seed input component
  67099. */
  67100. get seed(): NodeMaterialConnectionPoint;
  67101. /**
  67102. * Gets the jitter input component
  67103. */
  67104. get jitter(): NodeMaterialConnectionPoint;
  67105. /**
  67106. * Gets the output component
  67107. */
  67108. get output(): NodeMaterialConnectionPoint;
  67109. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67110. /**
  67111. * Exposes the properties to the UI?
  67112. */
  67113. protected _dumpPropertiesCode(): string;
  67114. /**
  67115. * Exposes the properties to the Seralize?
  67116. */
  67117. serialize(): any;
  67118. /**
  67119. * Exposes the properties to the deseralize?
  67120. */
  67121. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67122. }
  67123. }
  67124. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67125. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67126. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67127. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67128. /**
  67129. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67130. */
  67131. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67132. /**
  67133. * Creates a new SimplexPerlin3DBlock
  67134. * @param name defines the block name
  67135. */
  67136. constructor(name: string);
  67137. /**
  67138. * Gets the current class name
  67139. * @returns the class name
  67140. */
  67141. getClassName(): string;
  67142. /**
  67143. * Gets the seed operand input component
  67144. */
  67145. get seed(): NodeMaterialConnectionPoint;
  67146. /**
  67147. * Gets the output component
  67148. */
  67149. get output(): NodeMaterialConnectionPoint;
  67150. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67151. }
  67152. }
  67153. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67154. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67155. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67156. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67157. /**
  67158. * Block used to blend normals
  67159. */
  67160. export class NormalBlendBlock extends NodeMaterialBlock {
  67161. /**
  67162. * Creates a new NormalBlendBlock
  67163. * @param name defines the block name
  67164. */
  67165. constructor(name: string);
  67166. /**
  67167. * Gets the current class name
  67168. * @returns the class name
  67169. */
  67170. getClassName(): string;
  67171. /**
  67172. * Gets the first input component
  67173. */
  67174. get normalMap0(): NodeMaterialConnectionPoint;
  67175. /**
  67176. * Gets the second input component
  67177. */
  67178. get normalMap1(): NodeMaterialConnectionPoint;
  67179. /**
  67180. * Gets the output component
  67181. */
  67182. get output(): NodeMaterialConnectionPoint;
  67183. protected _buildBlock(state: NodeMaterialBuildState): this;
  67184. }
  67185. }
  67186. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67187. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67188. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67189. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67190. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67191. /**
  67192. * Block used to rotate a 2d vector by a given angle
  67193. */
  67194. export class Rotate2dBlock extends NodeMaterialBlock {
  67195. /**
  67196. * Creates a new Rotate2dBlock
  67197. * @param name defines the block name
  67198. */
  67199. constructor(name: string);
  67200. /**
  67201. * Gets the current class name
  67202. * @returns the class name
  67203. */
  67204. getClassName(): string;
  67205. /**
  67206. * Gets the input vector
  67207. */
  67208. get input(): NodeMaterialConnectionPoint;
  67209. /**
  67210. * Gets the input angle
  67211. */
  67212. get angle(): NodeMaterialConnectionPoint;
  67213. /**
  67214. * Gets the output component
  67215. */
  67216. get output(): NodeMaterialConnectionPoint;
  67217. autoConfigure(material: NodeMaterial): void;
  67218. protected _buildBlock(state: NodeMaterialBuildState): this;
  67219. }
  67220. }
  67221. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67222. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67223. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67224. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67225. /**
  67226. * Block used to get the reflected vector from a direction and a normal
  67227. */
  67228. export class ReflectBlock extends NodeMaterialBlock {
  67229. /**
  67230. * Creates a new ReflectBlock
  67231. * @param name defines the block name
  67232. */
  67233. constructor(name: string);
  67234. /**
  67235. * Gets the current class name
  67236. * @returns the class name
  67237. */
  67238. getClassName(): string;
  67239. /**
  67240. * Gets the incident component
  67241. */
  67242. get incident(): NodeMaterialConnectionPoint;
  67243. /**
  67244. * Gets the normal component
  67245. */
  67246. get normal(): NodeMaterialConnectionPoint;
  67247. /**
  67248. * Gets the output component
  67249. */
  67250. get output(): NodeMaterialConnectionPoint;
  67251. protected _buildBlock(state: NodeMaterialBuildState): this;
  67252. }
  67253. }
  67254. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67255. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67256. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67257. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67258. /**
  67259. * Block used to get the refracted vector from a direction and a normal
  67260. */
  67261. export class RefractBlock extends NodeMaterialBlock {
  67262. /**
  67263. * Creates a new RefractBlock
  67264. * @param name defines the block name
  67265. */
  67266. constructor(name: string);
  67267. /**
  67268. * Gets the current class name
  67269. * @returns the class name
  67270. */
  67271. getClassName(): string;
  67272. /**
  67273. * Gets the incident component
  67274. */
  67275. get incident(): NodeMaterialConnectionPoint;
  67276. /**
  67277. * Gets the normal component
  67278. */
  67279. get normal(): NodeMaterialConnectionPoint;
  67280. /**
  67281. * Gets the index of refraction component
  67282. */
  67283. get ior(): NodeMaterialConnectionPoint;
  67284. /**
  67285. * Gets the output component
  67286. */
  67287. get output(): NodeMaterialConnectionPoint;
  67288. protected _buildBlock(state: NodeMaterialBuildState): this;
  67289. }
  67290. }
  67291. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67292. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67293. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67294. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67295. /**
  67296. * Block used to desaturate a color
  67297. */
  67298. export class DesaturateBlock extends NodeMaterialBlock {
  67299. /**
  67300. * Creates a new DesaturateBlock
  67301. * @param name defines the block name
  67302. */
  67303. constructor(name: string);
  67304. /**
  67305. * Gets the current class name
  67306. * @returns the class name
  67307. */
  67308. getClassName(): string;
  67309. /**
  67310. * Gets the color operand input component
  67311. */
  67312. get color(): NodeMaterialConnectionPoint;
  67313. /**
  67314. * Gets the level operand input component
  67315. */
  67316. get level(): NodeMaterialConnectionPoint;
  67317. /**
  67318. * Gets the output component
  67319. */
  67320. get output(): NodeMaterialConnectionPoint;
  67321. protected _buildBlock(state: NodeMaterialBuildState): this;
  67322. }
  67323. }
  67324. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67325. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67326. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67327. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67328. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67329. import { Nullable } from "babylonjs/types";
  67330. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67331. import { Scene } from "babylonjs/scene";
  67332. /**
  67333. * Block used to implement the ambient occlusion module of the PBR material
  67334. */
  67335. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67336. /**
  67337. * Create a new AmbientOcclusionBlock
  67338. * @param name defines the block name
  67339. */
  67340. constructor(name: string);
  67341. /**
  67342. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67343. */
  67344. useAmbientInGrayScale: boolean;
  67345. /**
  67346. * Initialize the block and prepare the context for build
  67347. * @param state defines the state that will be used for the build
  67348. */
  67349. initialize(state: NodeMaterialBuildState): void;
  67350. /**
  67351. * Gets the current class name
  67352. * @returns the class name
  67353. */
  67354. getClassName(): string;
  67355. /**
  67356. * Gets the texture input component
  67357. */
  67358. get texture(): NodeMaterialConnectionPoint;
  67359. /**
  67360. * Gets the texture intensity component
  67361. */
  67362. get intensity(): NodeMaterialConnectionPoint;
  67363. /**
  67364. * Gets the direct light intensity input component
  67365. */
  67366. get directLightIntensity(): NodeMaterialConnectionPoint;
  67367. /**
  67368. * Gets the ambient occlusion object output component
  67369. */
  67370. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67371. /**
  67372. * Gets the main code of the block (fragment side)
  67373. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67374. * @returns the shader code
  67375. */
  67376. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67377. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67378. protected _buildBlock(state: NodeMaterialBuildState): this;
  67379. protected _dumpPropertiesCode(): string;
  67380. serialize(): any;
  67381. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67382. }
  67383. }
  67384. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67385. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67386. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67387. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67388. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67389. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67390. import { Nullable } from "babylonjs/types";
  67391. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67392. import { Mesh } from "babylonjs/Meshes/mesh";
  67393. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67394. import { Effect } from "babylonjs/Materials/effect";
  67395. import { Scene } from "babylonjs/scene";
  67396. /**
  67397. * Block used to implement the reflection module of the PBR material
  67398. */
  67399. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67400. /** @hidden */
  67401. _defineLODReflectionAlpha: string;
  67402. /** @hidden */
  67403. _defineLinearSpecularReflection: string;
  67404. private _vEnvironmentIrradianceName;
  67405. /** @hidden */
  67406. _vReflectionMicrosurfaceInfosName: string;
  67407. /** @hidden */
  67408. _vReflectionInfosName: string;
  67409. /** @hidden */
  67410. _vReflectionFilteringInfoName: string;
  67411. private _scene;
  67412. /**
  67413. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67414. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67415. * It's less burden on the user side in the editor part.
  67416. */
  67417. /** @hidden */
  67418. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67419. /** @hidden */
  67420. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67421. /** @hidden */
  67422. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67423. /**
  67424. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67425. * diffuse part of the IBL.
  67426. */
  67427. useSphericalHarmonics: boolean;
  67428. /**
  67429. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67430. */
  67431. forceIrradianceInFragment: boolean;
  67432. /**
  67433. * Create a new ReflectionBlock
  67434. * @param name defines the block name
  67435. */
  67436. constructor(name: string);
  67437. /**
  67438. * Gets the current class name
  67439. * @returns the class name
  67440. */
  67441. getClassName(): string;
  67442. /**
  67443. * Gets the position input component
  67444. */
  67445. get position(): NodeMaterialConnectionPoint;
  67446. /**
  67447. * Gets the world position input component
  67448. */
  67449. get worldPosition(): NodeMaterialConnectionPoint;
  67450. /**
  67451. * Gets the world normal input component
  67452. */
  67453. get worldNormal(): NodeMaterialConnectionPoint;
  67454. /**
  67455. * Gets the world input component
  67456. */
  67457. get world(): NodeMaterialConnectionPoint;
  67458. /**
  67459. * Gets the camera (or eye) position component
  67460. */
  67461. get cameraPosition(): NodeMaterialConnectionPoint;
  67462. /**
  67463. * Gets the view input component
  67464. */
  67465. get view(): NodeMaterialConnectionPoint;
  67466. /**
  67467. * Gets the color input component
  67468. */
  67469. get color(): NodeMaterialConnectionPoint;
  67470. /**
  67471. * Gets the reflection object output component
  67472. */
  67473. get reflection(): NodeMaterialConnectionPoint;
  67474. /**
  67475. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67476. */
  67477. get hasTexture(): boolean;
  67478. /**
  67479. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67480. */
  67481. get reflectionColor(): string;
  67482. protected _getTexture(): Nullable<BaseTexture>;
  67483. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67484. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67485. /**
  67486. * Gets the code to inject in the vertex shader
  67487. * @param state current state of the node material building
  67488. * @returns the shader code
  67489. */
  67490. handleVertexSide(state: NodeMaterialBuildState): string;
  67491. /**
  67492. * Gets the main code of the block (fragment side)
  67493. * @param state current state of the node material building
  67494. * @param normalVarName name of the existing variable corresponding to the normal
  67495. * @returns the shader code
  67496. */
  67497. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67498. protected _buildBlock(state: NodeMaterialBuildState): this;
  67499. protected _dumpPropertiesCode(): string;
  67500. serialize(): any;
  67501. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67502. }
  67503. }
  67504. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67505. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67506. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67507. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67508. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67509. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67510. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67511. import { Scene } from "babylonjs/scene";
  67512. import { Nullable } from "babylonjs/types";
  67513. /**
  67514. * Block used to implement the sheen module of the PBR material
  67515. */
  67516. export class SheenBlock extends NodeMaterialBlock {
  67517. /**
  67518. * Create a new SheenBlock
  67519. * @param name defines the block name
  67520. */
  67521. constructor(name: string);
  67522. /**
  67523. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67524. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67525. * making it easier to setup and tweak the effect
  67526. */
  67527. albedoScaling: boolean;
  67528. /**
  67529. * Defines if the sheen is linked to the sheen color.
  67530. */
  67531. linkSheenWithAlbedo: boolean;
  67532. /**
  67533. * Initialize the block and prepare the context for build
  67534. * @param state defines the state that will be used for the build
  67535. */
  67536. initialize(state: NodeMaterialBuildState): void;
  67537. /**
  67538. * Gets the current class name
  67539. * @returns the class name
  67540. */
  67541. getClassName(): string;
  67542. /**
  67543. * Gets the intensity input component
  67544. */
  67545. get intensity(): NodeMaterialConnectionPoint;
  67546. /**
  67547. * Gets the color input component
  67548. */
  67549. get color(): NodeMaterialConnectionPoint;
  67550. /**
  67551. * Gets the roughness input component
  67552. */
  67553. get roughness(): NodeMaterialConnectionPoint;
  67554. /**
  67555. * Gets the sheen object output component
  67556. */
  67557. get sheen(): NodeMaterialConnectionPoint;
  67558. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67559. /**
  67560. * Gets the main code of the block (fragment side)
  67561. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67562. * @returns the shader code
  67563. */
  67564. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67565. protected _buildBlock(state: NodeMaterialBuildState): this;
  67566. protected _dumpPropertiesCode(): string;
  67567. serialize(): any;
  67568. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67569. }
  67570. }
  67571. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67572. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67573. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67574. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67575. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67576. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67577. import { Scene } from "babylonjs/scene";
  67578. import { Nullable } from "babylonjs/types";
  67579. import { Mesh } from "babylonjs/Meshes/mesh";
  67580. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67581. import { Effect } from "babylonjs/Materials/effect";
  67582. /**
  67583. * Block used to implement the reflectivity module of the PBR material
  67584. */
  67585. export class ReflectivityBlock extends NodeMaterialBlock {
  67586. private _metallicReflectanceColor;
  67587. private _metallicF0Factor;
  67588. /** @hidden */
  67589. _vMetallicReflectanceFactorsName: string;
  67590. /**
  67591. * The property below is set by the main PBR block prior to calling methods of this class.
  67592. */
  67593. /** @hidden */
  67594. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67595. /**
  67596. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67597. */
  67598. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67599. /**
  67600. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67601. */
  67602. useMetallnessFromMetallicTextureBlue: boolean;
  67603. /**
  67604. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67605. */
  67606. useRoughnessFromMetallicTextureAlpha: boolean;
  67607. /**
  67608. * Specifies if the metallic texture contains the roughness information in its green channel.
  67609. */
  67610. useRoughnessFromMetallicTextureGreen: boolean;
  67611. /**
  67612. * Create a new ReflectivityBlock
  67613. * @param name defines the block name
  67614. */
  67615. constructor(name: string);
  67616. /**
  67617. * Initialize the block and prepare the context for build
  67618. * @param state defines the state that will be used for the build
  67619. */
  67620. initialize(state: NodeMaterialBuildState): void;
  67621. /**
  67622. * Gets the current class name
  67623. * @returns the class name
  67624. */
  67625. getClassName(): string;
  67626. /**
  67627. * Gets the metallic input component
  67628. */
  67629. get metallic(): NodeMaterialConnectionPoint;
  67630. /**
  67631. * Gets the roughness input component
  67632. */
  67633. get roughness(): NodeMaterialConnectionPoint;
  67634. /**
  67635. * Gets the texture input component
  67636. */
  67637. get texture(): NodeMaterialConnectionPoint;
  67638. /**
  67639. * Gets the reflectivity object output component
  67640. */
  67641. get reflectivity(): NodeMaterialConnectionPoint;
  67642. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67643. /**
  67644. * Gets the main code of the block (fragment side)
  67645. * @param state current state of the node material building
  67646. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67647. * @returns the shader code
  67648. */
  67649. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67650. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67651. protected _buildBlock(state: NodeMaterialBuildState): this;
  67652. protected _dumpPropertiesCode(): string;
  67653. serialize(): any;
  67654. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67655. }
  67656. }
  67657. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67658. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67659. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67660. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67661. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67662. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67663. /**
  67664. * Block used to implement the anisotropy module of the PBR material
  67665. */
  67666. export class AnisotropyBlock extends NodeMaterialBlock {
  67667. /**
  67668. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67669. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67670. * It's less burden on the user side in the editor part.
  67671. */
  67672. /** @hidden */
  67673. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67674. /** @hidden */
  67675. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67676. /**
  67677. * Create a new AnisotropyBlock
  67678. * @param name defines the block name
  67679. */
  67680. constructor(name: string);
  67681. /**
  67682. * Initialize the block and prepare the context for build
  67683. * @param state defines the state that will be used for the build
  67684. */
  67685. initialize(state: NodeMaterialBuildState): void;
  67686. /**
  67687. * Gets the current class name
  67688. * @returns the class name
  67689. */
  67690. getClassName(): string;
  67691. /**
  67692. * Gets the intensity input component
  67693. */
  67694. get intensity(): NodeMaterialConnectionPoint;
  67695. /**
  67696. * Gets the direction input component
  67697. */
  67698. get direction(): NodeMaterialConnectionPoint;
  67699. /**
  67700. * Gets the texture input component
  67701. */
  67702. get texture(): NodeMaterialConnectionPoint;
  67703. /**
  67704. * Gets the uv input component
  67705. */
  67706. get uv(): NodeMaterialConnectionPoint;
  67707. /**
  67708. * Gets the worldTangent input component
  67709. */
  67710. get worldTangent(): NodeMaterialConnectionPoint;
  67711. /**
  67712. * Gets the anisotropy object output component
  67713. */
  67714. get anisotropy(): NodeMaterialConnectionPoint;
  67715. private _generateTBNSpace;
  67716. /**
  67717. * Gets the main code of the block (fragment side)
  67718. * @param state current state of the node material building
  67719. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67720. * @returns the shader code
  67721. */
  67722. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67723. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67724. protected _buildBlock(state: NodeMaterialBuildState): this;
  67725. }
  67726. }
  67727. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67728. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67729. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67730. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67731. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67732. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67733. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67734. import { Nullable } from "babylonjs/types";
  67735. import { Mesh } from "babylonjs/Meshes/mesh";
  67736. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67737. import { Effect } from "babylonjs/Materials/effect";
  67738. /**
  67739. * Block used to implement the clear coat module of the PBR material
  67740. */
  67741. export class ClearCoatBlock extends NodeMaterialBlock {
  67742. private _scene;
  67743. /**
  67744. * Create a new ClearCoatBlock
  67745. * @param name defines the block name
  67746. */
  67747. constructor(name: string);
  67748. /**
  67749. * Initialize the block and prepare the context for build
  67750. * @param state defines the state that will be used for the build
  67751. */
  67752. initialize(state: NodeMaterialBuildState): void;
  67753. /**
  67754. * Gets the current class name
  67755. * @returns the class name
  67756. */
  67757. getClassName(): string;
  67758. /**
  67759. * Gets the intensity input component
  67760. */
  67761. get intensity(): NodeMaterialConnectionPoint;
  67762. /**
  67763. * Gets the roughness input component
  67764. */
  67765. get roughness(): NodeMaterialConnectionPoint;
  67766. /**
  67767. * Gets the ior input component
  67768. */
  67769. get ior(): NodeMaterialConnectionPoint;
  67770. /**
  67771. * Gets the texture input component
  67772. */
  67773. get texture(): NodeMaterialConnectionPoint;
  67774. /**
  67775. * Gets the bump texture input component
  67776. */
  67777. get bumpTexture(): NodeMaterialConnectionPoint;
  67778. /**
  67779. * Gets the uv input component
  67780. */
  67781. get uv(): NodeMaterialConnectionPoint;
  67782. /**
  67783. * Gets the tint color input component
  67784. */
  67785. get tintColor(): NodeMaterialConnectionPoint;
  67786. /**
  67787. * Gets the tint "at distance" input component
  67788. */
  67789. get tintAtDistance(): NodeMaterialConnectionPoint;
  67790. /**
  67791. * Gets the tint thickness input component
  67792. */
  67793. get tintThickness(): NodeMaterialConnectionPoint;
  67794. /**
  67795. * Gets the world tangent input component
  67796. */
  67797. get worldTangent(): NodeMaterialConnectionPoint;
  67798. /**
  67799. * Gets the clear coat object output component
  67800. */
  67801. get clearcoat(): NodeMaterialConnectionPoint;
  67802. autoConfigure(material: NodeMaterial): void;
  67803. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67804. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67805. private _generateTBNSpace;
  67806. /**
  67807. * Gets the main code of the block (fragment side)
  67808. * @param state current state of the node material building
  67809. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67810. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67811. * @param worldPosVarName name of the variable holding the world position
  67812. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67813. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67814. * @param worldNormalVarName name of the variable holding the world normal
  67815. * @returns the shader code
  67816. */
  67817. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67818. protected _buildBlock(state: NodeMaterialBuildState): this;
  67819. }
  67820. }
  67821. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67822. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67823. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67824. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67825. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67826. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67827. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67828. import { Nullable } from "babylonjs/types";
  67829. /**
  67830. * Block used to implement the sub surface module of the PBR material
  67831. */
  67832. export class SubSurfaceBlock extends NodeMaterialBlock {
  67833. /**
  67834. * Create a new SubSurfaceBlock
  67835. * @param name defines the block name
  67836. */
  67837. constructor(name: string);
  67838. /**
  67839. * Stores the intensity of the different subsurface effects in the thickness texture.
  67840. * * the green channel is the translucency intensity.
  67841. * * the blue channel is the scattering intensity.
  67842. * * the alpha channel is the refraction intensity.
  67843. */
  67844. useMaskFromThicknessTexture: boolean;
  67845. /**
  67846. * Initialize the block and prepare the context for build
  67847. * @param state defines the state that will be used for the build
  67848. */
  67849. initialize(state: NodeMaterialBuildState): void;
  67850. /**
  67851. * Gets the current class name
  67852. * @returns the class name
  67853. */
  67854. getClassName(): string;
  67855. /**
  67856. * Gets the min thickness input component
  67857. */
  67858. get minThickness(): NodeMaterialConnectionPoint;
  67859. /**
  67860. * Gets the max thickness input component
  67861. */
  67862. get maxThickness(): NodeMaterialConnectionPoint;
  67863. /**
  67864. * Gets the thickness texture component
  67865. */
  67866. get thicknessTexture(): NodeMaterialConnectionPoint;
  67867. /**
  67868. * Gets the tint color input component
  67869. */
  67870. get tintColor(): NodeMaterialConnectionPoint;
  67871. /**
  67872. * Gets the translucency intensity input component
  67873. */
  67874. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67875. /**
  67876. * Gets the translucency diffusion distance input component
  67877. */
  67878. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67879. /**
  67880. * Gets the refraction object parameters
  67881. */
  67882. get refraction(): NodeMaterialConnectionPoint;
  67883. /**
  67884. * Gets the sub surface object output component
  67885. */
  67886. get subsurface(): NodeMaterialConnectionPoint;
  67887. autoConfigure(material: NodeMaterial): void;
  67888. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67889. /**
  67890. * Gets the main code of the block (fragment side)
  67891. * @param state current state of the node material building
  67892. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67893. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67894. * @param worldPosVarName name of the variable holding the world position
  67895. * @returns the shader code
  67896. */
  67897. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67898. protected _buildBlock(state: NodeMaterialBuildState): this;
  67899. }
  67900. }
  67901. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67902. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67903. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67904. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67905. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67906. import { Light } from "babylonjs/Lights/light";
  67907. import { Nullable } from "babylonjs/types";
  67908. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67909. import { Effect } from "babylonjs/Materials/effect";
  67910. import { Mesh } from "babylonjs/Meshes/mesh";
  67911. import { Scene } from "babylonjs/scene";
  67912. /**
  67913. * Block used to implement the PBR metallic/roughness model
  67914. */
  67915. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  67916. /**
  67917. * Gets or sets the light associated with this block
  67918. */
  67919. light: Nullable<Light>;
  67920. private _lightId;
  67921. private _scene;
  67922. private _environmentBRDFTexture;
  67923. private _environmentBrdfSamplerName;
  67924. private _vNormalWName;
  67925. private _invertNormalName;
  67926. /**
  67927. * Create a new ReflectionBlock
  67928. * @param name defines the block name
  67929. */
  67930. constructor(name: string);
  67931. /**
  67932. * Intensity of the direct lights e.g. the four lights available in your scene.
  67933. * This impacts both the direct diffuse and specular highlights.
  67934. */
  67935. directIntensity: number;
  67936. /**
  67937. * Intensity of the environment e.g. how much the environment will light the object
  67938. * either through harmonics for rough material or through the refelction for shiny ones.
  67939. */
  67940. environmentIntensity: number;
  67941. /**
  67942. * This is a special control allowing the reduction of the specular highlights coming from the
  67943. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  67944. */
  67945. specularIntensity: number;
  67946. /**
  67947. * Defines the falloff type used in this material.
  67948. * It by default is Physical.
  67949. */
  67950. lightFalloff: number;
  67951. /**
  67952. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  67953. */
  67954. useAlphaFromAlbedoTexture: boolean;
  67955. /**
  67956. * Specifies that alpha test should be used
  67957. */
  67958. useAlphaTest: boolean;
  67959. /**
  67960. * Defines the alpha limits in alpha test mode.
  67961. */
  67962. alphaTestCutoff: number;
  67963. /**
  67964. * Specifies that alpha blending should be used
  67965. */
  67966. useAlphaBlending: boolean;
  67967. /**
  67968. * Defines if the alpha value should be determined via the rgb values.
  67969. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  67970. */
  67971. opacityRGB: boolean;
  67972. /**
  67973. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  67974. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  67975. */
  67976. useRadianceOverAlpha: boolean;
  67977. /**
  67978. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  67979. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  67980. */
  67981. useSpecularOverAlpha: boolean;
  67982. /**
  67983. * Enables specular anti aliasing in the PBR shader.
  67984. * It will both interacts on the Geometry for analytical and IBL lighting.
  67985. * It also prefilter the roughness map based on the bump values.
  67986. */
  67987. enableSpecularAntiAliasing: boolean;
  67988. /**
  67989. * Enables realtime filtering on the texture.
  67990. */
  67991. realTimeFiltering: boolean;
  67992. /**
  67993. * Quality switch for realtime filtering
  67994. */
  67995. realTimeFilteringQuality: number;
  67996. /**
  67997. * Defines if the material uses energy conservation.
  67998. */
  67999. useEnergyConservation: boolean;
  68000. /**
  68001. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  68002. * too much the area relying on ambient texture to define their ambient occlusion.
  68003. */
  68004. useRadianceOcclusion: boolean;
  68005. /**
  68006. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  68007. * makes the reflect vector face the model (under horizon).
  68008. */
  68009. useHorizonOcclusion: boolean;
  68010. /**
  68011. * If set to true, no lighting calculations will be applied.
  68012. */
  68013. unlit: boolean;
  68014. /**
  68015. * Force normal to face away from face.
  68016. */
  68017. forceNormalForward: boolean;
  68018. /**
  68019. * Defines the material debug mode.
  68020. * It helps seeing only some components of the material while troubleshooting.
  68021. */
  68022. debugMode: number;
  68023. /**
  68024. * Specify from where on screen the debug mode should start.
  68025. * The value goes from -1 (full screen) to 1 (not visible)
  68026. * It helps with side by side comparison against the final render
  68027. * This defaults to 0
  68028. */
  68029. debugLimit: number;
  68030. /**
  68031. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68032. * You can use the factor to better multiply the final value.
  68033. */
  68034. debugFactor: number;
  68035. /**
  68036. * Initialize the block and prepare the context for build
  68037. * @param state defines the state that will be used for the build
  68038. */
  68039. initialize(state: NodeMaterialBuildState): void;
  68040. /**
  68041. * Gets the current class name
  68042. * @returns the class name
  68043. */
  68044. getClassName(): string;
  68045. /**
  68046. * Gets the world position input component
  68047. */
  68048. get worldPosition(): NodeMaterialConnectionPoint;
  68049. /**
  68050. * Gets the world normal input component
  68051. */
  68052. get worldNormal(): NodeMaterialConnectionPoint;
  68053. /**
  68054. * Gets the perturbed normal input component
  68055. */
  68056. get perturbedNormal(): NodeMaterialConnectionPoint;
  68057. /**
  68058. * Gets the camera position input component
  68059. */
  68060. get cameraPosition(): NodeMaterialConnectionPoint;
  68061. /**
  68062. * Gets the base color input component
  68063. */
  68064. get baseColor(): NodeMaterialConnectionPoint;
  68065. /**
  68066. * Gets the opacity texture input component
  68067. */
  68068. get opacityTexture(): NodeMaterialConnectionPoint;
  68069. /**
  68070. * Gets the ambient color input component
  68071. */
  68072. get ambientColor(): NodeMaterialConnectionPoint;
  68073. /**
  68074. * Gets the reflectivity object parameters
  68075. */
  68076. get reflectivity(): NodeMaterialConnectionPoint;
  68077. /**
  68078. * Gets the ambient occlusion object parameters
  68079. */
  68080. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68081. /**
  68082. * Gets the reflection object parameters
  68083. */
  68084. get reflection(): NodeMaterialConnectionPoint;
  68085. /**
  68086. * Gets the sheen object parameters
  68087. */
  68088. get sheen(): NodeMaterialConnectionPoint;
  68089. /**
  68090. * Gets the clear coat object parameters
  68091. */
  68092. get clearcoat(): NodeMaterialConnectionPoint;
  68093. /**
  68094. * Gets the sub surface object parameters
  68095. */
  68096. get subsurface(): NodeMaterialConnectionPoint;
  68097. /**
  68098. * Gets the anisotropy object parameters
  68099. */
  68100. get anisotropy(): NodeMaterialConnectionPoint;
  68101. /**
  68102. * Gets the ambient output component
  68103. */
  68104. get ambient(): NodeMaterialConnectionPoint;
  68105. /**
  68106. * Gets the diffuse output component
  68107. */
  68108. get diffuse(): NodeMaterialConnectionPoint;
  68109. /**
  68110. * Gets the specular output component
  68111. */
  68112. get specular(): NodeMaterialConnectionPoint;
  68113. /**
  68114. * Gets the sheen output component
  68115. */
  68116. get sheenDir(): NodeMaterialConnectionPoint;
  68117. /**
  68118. * Gets the clear coat output component
  68119. */
  68120. get clearcoatDir(): NodeMaterialConnectionPoint;
  68121. /**
  68122. * Gets the indirect diffuse output component
  68123. */
  68124. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68125. /**
  68126. * Gets the indirect specular output component
  68127. */
  68128. get specularIndirect(): NodeMaterialConnectionPoint;
  68129. /**
  68130. * Gets the indirect sheen output component
  68131. */
  68132. get sheenIndirect(): NodeMaterialConnectionPoint;
  68133. /**
  68134. * Gets the indirect clear coat output component
  68135. */
  68136. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68137. /**
  68138. * Gets the refraction output component
  68139. */
  68140. get refraction(): NodeMaterialConnectionPoint;
  68141. /**
  68142. * Gets the global lighting output component
  68143. */
  68144. get lighting(): NodeMaterialConnectionPoint;
  68145. /**
  68146. * Gets the shadow output component
  68147. */
  68148. get shadow(): NodeMaterialConnectionPoint;
  68149. /**
  68150. * Gets the alpha output component
  68151. */
  68152. get alpha(): NodeMaterialConnectionPoint;
  68153. autoConfigure(material: NodeMaterial): void;
  68154. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68155. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68156. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68157. private _injectVertexCode;
  68158. /**
  68159. * Gets the code corresponding to the albedo/opacity module
  68160. * @returns the shader code
  68161. */
  68162. getAlbedoOpacityCode(): string;
  68163. protected _buildBlock(state: NodeMaterialBuildState): this;
  68164. protected _dumpPropertiesCode(): string;
  68165. serialize(): any;
  68166. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68167. }
  68168. }
  68169. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68170. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68171. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68172. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68173. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68174. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68175. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68176. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68177. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68178. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68179. }
  68180. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68181. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68182. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68183. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68184. }
  68185. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68186. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68187. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68188. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68189. /**
  68190. * Block used to compute value of one parameter modulo another
  68191. */
  68192. export class ModBlock extends NodeMaterialBlock {
  68193. /**
  68194. * Creates a new ModBlock
  68195. * @param name defines the block name
  68196. */
  68197. constructor(name: string);
  68198. /**
  68199. * Gets the current class name
  68200. * @returns the class name
  68201. */
  68202. getClassName(): string;
  68203. /**
  68204. * Gets the left operand input component
  68205. */
  68206. get left(): NodeMaterialConnectionPoint;
  68207. /**
  68208. * Gets the right operand input component
  68209. */
  68210. get right(): NodeMaterialConnectionPoint;
  68211. /**
  68212. * Gets the output component
  68213. */
  68214. get output(): NodeMaterialConnectionPoint;
  68215. protected _buildBlock(state: NodeMaterialBuildState): this;
  68216. }
  68217. }
  68218. declare module "babylonjs/Materials/Node/Blocks/index" {
  68219. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68220. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68221. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68222. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68223. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68224. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68225. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68226. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68227. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68228. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68229. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68230. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68231. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68232. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68233. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68234. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68235. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68236. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68237. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68238. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68239. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68240. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68241. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68242. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68243. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68244. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68245. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68246. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68247. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68248. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68249. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68250. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68251. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68252. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68253. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68254. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68255. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68256. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68257. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68258. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68259. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68260. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68261. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68262. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68263. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68264. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68265. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68266. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68267. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68268. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68269. }
  68270. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68271. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68272. }
  68273. declare module "babylonjs/Materials/Node/index" {
  68274. export * from "babylonjs/Materials/Node/Enums/index";
  68275. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68276. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68277. export * from "babylonjs/Materials/Node/nodeMaterial";
  68278. export * from "babylonjs/Materials/Node/Blocks/index";
  68279. export * from "babylonjs/Materials/Node/Optimizers/index";
  68280. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68281. }
  68282. declare module "babylonjs/Materials/index" {
  68283. export * from "babylonjs/Materials/Background/index";
  68284. export * from "babylonjs/Materials/colorCurves";
  68285. export * from "babylonjs/Materials/iEffectFallbacks";
  68286. export * from "babylonjs/Materials/effectFallbacks";
  68287. export * from "babylonjs/Materials/effect";
  68288. export * from "babylonjs/Materials/fresnelParameters";
  68289. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68290. export * from "babylonjs/Materials/material";
  68291. export * from "babylonjs/Materials/materialDefines";
  68292. export * from "babylonjs/Materials/thinMaterialHelper";
  68293. export * from "babylonjs/Materials/materialHelper";
  68294. export * from "babylonjs/Materials/multiMaterial";
  68295. export * from "babylonjs/Materials/PBR/index";
  68296. export * from "babylonjs/Materials/pushMaterial";
  68297. export * from "babylonjs/Materials/shaderMaterial";
  68298. export * from "babylonjs/Materials/standardMaterial";
  68299. export * from "babylonjs/Materials/Textures/index";
  68300. export * from "babylonjs/Materials/uniformBuffer";
  68301. export * from "babylonjs/Materials/materialFlags";
  68302. export * from "babylonjs/Materials/Node/index";
  68303. export * from "babylonjs/Materials/effectRenderer";
  68304. export * from "babylonjs/Materials/shadowDepthWrapper";
  68305. }
  68306. declare module "babylonjs/Maths/index" {
  68307. export * from "babylonjs/Maths/math.scalar";
  68308. export * from "babylonjs/Maths/math";
  68309. export * from "babylonjs/Maths/sphericalPolynomial";
  68310. }
  68311. declare module "babylonjs/Misc/workerPool" {
  68312. import { IDisposable } from "babylonjs/scene";
  68313. /**
  68314. * Helper class to push actions to a pool of workers.
  68315. */
  68316. export class WorkerPool implements IDisposable {
  68317. private _workerInfos;
  68318. private _pendingActions;
  68319. /**
  68320. * Constructor
  68321. * @param workers Array of workers to use for actions
  68322. */
  68323. constructor(workers: Array<Worker>);
  68324. /**
  68325. * Terminates all workers and clears any pending actions.
  68326. */
  68327. dispose(): void;
  68328. /**
  68329. * Pushes an action to the worker pool. If all the workers are active, the action will be
  68330. * pended until a worker has completed its action.
  68331. * @param action The action to perform. Call onComplete when the action is complete.
  68332. */
  68333. push(action: (worker: Worker, onComplete: () => void) => void): void;
  68334. private _execute;
  68335. }
  68336. }
  68337. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68338. import { IDisposable } from "babylonjs/scene";
  68339. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68340. /**
  68341. * Configuration for Draco compression
  68342. */
  68343. export interface IDracoCompressionConfiguration {
  68344. /**
  68345. * Configuration for the decoder.
  68346. */
  68347. decoder: {
  68348. /**
  68349. * The url to the WebAssembly module.
  68350. */
  68351. wasmUrl?: string;
  68352. /**
  68353. * The url to the WebAssembly binary.
  68354. */
  68355. wasmBinaryUrl?: string;
  68356. /**
  68357. * The url to the fallback JavaScript module.
  68358. */
  68359. fallbackUrl?: string;
  68360. };
  68361. }
  68362. /**
  68363. * Draco compression (https://google.github.io/draco/)
  68364. *
  68365. * This class wraps the Draco module.
  68366. *
  68367. * **Encoder**
  68368. *
  68369. * The encoder is not currently implemented.
  68370. *
  68371. * **Decoder**
  68372. *
  68373. * 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.
  68374. *
  68375. * To update the configuration, use the following code:
  68376. * ```javascript
  68377. * DracoCompression.Configuration = {
  68378. * decoder: {
  68379. * wasmUrl: "<url to the WebAssembly library>",
  68380. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68381. * fallbackUrl: "<url to the fallback JavaScript library>",
  68382. * }
  68383. * };
  68384. * ```
  68385. *
  68386. * 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.
  68387. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68388. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68389. *
  68390. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68391. * ```javascript
  68392. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68393. * ```
  68394. *
  68395. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68396. */
  68397. export class DracoCompression implements IDisposable {
  68398. private _workerPoolPromise?;
  68399. private _decoderModulePromise?;
  68400. /**
  68401. * The configuration. Defaults to the following urls:
  68402. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68403. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68404. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68405. */
  68406. static Configuration: IDracoCompressionConfiguration;
  68407. /**
  68408. * Returns true if the decoder configuration is available.
  68409. */
  68410. static get DecoderAvailable(): boolean;
  68411. /**
  68412. * Default number of workers to create when creating the draco compression object.
  68413. */
  68414. static DefaultNumWorkers: number;
  68415. private static GetDefaultNumWorkers;
  68416. private static _Default;
  68417. /**
  68418. * Default instance for the draco compression object.
  68419. */
  68420. static get Default(): DracoCompression;
  68421. /**
  68422. * Constructor
  68423. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68424. */
  68425. constructor(numWorkers?: number);
  68426. /**
  68427. * Stop all async operations and release resources.
  68428. */
  68429. dispose(): void;
  68430. /**
  68431. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68432. * @returns a promise that resolves when ready
  68433. */
  68434. whenReadyAsync(): Promise<void>;
  68435. /**
  68436. * Decode Draco compressed mesh data to vertex data.
  68437. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68438. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68439. * @returns A promise that resolves with the decoded vertex data
  68440. */
  68441. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68442. [kind: string]: number;
  68443. }): Promise<VertexData>;
  68444. }
  68445. }
  68446. declare module "babylonjs/Meshes/Compression/index" {
  68447. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68448. }
  68449. declare module "babylonjs/Meshes/csg" {
  68450. import { Nullable } from "babylonjs/types";
  68451. import { Scene } from "babylonjs/scene";
  68452. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68453. import { Mesh } from "babylonjs/Meshes/mesh";
  68454. import { Material } from "babylonjs/Materials/material";
  68455. /**
  68456. * Class for building Constructive Solid Geometry
  68457. */
  68458. export class CSG {
  68459. private polygons;
  68460. /**
  68461. * The world matrix
  68462. */
  68463. matrix: Matrix;
  68464. /**
  68465. * Stores the position
  68466. */
  68467. position: Vector3;
  68468. /**
  68469. * Stores the rotation
  68470. */
  68471. rotation: Vector3;
  68472. /**
  68473. * Stores the rotation quaternion
  68474. */
  68475. rotationQuaternion: Nullable<Quaternion>;
  68476. /**
  68477. * Stores the scaling vector
  68478. */
  68479. scaling: Vector3;
  68480. /**
  68481. * Convert the Mesh to CSG
  68482. * @param mesh The Mesh to convert to CSG
  68483. * @returns A new CSG from the Mesh
  68484. */
  68485. static FromMesh(mesh: Mesh): CSG;
  68486. /**
  68487. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68488. * @param polygons Polygons used to construct a CSG solid
  68489. */
  68490. private static FromPolygons;
  68491. /**
  68492. * Clones, or makes a deep copy, of the CSG
  68493. * @returns A new CSG
  68494. */
  68495. clone(): CSG;
  68496. /**
  68497. * Unions this CSG with another CSG
  68498. * @param csg The CSG to union against this CSG
  68499. * @returns The unioned CSG
  68500. */
  68501. union(csg: CSG): CSG;
  68502. /**
  68503. * Unions this CSG with another CSG in place
  68504. * @param csg The CSG to union against this CSG
  68505. */
  68506. unionInPlace(csg: CSG): void;
  68507. /**
  68508. * Subtracts this CSG with another CSG
  68509. * @param csg The CSG to subtract against this CSG
  68510. * @returns A new CSG
  68511. */
  68512. subtract(csg: CSG): CSG;
  68513. /**
  68514. * Subtracts this CSG with another CSG in place
  68515. * @param csg The CSG to subtact against this CSG
  68516. */
  68517. subtractInPlace(csg: CSG): void;
  68518. /**
  68519. * Intersect this CSG with another CSG
  68520. * @param csg The CSG to intersect against this CSG
  68521. * @returns A new CSG
  68522. */
  68523. intersect(csg: CSG): CSG;
  68524. /**
  68525. * Intersects this CSG with another CSG in place
  68526. * @param csg The CSG to intersect against this CSG
  68527. */
  68528. intersectInPlace(csg: CSG): void;
  68529. /**
  68530. * Return a new CSG solid with solid and empty space switched. This solid is
  68531. * not modified.
  68532. * @returns A new CSG solid with solid and empty space switched
  68533. */
  68534. inverse(): CSG;
  68535. /**
  68536. * Inverses the CSG in place
  68537. */
  68538. inverseInPlace(): void;
  68539. /**
  68540. * This is used to keep meshes transformations so they can be restored
  68541. * when we build back a Babylon Mesh
  68542. * NB : All CSG operations are performed in world coordinates
  68543. * @param csg The CSG to copy the transform attributes from
  68544. * @returns This CSG
  68545. */
  68546. copyTransformAttributes(csg: CSG): CSG;
  68547. /**
  68548. * Build Raw mesh from CSG
  68549. * Coordinates here are in world space
  68550. * @param name The name of the mesh geometry
  68551. * @param scene The Scene
  68552. * @param keepSubMeshes Specifies if the submeshes should be kept
  68553. * @returns A new Mesh
  68554. */
  68555. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68556. /**
  68557. * Build Mesh from CSG taking material and transforms into account
  68558. * @param name The name of the Mesh
  68559. * @param material The material of the Mesh
  68560. * @param scene The Scene
  68561. * @param keepSubMeshes Specifies if submeshes should be kept
  68562. * @returns The new Mesh
  68563. */
  68564. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68565. }
  68566. }
  68567. declare module "babylonjs/Meshes/trailMesh" {
  68568. import { Mesh } from "babylonjs/Meshes/mesh";
  68569. import { Scene } from "babylonjs/scene";
  68570. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68571. /**
  68572. * Class used to create a trail following a mesh
  68573. */
  68574. export class TrailMesh extends Mesh {
  68575. private _generator;
  68576. private _autoStart;
  68577. private _running;
  68578. private _diameter;
  68579. private _length;
  68580. private _sectionPolygonPointsCount;
  68581. private _sectionVectors;
  68582. private _sectionNormalVectors;
  68583. private _beforeRenderObserver;
  68584. /**
  68585. * @constructor
  68586. * @param name The value used by scene.getMeshByName() to do a lookup.
  68587. * @param generator The mesh or transform node to generate a trail.
  68588. * @param scene The scene to add this mesh to.
  68589. * @param diameter Diameter of trailing mesh. Default is 1.
  68590. * @param length Length of trailing mesh. Default is 60.
  68591. * @param autoStart Automatically start trailing mesh. Default true.
  68592. */
  68593. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68594. /**
  68595. * "TrailMesh"
  68596. * @returns "TrailMesh"
  68597. */
  68598. getClassName(): string;
  68599. private _createMesh;
  68600. /**
  68601. * Start trailing mesh.
  68602. */
  68603. start(): void;
  68604. /**
  68605. * Stop trailing mesh.
  68606. */
  68607. stop(): void;
  68608. /**
  68609. * Update trailing mesh geometry.
  68610. */
  68611. update(): void;
  68612. /**
  68613. * Returns a new TrailMesh object.
  68614. * @param name is a string, the name given to the new mesh
  68615. * @param newGenerator use new generator object for cloned trail mesh
  68616. * @returns a new mesh
  68617. */
  68618. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68619. /**
  68620. * Serializes this trail mesh
  68621. * @param serializationObject object to write serialization to
  68622. */
  68623. serialize(serializationObject: any): void;
  68624. /**
  68625. * Parses a serialized trail mesh
  68626. * @param parsedMesh the serialized mesh
  68627. * @param scene the scene to create the trail mesh in
  68628. * @returns the created trail mesh
  68629. */
  68630. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68631. }
  68632. }
  68633. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68634. import { Nullable } from "babylonjs/types";
  68635. import { Scene } from "babylonjs/scene";
  68636. import { Vector4 } from "babylonjs/Maths/math.vector";
  68637. import { Color4 } from "babylonjs/Maths/math.color";
  68638. import { Mesh } from "babylonjs/Meshes/mesh";
  68639. /**
  68640. * Class containing static functions to help procedurally build meshes
  68641. */
  68642. export class TiledBoxBuilder {
  68643. /**
  68644. * Creates a box mesh
  68645. * 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)
  68646. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68647. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68648. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68649. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68650. * @param name defines the name of the mesh
  68651. * @param options defines the options used to create the mesh
  68652. * @param scene defines the hosting scene
  68653. * @returns the box mesh
  68654. */
  68655. static CreateTiledBox(name: string, options: {
  68656. pattern?: number;
  68657. width?: number;
  68658. height?: number;
  68659. depth?: number;
  68660. tileSize?: number;
  68661. tileWidth?: number;
  68662. tileHeight?: number;
  68663. alignHorizontal?: number;
  68664. alignVertical?: number;
  68665. faceUV?: Vector4[];
  68666. faceColors?: Color4[];
  68667. sideOrientation?: number;
  68668. updatable?: boolean;
  68669. }, scene?: Nullable<Scene>): Mesh;
  68670. }
  68671. }
  68672. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68673. import { Vector4 } from "babylonjs/Maths/math.vector";
  68674. import { Mesh } from "babylonjs/Meshes/mesh";
  68675. /**
  68676. * Class containing static functions to help procedurally build meshes
  68677. */
  68678. export class TorusKnotBuilder {
  68679. /**
  68680. * Creates a torus knot mesh
  68681. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68682. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68683. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68684. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68685. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68686. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68687. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68688. * @param name defines the name of the mesh
  68689. * @param options defines the options used to create the mesh
  68690. * @param scene defines the hosting scene
  68691. * @returns the torus knot mesh
  68692. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68693. */
  68694. static CreateTorusKnot(name: string, options: {
  68695. radius?: number;
  68696. tube?: number;
  68697. radialSegments?: number;
  68698. tubularSegments?: number;
  68699. p?: number;
  68700. q?: number;
  68701. updatable?: boolean;
  68702. sideOrientation?: number;
  68703. frontUVs?: Vector4;
  68704. backUVs?: Vector4;
  68705. }, scene: any): Mesh;
  68706. }
  68707. }
  68708. declare module "babylonjs/Meshes/polygonMesh" {
  68709. import { Scene } from "babylonjs/scene";
  68710. import { Vector2 } from "babylonjs/Maths/math.vector";
  68711. import { Mesh } from "babylonjs/Meshes/mesh";
  68712. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68713. import { Path2 } from "babylonjs/Maths/math.path";
  68714. /**
  68715. * Polygon
  68716. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68717. */
  68718. export class Polygon {
  68719. /**
  68720. * Creates a rectangle
  68721. * @param xmin bottom X coord
  68722. * @param ymin bottom Y coord
  68723. * @param xmax top X coord
  68724. * @param ymax top Y coord
  68725. * @returns points that make the resulting rectation
  68726. */
  68727. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68728. /**
  68729. * Creates a circle
  68730. * @param radius radius of circle
  68731. * @param cx scale in x
  68732. * @param cy scale in y
  68733. * @param numberOfSides number of sides that make up the circle
  68734. * @returns points that make the resulting circle
  68735. */
  68736. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68737. /**
  68738. * Creates a polygon from input string
  68739. * @param input Input polygon data
  68740. * @returns the parsed points
  68741. */
  68742. static Parse(input: string): Vector2[];
  68743. /**
  68744. * Starts building a polygon from x and y coordinates
  68745. * @param x x coordinate
  68746. * @param y y coordinate
  68747. * @returns the started path2
  68748. */
  68749. static StartingAt(x: number, y: number): Path2;
  68750. }
  68751. /**
  68752. * Builds a polygon
  68753. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68754. */
  68755. export class PolygonMeshBuilder {
  68756. private _points;
  68757. private _outlinepoints;
  68758. private _holes;
  68759. private _name;
  68760. private _scene;
  68761. private _epoints;
  68762. private _eholes;
  68763. private _addToepoint;
  68764. /**
  68765. * Babylon reference to the earcut plugin.
  68766. */
  68767. bjsEarcut: any;
  68768. /**
  68769. * Creates a PolygonMeshBuilder
  68770. * @param name name of the builder
  68771. * @param contours Path of the polygon
  68772. * @param scene scene to add to when creating the mesh
  68773. * @param earcutInjection can be used to inject your own earcut reference
  68774. */
  68775. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68776. /**
  68777. * Adds a whole within the polygon
  68778. * @param hole Array of points defining the hole
  68779. * @returns this
  68780. */
  68781. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68782. /**
  68783. * Creates the polygon
  68784. * @param updatable If the mesh should be updatable
  68785. * @param depth The depth of the mesh created
  68786. * @returns the created mesh
  68787. */
  68788. build(updatable?: boolean, depth?: number): Mesh;
  68789. /**
  68790. * Creates the polygon
  68791. * @param depth The depth of the mesh created
  68792. * @returns the created VertexData
  68793. */
  68794. buildVertexData(depth?: number): VertexData;
  68795. /**
  68796. * Adds a side to the polygon
  68797. * @param positions points that make the polygon
  68798. * @param normals normals of the polygon
  68799. * @param uvs uvs of the polygon
  68800. * @param indices indices of the polygon
  68801. * @param bounds bounds of the polygon
  68802. * @param points points of the polygon
  68803. * @param depth depth of the polygon
  68804. * @param flip flip of the polygon
  68805. */
  68806. private addSide;
  68807. }
  68808. }
  68809. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68810. import { Scene } from "babylonjs/scene";
  68811. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68812. import { Color4 } from "babylonjs/Maths/math.color";
  68813. import { Mesh } from "babylonjs/Meshes/mesh";
  68814. import { Nullable } from "babylonjs/types";
  68815. /**
  68816. * Class containing static functions to help procedurally build meshes
  68817. */
  68818. export class PolygonBuilder {
  68819. /**
  68820. * Creates a polygon mesh
  68821. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68822. * * 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
  68823. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68824. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68825. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  68826. * * Remember you can only change the shape positions, not their number when updating a polygon
  68827. * @param name defines the name of the mesh
  68828. * @param options defines the options used to create the mesh
  68829. * @param scene defines the hosting scene
  68830. * @param earcutInjection can be used to inject your own earcut reference
  68831. * @returns the polygon mesh
  68832. */
  68833. static CreatePolygon(name: string, options: {
  68834. shape: Vector3[];
  68835. holes?: Vector3[][];
  68836. depth?: number;
  68837. faceUV?: Vector4[];
  68838. faceColors?: Color4[];
  68839. updatable?: boolean;
  68840. sideOrientation?: number;
  68841. frontUVs?: Vector4;
  68842. backUVs?: Vector4;
  68843. wrap?: boolean;
  68844. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68845. /**
  68846. * Creates an extruded polygon mesh, with depth in the Y direction.
  68847. * * 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)
  68848. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68849. * @param name defines the name of the mesh
  68850. * @param options defines the options used to create the mesh
  68851. * @param scene defines the hosting scene
  68852. * @param earcutInjection can be used to inject your own earcut reference
  68853. * @returns the polygon mesh
  68854. */
  68855. static ExtrudePolygon(name: string, options: {
  68856. shape: Vector3[];
  68857. holes?: Vector3[][];
  68858. depth?: number;
  68859. faceUV?: Vector4[];
  68860. faceColors?: Color4[];
  68861. updatable?: boolean;
  68862. sideOrientation?: number;
  68863. frontUVs?: Vector4;
  68864. backUVs?: Vector4;
  68865. wrap?: boolean;
  68866. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68867. }
  68868. }
  68869. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68870. import { Scene } from "babylonjs/scene";
  68871. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68872. import { Mesh } from "babylonjs/Meshes/mesh";
  68873. import { Nullable } from "babylonjs/types";
  68874. /**
  68875. * Class containing static functions to help procedurally build meshes
  68876. */
  68877. export class LatheBuilder {
  68878. /**
  68879. * Creates lathe mesh.
  68880. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68881. * * 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
  68882. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68883. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68884. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68885. * * 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
  68886. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68887. * * 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
  68888. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68889. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68890. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68891. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68892. * @param name defines the name of the mesh
  68893. * @param options defines the options used to create the mesh
  68894. * @param scene defines the hosting scene
  68895. * @returns the lathe mesh
  68896. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68897. */
  68898. static CreateLathe(name: string, options: {
  68899. shape: Vector3[];
  68900. radius?: number;
  68901. tessellation?: number;
  68902. clip?: number;
  68903. arc?: number;
  68904. closed?: boolean;
  68905. updatable?: boolean;
  68906. sideOrientation?: number;
  68907. frontUVs?: Vector4;
  68908. backUVs?: Vector4;
  68909. cap?: number;
  68910. invertUV?: boolean;
  68911. }, scene?: Nullable<Scene>): Mesh;
  68912. }
  68913. }
  68914. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  68915. import { Nullable } from "babylonjs/types";
  68916. import { Scene } from "babylonjs/scene";
  68917. import { Vector4 } from "babylonjs/Maths/math.vector";
  68918. import { Mesh } from "babylonjs/Meshes/mesh";
  68919. /**
  68920. * Class containing static functions to help procedurally build meshes
  68921. */
  68922. export class TiledPlaneBuilder {
  68923. /**
  68924. * Creates a tiled plane mesh
  68925. * * The parameter `pattern` will, depending on value, do nothing or
  68926. * * * flip (reflect about central vertical) alternate tiles across and up
  68927. * * * flip every tile on alternate rows
  68928. * * * rotate (180 degs) alternate tiles across and up
  68929. * * * rotate every tile on alternate rows
  68930. * * * flip and rotate alternate tiles across and up
  68931. * * * flip and rotate every tile on alternate rows
  68932. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  68933. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  68934. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68935. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68936. * * 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)
  68937. * * 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)
  68938. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68939. * @param name defines the name of the mesh
  68940. * @param options defines the options used to create the mesh
  68941. * @param scene defines the hosting scene
  68942. * @returns the box mesh
  68943. */
  68944. static CreateTiledPlane(name: string, options: {
  68945. pattern?: number;
  68946. tileSize?: number;
  68947. tileWidth?: number;
  68948. tileHeight?: number;
  68949. size?: number;
  68950. width?: number;
  68951. height?: number;
  68952. alignHorizontal?: number;
  68953. alignVertical?: number;
  68954. sideOrientation?: number;
  68955. frontUVs?: Vector4;
  68956. backUVs?: Vector4;
  68957. updatable?: boolean;
  68958. }, scene?: Nullable<Scene>): Mesh;
  68959. }
  68960. }
  68961. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  68962. import { Nullable } from "babylonjs/types";
  68963. import { Scene } from "babylonjs/scene";
  68964. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68965. import { Mesh } from "babylonjs/Meshes/mesh";
  68966. /**
  68967. * Class containing static functions to help procedurally build meshes
  68968. */
  68969. export class TubeBuilder {
  68970. /**
  68971. * Creates a tube mesh.
  68972. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68973. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68974. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68975. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68976. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68977. * * 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)
  68978. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68979. * * 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
  68980. * * 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
  68981. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68982. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68983. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68984. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68985. * @param name defines the name of the mesh
  68986. * @param options defines the options used to create the mesh
  68987. * @param scene defines the hosting scene
  68988. * @returns the tube mesh
  68989. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68990. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  68991. */
  68992. static CreateTube(name: string, options: {
  68993. path: Vector3[];
  68994. radius?: number;
  68995. tessellation?: number;
  68996. radiusFunction?: {
  68997. (i: number, distance: number): number;
  68998. };
  68999. cap?: number;
  69000. arc?: number;
  69001. updatable?: boolean;
  69002. sideOrientation?: number;
  69003. frontUVs?: Vector4;
  69004. backUVs?: Vector4;
  69005. instance?: Mesh;
  69006. invertUV?: boolean;
  69007. }, scene?: Nullable<Scene>): Mesh;
  69008. }
  69009. }
  69010. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  69011. import { Scene } from "babylonjs/scene";
  69012. import { Vector4 } from "babylonjs/Maths/math.vector";
  69013. import { Mesh } from "babylonjs/Meshes/mesh";
  69014. import { Nullable } from "babylonjs/types";
  69015. /**
  69016. * Class containing static functions to help procedurally build meshes
  69017. */
  69018. export class IcoSphereBuilder {
  69019. /**
  69020. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69021. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69022. * * 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`)
  69023. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69024. * * 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
  69025. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69026. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69027. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69028. * @param name defines the name of the mesh
  69029. * @param options defines the options used to create the mesh
  69030. * @param scene defines the hosting scene
  69031. * @returns the icosahedron mesh
  69032. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69033. */
  69034. static CreateIcoSphere(name: string, options: {
  69035. radius?: number;
  69036. radiusX?: number;
  69037. radiusY?: number;
  69038. radiusZ?: number;
  69039. flat?: boolean;
  69040. subdivisions?: number;
  69041. sideOrientation?: number;
  69042. frontUVs?: Vector4;
  69043. backUVs?: Vector4;
  69044. updatable?: boolean;
  69045. }, scene?: Nullable<Scene>): Mesh;
  69046. }
  69047. }
  69048. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69049. import { Vector3 } from "babylonjs/Maths/math.vector";
  69050. import { Mesh } from "babylonjs/Meshes/mesh";
  69051. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69052. /**
  69053. * Class containing static functions to help procedurally build meshes
  69054. */
  69055. export class DecalBuilder {
  69056. /**
  69057. * Creates a decal mesh.
  69058. * 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
  69059. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69060. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69061. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69062. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69063. * @param name defines the name of the mesh
  69064. * @param sourceMesh defines the mesh where the decal must be applied
  69065. * @param options defines the options used to create the mesh
  69066. * @param scene defines the hosting scene
  69067. * @returns the decal mesh
  69068. * @see https://doc.babylonjs.com/how_to/decals
  69069. */
  69070. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69071. position?: Vector3;
  69072. normal?: Vector3;
  69073. size?: Vector3;
  69074. angle?: number;
  69075. }): Mesh;
  69076. }
  69077. }
  69078. declare module "babylonjs/Meshes/meshBuilder" {
  69079. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69080. import { Nullable } from "babylonjs/types";
  69081. import { Scene } from "babylonjs/scene";
  69082. import { Mesh } from "babylonjs/Meshes/mesh";
  69083. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69084. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69085. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69086. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69087. import { Plane } from "babylonjs/Maths/math.plane";
  69088. /**
  69089. * Class containing static functions to help procedurally build meshes
  69090. */
  69091. export class MeshBuilder {
  69092. /**
  69093. * Creates a box mesh
  69094. * * The parameter `size` sets the size (float) of each box side (default 1)
  69095. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69096. * * 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)
  69097. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69098. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69099. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69100. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69101. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69102. * @param name defines the name of the mesh
  69103. * @param options defines the options used to create the mesh
  69104. * @param scene defines the hosting scene
  69105. * @returns the box mesh
  69106. */
  69107. static CreateBox(name: string, options: {
  69108. size?: number;
  69109. width?: number;
  69110. height?: number;
  69111. depth?: number;
  69112. faceUV?: Vector4[];
  69113. faceColors?: Color4[];
  69114. sideOrientation?: number;
  69115. frontUVs?: Vector4;
  69116. backUVs?: Vector4;
  69117. wrap?: boolean;
  69118. topBaseAt?: number;
  69119. bottomBaseAt?: number;
  69120. updatable?: boolean;
  69121. }, scene?: Nullable<Scene>): Mesh;
  69122. /**
  69123. * Creates a tiled box mesh
  69124. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69125. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69126. * @param name defines the name of the mesh
  69127. * @param options defines the options used to create the mesh
  69128. * @param scene defines the hosting scene
  69129. * @returns the tiled box mesh
  69130. */
  69131. static CreateTiledBox(name: string, options: {
  69132. pattern?: number;
  69133. size?: number;
  69134. width?: number;
  69135. height?: number;
  69136. depth: number;
  69137. tileSize?: number;
  69138. tileWidth?: number;
  69139. tileHeight?: number;
  69140. faceUV?: Vector4[];
  69141. faceColors?: Color4[];
  69142. alignHorizontal?: number;
  69143. alignVertical?: number;
  69144. sideOrientation?: number;
  69145. updatable?: boolean;
  69146. }, scene?: Nullable<Scene>): Mesh;
  69147. /**
  69148. * Creates a sphere mesh
  69149. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69150. * * 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`)
  69151. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69152. * * 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
  69153. * * 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)
  69154. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69155. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69156. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69157. * @param name defines the name of the mesh
  69158. * @param options defines the options used to create the mesh
  69159. * @param scene defines the hosting scene
  69160. * @returns the sphere mesh
  69161. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69162. */
  69163. static CreateSphere(name: string, options: {
  69164. segments?: number;
  69165. diameter?: number;
  69166. diameterX?: number;
  69167. diameterY?: number;
  69168. diameterZ?: number;
  69169. arc?: number;
  69170. slice?: number;
  69171. sideOrientation?: number;
  69172. frontUVs?: Vector4;
  69173. backUVs?: Vector4;
  69174. updatable?: boolean;
  69175. }, scene?: Nullable<Scene>): Mesh;
  69176. /**
  69177. * Creates a plane polygonal mesh. By default, this is a disc
  69178. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69179. * * 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
  69180. * * 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
  69181. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69182. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69183. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69184. * @param name defines the name of the mesh
  69185. * @param options defines the options used to create the mesh
  69186. * @param scene defines the hosting scene
  69187. * @returns the plane polygonal mesh
  69188. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69189. */
  69190. static CreateDisc(name: string, options: {
  69191. radius?: number;
  69192. tessellation?: number;
  69193. arc?: number;
  69194. updatable?: boolean;
  69195. sideOrientation?: number;
  69196. frontUVs?: Vector4;
  69197. backUVs?: Vector4;
  69198. }, scene?: Nullable<Scene>): Mesh;
  69199. /**
  69200. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69201. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69202. * * 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`)
  69203. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69204. * * 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
  69205. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69206. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69207. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69208. * @param name defines the name of the mesh
  69209. * @param options defines the options used to create the mesh
  69210. * @param scene defines the hosting scene
  69211. * @returns the icosahedron mesh
  69212. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69213. */
  69214. static CreateIcoSphere(name: string, options: {
  69215. radius?: number;
  69216. radiusX?: number;
  69217. radiusY?: number;
  69218. radiusZ?: number;
  69219. flat?: boolean;
  69220. subdivisions?: number;
  69221. sideOrientation?: number;
  69222. frontUVs?: Vector4;
  69223. backUVs?: Vector4;
  69224. updatable?: boolean;
  69225. }, scene?: Nullable<Scene>): Mesh;
  69226. /**
  69227. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69228. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69229. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69230. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69231. * * 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
  69232. * * 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
  69233. * * 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
  69234. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69235. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69236. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69237. * * 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
  69238. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69239. * * 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
  69240. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69241. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69242. * @param name defines the name of the mesh
  69243. * @param options defines the options used to create the mesh
  69244. * @param scene defines the hosting scene
  69245. * @returns the ribbon mesh
  69246. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69247. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69248. */
  69249. static CreateRibbon(name: string, options: {
  69250. pathArray: Vector3[][];
  69251. closeArray?: boolean;
  69252. closePath?: boolean;
  69253. offset?: number;
  69254. updatable?: boolean;
  69255. sideOrientation?: number;
  69256. frontUVs?: Vector4;
  69257. backUVs?: Vector4;
  69258. instance?: Mesh;
  69259. invertUV?: boolean;
  69260. uvs?: Vector2[];
  69261. colors?: Color4[];
  69262. }, scene?: Nullable<Scene>): Mesh;
  69263. /**
  69264. * Creates a cylinder or a cone mesh
  69265. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69266. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69267. * * 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.
  69268. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69269. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69270. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69271. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69272. * * 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).
  69273. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69274. * * 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).
  69275. * * 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
  69276. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69277. * * 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
  69278. * * 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.
  69279. * * If `enclose` is false, a ring surface is one element.
  69280. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69281. * * 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
  69282. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69283. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69284. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69285. * @param name defines the name of the mesh
  69286. * @param options defines the options used to create the mesh
  69287. * @param scene defines the hosting scene
  69288. * @returns the cylinder mesh
  69289. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69290. */
  69291. static CreateCylinder(name: string, options: {
  69292. height?: number;
  69293. diameterTop?: number;
  69294. diameterBottom?: number;
  69295. diameter?: number;
  69296. tessellation?: number;
  69297. subdivisions?: number;
  69298. arc?: number;
  69299. faceColors?: Color4[];
  69300. faceUV?: Vector4[];
  69301. updatable?: boolean;
  69302. hasRings?: boolean;
  69303. enclose?: boolean;
  69304. cap?: number;
  69305. sideOrientation?: number;
  69306. frontUVs?: Vector4;
  69307. backUVs?: Vector4;
  69308. }, scene?: Nullable<Scene>): Mesh;
  69309. /**
  69310. * Creates a torus mesh
  69311. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69312. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69313. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69314. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69315. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69316. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69317. * @param name defines the name of the mesh
  69318. * @param options defines the options used to create the mesh
  69319. * @param scene defines the hosting scene
  69320. * @returns the torus mesh
  69321. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69322. */
  69323. static CreateTorus(name: string, options: {
  69324. diameter?: number;
  69325. thickness?: number;
  69326. tessellation?: number;
  69327. updatable?: boolean;
  69328. sideOrientation?: number;
  69329. frontUVs?: Vector4;
  69330. backUVs?: Vector4;
  69331. }, scene?: Nullable<Scene>): Mesh;
  69332. /**
  69333. * Creates a torus knot mesh
  69334. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69335. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69336. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69337. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69338. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69339. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69340. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  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 torus knot mesh
  69345. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69346. */
  69347. static CreateTorusKnot(name: string, options: {
  69348. radius?: number;
  69349. tube?: number;
  69350. radialSegments?: number;
  69351. tubularSegments?: number;
  69352. p?: number;
  69353. q?: number;
  69354. updatable?: boolean;
  69355. sideOrientation?: number;
  69356. frontUVs?: Vector4;
  69357. backUVs?: Vector4;
  69358. }, scene?: Nullable<Scene>): Mesh;
  69359. /**
  69360. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69361. * * 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
  69362. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69363. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69364. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69365. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69366. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69367. * * 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
  69368. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69369. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69370. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69371. * @param name defines the name of the new line system
  69372. * @param options defines the options used to create the line system
  69373. * @param scene defines the hosting scene
  69374. * @returns a new line system mesh
  69375. */
  69376. static CreateLineSystem(name: string, options: {
  69377. lines: Vector3[][];
  69378. updatable?: boolean;
  69379. instance?: Nullable<LinesMesh>;
  69380. colors?: Nullable<Color4[][]>;
  69381. useVertexAlpha?: boolean;
  69382. }, scene: Nullable<Scene>): LinesMesh;
  69383. /**
  69384. * Creates a line mesh
  69385. * 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
  69386. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69387. * * The parameter `points` is an array successive Vector3
  69388. * * 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
  69389. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69390. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69391. * * When updating an instance, remember that only point positions can change, not the number of points
  69392. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69393. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69394. * @param name defines the name of the new line system
  69395. * @param options defines the options used to create the line system
  69396. * @param scene defines the hosting scene
  69397. * @returns a new line mesh
  69398. */
  69399. static CreateLines(name: string, options: {
  69400. points: Vector3[];
  69401. updatable?: boolean;
  69402. instance?: Nullable<LinesMesh>;
  69403. colors?: Color4[];
  69404. useVertexAlpha?: boolean;
  69405. }, scene?: Nullable<Scene>): LinesMesh;
  69406. /**
  69407. * Creates a dashed line mesh
  69408. * * 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
  69409. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69410. * * The parameter `points` is an array successive Vector3
  69411. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69412. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69413. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69414. * * 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
  69415. * * When updating an instance, remember that only point positions can change, not the number of points
  69416. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69417. * @param name defines the name of the mesh
  69418. * @param options defines the options used to create the mesh
  69419. * @param scene defines the hosting scene
  69420. * @returns the dashed line mesh
  69421. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69422. */
  69423. static CreateDashedLines(name: string, options: {
  69424. points: Vector3[];
  69425. dashSize?: number;
  69426. gapSize?: number;
  69427. dashNb?: number;
  69428. updatable?: boolean;
  69429. instance?: LinesMesh;
  69430. }, scene?: Nullable<Scene>): LinesMesh;
  69431. /**
  69432. * 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.
  69433. * * 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.
  69434. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69435. * * 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.
  69436. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69437. * * 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
  69438. * * 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
  69439. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69440. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69441. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69442. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69443. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69444. * @param name defines the name of the mesh
  69445. * @param options defines the options used to create the mesh
  69446. * @param scene defines the hosting scene
  69447. * @returns the extruded shape mesh
  69448. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69449. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69450. */
  69451. static ExtrudeShape(name: string, options: {
  69452. shape: Vector3[];
  69453. path: Vector3[];
  69454. scale?: number;
  69455. rotation?: number;
  69456. cap?: number;
  69457. updatable?: boolean;
  69458. sideOrientation?: number;
  69459. frontUVs?: Vector4;
  69460. backUVs?: Vector4;
  69461. instance?: Mesh;
  69462. invertUV?: boolean;
  69463. }, scene?: Nullable<Scene>): Mesh;
  69464. /**
  69465. * Creates an custom extruded shape mesh.
  69466. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69467. * * 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.
  69468. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69469. * * 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
  69470. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69471. * * 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
  69472. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69473. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69474. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69475. * * 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
  69476. * * 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
  69477. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69478. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69479. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69480. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69481. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69482. * @param name defines the name of the mesh
  69483. * @param options defines the options used to create the mesh
  69484. * @param scene defines the hosting scene
  69485. * @returns the custom extruded shape mesh
  69486. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69487. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69488. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69489. */
  69490. static ExtrudeShapeCustom(name: string, options: {
  69491. shape: Vector3[];
  69492. path: Vector3[];
  69493. scaleFunction?: any;
  69494. rotationFunction?: any;
  69495. ribbonCloseArray?: boolean;
  69496. ribbonClosePath?: boolean;
  69497. cap?: number;
  69498. updatable?: boolean;
  69499. sideOrientation?: number;
  69500. frontUVs?: Vector4;
  69501. backUVs?: Vector4;
  69502. instance?: Mesh;
  69503. invertUV?: boolean;
  69504. }, scene?: Nullable<Scene>): Mesh;
  69505. /**
  69506. * Creates lathe mesh.
  69507. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69508. * * 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
  69509. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69510. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69511. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69512. * * 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
  69513. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69514. * * 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
  69515. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69516. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69517. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69518. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69519. * @param name defines the name of the mesh
  69520. * @param options defines the options used to create the mesh
  69521. * @param scene defines the hosting scene
  69522. * @returns the lathe mesh
  69523. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69524. */
  69525. static CreateLathe(name: string, options: {
  69526. shape: Vector3[];
  69527. radius?: number;
  69528. tessellation?: number;
  69529. clip?: number;
  69530. arc?: number;
  69531. closed?: boolean;
  69532. updatable?: boolean;
  69533. sideOrientation?: number;
  69534. frontUVs?: Vector4;
  69535. backUVs?: Vector4;
  69536. cap?: number;
  69537. invertUV?: boolean;
  69538. }, scene?: Nullable<Scene>): Mesh;
  69539. /**
  69540. * Creates a tiled plane mesh
  69541. * * You can set a limited pattern arrangement with the tiles
  69542. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69543. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69544. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69545. * @param name defines the name of the mesh
  69546. * @param options defines the options used to create the mesh
  69547. * @param scene defines the hosting scene
  69548. * @returns the plane mesh
  69549. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69550. */
  69551. static CreateTiledPlane(name: string, options: {
  69552. pattern?: number;
  69553. tileSize?: number;
  69554. tileWidth?: number;
  69555. tileHeight?: number;
  69556. size?: number;
  69557. width?: number;
  69558. height?: number;
  69559. alignHorizontal?: number;
  69560. alignVertical?: number;
  69561. sideOrientation?: number;
  69562. frontUVs?: Vector4;
  69563. backUVs?: Vector4;
  69564. updatable?: boolean;
  69565. }, scene?: Nullable<Scene>): Mesh;
  69566. /**
  69567. * Creates a plane mesh
  69568. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69569. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69570. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69571. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69572. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69573. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69574. * @param name defines the name of the mesh
  69575. * @param options defines the options used to create the mesh
  69576. * @param scene defines the hosting scene
  69577. * @returns the plane mesh
  69578. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69579. */
  69580. static CreatePlane(name: string, options: {
  69581. size?: number;
  69582. width?: number;
  69583. height?: number;
  69584. sideOrientation?: number;
  69585. frontUVs?: Vector4;
  69586. backUVs?: Vector4;
  69587. updatable?: boolean;
  69588. sourcePlane?: Plane;
  69589. }, scene?: Nullable<Scene>): Mesh;
  69590. /**
  69591. * Creates a ground mesh
  69592. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69593. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69594. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69595. * @param name defines the name of the mesh
  69596. * @param options defines the options used to create the mesh
  69597. * @param scene defines the hosting scene
  69598. * @returns the ground mesh
  69599. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69600. */
  69601. static CreateGround(name: string, options: {
  69602. width?: number;
  69603. height?: number;
  69604. subdivisions?: number;
  69605. subdivisionsX?: number;
  69606. subdivisionsY?: number;
  69607. updatable?: boolean;
  69608. }, scene?: Nullable<Scene>): Mesh;
  69609. /**
  69610. * Creates a tiled ground mesh
  69611. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69612. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69613. * * 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
  69614. * * 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
  69615. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69616. * @param name defines the name of the mesh
  69617. * @param options defines the options used to create the mesh
  69618. * @param scene defines the hosting scene
  69619. * @returns the tiled ground mesh
  69620. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69621. */
  69622. static CreateTiledGround(name: string, options: {
  69623. xmin: number;
  69624. zmin: number;
  69625. xmax: number;
  69626. zmax: number;
  69627. subdivisions?: {
  69628. w: number;
  69629. h: number;
  69630. };
  69631. precision?: {
  69632. w: number;
  69633. h: number;
  69634. };
  69635. updatable?: boolean;
  69636. }, scene?: Nullable<Scene>): Mesh;
  69637. /**
  69638. * Creates a ground mesh from a height map
  69639. * * The parameter `url` sets the URL of the height map image resource.
  69640. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69641. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69642. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69643. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69644. * * 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.
  69645. * * 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).
  69646. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69647. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69648. * @param name defines the name of the mesh
  69649. * @param url defines the url to the height map
  69650. * @param options defines the options used to create the mesh
  69651. * @param scene defines the hosting scene
  69652. * @returns the ground mesh
  69653. * @see https://doc.babylonjs.com/babylon101/height_map
  69654. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69655. */
  69656. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69657. width?: number;
  69658. height?: number;
  69659. subdivisions?: number;
  69660. minHeight?: number;
  69661. maxHeight?: number;
  69662. colorFilter?: Color3;
  69663. alphaFilter?: number;
  69664. updatable?: boolean;
  69665. onReady?: (mesh: GroundMesh) => void;
  69666. }, scene?: Nullable<Scene>): GroundMesh;
  69667. /**
  69668. * Creates a polygon mesh
  69669. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69670. * * 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
  69671. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69672. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69673. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69674. * * Remember you can only change the shape positions, not their number when updating a polygon
  69675. * @param name defines the name of the mesh
  69676. * @param options defines the options used to create the mesh
  69677. * @param scene defines the hosting scene
  69678. * @param earcutInjection can be used to inject your own earcut reference
  69679. * @returns the polygon mesh
  69680. */
  69681. static CreatePolygon(name: string, options: {
  69682. shape: Vector3[];
  69683. holes?: Vector3[][];
  69684. depth?: number;
  69685. faceUV?: Vector4[];
  69686. faceColors?: Color4[];
  69687. updatable?: boolean;
  69688. sideOrientation?: number;
  69689. frontUVs?: Vector4;
  69690. backUVs?: Vector4;
  69691. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69692. /**
  69693. * Creates an extruded polygon mesh, with depth in the Y direction.
  69694. * * 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)
  69695. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69696. * @param name defines the name of the mesh
  69697. * @param options defines the options used to create the mesh
  69698. * @param scene defines the hosting scene
  69699. * @param earcutInjection can be used to inject your own earcut reference
  69700. * @returns the polygon mesh
  69701. */
  69702. static ExtrudePolygon(name: string, options: {
  69703. shape: Vector3[];
  69704. holes?: Vector3[][];
  69705. depth?: number;
  69706. faceUV?: Vector4[];
  69707. faceColors?: Color4[];
  69708. updatable?: boolean;
  69709. sideOrientation?: number;
  69710. frontUVs?: Vector4;
  69711. backUVs?: Vector4;
  69712. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69713. /**
  69714. * Creates a tube mesh.
  69715. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69716. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69717. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69718. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69719. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69720. * * 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)
  69721. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69722. * * 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
  69723. * * 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
  69724. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69725. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69726. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69727. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69728. * @param name defines the name of the mesh
  69729. * @param options defines the options used to create the mesh
  69730. * @param scene defines the hosting scene
  69731. * @returns the tube mesh
  69732. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69733. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69734. */
  69735. static CreateTube(name: string, options: {
  69736. path: Vector3[];
  69737. radius?: number;
  69738. tessellation?: number;
  69739. radiusFunction?: {
  69740. (i: number, distance: number): number;
  69741. };
  69742. cap?: number;
  69743. arc?: number;
  69744. updatable?: boolean;
  69745. sideOrientation?: number;
  69746. frontUVs?: Vector4;
  69747. backUVs?: Vector4;
  69748. instance?: Mesh;
  69749. invertUV?: boolean;
  69750. }, scene?: Nullable<Scene>): Mesh;
  69751. /**
  69752. * Creates a polyhedron mesh
  69753. * * 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
  69754. * * The parameter `size` (positive float, default 1) sets the polygon size
  69755. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69756. * * 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`
  69757. * * 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
  69758. * * 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)`)
  69759. * * 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
  69760. * * 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
  69761. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69762. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69763. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69764. * @param name defines the name of the mesh
  69765. * @param options defines the options used to create the mesh
  69766. * @param scene defines the hosting scene
  69767. * @returns the polyhedron mesh
  69768. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69769. */
  69770. static CreatePolyhedron(name: string, options: {
  69771. type?: number;
  69772. size?: number;
  69773. sizeX?: number;
  69774. sizeY?: number;
  69775. sizeZ?: number;
  69776. custom?: any;
  69777. faceUV?: Vector4[];
  69778. faceColors?: Color4[];
  69779. flat?: boolean;
  69780. updatable?: boolean;
  69781. sideOrientation?: number;
  69782. frontUVs?: Vector4;
  69783. backUVs?: Vector4;
  69784. }, scene?: Nullable<Scene>): Mesh;
  69785. /**
  69786. * Creates a decal mesh.
  69787. * 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
  69788. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69789. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69790. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69791. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69792. * @param name defines the name of the mesh
  69793. * @param sourceMesh defines the mesh where the decal must be applied
  69794. * @param options defines the options used to create the mesh
  69795. * @param scene defines the hosting scene
  69796. * @returns the decal mesh
  69797. * @see https://doc.babylonjs.com/how_to/decals
  69798. */
  69799. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69800. position?: Vector3;
  69801. normal?: Vector3;
  69802. size?: Vector3;
  69803. angle?: number;
  69804. }): Mesh;
  69805. }
  69806. }
  69807. declare module "babylonjs/Meshes/meshSimplification" {
  69808. import { Mesh } from "babylonjs/Meshes/mesh";
  69809. /**
  69810. * A simplifier interface for future simplification implementations
  69811. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69812. */
  69813. export interface ISimplifier {
  69814. /**
  69815. * Simplification of a given mesh according to the given settings.
  69816. * Since this requires computation, it is assumed that the function runs async.
  69817. * @param settings The settings of the simplification, including quality and distance
  69818. * @param successCallback A callback that will be called after the mesh was simplified.
  69819. * @param errorCallback in case of an error, this callback will be called. optional.
  69820. */
  69821. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69822. }
  69823. /**
  69824. * Expected simplification settings.
  69825. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69826. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69827. */
  69828. export interface ISimplificationSettings {
  69829. /**
  69830. * Gets or sets the expected quality
  69831. */
  69832. quality: number;
  69833. /**
  69834. * Gets or sets the distance when this optimized version should be used
  69835. */
  69836. distance: number;
  69837. /**
  69838. * Gets an already optimized mesh
  69839. */
  69840. optimizeMesh?: boolean;
  69841. }
  69842. /**
  69843. * Class used to specify simplification options
  69844. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69845. */
  69846. export class SimplificationSettings implements ISimplificationSettings {
  69847. /** expected quality */
  69848. quality: number;
  69849. /** distance when this optimized version should be used */
  69850. distance: number;
  69851. /** already optimized mesh */
  69852. optimizeMesh?: boolean | undefined;
  69853. /**
  69854. * Creates a SimplificationSettings
  69855. * @param quality expected quality
  69856. * @param distance distance when this optimized version should be used
  69857. * @param optimizeMesh already optimized mesh
  69858. */
  69859. constructor(
  69860. /** expected quality */
  69861. quality: number,
  69862. /** distance when this optimized version should be used */
  69863. distance: number,
  69864. /** already optimized mesh */
  69865. optimizeMesh?: boolean | undefined);
  69866. }
  69867. /**
  69868. * Interface used to define a simplification task
  69869. */
  69870. export interface ISimplificationTask {
  69871. /**
  69872. * Array of settings
  69873. */
  69874. settings: Array<ISimplificationSettings>;
  69875. /**
  69876. * Simplification type
  69877. */
  69878. simplificationType: SimplificationType;
  69879. /**
  69880. * Mesh to simplify
  69881. */
  69882. mesh: Mesh;
  69883. /**
  69884. * Callback called on success
  69885. */
  69886. successCallback?: () => void;
  69887. /**
  69888. * Defines if parallel processing can be used
  69889. */
  69890. parallelProcessing: boolean;
  69891. }
  69892. /**
  69893. * Queue used to order the simplification tasks
  69894. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69895. */
  69896. export class SimplificationQueue {
  69897. private _simplificationArray;
  69898. /**
  69899. * Gets a boolean indicating that the process is still running
  69900. */
  69901. running: boolean;
  69902. /**
  69903. * Creates a new queue
  69904. */
  69905. constructor();
  69906. /**
  69907. * Adds a new simplification task
  69908. * @param task defines a task to add
  69909. */
  69910. addTask(task: ISimplificationTask): void;
  69911. /**
  69912. * Execute next task
  69913. */
  69914. executeNext(): void;
  69915. /**
  69916. * Execute a simplification task
  69917. * @param task defines the task to run
  69918. */
  69919. runSimplification(task: ISimplificationTask): void;
  69920. private getSimplifier;
  69921. }
  69922. /**
  69923. * The implemented types of simplification
  69924. * At the moment only Quadratic Error Decimation is implemented
  69925. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69926. */
  69927. export enum SimplificationType {
  69928. /** Quadratic error decimation */
  69929. QUADRATIC = 0
  69930. }
  69931. /**
  69932. * An implementation of the Quadratic Error simplification algorithm.
  69933. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  69934. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  69935. * @author RaananW
  69936. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69937. */
  69938. export class QuadraticErrorSimplification implements ISimplifier {
  69939. private _mesh;
  69940. private triangles;
  69941. private vertices;
  69942. private references;
  69943. private _reconstructedMesh;
  69944. /** Gets or sets the number pf sync interations */
  69945. syncIterations: number;
  69946. /** Gets or sets the aggressiveness of the simplifier */
  69947. aggressiveness: number;
  69948. /** Gets or sets the number of allowed iterations for decimation */
  69949. decimationIterations: number;
  69950. /** Gets or sets the espilon to use for bounding box computation */
  69951. boundingBoxEpsilon: number;
  69952. /**
  69953. * Creates a new QuadraticErrorSimplification
  69954. * @param _mesh defines the target mesh
  69955. */
  69956. constructor(_mesh: Mesh);
  69957. /**
  69958. * Simplification of a given mesh according to the given settings.
  69959. * Since this requires computation, it is assumed that the function runs async.
  69960. * @param settings The settings of the simplification, including quality and distance
  69961. * @param successCallback A callback that will be called after the mesh was simplified.
  69962. */
  69963. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  69964. private runDecimation;
  69965. private initWithMesh;
  69966. private init;
  69967. private reconstructMesh;
  69968. private initDecimatedMesh;
  69969. private isFlipped;
  69970. private updateTriangles;
  69971. private identifyBorder;
  69972. private updateMesh;
  69973. private vertexError;
  69974. private calculateError;
  69975. }
  69976. }
  69977. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  69978. import { Scene } from "babylonjs/scene";
  69979. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  69980. import { ISceneComponent } from "babylonjs/sceneComponent";
  69981. module "babylonjs/scene" {
  69982. interface Scene {
  69983. /** @hidden (Backing field) */
  69984. _simplificationQueue: SimplificationQueue;
  69985. /**
  69986. * Gets or sets the simplification queue attached to the scene
  69987. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69988. */
  69989. simplificationQueue: SimplificationQueue;
  69990. }
  69991. }
  69992. module "babylonjs/Meshes/mesh" {
  69993. interface Mesh {
  69994. /**
  69995. * Simplify the mesh according to the given array of settings.
  69996. * Function will return immediately and will simplify async
  69997. * @param settings a collection of simplification settings
  69998. * @param parallelProcessing should all levels calculate parallel or one after the other
  69999. * @param simplificationType the type of simplification to run
  70000. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  70001. * @returns the current mesh
  70002. */
  70003. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  70004. }
  70005. }
  70006. /**
  70007. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  70008. * created in a scene
  70009. */
  70010. export class SimplicationQueueSceneComponent implements ISceneComponent {
  70011. /**
  70012. * The component name helpfull to identify the component in the list of scene components.
  70013. */
  70014. readonly name: string;
  70015. /**
  70016. * The scene the component belongs to.
  70017. */
  70018. scene: Scene;
  70019. /**
  70020. * Creates a new instance of the component for the given scene
  70021. * @param scene Defines the scene to register the component in
  70022. */
  70023. constructor(scene: Scene);
  70024. /**
  70025. * Registers the component in a given scene
  70026. */
  70027. register(): void;
  70028. /**
  70029. * Rebuilds the elements related to this component in case of
  70030. * context lost for instance.
  70031. */
  70032. rebuild(): void;
  70033. /**
  70034. * Disposes the component and the associated ressources
  70035. */
  70036. dispose(): void;
  70037. private _beforeCameraUpdate;
  70038. }
  70039. }
  70040. declare module "babylonjs/Meshes/Builders/index" {
  70041. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70042. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70043. export * from "babylonjs/Meshes/Builders/discBuilder";
  70044. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70045. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70046. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70047. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70048. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70049. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70050. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70051. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70052. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70053. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70054. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70055. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70056. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70057. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70058. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70059. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70060. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70061. }
  70062. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70063. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70064. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70065. import { Matrix } from "babylonjs/Maths/math.vector";
  70066. module "babylonjs/Meshes/mesh" {
  70067. interface Mesh {
  70068. /**
  70069. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70070. */
  70071. thinInstanceEnablePicking: boolean;
  70072. /**
  70073. * Creates a new thin instance
  70074. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70075. * @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
  70076. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70077. */
  70078. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70079. /**
  70080. * Adds the transformation (matrix) of the current mesh as a thin instance
  70081. * @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
  70082. * @returns the thin instance index number
  70083. */
  70084. thinInstanceAddSelf(refresh: boolean): number;
  70085. /**
  70086. * Registers a custom attribute to be used with thin instances
  70087. * @param kind name of the attribute
  70088. * @param stride size in floats of the attribute
  70089. */
  70090. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70091. /**
  70092. * Sets the matrix of a thin instance
  70093. * @param index index of the thin instance
  70094. * @param matrix matrix to set
  70095. * @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
  70096. */
  70097. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70098. /**
  70099. * Sets the value of a custom attribute for a thin instance
  70100. * @param kind name of the attribute
  70101. * @param index index of the thin instance
  70102. * @param value value to set
  70103. * @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
  70104. */
  70105. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70106. /**
  70107. * 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.
  70108. */
  70109. thinInstanceCount: number;
  70110. /**
  70111. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70112. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70113. * @param buffer buffer to set
  70114. * @param stride size in floats of each value of the buffer
  70115. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70116. */
  70117. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70118. /**
  70119. * Gets the list of world matrices
  70120. * @return an array containing all the world matrices from the thin instances
  70121. */
  70122. thinInstanceGetWorldMatrices(): Matrix[];
  70123. /**
  70124. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70125. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70126. */
  70127. thinInstanceBufferUpdated(kind: string): void;
  70128. /**
  70129. * Refreshes the bounding info, taking into account all the thin instances defined
  70130. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70131. */
  70132. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70133. /** @hidden */
  70134. _thinInstanceInitializeUserStorage(): void;
  70135. /** @hidden */
  70136. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70137. /** @hidden */
  70138. _userThinInstanceBuffersStorage: {
  70139. data: {
  70140. [key: string]: Float32Array;
  70141. };
  70142. sizes: {
  70143. [key: string]: number;
  70144. };
  70145. vertexBuffers: {
  70146. [key: string]: Nullable<VertexBuffer>;
  70147. };
  70148. strides: {
  70149. [key: string]: number;
  70150. };
  70151. };
  70152. }
  70153. }
  70154. }
  70155. declare module "babylonjs/Meshes/index" {
  70156. export * from "babylonjs/Meshes/abstractMesh";
  70157. export * from "babylonjs/Meshes/buffer";
  70158. export * from "babylonjs/Meshes/Compression/index";
  70159. export * from "babylonjs/Meshes/csg";
  70160. export * from "babylonjs/Meshes/geometry";
  70161. export * from "babylonjs/Meshes/groundMesh";
  70162. export * from "babylonjs/Meshes/trailMesh";
  70163. export * from "babylonjs/Meshes/instancedMesh";
  70164. export * from "babylonjs/Meshes/linesMesh";
  70165. export * from "babylonjs/Meshes/mesh";
  70166. export * from "babylonjs/Meshes/mesh.vertexData";
  70167. export * from "babylonjs/Meshes/meshBuilder";
  70168. export * from "babylonjs/Meshes/meshSimplification";
  70169. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70170. export * from "babylonjs/Meshes/polygonMesh";
  70171. export * from "babylonjs/Meshes/subMesh";
  70172. export * from "babylonjs/Meshes/meshLODLevel";
  70173. export * from "babylonjs/Meshes/transformNode";
  70174. export * from "babylonjs/Meshes/Builders/index";
  70175. export * from "babylonjs/Meshes/dataBuffer";
  70176. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70177. import "babylonjs/Meshes/thinInstanceMesh";
  70178. export * from "babylonjs/Meshes/thinInstanceMesh";
  70179. }
  70180. declare module "babylonjs/Morph/index" {
  70181. export * from "babylonjs/Morph/morphTarget";
  70182. export * from "babylonjs/Morph/morphTargetManager";
  70183. }
  70184. declare module "babylonjs/Navigation/INavigationEngine" {
  70185. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70186. import { Vector3 } from "babylonjs/Maths/math";
  70187. import { Mesh } from "babylonjs/Meshes/mesh";
  70188. import { Scene } from "babylonjs/scene";
  70189. /**
  70190. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70191. */
  70192. export interface INavigationEnginePlugin {
  70193. /**
  70194. * plugin name
  70195. */
  70196. name: string;
  70197. /**
  70198. * Creates a navigation mesh
  70199. * @param meshes array of all the geometry used to compute the navigatio mesh
  70200. * @param parameters bunch of parameters used to filter geometry
  70201. */
  70202. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70203. /**
  70204. * Create a navigation mesh debug mesh
  70205. * @param scene is where the mesh will be added
  70206. * @returns debug display mesh
  70207. */
  70208. createDebugNavMesh(scene: Scene): Mesh;
  70209. /**
  70210. * Get a navigation mesh constrained position, closest to the parameter position
  70211. * @param position world position
  70212. * @returns the closest point to position constrained by the navigation mesh
  70213. */
  70214. getClosestPoint(position: Vector3): Vector3;
  70215. /**
  70216. * Get a navigation mesh constrained position, closest to the parameter position
  70217. * @param position world position
  70218. * @param result output the closest point to position constrained by the navigation mesh
  70219. */
  70220. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70221. /**
  70222. * Get a navigation mesh constrained position, within a particular radius
  70223. * @param position world position
  70224. * @param maxRadius the maximum distance to the constrained world position
  70225. * @returns the closest point to position constrained by the navigation mesh
  70226. */
  70227. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70228. /**
  70229. * Get a navigation mesh constrained position, within a particular radius
  70230. * @param position world position
  70231. * @param maxRadius the maximum distance to the constrained world position
  70232. * @param result output the closest point to position constrained by the navigation mesh
  70233. */
  70234. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70235. /**
  70236. * Compute the final position from a segment made of destination-position
  70237. * @param position world position
  70238. * @param destination world position
  70239. * @returns the resulting point along the navmesh
  70240. */
  70241. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70242. /**
  70243. * Compute the final position from a segment made of destination-position
  70244. * @param position world position
  70245. * @param destination world position
  70246. * @param result output the resulting point along the navmesh
  70247. */
  70248. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70249. /**
  70250. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70251. * @param start world position
  70252. * @param end world position
  70253. * @returns array containing world position composing the path
  70254. */
  70255. computePath(start: Vector3, end: Vector3): Vector3[];
  70256. /**
  70257. * If this plugin is supported
  70258. * @returns true if plugin is supported
  70259. */
  70260. isSupported(): boolean;
  70261. /**
  70262. * Create a new Crowd so you can add agents
  70263. * @param maxAgents the maximum agent count in the crowd
  70264. * @param maxAgentRadius the maximum radius an agent can have
  70265. * @param scene to attach the crowd to
  70266. * @returns the crowd you can add agents to
  70267. */
  70268. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70269. /**
  70270. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70271. * The queries will try to find a solution within those bounds
  70272. * default is (1,1,1)
  70273. * @param extent x,y,z value that define the extent around the queries point of reference
  70274. */
  70275. setDefaultQueryExtent(extent: Vector3): void;
  70276. /**
  70277. * Get the Bounding box extent specified by setDefaultQueryExtent
  70278. * @returns the box extent values
  70279. */
  70280. getDefaultQueryExtent(): Vector3;
  70281. /**
  70282. * build the navmesh from a previously saved state using getNavmeshData
  70283. * @param data the Uint8Array returned by getNavmeshData
  70284. */
  70285. buildFromNavmeshData(data: Uint8Array): void;
  70286. /**
  70287. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70288. * @returns data the Uint8Array that can be saved and reused
  70289. */
  70290. getNavmeshData(): Uint8Array;
  70291. /**
  70292. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70293. * @param result output the box extent values
  70294. */
  70295. getDefaultQueryExtentToRef(result: Vector3): void;
  70296. /**
  70297. * Release all resources
  70298. */
  70299. dispose(): void;
  70300. }
  70301. /**
  70302. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70303. */
  70304. export interface ICrowd {
  70305. /**
  70306. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70307. * You can attach anything to that node. The node position is updated in the scene update tick.
  70308. * @param pos world position that will be constrained by the navigation mesh
  70309. * @param parameters agent parameters
  70310. * @param transform hooked to the agent that will be update by the scene
  70311. * @returns agent index
  70312. */
  70313. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70314. /**
  70315. * Returns the agent position in world space
  70316. * @param index agent index returned by addAgent
  70317. * @returns world space position
  70318. */
  70319. getAgentPosition(index: number): Vector3;
  70320. /**
  70321. * Gets the agent position result in world space
  70322. * @param index agent index returned by addAgent
  70323. * @param result output world space position
  70324. */
  70325. getAgentPositionToRef(index: number, result: Vector3): void;
  70326. /**
  70327. * Gets the agent velocity in world space
  70328. * @param index agent index returned by addAgent
  70329. * @returns world space velocity
  70330. */
  70331. getAgentVelocity(index: number): Vector3;
  70332. /**
  70333. * Gets the agent velocity result in world space
  70334. * @param index agent index returned by addAgent
  70335. * @param result output world space velocity
  70336. */
  70337. getAgentVelocityToRef(index: number, result: Vector3): void;
  70338. /**
  70339. * remove a particular agent previously created
  70340. * @param index agent index returned by addAgent
  70341. */
  70342. removeAgent(index: number): void;
  70343. /**
  70344. * get the list of all agents attached to this crowd
  70345. * @returns list of agent indices
  70346. */
  70347. getAgents(): number[];
  70348. /**
  70349. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70350. * @param deltaTime in seconds
  70351. */
  70352. update(deltaTime: number): void;
  70353. /**
  70354. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70355. * @param index agent index returned by addAgent
  70356. * @param destination targeted world position
  70357. */
  70358. agentGoto(index: number, destination: Vector3): void;
  70359. /**
  70360. * Teleport the agent to a new position
  70361. * @param index agent index returned by addAgent
  70362. * @param destination targeted world position
  70363. */
  70364. agentTeleport(index: number, destination: Vector3): void;
  70365. /**
  70366. * Update agent parameters
  70367. * @param index agent index returned by addAgent
  70368. * @param parameters agent parameters
  70369. */
  70370. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70371. /**
  70372. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70373. * The queries will try to find a solution within those bounds
  70374. * default is (1,1,1)
  70375. * @param extent x,y,z value that define the extent around the queries point of reference
  70376. */
  70377. setDefaultQueryExtent(extent: Vector3): void;
  70378. /**
  70379. * Get the Bounding box extent specified by setDefaultQueryExtent
  70380. * @returns the box extent values
  70381. */
  70382. getDefaultQueryExtent(): Vector3;
  70383. /**
  70384. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70385. * @param result output the box extent values
  70386. */
  70387. getDefaultQueryExtentToRef(result: Vector3): void;
  70388. /**
  70389. * Release all resources
  70390. */
  70391. dispose(): void;
  70392. }
  70393. /**
  70394. * Configures an agent
  70395. */
  70396. export interface IAgentParameters {
  70397. /**
  70398. * Agent radius. [Limit: >= 0]
  70399. */
  70400. radius: number;
  70401. /**
  70402. * Agent height. [Limit: > 0]
  70403. */
  70404. height: number;
  70405. /**
  70406. * Maximum allowed acceleration. [Limit: >= 0]
  70407. */
  70408. maxAcceleration: number;
  70409. /**
  70410. * Maximum allowed speed. [Limit: >= 0]
  70411. */
  70412. maxSpeed: number;
  70413. /**
  70414. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70415. */
  70416. collisionQueryRange: number;
  70417. /**
  70418. * The path visibility optimization range. [Limit: > 0]
  70419. */
  70420. pathOptimizationRange: number;
  70421. /**
  70422. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70423. */
  70424. separationWeight: number;
  70425. }
  70426. /**
  70427. * Configures the navigation mesh creation
  70428. */
  70429. export interface INavMeshParameters {
  70430. /**
  70431. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70432. */
  70433. cs: number;
  70434. /**
  70435. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70436. */
  70437. ch: number;
  70438. /**
  70439. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70440. */
  70441. walkableSlopeAngle: number;
  70442. /**
  70443. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70444. * be considered walkable. [Limit: >= 3] [Units: vx]
  70445. */
  70446. walkableHeight: number;
  70447. /**
  70448. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70449. */
  70450. walkableClimb: number;
  70451. /**
  70452. * The distance to erode/shrink the walkable area of the heightfield away from
  70453. * obstructions. [Limit: >=0] [Units: vx]
  70454. */
  70455. walkableRadius: number;
  70456. /**
  70457. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70458. */
  70459. maxEdgeLen: number;
  70460. /**
  70461. * The maximum distance a simplfied contour's border edges should deviate
  70462. * the original raw contour. [Limit: >=0] [Units: vx]
  70463. */
  70464. maxSimplificationError: number;
  70465. /**
  70466. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70467. */
  70468. minRegionArea: number;
  70469. /**
  70470. * Any regions with a span count smaller than this value will, if possible,
  70471. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70472. */
  70473. mergeRegionArea: number;
  70474. /**
  70475. * The maximum number of vertices allowed for polygons generated during the
  70476. * contour to polygon conversion process. [Limit: >= 3]
  70477. */
  70478. maxVertsPerPoly: number;
  70479. /**
  70480. * Sets the sampling distance to use when generating the detail mesh.
  70481. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70482. */
  70483. detailSampleDist: number;
  70484. /**
  70485. * The maximum distance the detail mesh surface should deviate from heightfield
  70486. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70487. */
  70488. detailSampleMaxError: number;
  70489. }
  70490. }
  70491. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70492. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70493. import { Mesh } from "babylonjs/Meshes/mesh";
  70494. import { Scene } from "babylonjs/scene";
  70495. import { Vector3 } from "babylonjs/Maths/math";
  70496. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70497. /**
  70498. * RecastJS navigation plugin
  70499. */
  70500. export class RecastJSPlugin implements INavigationEnginePlugin {
  70501. /**
  70502. * Reference to the Recast library
  70503. */
  70504. bjsRECAST: any;
  70505. /**
  70506. * plugin name
  70507. */
  70508. name: string;
  70509. /**
  70510. * the first navmesh created. We might extend this to support multiple navmeshes
  70511. */
  70512. navMesh: any;
  70513. /**
  70514. * Initializes the recastJS plugin
  70515. * @param recastInjection can be used to inject your own recast reference
  70516. */
  70517. constructor(recastInjection?: any);
  70518. /**
  70519. * Creates a navigation mesh
  70520. * @param meshes array of all the geometry used to compute the navigatio mesh
  70521. * @param parameters bunch of parameters used to filter geometry
  70522. */
  70523. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70524. /**
  70525. * Create a navigation mesh debug mesh
  70526. * @param scene is where the mesh will be added
  70527. * @returns debug display mesh
  70528. */
  70529. createDebugNavMesh(scene: Scene): Mesh;
  70530. /**
  70531. * Get a navigation mesh constrained position, closest to the parameter position
  70532. * @param position world position
  70533. * @returns the closest point to position constrained by the navigation mesh
  70534. */
  70535. getClosestPoint(position: Vector3): Vector3;
  70536. /**
  70537. * Get a navigation mesh constrained position, closest to the parameter position
  70538. * @param position world position
  70539. * @param result output the closest point to position constrained by the navigation mesh
  70540. */
  70541. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70542. /**
  70543. * Get a navigation mesh constrained position, within a particular radius
  70544. * @param position world position
  70545. * @param maxRadius the maximum distance to the constrained world position
  70546. * @returns the closest point to position constrained by the navigation mesh
  70547. */
  70548. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70549. /**
  70550. * Get a navigation mesh constrained position, within a particular radius
  70551. * @param position world position
  70552. * @param maxRadius the maximum distance to the constrained world position
  70553. * @param result output the closest point to position constrained by the navigation mesh
  70554. */
  70555. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70556. /**
  70557. * Compute the final position from a segment made of destination-position
  70558. * @param position world position
  70559. * @param destination world position
  70560. * @returns the resulting point along the navmesh
  70561. */
  70562. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70563. /**
  70564. * Compute the final position from a segment made of destination-position
  70565. * @param position world position
  70566. * @param destination world position
  70567. * @param result output the resulting point along the navmesh
  70568. */
  70569. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70570. /**
  70571. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70572. * @param start world position
  70573. * @param end world position
  70574. * @returns array containing world position composing the path
  70575. */
  70576. computePath(start: Vector3, end: Vector3): Vector3[];
  70577. /**
  70578. * Create a new Crowd so you can add agents
  70579. * @param maxAgents the maximum agent count in the crowd
  70580. * @param maxAgentRadius the maximum radius an agent can have
  70581. * @param scene to attach the crowd to
  70582. * @returns the crowd you can add agents to
  70583. */
  70584. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70585. /**
  70586. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70587. * The queries will try to find a solution within those bounds
  70588. * default is (1,1,1)
  70589. * @param extent x,y,z value that define the extent around the queries point of reference
  70590. */
  70591. setDefaultQueryExtent(extent: Vector3): void;
  70592. /**
  70593. * Get the Bounding box extent specified by setDefaultQueryExtent
  70594. * @returns the box extent values
  70595. */
  70596. getDefaultQueryExtent(): Vector3;
  70597. /**
  70598. * build the navmesh from a previously saved state using getNavmeshData
  70599. * @param data the Uint8Array returned by getNavmeshData
  70600. */
  70601. buildFromNavmeshData(data: Uint8Array): void;
  70602. /**
  70603. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70604. * @returns data the Uint8Array that can be saved and reused
  70605. */
  70606. getNavmeshData(): Uint8Array;
  70607. /**
  70608. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70609. * @param result output the box extent values
  70610. */
  70611. getDefaultQueryExtentToRef(result: Vector3): void;
  70612. /**
  70613. * Disposes
  70614. */
  70615. dispose(): void;
  70616. /**
  70617. * If this plugin is supported
  70618. * @returns true if plugin is supported
  70619. */
  70620. isSupported(): boolean;
  70621. }
  70622. /**
  70623. * Recast detour crowd implementation
  70624. */
  70625. export class RecastJSCrowd implements ICrowd {
  70626. /**
  70627. * Recast/detour plugin
  70628. */
  70629. bjsRECASTPlugin: RecastJSPlugin;
  70630. /**
  70631. * Link to the detour crowd
  70632. */
  70633. recastCrowd: any;
  70634. /**
  70635. * One transform per agent
  70636. */
  70637. transforms: TransformNode[];
  70638. /**
  70639. * All agents created
  70640. */
  70641. agents: number[];
  70642. /**
  70643. * Link to the scene is kept to unregister the crowd from the scene
  70644. */
  70645. private _scene;
  70646. /**
  70647. * Observer for crowd updates
  70648. */
  70649. private _onBeforeAnimationsObserver;
  70650. /**
  70651. * Constructor
  70652. * @param plugin recastJS plugin
  70653. * @param maxAgents the maximum agent count in the crowd
  70654. * @param maxAgentRadius the maximum radius an agent can have
  70655. * @param scene to attach the crowd to
  70656. * @returns the crowd you can add agents to
  70657. */
  70658. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70659. /**
  70660. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70661. * You can attach anything to that node. The node position is updated in the scene update tick.
  70662. * @param pos world position that will be constrained by the navigation mesh
  70663. * @param parameters agent parameters
  70664. * @param transform hooked to the agent that will be update by the scene
  70665. * @returns agent index
  70666. */
  70667. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70668. /**
  70669. * Returns the agent position in world space
  70670. * @param index agent index returned by addAgent
  70671. * @returns world space position
  70672. */
  70673. getAgentPosition(index: number): Vector3;
  70674. /**
  70675. * Returns the agent position result in world space
  70676. * @param index agent index returned by addAgent
  70677. * @param result output world space position
  70678. */
  70679. getAgentPositionToRef(index: number, result: Vector3): void;
  70680. /**
  70681. * Returns the agent velocity in world space
  70682. * @param index agent index returned by addAgent
  70683. * @returns world space velocity
  70684. */
  70685. getAgentVelocity(index: number): Vector3;
  70686. /**
  70687. * Returns the agent velocity result in world space
  70688. * @param index agent index returned by addAgent
  70689. * @param result output world space velocity
  70690. */
  70691. getAgentVelocityToRef(index: number, result: Vector3): void;
  70692. /**
  70693. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70694. * @param index agent index returned by addAgent
  70695. * @param destination targeted world position
  70696. */
  70697. agentGoto(index: number, destination: Vector3): void;
  70698. /**
  70699. * Teleport the agent to a new position
  70700. * @param index agent index returned by addAgent
  70701. * @param destination targeted world position
  70702. */
  70703. agentTeleport(index: number, destination: Vector3): void;
  70704. /**
  70705. * Update agent parameters
  70706. * @param index agent index returned by addAgent
  70707. * @param parameters agent parameters
  70708. */
  70709. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70710. /**
  70711. * remove a particular agent previously created
  70712. * @param index agent index returned by addAgent
  70713. */
  70714. removeAgent(index: number): void;
  70715. /**
  70716. * get the list of all agents attached to this crowd
  70717. * @returns list of agent indices
  70718. */
  70719. getAgents(): number[];
  70720. /**
  70721. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70722. * @param deltaTime in seconds
  70723. */
  70724. update(deltaTime: number): void;
  70725. /**
  70726. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70727. * The queries will try to find a solution within those bounds
  70728. * default is (1,1,1)
  70729. * @param extent x,y,z value that define the extent around the queries point of reference
  70730. */
  70731. setDefaultQueryExtent(extent: Vector3): void;
  70732. /**
  70733. * Get the Bounding box extent specified by setDefaultQueryExtent
  70734. * @returns the box extent values
  70735. */
  70736. getDefaultQueryExtent(): Vector3;
  70737. /**
  70738. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70739. * @param result output the box extent values
  70740. */
  70741. getDefaultQueryExtentToRef(result: Vector3): void;
  70742. /**
  70743. * Release all resources
  70744. */
  70745. dispose(): void;
  70746. }
  70747. }
  70748. declare module "babylonjs/Navigation/Plugins/index" {
  70749. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70750. }
  70751. declare module "babylonjs/Navigation/index" {
  70752. export * from "babylonjs/Navigation/INavigationEngine";
  70753. export * from "babylonjs/Navigation/Plugins/index";
  70754. }
  70755. declare module "babylonjs/Offline/database" {
  70756. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70757. /**
  70758. * Class used to enable access to IndexedDB
  70759. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70760. */
  70761. export class Database implements IOfflineProvider {
  70762. private _callbackManifestChecked;
  70763. private _currentSceneUrl;
  70764. private _db;
  70765. private _enableSceneOffline;
  70766. private _enableTexturesOffline;
  70767. private _manifestVersionFound;
  70768. private _mustUpdateRessources;
  70769. private _hasReachedQuota;
  70770. private _isSupported;
  70771. private _idbFactory;
  70772. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70773. private static IsUASupportingBlobStorage;
  70774. /**
  70775. * Gets a boolean indicating if Database storate is enabled (off by default)
  70776. */
  70777. static IDBStorageEnabled: boolean;
  70778. /**
  70779. * Gets a boolean indicating if scene must be saved in the database
  70780. */
  70781. get enableSceneOffline(): boolean;
  70782. /**
  70783. * Gets a boolean indicating if textures must be saved in the database
  70784. */
  70785. get enableTexturesOffline(): boolean;
  70786. /**
  70787. * Creates a new Database
  70788. * @param urlToScene defines the url to load the scene
  70789. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70790. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70791. */
  70792. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70793. private static _ParseURL;
  70794. private static _ReturnFullUrlLocation;
  70795. private _checkManifestFile;
  70796. /**
  70797. * Open the database and make it available
  70798. * @param successCallback defines the callback to call on success
  70799. * @param errorCallback defines the callback to call on error
  70800. */
  70801. open(successCallback: () => void, errorCallback: () => void): void;
  70802. /**
  70803. * Loads an image from the database
  70804. * @param url defines the url to load from
  70805. * @param image defines the target DOM image
  70806. */
  70807. loadImage(url: string, image: HTMLImageElement): void;
  70808. private _loadImageFromDBAsync;
  70809. private _saveImageIntoDBAsync;
  70810. private _checkVersionFromDB;
  70811. private _loadVersionFromDBAsync;
  70812. private _saveVersionIntoDBAsync;
  70813. /**
  70814. * Loads a file from database
  70815. * @param url defines the URL to load from
  70816. * @param sceneLoaded defines a callback to call on success
  70817. * @param progressCallBack defines a callback to call when progress changed
  70818. * @param errorCallback defines a callback to call on error
  70819. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70820. */
  70821. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70822. private _loadFileAsync;
  70823. private _saveFileAsync;
  70824. /**
  70825. * Validates if xhr data is correct
  70826. * @param xhr defines the request to validate
  70827. * @param dataType defines the expected data type
  70828. * @returns true if data is correct
  70829. */
  70830. private static _ValidateXHRData;
  70831. }
  70832. }
  70833. declare module "babylonjs/Offline/index" {
  70834. export * from "babylonjs/Offline/database";
  70835. export * from "babylonjs/Offline/IOfflineProvider";
  70836. }
  70837. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70838. /** @hidden */
  70839. export var gpuUpdateParticlesPixelShader: {
  70840. name: string;
  70841. shader: string;
  70842. };
  70843. }
  70844. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70845. /** @hidden */
  70846. export var gpuUpdateParticlesVertexShader: {
  70847. name: string;
  70848. shader: string;
  70849. };
  70850. }
  70851. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70852. /** @hidden */
  70853. export var clipPlaneFragmentDeclaration2: {
  70854. name: string;
  70855. shader: string;
  70856. };
  70857. }
  70858. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70859. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70860. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70861. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70862. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70863. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70864. /** @hidden */
  70865. export var gpuRenderParticlesPixelShader: {
  70866. name: string;
  70867. shader: string;
  70868. };
  70869. }
  70870. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70871. /** @hidden */
  70872. export var clipPlaneVertexDeclaration2: {
  70873. name: string;
  70874. shader: string;
  70875. };
  70876. }
  70877. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70878. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70879. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70880. /** @hidden */
  70881. export var gpuRenderParticlesVertexShader: {
  70882. name: string;
  70883. shader: string;
  70884. };
  70885. }
  70886. declare module "babylonjs/Particles/gpuParticleSystem" {
  70887. import { Nullable } from "babylonjs/types";
  70888. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70889. import { Observable } from "babylonjs/Misc/observable";
  70890. import { Matrix } from "babylonjs/Maths/math.vector";
  70891. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70892. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70893. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70894. import { IDisposable } from "babylonjs/scene";
  70895. import { Effect } from "babylonjs/Materials/effect";
  70896. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  70897. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  70898. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  70899. import { Scene } from "babylonjs/scene";
  70900. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  70901. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  70902. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  70903. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  70904. /**
  70905. * This represents a GPU particle system in Babylon
  70906. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  70907. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  70908. */
  70909. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  70910. /**
  70911. * The layer mask we are rendering the particles through.
  70912. */
  70913. layerMask: number;
  70914. private _capacity;
  70915. private _activeCount;
  70916. private _currentActiveCount;
  70917. private _accumulatedCount;
  70918. private _renderEffect;
  70919. private _updateEffect;
  70920. private _buffer0;
  70921. private _buffer1;
  70922. private _spriteBuffer;
  70923. private _updateVAO;
  70924. private _renderVAO;
  70925. private _targetIndex;
  70926. private _sourceBuffer;
  70927. private _targetBuffer;
  70928. private _currentRenderId;
  70929. private _started;
  70930. private _stopped;
  70931. private _timeDelta;
  70932. private _randomTexture;
  70933. private _randomTexture2;
  70934. private _attributesStrideSize;
  70935. private _updateEffectOptions;
  70936. private _randomTextureSize;
  70937. private _actualFrame;
  70938. private _customEffect;
  70939. private readonly _rawTextureWidth;
  70940. /**
  70941. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  70942. */
  70943. static get IsSupported(): boolean;
  70944. /**
  70945. * An event triggered when the system is disposed.
  70946. */
  70947. onDisposeObservable: Observable<IParticleSystem>;
  70948. /**
  70949. * Gets the maximum number of particles active at the same time.
  70950. * @returns The max number of active particles.
  70951. */
  70952. getCapacity(): number;
  70953. /**
  70954. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  70955. * to override the particles.
  70956. */
  70957. forceDepthWrite: boolean;
  70958. /**
  70959. * Gets or set the number of active particles
  70960. */
  70961. get activeParticleCount(): number;
  70962. set activeParticleCount(value: number);
  70963. private _preWarmDone;
  70964. /**
  70965. * Specifies if the particles are updated in emitter local space or world space.
  70966. */
  70967. isLocal: boolean;
  70968. /** Gets or sets a matrix to use to compute projection */
  70969. defaultProjectionMatrix: Matrix;
  70970. /**
  70971. * Is this system ready to be used/rendered
  70972. * @return true if the system is ready
  70973. */
  70974. isReady(): boolean;
  70975. /**
  70976. * Gets if the system has been started. (Note: this will still be true after stop is called)
  70977. * @returns True if it has been started, otherwise false.
  70978. */
  70979. isStarted(): boolean;
  70980. /**
  70981. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  70982. * @returns True if it has been stopped, otherwise false.
  70983. */
  70984. isStopped(): boolean;
  70985. /**
  70986. * Gets a boolean indicating that the system is stopping
  70987. * @returns true if the system is currently stopping
  70988. */
  70989. isStopping(): boolean;
  70990. /**
  70991. * Gets the number of particles active at the same time.
  70992. * @returns The number of active particles.
  70993. */
  70994. getActiveCount(): number;
  70995. /**
  70996. * Starts the particle system and begins to emit
  70997. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  70998. */
  70999. start(delay?: number): void;
  71000. /**
  71001. * Stops the particle system.
  71002. */
  71003. stop(): void;
  71004. /**
  71005. * Remove all active particles
  71006. */
  71007. reset(): void;
  71008. /**
  71009. * Returns the string "GPUParticleSystem"
  71010. * @returns a string containing the class name
  71011. */
  71012. getClassName(): string;
  71013. /**
  71014. * Gets the custom effect used to render the particles
  71015. * @param blendMode Blend mode for which the effect should be retrieved
  71016. * @returns The effect
  71017. */
  71018. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71019. /**
  71020. * Sets the custom effect used to render the particles
  71021. * @param effect The effect to set
  71022. * @param blendMode Blend mode for which the effect should be set
  71023. */
  71024. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71025. /** @hidden */
  71026. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71027. /**
  71028. * Observable that will be called just before the particles are drawn
  71029. */
  71030. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71031. /**
  71032. * Gets the name of the particle vertex shader
  71033. */
  71034. get vertexShaderName(): string;
  71035. private _colorGradientsTexture;
  71036. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71037. /**
  71038. * Adds a new color gradient
  71039. * @param gradient defines the gradient to use (between 0 and 1)
  71040. * @param color1 defines the color to affect to the specified gradient
  71041. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71042. * @returns the current particle system
  71043. */
  71044. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71045. private _refreshColorGradient;
  71046. /** Force the system to rebuild all gradients that need to be resync */
  71047. forceRefreshGradients(): void;
  71048. /**
  71049. * Remove a specific color gradient
  71050. * @param gradient defines the gradient to remove
  71051. * @returns the current particle system
  71052. */
  71053. removeColorGradient(gradient: number): GPUParticleSystem;
  71054. private _angularSpeedGradientsTexture;
  71055. private _sizeGradientsTexture;
  71056. private _velocityGradientsTexture;
  71057. private _limitVelocityGradientsTexture;
  71058. private _dragGradientsTexture;
  71059. private _addFactorGradient;
  71060. /**
  71061. * Adds a new size gradient
  71062. * @param gradient defines the gradient to use (between 0 and 1)
  71063. * @param factor defines the size factor to affect to the specified gradient
  71064. * @returns the current particle system
  71065. */
  71066. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71067. /**
  71068. * Remove a specific size gradient
  71069. * @param gradient defines the gradient to remove
  71070. * @returns the current particle system
  71071. */
  71072. removeSizeGradient(gradient: number): GPUParticleSystem;
  71073. private _refreshFactorGradient;
  71074. /**
  71075. * Adds a new angular speed gradient
  71076. * @param gradient defines the gradient to use (between 0 and 1)
  71077. * @param factor defines the angular speed to affect to the specified gradient
  71078. * @returns the current particle system
  71079. */
  71080. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71081. /**
  71082. * Remove a specific angular speed gradient
  71083. * @param gradient defines the gradient to remove
  71084. * @returns the current particle system
  71085. */
  71086. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71087. /**
  71088. * Adds a new velocity gradient
  71089. * @param gradient defines the gradient to use (between 0 and 1)
  71090. * @param factor defines the velocity to affect to the specified gradient
  71091. * @returns the current particle system
  71092. */
  71093. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71094. /**
  71095. * Remove a specific velocity gradient
  71096. * @param gradient defines the gradient to remove
  71097. * @returns the current particle system
  71098. */
  71099. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71100. /**
  71101. * Adds a new limit velocity gradient
  71102. * @param gradient defines the gradient to use (between 0 and 1)
  71103. * @param factor defines the limit velocity value to affect to the specified gradient
  71104. * @returns the current particle system
  71105. */
  71106. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71107. /**
  71108. * Remove a specific limit velocity gradient
  71109. * @param gradient defines the gradient to remove
  71110. * @returns the current particle system
  71111. */
  71112. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71113. /**
  71114. * Adds a new drag gradient
  71115. * @param gradient defines the gradient to use (between 0 and 1)
  71116. * @param factor defines the drag value to affect to the specified gradient
  71117. * @returns the current particle system
  71118. */
  71119. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71120. /**
  71121. * Remove a specific drag gradient
  71122. * @param gradient defines the gradient to remove
  71123. * @returns the current particle system
  71124. */
  71125. removeDragGradient(gradient: number): GPUParticleSystem;
  71126. /**
  71127. * Not supported by GPUParticleSystem
  71128. * @param gradient defines the gradient to use (between 0 and 1)
  71129. * @param factor defines the emit rate value to affect to the specified gradient
  71130. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71131. * @returns the current particle system
  71132. */
  71133. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71134. /**
  71135. * Not supported by GPUParticleSystem
  71136. * @param gradient defines the gradient to remove
  71137. * @returns the current particle system
  71138. */
  71139. removeEmitRateGradient(gradient: number): IParticleSystem;
  71140. /**
  71141. * Not supported by GPUParticleSystem
  71142. * @param gradient defines the gradient to use (between 0 and 1)
  71143. * @param factor defines the start size value to affect to the specified gradient
  71144. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71145. * @returns the current particle system
  71146. */
  71147. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71148. /**
  71149. * Not supported by GPUParticleSystem
  71150. * @param gradient defines the gradient to remove
  71151. * @returns the current particle system
  71152. */
  71153. removeStartSizeGradient(gradient: number): IParticleSystem;
  71154. /**
  71155. * Not supported by GPUParticleSystem
  71156. * @param gradient defines the gradient to use (between 0 and 1)
  71157. * @param min defines the color remap minimal range
  71158. * @param max defines the color remap maximal range
  71159. * @returns the current particle system
  71160. */
  71161. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71162. /**
  71163. * Not supported by GPUParticleSystem
  71164. * @param gradient defines the gradient to remove
  71165. * @returns the current particle system
  71166. */
  71167. removeColorRemapGradient(): IParticleSystem;
  71168. /**
  71169. * Not supported by GPUParticleSystem
  71170. * @param gradient defines the gradient to use (between 0 and 1)
  71171. * @param min defines the alpha remap minimal range
  71172. * @param max defines the alpha remap maximal range
  71173. * @returns the current particle system
  71174. */
  71175. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71176. /**
  71177. * Not supported by GPUParticleSystem
  71178. * @param gradient defines the gradient to remove
  71179. * @returns the current particle system
  71180. */
  71181. removeAlphaRemapGradient(): IParticleSystem;
  71182. /**
  71183. * Not supported by GPUParticleSystem
  71184. * @param gradient defines the gradient to use (between 0 and 1)
  71185. * @param color defines the color to affect to the specified gradient
  71186. * @returns the current particle system
  71187. */
  71188. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71189. /**
  71190. * Not supported by GPUParticleSystem
  71191. * @param gradient defines the gradient to remove
  71192. * @returns the current particle system
  71193. */
  71194. removeRampGradient(): IParticleSystem;
  71195. /**
  71196. * Not supported by GPUParticleSystem
  71197. * @returns the list of ramp gradients
  71198. */
  71199. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71200. /**
  71201. * Not supported by GPUParticleSystem
  71202. * Gets or sets a boolean indicating that ramp gradients must be used
  71203. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71204. */
  71205. get useRampGradients(): boolean;
  71206. set useRampGradients(value: boolean);
  71207. /**
  71208. * Not supported by GPUParticleSystem
  71209. * @param gradient defines the gradient to use (between 0 and 1)
  71210. * @param factor defines the life time factor to affect to the specified gradient
  71211. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71212. * @returns the current particle system
  71213. */
  71214. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71215. /**
  71216. * Not supported by GPUParticleSystem
  71217. * @param gradient defines the gradient to remove
  71218. * @returns the current particle system
  71219. */
  71220. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71221. /**
  71222. * Instantiates a GPU particle system.
  71223. * 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.
  71224. * @param name The name of the particle system
  71225. * @param options The options used to create the system
  71226. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71227. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71228. * @param customEffect a custom effect used to change the way particles are rendered by default
  71229. */
  71230. constructor(name: string, options: Partial<{
  71231. capacity: number;
  71232. randomTextureSize: number;
  71233. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71234. protected _reset(): void;
  71235. private _createUpdateVAO;
  71236. private _createRenderVAO;
  71237. private _initialize;
  71238. /** @hidden */
  71239. _recreateUpdateEffect(): void;
  71240. private _getEffect;
  71241. /**
  71242. * Fill the defines array according to the current settings of the particle system
  71243. * @param defines Array to be updated
  71244. * @param blendMode blend mode to take into account when updating the array
  71245. */
  71246. fillDefines(defines: Array<string>, blendMode?: number): void;
  71247. /**
  71248. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71249. * @param uniforms Uniforms array to fill
  71250. * @param attributes Attributes array to fill
  71251. * @param samplers Samplers array to fill
  71252. */
  71253. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71254. /** @hidden */
  71255. _recreateRenderEffect(): Effect;
  71256. /**
  71257. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71258. * @param preWarm defines if we are in the pre-warmimg phase
  71259. */
  71260. animate(preWarm?: boolean): void;
  71261. private _createFactorGradientTexture;
  71262. private _createSizeGradientTexture;
  71263. private _createAngularSpeedGradientTexture;
  71264. private _createVelocityGradientTexture;
  71265. private _createLimitVelocityGradientTexture;
  71266. private _createDragGradientTexture;
  71267. private _createColorGradientTexture;
  71268. /**
  71269. * Renders the particle system in its current state
  71270. * @param preWarm defines if the system should only update the particles but not render them
  71271. * @returns the current number of particles
  71272. */
  71273. render(preWarm?: boolean): number;
  71274. /**
  71275. * Rebuilds the particle system
  71276. */
  71277. rebuild(): void;
  71278. private _releaseBuffers;
  71279. private _releaseVAOs;
  71280. /**
  71281. * Disposes the particle system and free the associated resources
  71282. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71283. */
  71284. dispose(disposeTexture?: boolean): void;
  71285. /**
  71286. * Clones the particle system.
  71287. * @param name The name of the cloned object
  71288. * @param newEmitter The new emitter to use
  71289. * @returns the cloned particle system
  71290. */
  71291. clone(name: string, newEmitter: any): GPUParticleSystem;
  71292. /**
  71293. * Serializes the particle system to a JSON object
  71294. * @param serializeTexture defines if the texture must be serialized as well
  71295. * @returns the JSON object
  71296. */
  71297. serialize(serializeTexture?: boolean): any;
  71298. /**
  71299. * Parses a JSON object to create a GPU particle system.
  71300. * @param parsedParticleSystem The JSON object to parse
  71301. * @param sceneOrEngine The scene or the engine to create the particle system in
  71302. * @param rootUrl The root url to use to load external dependencies like texture
  71303. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71304. * @returns the parsed GPU particle system
  71305. */
  71306. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71307. }
  71308. }
  71309. declare module "babylonjs/Particles/particleSystemSet" {
  71310. import { Nullable } from "babylonjs/types";
  71311. import { Color3 } from "babylonjs/Maths/math.color";
  71312. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71313. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71314. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71315. import { Scene, IDisposable } from "babylonjs/scene";
  71316. /**
  71317. * Represents a set of particle systems working together to create a specific effect
  71318. */
  71319. export class ParticleSystemSet implements IDisposable {
  71320. /**
  71321. * Gets or sets base Assets URL
  71322. */
  71323. static BaseAssetsUrl: string;
  71324. private _emitterCreationOptions;
  71325. private _emitterNode;
  71326. /**
  71327. * Gets the particle system list
  71328. */
  71329. systems: IParticleSystem[];
  71330. /**
  71331. * Gets the emitter node used with this set
  71332. */
  71333. get emitterNode(): Nullable<TransformNode>;
  71334. /**
  71335. * Creates a new emitter mesh as a sphere
  71336. * @param options defines the options used to create the sphere
  71337. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71338. * @param scene defines the hosting scene
  71339. */
  71340. setEmitterAsSphere(options: {
  71341. diameter: number;
  71342. segments: number;
  71343. color: Color3;
  71344. }, renderingGroupId: number, scene: Scene): void;
  71345. /**
  71346. * Starts all particle systems of the set
  71347. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71348. */
  71349. start(emitter?: AbstractMesh): void;
  71350. /**
  71351. * Release all associated resources
  71352. */
  71353. dispose(): void;
  71354. /**
  71355. * Serialize the set into a JSON compatible object
  71356. * @param serializeTexture defines if the texture must be serialized as well
  71357. * @returns a JSON compatible representation of the set
  71358. */
  71359. serialize(serializeTexture?: boolean): any;
  71360. /**
  71361. * Parse a new ParticleSystemSet from a serialized source
  71362. * @param data defines a JSON compatible representation of the set
  71363. * @param scene defines the hosting scene
  71364. * @param gpu defines if we want GPU particles or CPU particles
  71365. * @returns a new ParticleSystemSet
  71366. */
  71367. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71368. }
  71369. }
  71370. declare module "babylonjs/Particles/particleHelper" {
  71371. import { Nullable } from "babylonjs/types";
  71372. import { Scene } from "babylonjs/scene";
  71373. import { Vector3 } from "babylonjs/Maths/math.vector";
  71374. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71375. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71376. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71377. /**
  71378. * This class is made for on one-liner static method to help creating particle system set.
  71379. */
  71380. export class ParticleHelper {
  71381. /**
  71382. * Gets or sets base Assets URL
  71383. */
  71384. static BaseAssetsUrl: string;
  71385. /** Define the Url to load snippets */
  71386. static SnippetUrl: string;
  71387. /**
  71388. * Create a default particle system that you can tweak
  71389. * @param emitter defines the emitter to use
  71390. * @param capacity defines the system capacity (default is 500 particles)
  71391. * @param scene defines the hosting scene
  71392. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71393. * @returns the new Particle system
  71394. */
  71395. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71396. /**
  71397. * This is the main static method (one-liner) of this helper to create different particle systems
  71398. * @param type This string represents the type to the particle system to create
  71399. * @param scene The scene where the particle system should live
  71400. * @param gpu If the system will use gpu
  71401. * @returns the ParticleSystemSet created
  71402. */
  71403. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71404. /**
  71405. * Static function used to export a particle system to a ParticleSystemSet variable.
  71406. * Please note that the emitter shape is not exported
  71407. * @param systems defines the particle systems to export
  71408. * @returns the created particle system set
  71409. */
  71410. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71411. /**
  71412. * Creates a particle system from a snippet saved in a remote file
  71413. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71414. * @param url defines the url to load from
  71415. * @param scene defines the hosting scene
  71416. * @param gpu If the system will use gpu
  71417. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71418. * @returns a promise that will resolve to the new particle system
  71419. */
  71420. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71421. /**
  71422. * Creates a particle system from a snippet saved by the particle system editor
  71423. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71424. * @param scene defines the hosting scene
  71425. * @param gpu If the system will use gpu
  71426. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71427. * @returns a promise that will resolve to the new particle system
  71428. */
  71429. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71430. }
  71431. }
  71432. declare module "babylonjs/Particles/particleSystemComponent" {
  71433. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71434. import { Effect } from "babylonjs/Materials/effect";
  71435. import "babylonjs/Shaders/particles.vertex";
  71436. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71437. module "babylonjs/Engines/engine" {
  71438. interface Engine {
  71439. /**
  71440. * Create an effect to use with particle systems.
  71441. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71442. * the particle system for which you want to create a custom effect in the last parameter
  71443. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71444. * @param uniformsNames defines a list of attribute names
  71445. * @param samplers defines an array of string used to represent textures
  71446. * @param defines defines the string containing the defines to use to compile the shaders
  71447. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71448. * @param onCompiled defines a function to call when the effect creation is successful
  71449. * @param onError defines a function to call when the effect creation has failed
  71450. * @param particleSystem the particle system you want to create the effect for
  71451. * @returns the new Effect
  71452. */
  71453. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71454. }
  71455. }
  71456. module "babylonjs/Meshes/mesh" {
  71457. interface Mesh {
  71458. /**
  71459. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71460. * @returns an array of IParticleSystem
  71461. */
  71462. getEmittedParticleSystems(): IParticleSystem[];
  71463. /**
  71464. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71465. * @returns an array of IParticleSystem
  71466. */
  71467. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71468. }
  71469. }
  71470. }
  71471. declare module "babylonjs/Particles/pointsCloudSystem" {
  71472. import { Color4 } from "babylonjs/Maths/math";
  71473. import { Mesh } from "babylonjs/Meshes/mesh";
  71474. import { Scene, IDisposable } from "babylonjs/scene";
  71475. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71476. /** Defines the 4 color options */
  71477. export enum PointColor {
  71478. /** color value */
  71479. Color = 2,
  71480. /** uv value */
  71481. UV = 1,
  71482. /** random value */
  71483. Random = 0,
  71484. /** stated value */
  71485. Stated = 3
  71486. }
  71487. /**
  71488. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71489. * 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.
  71490. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71491. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71492. *
  71493. * Full documentation here : TO BE ENTERED
  71494. */
  71495. export class PointsCloudSystem implements IDisposable {
  71496. /**
  71497. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71498. * Example : var p = SPS.particles[i];
  71499. */
  71500. particles: CloudPoint[];
  71501. /**
  71502. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71503. */
  71504. nbParticles: number;
  71505. /**
  71506. * This a counter for your own usage. It's not set by any SPS functions.
  71507. */
  71508. counter: number;
  71509. /**
  71510. * The PCS name. This name is also given to the underlying mesh.
  71511. */
  71512. name: string;
  71513. /**
  71514. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71515. */
  71516. mesh: Mesh;
  71517. /**
  71518. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71519. * Please read :
  71520. */
  71521. vars: any;
  71522. /**
  71523. * @hidden
  71524. */
  71525. _size: number;
  71526. private _scene;
  71527. private _promises;
  71528. private _positions;
  71529. private _indices;
  71530. private _normals;
  71531. private _colors;
  71532. private _uvs;
  71533. private _indices32;
  71534. private _positions32;
  71535. private _colors32;
  71536. private _uvs32;
  71537. private _updatable;
  71538. private _isVisibilityBoxLocked;
  71539. private _alwaysVisible;
  71540. private _groups;
  71541. private _groupCounter;
  71542. private _computeParticleColor;
  71543. private _computeParticleTexture;
  71544. private _computeParticleRotation;
  71545. private _computeBoundingBox;
  71546. private _isReady;
  71547. /**
  71548. * Creates a PCS (Points Cloud System) object
  71549. * @param name (String) is the PCS name, this will be the underlying mesh name
  71550. * @param pointSize (number) is the size for each point
  71551. * @param scene (Scene) is the scene in which the PCS is added
  71552. * @param options defines the options of the PCS e.g.
  71553. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71554. */
  71555. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71556. updatable?: boolean;
  71557. });
  71558. /**
  71559. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71560. * If no points were added to the PCS, the returned mesh is just a single point.
  71561. * @returns a promise for the created mesh
  71562. */
  71563. buildMeshAsync(): Promise<Mesh>;
  71564. /**
  71565. * @hidden
  71566. */
  71567. private _buildMesh;
  71568. private _addParticle;
  71569. private _randomUnitVector;
  71570. private _getColorIndicesForCoord;
  71571. private _setPointsColorOrUV;
  71572. private _colorFromTexture;
  71573. private _calculateDensity;
  71574. /**
  71575. * Adds points to the PCS in random positions within a unit sphere
  71576. * @param nb (positive integer) the number of particles to be created from this model
  71577. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71578. * @returns the number of groups in the system
  71579. */
  71580. addPoints(nb: number, pointFunction?: any): number;
  71581. /**
  71582. * Adds points to the PCS from the surface of the model shape
  71583. * @param mesh is any Mesh object that will be used as a surface model for the points
  71584. * @param nb (positive integer) the number of particles to be created from this model
  71585. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71586. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71587. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71588. * @returns the number of groups in the system
  71589. */
  71590. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71591. /**
  71592. * Adds points to the PCS inside the model shape
  71593. * @param mesh is any Mesh object that will be used as a surface model for the points
  71594. * @param nb (positive integer) the number of particles to be created from this model
  71595. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71596. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71597. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71598. * @returns the number of groups in the system
  71599. */
  71600. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71601. /**
  71602. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71603. * This method calls `updateParticle()` for each particle of the SPS.
  71604. * For an animated SPS, it is usually called within the render loop.
  71605. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71606. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71607. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71608. * @returns the PCS.
  71609. */
  71610. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71611. /**
  71612. * Disposes the PCS.
  71613. */
  71614. dispose(): void;
  71615. /**
  71616. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71617. * doc :
  71618. * @returns the PCS.
  71619. */
  71620. refreshVisibleSize(): PointsCloudSystem;
  71621. /**
  71622. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71623. * @param size the size (float) of the visibility box
  71624. * note : this doesn't lock the PCS mesh bounding box.
  71625. * doc :
  71626. */
  71627. setVisibilityBox(size: number): void;
  71628. /**
  71629. * Gets whether the PCS is always visible or not
  71630. * doc :
  71631. */
  71632. get isAlwaysVisible(): boolean;
  71633. /**
  71634. * Sets the PCS as always visible or not
  71635. * doc :
  71636. */
  71637. set isAlwaysVisible(val: boolean);
  71638. /**
  71639. * Tells to `setParticles()` to compute the particle rotations or not
  71640. * Default value : false. The PCS is faster when it's set to false
  71641. * Note : particle rotations are only applied to parent particles
  71642. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71643. */
  71644. set computeParticleRotation(val: boolean);
  71645. /**
  71646. * Tells to `setParticles()` to compute the particle colors or not.
  71647. * Default value : true. The PCS is faster when it's set to false.
  71648. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71649. */
  71650. set computeParticleColor(val: boolean);
  71651. set computeParticleTexture(val: boolean);
  71652. /**
  71653. * Gets if `setParticles()` computes the particle colors or not.
  71654. * Default value : false. The PCS is faster when it's set to false.
  71655. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71656. */
  71657. get computeParticleColor(): boolean;
  71658. /**
  71659. * Gets if `setParticles()` computes the particle textures or not.
  71660. * Default value : false. The PCS is faster when it's set to false.
  71661. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71662. */
  71663. get computeParticleTexture(): boolean;
  71664. /**
  71665. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71666. */
  71667. set computeBoundingBox(val: boolean);
  71668. /**
  71669. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71670. */
  71671. get computeBoundingBox(): boolean;
  71672. /**
  71673. * This function does nothing. It may be overwritten to set all the particle first values.
  71674. * The PCS doesn't call this function, you may have to call it by your own.
  71675. * doc :
  71676. */
  71677. initParticles(): void;
  71678. /**
  71679. * This function does nothing. It may be overwritten to recycle a particle
  71680. * The PCS doesn't call this function, you can to call it
  71681. * doc :
  71682. * @param particle The particle to recycle
  71683. * @returns the recycled particle
  71684. */
  71685. recycleParticle(particle: CloudPoint): CloudPoint;
  71686. /**
  71687. * Updates a particle : this function should be overwritten by the user.
  71688. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71689. * doc :
  71690. * @example : just set a particle position or velocity and recycle conditions
  71691. * @param particle The particle to update
  71692. * @returns the updated particle
  71693. */
  71694. updateParticle(particle: CloudPoint): CloudPoint;
  71695. /**
  71696. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71697. * This does nothing and may be overwritten by the user.
  71698. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71699. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71700. * @param update the boolean update value actually passed to setParticles()
  71701. */
  71702. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71703. /**
  71704. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71705. * This will be passed three parameters.
  71706. * This does nothing and may be overwritten by the user.
  71707. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71708. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71709. * @param update the boolean update value actually passed to setParticles()
  71710. */
  71711. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71712. }
  71713. }
  71714. declare module "babylonjs/Particles/cloudPoint" {
  71715. import { Nullable } from "babylonjs/types";
  71716. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71717. import { Mesh } from "babylonjs/Meshes/mesh";
  71718. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71719. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71720. /**
  71721. * Represents one particle of a points cloud system.
  71722. */
  71723. export class CloudPoint {
  71724. /**
  71725. * particle global index
  71726. */
  71727. idx: number;
  71728. /**
  71729. * The color of the particle
  71730. */
  71731. color: Nullable<Color4>;
  71732. /**
  71733. * The world space position of the particle.
  71734. */
  71735. position: Vector3;
  71736. /**
  71737. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71738. */
  71739. rotation: Vector3;
  71740. /**
  71741. * The world space rotation quaternion of the particle.
  71742. */
  71743. rotationQuaternion: Nullable<Quaternion>;
  71744. /**
  71745. * The uv of the particle.
  71746. */
  71747. uv: Nullable<Vector2>;
  71748. /**
  71749. * The current speed of the particle.
  71750. */
  71751. velocity: Vector3;
  71752. /**
  71753. * The pivot point in the particle local space.
  71754. */
  71755. pivot: Vector3;
  71756. /**
  71757. * Must the particle be translated from its pivot point in its local space ?
  71758. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71759. * Default : false
  71760. */
  71761. translateFromPivot: boolean;
  71762. /**
  71763. * Index of this particle in the global "positions" array (Internal use)
  71764. * @hidden
  71765. */
  71766. _pos: number;
  71767. /**
  71768. * @hidden Index of this particle in the global "indices" array (Internal use)
  71769. */
  71770. _ind: number;
  71771. /**
  71772. * Group this particle belongs to
  71773. */
  71774. _group: PointsGroup;
  71775. /**
  71776. * Group id of this particle
  71777. */
  71778. groupId: number;
  71779. /**
  71780. * Index of the particle in its group id (Internal use)
  71781. */
  71782. idxInGroup: number;
  71783. /**
  71784. * @hidden Particle BoundingInfo object (Internal use)
  71785. */
  71786. _boundingInfo: BoundingInfo;
  71787. /**
  71788. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71789. */
  71790. _pcs: PointsCloudSystem;
  71791. /**
  71792. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71793. */
  71794. _stillInvisible: boolean;
  71795. /**
  71796. * @hidden Last computed particle rotation matrix
  71797. */
  71798. _rotationMatrix: number[];
  71799. /**
  71800. * Parent particle Id, if any.
  71801. * Default null.
  71802. */
  71803. parentId: Nullable<number>;
  71804. /**
  71805. * @hidden Internal global position in the PCS.
  71806. */
  71807. _globalPosition: Vector3;
  71808. /**
  71809. * Creates a Point Cloud object.
  71810. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71811. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71812. * @param group (PointsGroup) is the group the particle belongs to
  71813. * @param groupId (integer) is the group identifier in the PCS.
  71814. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71815. * @param pcs defines the PCS it is associated to
  71816. */
  71817. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71818. /**
  71819. * get point size
  71820. */
  71821. get size(): Vector3;
  71822. /**
  71823. * Set point size
  71824. */
  71825. set size(scale: Vector3);
  71826. /**
  71827. * Legacy support, changed quaternion to rotationQuaternion
  71828. */
  71829. get quaternion(): Nullable<Quaternion>;
  71830. /**
  71831. * Legacy support, changed quaternion to rotationQuaternion
  71832. */
  71833. set quaternion(q: Nullable<Quaternion>);
  71834. /**
  71835. * Returns a boolean. True if the particle intersects a mesh, else false
  71836. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71837. * @param target is the object (point or mesh) what the intersection is computed against
  71838. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71839. * @returns true if it intersects
  71840. */
  71841. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71842. /**
  71843. * get the rotation matrix of the particle
  71844. * @hidden
  71845. */
  71846. getRotationMatrix(m: Matrix): void;
  71847. }
  71848. /**
  71849. * Represents a group of points in a points cloud system
  71850. * * PCS internal tool, don't use it manually.
  71851. */
  71852. export class PointsGroup {
  71853. /**
  71854. * The group id
  71855. * @hidden
  71856. */
  71857. groupID: number;
  71858. /**
  71859. * image data for group (internal use)
  71860. * @hidden
  71861. */
  71862. _groupImageData: Nullable<ArrayBufferView>;
  71863. /**
  71864. * Image Width (internal use)
  71865. * @hidden
  71866. */
  71867. _groupImgWidth: number;
  71868. /**
  71869. * Image Height (internal use)
  71870. * @hidden
  71871. */
  71872. _groupImgHeight: number;
  71873. /**
  71874. * Custom position function (internal use)
  71875. * @hidden
  71876. */
  71877. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71878. /**
  71879. * density per facet for surface points
  71880. * @hidden
  71881. */
  71882. _groupDensity: number[];
  71883. /**
  71884. * Only when points are colored by texture carries pointer to texture list array
  71885. * @hidden
  71886. */
  71887. _textureNb: number;
  71888. /**
  71889. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71890. * PCS internal tool, don't use it manually.
  71891. * @hidden
  71892. */
  71893. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71894. }
  71895. }
  71896. declare module "babylonjs/Particles/index" {
  71897. export * from "babylonjs/Particles/baseParticleSystem";
  71898. export * from "babylonjs/Particles/EmitterTypes/index";
  71899. export * from "babylonjs/Particles/gpuParticleSystem";
  71900. export * from "babylonjs/Particles/IParticleSystem";
  71901. export * from "babylonjs/Particles/particle";
  71902. export * from "babylonjs/Particles/particleHelper";
  71903. export * from "babylonjs/Particles/particleSystem";
  71904. import "babylonjs/Particles/particleSystemComponent";
  71905. export * from "babylonjs/Particles/particleSystemComponent";
  71906. export * from "babylonjs/Particles/particleSystemSet";
  71907. export * from "babylonjs/Particles/solidParticle";
  71908. export * from "babylonjs/Particles/solidParticleSystem";
  71909. export * from "babylonjs/Particles/cloudPoint";
  71910. export * from "babylonjs/Particles/pointsCloudSystem";
  71911. export * from "babylonjs/Particles/subEmitter";
  71912. }
  71913. declare module "babylonjs/Physics/physicsEngineComponent" {
  71914. import { Nullable } from "babylonjs/types";
  71915. import { Observable, Observer } from "babylonjs/Misc/observable";
  71916. import { Vector3 } from "babylonjs/Maths/math.vector";
  71917. import { Mesh } from "babylonjs/Meshes/mesh";
  71918. import { ISceneComponent } from "babylonjs/sceneComponent";
  71919. import { Scene } from "babylonjs/scene";
  71920. import { Node } from "babylonjs/node";
  71921. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  71922. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71923. module "babylonjs/scene" {
  71924. interface Scene {
  71925. /** @hidden (Backing field) */
  71926. _physicsEngine: Nullable<IPhysicsEngine>;
  71927. /** @hidden */
  71928. _physicsTimeAccumulator: number;
  71929. /**
  71930. * Gets the current physics engine
  71931. * @returns a IPhysicsEngine or null if none attached
  71932. */
  71933. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  71934. /**
  71935. * Enables physics to the current scene
  71936. * @param gravity defines the scene's gravity for the physics engine
  71937. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  71938. * @return a boolean indicating if the physics engine was initialized
  71939. */
  71940. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  71941. /**
  71942. * Disables and disposes the physics engine associated with the scene
  71943. */
  71944. disablePhysicsEngine(): void;
  71945. /**
  71946. * Gets a boolean indicating if there is an active physics engine
  71947. * @returns a boolean indicating if there is an active physics engine
  71948. */
  71949. isPhysicsEnabled(): boolean;
  71950. /**
  71951. * Deletes a physics compound impostor
  71952. * @param compound defines the compound to delete
  71953. */
  71954. deleteCompoundImpostor(compound: any): void;
  71955. /**
  71956. * An event triggered when physic simulation is about to be run
  71957. */
  71958. onBeforePhysicsObservable: Observable<Scene>;
  71959. /**
  71960. * An event triggered when physic simulation has been done
  71961. */
  71962. onAfterPhysicsObservable: Observable<Scene>;
  71963. }
  71964. }
  71965. module "babylonjs/Meshes/abstractMesh" {
  71966. interface AbstractMesh {
  71967. /** @hidden */
  71968. _physicsImpostor: Nullable<PhysicsImpostor>;
  71969. /**
  71970. * Gets or sets impostor used for physic simulation
  71971. * @see https://doc.babylonjs.com/features/physics_engine
  71972. */
  71973. physicsImpostor: Nullable<PhysicsImpostor>;
  71974. /**
  71975. * Gets the current physics impostor
  71976. * @see https://doc.babylonjs.com/features/physics_engine
  71977. * @returns a physics impostor or null
  71978. */
  71979. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  71980. /** Apply a physic impulse to the mesh
  71981. * @param force defines the force to apply
  71982. * @param contactPoint defines where to apply the force
  71983. * @returns the current mesh
  71984. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  71985. */
  71986. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  71987. /**
  71988. * Creates a physic joint between two meshes
  71989. * @param otherMesh defines the other mesh to use
  71990. * @param pivot1 defines the pivot to use on this mesh
  71991. * @param pivot2 defines the pivot to use on the other mesh
  71992. * @param options defines additional options (can be plugin dependent)
  71993. * @returns the current mesh
  71994. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  71995. */
  71996. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  71997. /** @hidden */
  71998. _disposePhysicsObserver: Nullable<Observer<Node>>;
  71999. }
  72000. }
  72001. /**
  72002. * Defines the physics engine scene component responsible to manage a physics engine
  72003. */
  72004. export class PhysicsEngineSceneComponent implements ISceneComponent {
  72005. /**
  72006. * The component name helpful to identify the component in the list of scene components.
  72007. */
  72008. readonly name: string;
  72009. /**
  72010. * The scene the component belongs to.
  72011. */
  72012. scene: Scene;
  72013. /**
  72014. * Creates a new instance of the component for the given scene
  72015. * @param scene Defines the scene to register the component in
  72016. */
  72017. constructor(scene: Scene);
  72018. /**
  72019. * Registers the component in a given scene
  72020. */
  72021. register(): void;
  72022. /**
  72023. * Rebuilds the elements related to this component in case of
  72024. * context lost for instance.
  72025. */
  72026. rebuild(): void;
  72027. /**
  72028. * Disposes the component and the associated ressources
  72029. */
  72030. dispose(): void;
  72031. }
  72032. }
  72033. declare module "babylonjs/Physics/physicsHelper" {
  72034. import { Nullable } from "babylonjs/types";
  72035. import { Vector3 } from "babylonjs/Maths/math.vector";
  72036. import { Mesh } from "babylonjs/Meshes/mesh";
  72037. import { Scene } from "babylonjs/scene";
  72038. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72039. /**
  72040. * A helper for physics simulations
  72041. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72042. */
  72043. export class PhysicsHelper {
  72044. private _scene;
  72045. private _physicsEngine;
  72046. /**
  72047. * Initializes the Physics helper
  72048. * @param scene Babylon.js scene
  72049. */
  72050. constructor(scene: Scene);
  72051. /**
  72052. * Applies a radial explosion impulse
  72053. * @param origin the origin of the explosion
  72054. * @param radiusOrEventOptions the radius or the options of radial explosion
  72055. * @param strength the explosion strength
  72056. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72057. * @returns A physics radial explosion event, or null
  72058. */
  72059. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72060. /**
  72061. * Applies a radial explosion force
  72062. * @param origin the origin of the explosion
  72063. * @param radiusOrEventOptions the radius or the options of radial explosion
  72064. * @param strength the explosion strength
  72065. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72066. * @returns A physics radial explosion event, or null
  72067. */
  72068. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72069. /**
  72070. * Creates a gravitational field
  72071. * @param origin the origin of the explosion
  72072. * @param radiusOrEventOptions the radius or the options of radial explosion
  72073. * @param strength the explosion strength
  72074. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72075. * @returns A physics gravitational field event, or null
  72076. */
  72077. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72078. /**
  72079. * Creates a physics updraft event
  72080. * @param origin the origin of the updraft
  72081. * @param radiusOrEventOptions the radius or the options of the updraft
  72082. * @param strength the strength of the updraft
  72083. * @param height the height of the updraft
  72084. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72085. * @returns A physics updraft event, or null
  72086. */
  72087. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72088. /**
  72089. * Creates a physics vortex event
  72090. * @param origin the of the vortex
  72091. * @param radiusOrEventOptions the radius or the options of the vortex
  72092. * @param strength the strength of the vortex
  72093. * @param height the height of the vortex
  72094. * @returns a Physics vortex event, or null
  72095. * A physics vortex event or null
  72096. */
  72097. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72098. }
  72099. /**
  72100. * Represents a physics radial explosion event
  72101. */
  72102. class PhysicsRadialExplosionEvent {
  72103. private _scene;
  72104. private _options;
  72105. private _sphere;
  72106. private _dataFetched;
  72107. /**
  72108. * Initializes a radial explosioin event
  72109. * @param _scene BabylonJS scene
  72110. * @param _options The options for the vortex event
  72111. */
  72112. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72113. /**
  72114. * Returns the data related to the radial explosion event (sphere).
  72115. * @returns The radial explosion event data
  72116. */
  72117. getData(): PhysicsRadialExplosionEventData;
  72118. /**
  72119. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72120. * @param impostor A physics imposter
  72121. * @param origin the origin of the explosion
  72122. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72123. */
  72124. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72125. /**
  72126. * Triggers affecterd impostors callbacks
  72127. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72128. */
  72129. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72130. /**
  72131. * Disposes the sphere.
  72132. * @param force Specifies if the sphere should be disposed by force
  72133. */
  72134. dispose(force?: boolean): void;
  72135. /*** Helpers ***/
  72136. private _prepareSphere;
  72137. private _intersectsWithSphere;
  72138. }
  72139. /**
  72140. * Represents a gravitational field event
  72141. */
  72142. class PhysicsGravitationalFieldEvent {
  72143. private _physicsHelper;
  72144. private _scene;
  72145. private _origin;
  72146. private _options;
  72147. private _tickCallback;
  72148. private _sphere;
  72149. private _dataFetched;
  72150. /**
  72151. * Initializes the physics gravitational field event
  72152. * @param _physicsHelper A physics helper
  72153. * @param _scene BabylonJS scene
  72154. * @param _origin The origin position of the gravitational field event
  72155. * @param _options The options for the vortex event
  72156. */
  72157. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72158. /**
  72159. * Returns the data related to the gravitational field event (sphere).
  72160. * @returns A gravitational field event
  72161. */
  72162. getData(): PhysicsGravitationalFieldEventData;
  72163. /**
  72164. * Enables the gravitational field.
  72165. */
  72166. enable(): void;
  72167. /**
  72168. * Disables the gravitational field.
  72169. */
  72170. disable(): void;
  72171. /**
  72172. * Disposes the sphere.
  72173. * @param force The force to dispose from the gravitational field event
  72174. */
  72175. dispose(force?: boolean): void;
  72176. private _tick;
  72177. }
  72178. /**
  72179. * Represents a physics updraft event
  72180. */
  72181. class PhysicsUpdraftEvent {
  72182. private _scene;
  72183. private _origin;
  72184. private _options;
  72185. private _physicsEngine;
  72186. private _originTop;
  72187. private _originDirection;
  72188. private _tickCallback;
  72189. private _cylinder;
  72190. private _cylinderPosition;
  72191. private _dataFetched;
  72192. /**
  72193. * Initializes the physics updraft event
  72194. * @param _scene BabylonJS scene
  72195. * @param _origin The origin position of the updraft
  72196. * @param _options The options for the updraft event
  72197. */
  72198. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72199. /**
  72200. * Returns the data related to the updraft event (cylinder).
  72201. * @returns A physics updraft event
  72202. */
  72203. getData(): PhysicsUpdraftEventData;
  72204. /**
  72205. * Enables the updraft.
  72206. */
  72207. enable(): void;
  72208. /**
  72209. * Disables the updraft.
  72210. */
  72211. disable(): void;
  72212. /**
  72213. * Disposes the cylinder.
  72214. * @param force Specifies if the updraft should be disposed by force
  72215. */
  72216. dispose(force?: boolean): void;
  72217. private getImpostorHitData;
  72218. private _tick;
  72219. /*** Helpers ***/
  72220. private _prepareCylinder;
  72221. private _intersectsWithCylinder;
  72222. }
  72223. /**
  72224. * Represents a physics vortex event
  72225. */
  72226. class PhysicsVortexEvent {
  72227. private _scene;
  72228. private _origin;
  72229. private _options;
  72230. private _physicsEngine;
  72231. private _originTop;
  72232. private _tickCallback;
  72233. private _cylinder;
  72234. private _cylinderPosition;
  72235. private _dataFetched;
  72236. /**
  72237. * Initializes the physics vortex event
  72238. * @param _scene The BabylonJS scene
  72239. * @param _origin The origin position of the vortex
  72240. * @param _options The options for the vortex event
  72241. */
  72242. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72243. /**
  72244. * Returns the data related to the vortex event (cylinder).
  72245. * @returns The physics vortex event data
  72246. */
  72247. getData(): PhysicsVortexEventData;
  72248. /**
  72249. * Enables the vortex.
  72250. */
  72251. enable(): void;
  72252. /**
  72253. * Disables the cortex.
  72254. */
  72255. disable(): void;
  72256. /**
  72257. * Disposes the sphere.
  72258. * @param force
  72259. */
  72260. dispose(force?: boolean): void;
  72261. private getImpostorHitData;
  72262. private _tick;
  72263. /*** Helpers ***/
  72264. private _prepareCylinder;
  72265. private _intersectsWithCylinder;
  72266. }
  72267. /**
  72268. * Options fot the radial explosion event
  72269. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72270. */
  72271. export class PhysicsRadialExplosionEventOptions {
  72272. /**
  72273. * The radius of the sphere for the radial explosion.
  72274. */
  72275. radius: number;
  72276. /**
  72277. * The strenth of the explosion.
  72278. */
  72279. strength: number;
  72280. /**
  72281. * The strenght of the force in correspondence to the distance of the affected object
  72282. */
  72283. falloff: PhysicsRadialImpulseFalloff;
  72284. /**
  72285. * Sphere options for the radial explosion.
  72286. */
  72287. sphere: {
  72288. segments: number;
  72289. diameter: number;
  72290. };
  72291. /**
  72292. * Sphere options for the radial explosion.
  72293. */
  72294. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72295. }
  72296. /**
  72297. * Options fot the updraft event
  72298. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72299. */
  72300. export class PhysicsUpdraftEventOptions {
  72301. /**
  72302. * The radius of the cylinder for the vortex
  72303. */
  72304. radius: number;
  72305. /**
  72306. * The strenth of the updraft.
  72307. */
  72308. strength: number;
  72309. /**
  72310. * The height of the cylinder for the updraft.
  72311. */
  72312. height: number;
  72313. /**
  72314. * The mode for the the updraft.
  72315. */
  72316. updraftMode: PhysicsUpdraftMode;
  72317. }
  72318. /**
  72319. * Options fot the vortex event
  72320. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72321. */
  72322. export class PhysicsVortexEventOptions {
  72323. /**
  72324. * The radius of the cylinder for the vortex
  72325. */
  72326. radius: number;
  72327. /**
  72328. * The strenth of the vortex.
  72329. */
  72330. strength: number;
  72331. /**
  72332. * The height of the cylinder for the vortex.
  72333. */
  72334. height: number;
  72335. /**
  72336. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72337. */
  72338. centripetalForceThreshold: number;
  72339. /**
  72340. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72341. */
  72342. centripetalForceMultiplier: number;
  72343. /**
  72344. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72345. */
  72346. centrifugalForceMultiplier: number;
  72347. /**
  72348. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72349. */
  72350. updraftForceMultiplier: number;
  72351. }
  72352. /**
  72353. * The strenght of the force in correspondence to the distance of the affected object
  72354. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72355. */
  72356. export enum PhysicsRadialImpulseFalloff {
  72357. /** Defines that impulse is constant in strength across it's whole radius */
  72358. Constant = 0,
  72359. /** Defines that impulse gets weaker if it's further from the origin */
  72360. Linear = 1
  72361. }
  72362. /**
  72363. * The strength of the force in correspondence to the distance of the affected object
  72364. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72365. */
  72366. export enum PhysicsUpdraftMode {
  72367. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72368. Center = 0,
  72369. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72370. Perpendicular = 1
  72371. }
  72372. /**
  72373. * Interface for a physics hit data
  72374. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72375. */
  72376. export interface PhysicsHitData {
  72377. /**
  72378. * The force applied at the contact point
  72379. */
  72380. force: Vector3;
  72381. /**
  72382. * The contact point
  72383. */
  72384. contactPoint: Vector3;
  72385. /**
  72386. * The distance from the origin to the contact point
  72387. */
  72388. distanceFromOrigin: number;
  72389. }
  72390. /**
  72391. * Interface for radial explosion event data
  72392. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72393. */
  72394. export interface PhysicsRadialExplosionEventData {
  72395. /**
  72396. * A sphere used for the radial explosion event
  72397. */
  72398. sphere: Mesh;
  72399. }
  72400. /**
  72401. * Interface for gravitational field event data
  72402. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72403. */
  72404. export interface PhysicsGravitationalFieldEventData {
  72405. /**
  72406. * A sphere mesh used for the gravitational field event
  72407. */
  72408. sphere: Mesh;
  72409. }
  72410. /**
  72411. * Interface for updraft event data
  72412. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72413. */
  72414. export interface PhysicsUpdraftEventData {
  72415. /**
  72416. * A cylinder used for the updraft event
  72417. */
  72418. cylinder: Mesh;
  72419. }
  72420. /**
  72421. * Interface for vortex event data
  72422. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72423. */
  72424. export interface PhysicsVortexEventData {
  72425. /**
  72426. * A cylinder used for the vortex event
  72427. */
  72428. cylinder: Mesh;
  72429. }
  72430. /**
  72431. * Interface for an affected physics impostor
  72432. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72433. */
  72434. export interface PhysicsAffectedImpostorWithData {
  72435. /**
  72436. * The impostor affected by the effect
  72437. */
  72438. impostor: PhysicsImpostor;
  72439. /**
  72440. * The data about the hit/horce from the explosion
  72441. */
  72442. hitData: PhysicsHitData;
  72443. }
  72444. }
  72445. declare module "babylonjs/Physics/Plugins/index" {
  72446. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72447. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72448. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72449. }
  72450. declare module "babylonjs/Physics/index" {
  72451. export * from "babylonjs/Physics/IPhysicsEngine";
  72452. export * from "babylonjs/Physics/physicsEngine";
  72453. export * from "babylonjs/Physics/physicsEngineComponent";
  72454. export * from "babylonjs/Physics/physicsHelper";
  72455. export * from "babylonjs/Physics/physicsImpostor";
  72456. export * from "babylonjs/Physics/physicsJoint";
  72457. export * from "babylonjs/Physics/Plugins/index";
  72458. }
  72459. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72460. /** @hidden */
  72461. export var blackAndWhitePixelShader: {
  72462. name: string;
  72463. shader: string;
  72464. };
  72465. }
  72466. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72467. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72468. import { Camera } from "babylonjs/Cameras/camera";
  72469. import { Engine } from "babylonjs/Engines/engine";
  72470. import "babylonjs/Shaders/blackAndWhite.fragment";
  72471. import { Nullable } from "babylonjs/types";
  72472. import { Scene } from "babylonjs/scene";
  72473. /**
  72474. * Post process used to render in black and white
  72475. */
  72476. export class BlackAndWhitePostProcess extends PostProcess {
  72477. /**
  72478. * Linear about to convert he result to black and white (default: 1)
  72479. */
  72480. degree: number;
  72481. /**
  72482. * Gets a string identifying the name of the class
  72483. * @returns "BlackAndWhitePostProcess" string
  72484. */
  72485. getClassName(): string;
  72486. /**
  72487. * Creates a black and white post process
  72488. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72489. * @param name The name of the effect.
  72490. * @param options The required width/height ratio to downsize to before computing the render pass.
  72491. * @param camera The camera to apply the render pass to.
  72492. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72493. * @param engine The engine which the post process will be applied. (default: current engine)
  72494. * @param reusable If the post process can be reused on the same frame. (default: false)
  72495. */
  72496. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72497. /** @hidden */
  72498. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72499. }
  72500. }
  72501. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72502. import { Nullable } from "babylonjs/types";
  72503. import { Camera } from "babylonjs/Cameras/camera";
  72504. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72505. import { Engine } from "babylonjs/Engines/engine";
  72506. /**
  72507. * This represents a set of one or more post processes in Babylon.
  72508. * A post process can be used to apply a shader to a texture after it is rendered.
  72509. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72510. */
  72511. export class PostProcessRenderEffect {
  72512. private _postProcesses;
  72513. private _getPostProcesses;
  72514. private _singleInstance;
  72515. private _cameras;
  72516. private _indicesForCamera;
  72517. /**
  72518. * Name of the effect
  72519. * @hidden
  72520. */
  72521. _name: string;
  72522. /**
  72523. * Instantiates a post process render effect.
  72524. * A post process can be used to apply a shader to a texture after it is rendered.
  72525. * @param engine The engine the effect is tied to
  72526. * @param name The name of the effect
  72527. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72528. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72529. */
  72530. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72531. /**
  72532. * Checks if all the post processes in the effect are supported.
  72533. */
  72534. get isSupported(): boolean;
  72535. /**
  72536. * Updates the current state of the effect
  72537. * @hidden
  72538. */
  72539. _update(): void;
  72540. /**
  72541. * Attaches the effect on cameras
  72542. * @param cameras The camera to attach to.
  72543. * @hidden
  72544. */
  72545. _attachCameras(cameras: Camera): void;
  72546. /**
  72547. * Attaches the effect on cameras
  72548. * @param cameras The camera to attach to.
  72549. * @hidden
  72550. */
  72551. _attachCameras(cameras: Camera[]): void;
  72552. /**
  72553. * Detaches the effect on cameras
  72554. * @param cameras The camera to detatch from.
  72555. * @hidden
  72556. */
  72557. _detachCameras(cameras: Camera): void;
  72558. /**
  72559. * Detatches the effect on cameras
  72560. * @param cameras The camera to detatch from.
  72561. * @hidden
  72562. */
  72563. _detachCameras(cameras: Camera[]): void;
  72564. /**
  72565. * Enables the effect on given cameras
  72566. * @param cameras The camera to enable.
  72567. * @hidden
  72568. */
  72569. _enable(cameras: Camera): void;
  72570. /**
  72571. * Enables the effect on given cameras
  72572. * @param cameras The camera to enable.
  72573. * @hidden
  72574. */
  72575. _enable(cameras: Nullable<Camera[]>): void;
  72576. /**
  72577. * Disables the effect on the given cameras
  72578. * @param cameras The camera to disable.
  72579. * @hidden
  72580. */
  72581. _disable(cameras: Camera): void;
  72582. /**
  72583. * Disables the effect on the given cameras
  72584. * @param cameras The camera to disable.
  72585. * @hidden
  72586. */
  72587. _disable(cameras: Nullable<Camera[]>): void;
  72588. /**
  72589. * Gets a list of the post processes contained in the effect.
  72590. * @param camera The camera to get the post processes on.
  72591. * @returns The list of the post processes in the effect.
  72592. */
  72593. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72594. }
  72595. }
  72596. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72597. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72598. /** @hidden */
  72599. export var extractHighlightsPixelShader: {
  72600. name: string;
  72601. shader: string;
  72602. };
  72603. }
  72604. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72605. import { Nullable } from "babylonjs/types";
  72606. import { Camera } from "babylonjs/Cameras/camera";
  72607. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72608. import { Engine } from "babylonjs/Engines/engine";
  72609. import "babylonjs/Shaders/extractHighlights.fragment";
  72610. /**
  72611. * 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.
  72612. */
  72613. export class ExtractHighlightsPostProcess extends PostProcess {
  72614. /**
  72615. * The luminance threshold, pixels below this value will be set to black.
  72616. */
  72617. threshold: number;
  72618. /** @hidden */
  72619. _exposure: number;
  72620. /**
  72621. * Post process which has the input texture to be used when performing highlight extraction
  72622. * @hidden
  72623. */
  72624. _inputPostProcess: Nullable<PostProcess>;
  72625. /**
  72626. * Gets a string identifying the name of the class
  72627. * @returns "ExtractHighlightsPostProcess" string
  72628. */
  72629. getClassName(): string;
  72630. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72631. }
  72632. }
  72633. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72634. /** @hidden */
  72635. export var bloomMergePixelShader: {
  72636. name: string;
  72637. shader: string;
  72638. };
  72639. }
  72640. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72641. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72642. import { Nullable } from "babylonjs/types";
  72643. import { Engine } from "babylonjs/Engines/engine";
  72644. import { Camera } from "babylonjs/Cameras/camera";
  72645. import "babylonjs/Shaders/bloomMerge.fragment";
  72646. /**
  72647. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72648. */
  72649. export class BloomMergePostProcess extends PostProcess {
  72650. /** Weight of the bloom to be added to the original input. */
  72651. weight: number;
  72652. /**
  72653. * Gets a string identifying the name of the class
  72654. * @returns "BloomMergePostProcess" string
  72655. */
  72656. getClassName(): string;
  72657. /**
  72658. * Creates a new instance of @see BloomMergePostProcess
  72659. * @param name The name of the effect.
  72660. * @param originalFromInput Post process which's input will be used for the merge.
  72661. * @param blurred Blurred highlights post process which's output will be used.
  72662. * @param weight Weight of the bloom to be added to the original input.
  72663. * @param options The required width/height ratio to downsize to before computing the render pass.
  72664. * @param camera The camera to apply the render pass to.
  72665. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72666. * @param engine The engine which the post process will be applied. (default: current engine)
  72667. * @param reusable If the post process can be reused on the same frame. (default: false)
  72668. * @param textureType Type of textures used when performing the post process. (default: 0)
  72669. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  72670. */
  72671. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72672. /** Weight of the bloom to be added to the original input. */
  72673. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72674. }
  72675. }
  72676. declare module "babylonjs/PostProcesses/bloomEffect" {
  72677. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72678. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72679. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72680. import { Camera } from "babylonjs/Cameras/camera";
  72681. import { Scene } from "babylonjs/scene";
  72682. /**
  72683. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72684. */
  72685. export class BloomEffect extends PostProcessRenderEffect {
  72686. private bloomScale;
  72687. /**
  72688. * @hidden Internal
  72689. */
  72690. _effects: Array<PostProcess>;
  72691. /**
  72692. * @hidden Internal
  72693. */
  72694. _downscale: ExtractHighlightsPostProcess;
  72695. private _blurX;
  72696. private _blurY;
  72697. private _merge;
  72698. /**
  72699. * The luminance threshold to find bright areas of the image to bloom.
  72700. */
  72701. get threshold(): number;
  72702. set threshold(value: number);
  72703. /**
  72704. * The strength of the bloom.
  72705. */
  72706. get weight(): number;
  72707. set weight(value: number);
  72708. /**
  72709. * Specifies the size of the bloom blur kernel, relative to the final output size
  72710. */
  72711. get kernel(): number;
  72712. set kernel(value: number);
  72713. /**
  72714. * Creates a new instance of @see BloomEffect
  72715. * @param scene The scene the effect belongs to.
  72716. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72717. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72718. * @param bloomWeight The the strength of bloom.
  72719. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72720. * @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)
  72721. */
  72722. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72723. /**
  72724. * Disposes each of the internal effects for a given camera.
  72725. * @param camera The camera to dispose the effect on.
  72726. */
  72727. disposeEffects(camera: Camera): void;
  72728. /**
  72729. * @hidden Internal
  72730. */
  72731. _updateEffects(): void;
  72732. /**
  72733. * Internal
  72734. * @returns if all the contained post processes are ready.
  72735. * @hidden
  72736. */
  72737. _isReady(): boolean;
  72738. }
  72739. }
  72740. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72741. /** @hidden */
  72742. export var chromaticAberrationPixelShader: {
  72743. name: string;
  72744. shader: string;
  72745. };
  72746. }
  72747. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72748. import { Vector2 } from "babylonjs/Maths/math.vector";
  72749. import { Nullable } from "babylonjs/types";
  72750. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72751. import { Camera } from "babylonjs/Cameras/camera";
  72752. import { Engine } from "babylonjs/Engines/engine";
  72753. import "babylonjs/Shaders/chromaticAberration.fragment";
  72754. import { Scene } from "babylonjs/scene";
  72755. /**
  72756. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72757. */
  72758. export class ChromaticAberrationPostProcess extends PostProcess {
  72759. /**
  72760. * The amount of seperation of rgb channels (default: 30)
  72761. */
  72762. aberrationAmount: number;
  72763. /**
  72764. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72765. */
  72766. radialIntensity: number;
  72767. /**
  72768. * 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))
  72769. */
  72770. direction: Vector2;
  72771. /**
  72772. * 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))
  72773. */
  72774. centerPosition: Vector2;
  72775. /** The width of the screen to apply the effect on */
  72776. screenWidth: number;
  72777. /** The height of the screen to apply the effect on */
  72778. screenHeight: number;
  72779. /**
  72780. * Gets a string identifying the name of the class
  72781. * @returns "ChromaticAberrationPostProcess" string
  72782. */
  72783. getClassName(): string;
  72784. /**
  72785. * Creates a new instance ChromaticAberrationPostProcess
  72786. * @param name The name of the effect.
  72787. * @param screenWidth The width of the screen to apply the effect on.
  72788. * @param screenHeight The height of the screen to apply the effect on.
  72789. * @param options The required width/height ratio to downsize to before computing the render pass.
  72790. * @param camera The camera to apply the render pass to.
  72791. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72792. * @param engine The engine which the post process will be applied. (default: current engine)
  72793. * @param reusable If the post process can be reused on the same frame. (default: false)
  72794. * @param textureType Type of textures used when performing the post process. (default: 0)
  72795. * @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)
  72796. */
  72797. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72798. /** @hidden */
  72799. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  72800. }
  72801. }
  72802. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72803. /** @hidden */
  72804. export var circleOfConfusionPixelShader: {
  72805. name: string;
  72806. shader: string;
  72807. };
  72808. }
  72809. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72810. import { Nullable } from "babylonjs/types";
  72811. import { Engine } from "babylonjs/Engines/engine";
  72812. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72813. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72814. import { Camera } from "babylonjs/Cameras/camera";
  72815. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72816. /**
  72817. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72818. */
  72819. export class CircleOfConfusionPostProcess extends PostProcess {
  72820. /**
  72821. * 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.
  72822. */
  72823. lensSize: number;
  72824. /**
  72825. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72826. */
  72827. fStop: number;
  72828. /**
  72829. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72830. */
  72831. focusDistance: number;
  72832. /**
  72833. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72834. */
  72835. focalLength: number;
  72836. /**
  72837. * Gets a string identifying the name of the class
  72838. * @returns "CircleOfConfusionPostProcess" string
  72839. */
  72840. getClassName(): string;
  72841. private _depthTexture;
  72842. /**
  72843. * Creates a new instance CircleOfConfusionPostProcess
  72844. * @param name The name of the effect.
  72845. * @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.
  72846. * @param options The required width/height ratio to downsize to before computing the render pass.
  72847. * @param camera The camera to apply the render pass to.
  72848. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72849. * @param engine The engine which the post process will be applied. (default: current engine)
  72850. * @param reusable If the post process can be reused on the same frame. (default: false)
  72851. * @param textureType Type of textures used when performing the post process. (default: 0)
  72852. * @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)
  72853. */
  72854. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72855. /**
  72856. * 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.
  72857. */
  72858. set depthTexture(value: RenderTargetTexture);
  72859. }
  72860. }
  72861. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72862. /** @hidden */
  72863. export var colorCorrectionPixelShader: {
  72864. name: string;
  72865. shader: string;
  72866. };
  72867. }
  72868. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72869. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72870. import { Engine } from "babylonjs/Engines/engine";
  72871. import { Camera } from "babylonjs/Cameras/camera";
  72872. import "babylonjs/Shaders/colorCorrection.fragment";
  72873. import { Nullable } from "babylonjs/types";
  72874. import { Scene } from "babylonjs/scene";
  72875. /**
  72876. *
  72877. * This post-process allows the modification of rendered colors by using
  72878. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72879. *
  72880. * The object needs to be provided an url to a texture containing the color
  72881. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72882. * Use an image editing software to tweak the LUT to match your needs.
  72883. *
  72884. * For an example of a color LUT, see here:
  72885. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72886. * For explanations on color grading, see here:
  72887. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72888. *
  72889. */
  72890. export class ColorCorrectionPostProcess extends PostProcess {
  72891. private _colorTableTexture;
  72892. /**
  72893. * Gets the color table url used to create the LUT texture
  72894. */
  72895. colorTableUrl: string;
  72896. /**
  72897. * Gets a string identifying the name of the class
  72898. * @returns "ColorCorrectionPostProcess" string
  72899. */
  72900. getClassName(): string;
  72901. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72902. /** @hidden */
  72903. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  72904. }
  72905. }
  72906. declare module "babylonjs/Shaders/convolution.fragment" {
  72907. /** @hidden */
  72908. export var convolutionPixelShader: {
  72909. name: string;
  72910. shader: string;
  72911. };
  72912. }
  72913. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  72914. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72915. import { Nullable } from "babylonjs/types";
  72916. import { Camera } from "babylonjs/Cameras/camera";
  72917. import { Engine } from "babylonjs/Engines/engine";
  72918. import "babylonjs/Shaders/convolution.fragment";
  72919. import { Scene } from "babylonjs/scene";
  72920. /**
  72921. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  72922. * input texture to perform effects such as edge detection or sharpening
  72923. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72924. */
  72925. export class ConvolutionPostProcess extends PostProcess {
  72926. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72927. kernel: number[];
  72928. /**
  72929. * Gets a string identifying the name of the class
  72930. * @returns "ConvolutionPostProcess" string
  72931. */
  72932. getClassName(): string;
  72933. /**
  72934. * Creates a new instance ConvolutionPostProcess
  72935. * @param name The name of the effect.
  72936. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  72937. * @param options The required width/height ratio to downsize to before computing the render pass.
  72938. * @param camera The camera to apply the render pass to.
  72939. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72940. * @param engine The engine which the post process will be applied. (default: current engine)
  72941. * @param reusable If the post process can be reused on the same frame. (default: false)
  72942. * @param textureType Type of textures used when performing the post process. (default: 0)
  72943. */
  72944. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72945. /** @hidden */
  72946. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  72947. /**
  72948. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72949. */
  72950. static EdgeDetect0Kernel: number[];
  72951. /**
  72952. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72953. */
  72954. static EdgeDetect1Kernel: number[];
  72955. /**
  72956. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72957. */
  72958. static EdgeDetect2Kernel: number[];
  72959. /**
  72960. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72961. */
  72962. static SharpenKernel: number[];
  72963. /**
  72964. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72965. */
  72966. static EmbossKernel: number[];
  72967. /**
  72968. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72969. */
  72970. static GaussianKernel: number[];
  72971. }
  72972. }
  72973. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  72974. import { Nullable } from "babylonjs/types";
  72975. import { Vector2 } from "babylonjs/Maths/math.vector";
  72976. import { Camera } from "babylonjs/Cameras/camera";
  72977. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72978. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  72979. import { Engine } from "babylonjs/Engines/engine";
  72980. import { Scene } from "babylonjs/scene";
  72981. /**
  72982. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  72983. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  72984. * based on samples that have a large difference in distance than the center pixel.
  72985. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  72986. */
  72987. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  72988. /**
  72989. * The direction the blur should be applied
  72990. */
  72991. direction: Vector2;
  72992. /**
  72993. * Gets a string identifying the name of the class
  72994. * @returns "DepthOfFieldBlurPostProcess" string
  72995. */
  72996. getClassName(): string;
  72997. /**
  72998. * Creates a new instance CircleOfConfusionPostProcess
  72999. * @param name The name of the effect.
  73000. * @param scene The scene the effect belongs to.
  73001. * @param direction The direction the blur should be applied.
  73002. * @param kernel The size of the kernel used to blur.
  73003. * @param options The required width/height ratio to downsize to before computing the render pass.
  73004. * @param camera The camera to apply the render pass to.
  73005. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  73006. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  73007. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73008. * @param engine The engine which the post process will be applied. (default: current engine)
  73009. * @param reusable If the post process can be reused on the same frame. (default: false)
  73010. * @param textureType Type of textures used when performing the post process. (default: 0)
  73011. * @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)
  73012. */
  73013. 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);
  73014. }
  73015. }
  73016. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73017. /** @hidden */
  73018. export var depthOfFieldMergePixelShader: {
  73019. name: string;
  73020. shader: string;
  73021. };
  73022. }
  73023. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73024. import { Nullable } from "babylonjs/types";
  73025. import { Camera } from "babylonjs/Cameras/camera";
  73026. import { Effect } from "babylonjs/Materials/effect";
  73027. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73028. import { Engine } from "babylonjs/Engines/engine";
  73029. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73030. /**
  73031. * Options to be set when merging outputs from the default pipeline.
  73032. */
  73033. export class DepthOfFieldMergePostProcessOptions {
  73034. /**
  73035. * The original image to merge on top of
  73036. */
  73037. originalFromInput: PostProcess;
  73038. /**
  73039. * Parameters to perform the merge of the depth of field effect
  73040. */
  73041. depthOfField?: {
  73042. circleOfConfusion: PostProcess;
  73043. blurSteps: Array<PostProcess>;
  73044. };
  73045. /**
  73046. * Parameters to perform the merge of bloom effect
  73047. */
  73048. bloom?: {
  73049. blurred: PostProcess;
  73050. weight: number;
  73051. };
  73052. }
  73053. /**
  73054. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73055. */
  73056. export class DepthOfFieldMergePostProcess extends PostProcess {
  73057. private blurSteps;
  73058. /**
  73059. * Gets a string identifying the name of the class
  73060. * @returns "DepthOfFieldMergePostProcess" string
  73061. */
  73062. getClassName(): string;
  73063. /**
  73064. * Creates a new instance of DepthOfFieldMergePostProcess
  73065. * @param name The name of the effect.
  73066. * @param originalFromInput Post process which's input will be used for the merge.
  73067. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73068. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73069. * @param options The required width/height ratio to downsize to before computing the render pass.
  73070. * @param camera The camera to apply the render pass to.
  73071. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73072. * @param engine The engine which the post process will be applied. (default: current engine)
  73073. * @param reusable If the post process can be reused on the same frame. (default: false)
  73074. * @param textureType Type of textures used when performing the post process. (default: 0)
  73075. * @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)
  73076. */
  73077. 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);
  73078. /**
  73079. * Updates the effect with the current post process compile time values and recompiles the shader.
  73080. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73081. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73082. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73083. * @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
  73084. * @param onCompiled Called when the shader has been compiled.
  73085. * @param onError Called if there is an error when compiling a shader.
  73086. */
  73087. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73088. }
  73089. }
  73090. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73091. import { Nullable } from "babylonjs/types";
  73092. import { Camera } from "babylonjs/Cameras/camera";
  73093. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73094. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73095. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73096. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73097. import { Scene } from "babylonjs/scene";
  73098. /**
  73099. * Specifies the level of max blur that should be applied when using the depth of field effect
  73100. */
  73101. export enum DepthOfFieldEffectBlurLevel {
  73102. /**
  73103. * Subtle blur
  73104. */
  73105. Low = 0,
  73106. /**
  73107. * Medium blur
  73108. */
  73109. Medium = 1,
  73110. /**
  73111. * Large blur
  73112. */
  73113. High = 2
  73114. }
  73115. /**
  73116. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73117. */
  73118. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73119. private _circleOfConfusion;
  73120. /**
  73121. * @hidden Internal, blurs from high to low
  73122. */
  73123. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73124. private _depthOfFieldBlurY;
  73125. private _dofMerge;
  73126. /**
  73127. * @hidden Internal post processes in depth of field effect
  73128. */
  73129. _effects: Array<PostProcess>;
  73130. /**
  73131. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73132. */
  73133. set focalLength(value: number);
  73134. get focalLength(): number;
  73135. /**
  73136. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73137. */
  73138. set fStop(value: number);
  73139. get fStop(): number;
  73140. /**
  73141. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73142. */
  73143. set focusDistance(value: number);
  73144. get focusDistance(): number;
  73145. /**
  73146. * 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.
  73147. */
  73148. set lensSize(value: number);
  73149. get lensSize(): number;
  73150. /**
  73151. * Creates a new instance DepthOfFieldEffect
  73152. * @param scene The scene the effect belongs to.
  73153. * @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.
  73154. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73155. * @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)
  73156. */
  73157. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73158. /**
  73159. * Get the current class name of the current effet
  73160. * @returns "DepthOfFieldEffect"
  73161. */
  73162. getClassName(): string;
  73163. /**
  73164. * 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.
  73165. */
  73166. set depthTexture(value: RenderTargetTexture);
  73167. /**
  73168. * Disposes each of the internal effects for a given camera.
  73169. * @param camera The camera to dispose the effect on.
  73170. */
  73171. disposeEffects(camera: Camera): void;
  73172. /**
  73173. * @hidden Internal
  73174. */
  73175. _updateEffects(): void;
  73176. /**
  73177. * Internal
  73178. * @returns if all the contained post processes are ready.
  73179. * @hidden
  73180. */
  73181. _isReady(): boolean;
  73182. }
  73183. }
  73184. declare module "babylonjs/Shaders/displayPass.fragment" {
  73185. /** @hidden */
  73186. export var displayPassPixelShader: {
  73187. name: string;
  73188. shader: string;
  73189. };
  73190. }
  73191. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73192. import { Nullable } from "babylonjs/types";
  73193. import { Camera } from "babylonjs/Cameras/camera";
  73194. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73195. import { Engine } from "babylonjs/Engines/engine";
  73196. import "babylonjs/Shaders/displayPass.fragment";
  73197. import { Scene } from "babylonjs/scene";
  73198. /**
  73199. * DisplayPassPostProcess which produces an output the same as it's input
  73200. */
  73201. export class DisplayPassPostProcess extends PostProcess {
  73202. /**
  73203. * Gets a string identifying the name of the class
  73204. * @returns "DisplayPassPostProcess" string
  73205. */
  73206. getClassName(): string;
  73207. /**
  73208. * Creates the DisplayPassPostProcess
  73209. * @param name The name of the effect.
  73210. * @param options The required width/height ratio to downsize to before computing the render pass.
  73211. * @param camera The camera to apply the render pass to.
  73212. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73213. * @param engine The engine which the post process will be applied. (default: current engine)
  73214. * @param reusable If the post process can be reused on the same frame. (default: false)
  73215. */
  73216. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73217. /** @hidden */
  73218. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73219. }
  73220. }
  73221. declare module "babylonjs/Shaders/filter.fragment" {
  73222. /** @hidden */
  73223. export var filterPixelShader: {
  73224. name: string;
  73225. shader: string;
  73226. };
  73227. }
  73228. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73229. import { Nullable } from "babylonjs/types";
  73230. import { Matrix } from "babylonjs/Maths/math.vector";
  73231. import { Camera } from "babylonjs/Cameras/camera";
  73232. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73233. import { Engine } from "babylonjs/Engines/engine";
  73234. import "babylonjs/Shaders/filter.fragment";
  73235. import { Scene } from "babylonjs/scene";
  73236. /**
  73237. * Applies a kernel filter to the image
  73238. */
  73239. export class FilterPostProcess extends PostProcess {
  73240. /** The matrix to be applied to the image */
  73241. kernelMatrix: Matrix;
  73242. /**
  73243. * Gets a string identifying the name of the class
  73244. * @returns "FilterPostProcess" string
  73245. */
  73246. getClassName(): string;
  73247. /**
  73248. *
  73249. * @param name The name of the effect.
  73250. * @param kernelMatrix The matrix to be applied to the image
  73251. * @param options The required width/height ratio to downsize to before computing the render pass.
  73252. * @param camera The camera to apply the render pass to.
  73253. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73254. * @param engine The engine which the post process will be applied. (default: current engine)
  73255. * @param reusable If the post process can be reused on the same frame. (default: false)
  73256. */
  73257. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73258. /** @hidden */
  73259. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73260. }
  73261. }
  73262. declare module "babylonjs/Shaders/fxaa.fragment" {
  73263. /** @hidden */
  73264. export var fxaaPixelShader: {
  73265. name: string;
  73266. shader: string;
  73267. };
  73268. }
  73269. declare module "babylonjs/Shaders/fxaa.vertex" {
  73270. /** @hidden */
  73271. export var fxaaVertexShader: {
  73272. name: string;
  73273. shader: string;
  73274. };
  73275. }
  73276. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73277. import { Nullable } from "babylonjs/types";
  73278. import { Camera } from "babylonjs/Cameras/camera";
  73279. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73280. import { Engine } from "babylonjs/Engines/engine";
  73281. import "babylonjs/Shaders/fxaa.fragment";
  73282. import "babylonjs/Shaders/fxaa.vertex";
  73283. import { Scene } from "babylonjs/scene";
  73284. /**
  73285. * Fxaa post process
  73286. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73287. */
  73288. export class FxaaPostProcess extends PostProcess {
  73289. /**
  73290. * Gets a string identifying the name of the class
  73291. * @returns "FxaaPostProcess" string
  73292. */
  73293. getClassName(): string;
  73294. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73295. private _getDefines;
  73296. /** @hidden */
  73297. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73298. }
  73299. }
  73300. declare module "babylonjs/Shaders/grain.fragment" {
  73301. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73302. /** @hidden */
  73303. export var grainPixelShader: {
  73304. name: string;
  73305. shader: string;
  73306. };
  73307. }
  73308. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73309. import { Nullable } from "babylonjs/types";
  73310. import { Camera } from "babylonjs/Cameras/camera";
  73311. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73312. import { Engine } from "babylonjs/Engines/engine";
  73313. import "babylonjs/Shaders/grain.fragment";
  73314. import { Scene } from "babylonjs/scene";
  73315. /**
  73316. * The GrainPostProcess adds noise to the image at mid luminance levels
  73317. */
  73318. export class GrainPostProcess extends PostProcess {
  73319. /**
  73320. * The intensity of the grain added (default: 30)
  73321. */
  73322. intensity: number;
  73323. /**
  73324. * If the grain should be randomized on every frame
  73325. */
  73326. animated: boolean;
  73327. /**
  73328. * Gets a string identifying the name of the class
  73329. * @returns "GrainPostProcess" string
  73330. */
  73331. getClassName(): string;
  73332. /**
  73333. * Creates a new instance of @see GrainPostProcess
  73334. * @param name The name of the effect.
  73335. * @param options The required width/height ratio to downsize to before computing the render pass.
  73336. * @param camera The camera to apply the render pass to.
  73337. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73338. * @param engine The engine which the post process will be applied. (default: current engine)
  73339. * @param reusable If the post process can be reused on the same frame. (default: false)
  73340. * @param textureType Type of textures used when performing the post process. (default: 0)
  73341. * @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)
  73342. */
  73343. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73344. /** @hidden */
  73345. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73346. }
  73347. }
  73348. declare module "babylonjs/Shaders/highlights.fragment" {
  73349. /** @hidden */
  73350. export var highlightsPixelShader: {
  73351. name: string;
  73352. shader: string;
  73353. };
  73354. }
  73355. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73356. import { Nullable } from "babylonjs/types";
  73357. import { Camera } from "babylonjs/Cameras/camera";
  73358. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73359. import { Engine } from "babylonjs/Engines/engine";
  73360. import "babylonjs/Shaders/highlights.fragment";
  73361. /**
  73362. * Extracts highlights from the image
  73363. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73364. */
  73365. export class HighlightsPostProcess extends PostProcess {
  73366. /**
  73367. * Gets a string identifying the name of the class
  73368. * @returns "HighlightsPostProcess" string
  73369. */
  73370. getClassName(): string;
  73371. /**
  73372. * Extracts highlights from the image
  73373. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73374. * @param name The name of the effect.
  73375. * @param options The required width/height ratio to downsize to before computing the render pass.
  73376. * @param camera The camera to apply the render pass to.
  73377. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73378. * @param engine The engine which the post process will be applied. (default: current engine)
  73379. * @param reusable If the post process can be reused on the same frame. (default: false)
  73380. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73381. */
  73382. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73383. }
  73384. }
  73385. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73386. /** @hidden */
  73387. export var mrtFragmentDeclaration: {
  73388. name: string;
  73389. shader: string;
  73390. };
  73391. }
  73392. declare module "babylonjs/Shaders/geometry.fragment" {
  73393. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73394. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73395. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73396. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73397. /** @hidden */
  73398. export var geometryPixelShader: {
  73399. name: string;
  73400. shader: string;
  73401. };
  73402. }
  73403. declare module "babylonjs/Shaders/geometry.vertex" {
  73404. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73405. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73406. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73407. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73408. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73409. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73410. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73411. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73412. /** @hidden */
  73413. export var geometryVertexShader: {
  73414. name: string;
  73415. shader: string;
  73416. };
  73417. }
  73418. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73419. import { Matrix } from "babylonjs/Maths/math.vector";
  73420. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73421. import { Mesh } from "babylonjs/Meshes/mesh";
  73422. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73423. import { Effect } from "babylonjs/Materials/effect";
  73424. import { Scene } from "babylonjs/scene";
  73425. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73426. import "babylonjs/Shaders/geometry.fragment";
  73427. import "babylonjs/Shaders/geometry.vertex";
  73428. /** @hidden */
  73429. interface ISavedTransformationMatrix {
  73430. world: Matrix;
  73431. viewProjection: Matrix;
  73432. }
  73433. /**
  73434. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73435. */
  73436. export class GeometryBufferRenderer {
  73437. /**
  73438. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73439. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73440. */
  73441. static readonly POSITION_TEXTURE_TYPE: number;
  73442. /**
  73443. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73444. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73445. */
  73446. static readonly VELOCITY_TEXTURE_TYPE: number;
  73447. /**
  73448. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73449. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73450. */
  73451. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73452. /**
  73453. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73454. * in order to compute objects velocities when enableVelocity is set to "true"
  73455. * @hidden
  73456. */
  73457. _previousTransformationMatrices: {
  73458. [index: number]: ISavedTransformationMatrix;
  73459. };
  73460. /**
  73461. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73462. * in order to compute objects velocities when enableVelocity is set to "true"
  73463. * @hidden
  73464. */
  73465. _previousBonesTransformationMatrices: {
  73466. [index: number]: Float32Array;
  73467. };
  73468. /**
  73469. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73470. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73471. */
  73472. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73473. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73474. renderTransparentMeshes: boolean;
  73475. private _scene;
  73476. private _resizeObserver;
  73477. private _multiRenderTarget;
  73478. private _ratio;
  73479. private _enablePosition;
  73480. private _enableVelocity;
  73481. private _enableReflectivity;
  73482. private _positionIndex;
  73483. private _velocityIndex;
  73484. private _reflectivityIndex;
  73485. protected _effect: Effect;
  73486. protected _cachedDefines: string;
  73487. /**
  73488. * Set the render list (meshes to be rendered) used in the G buffer.
  73489. */
  73490. set renderList(meshes: Mesh[]);
  73491. /**
  73492. * Gets wether or not G buffer are supported by the running hardware.
  73493. * This requires draw buffer supports
  73494. */
  73495. get isSupported(): boolean;
  73496. /**
  73497. * Returns the index of the given texture type in the G-Buffer textures array
  73498. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73499. * @returns the index of the given texture type in the G-Buffer textures array
  73500. */
  73501. getTextureIndex(textureType: number): number;
  73502. /**
  73503. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73504. */
  73505. get enablePosition(): boolean;
  73506. /**
  73507. * Sets whether or not objects positions are enabled for the G buffer.
  73508. */
  73509. set enablePosition(enable: boolean);
  73510. /**
  73511. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73512. */
  73513. get enableVelocity(): boolean;
  73514. /**
  73515. * Sets wether or not objects velocities are enabled for the G buffer.
  73516. */
  73517. set enableVelocity(enable: boolean);
  73518. /**
  73519. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73520. */
  73521. get enableReflectivity(): boolean;
  73522. /**
  73523. * Sets wether or not objects roughness are enabled for the G buffer.
  73524. */
  73525. set enableReflectivity(enable: boolean);
  73526. /**
  73527. * Gets the scene associated with the buffer.
  73528. */
  73529. get scene(): Scene;
  73530. /**
  73531. * Gets the ratio used by the buffer during its creation.
  73532. * How big is the buffer related to the main canvas.
  73533. */
  73534. get ratio(): number;
  73535. /** @hidden */
  73536. static _SceneComponentInitialization: (scene: Scene) => void;
  73537. /**
  73538. * Creates a new G Buffer for the scene
  73539. * @param scene The scene the buffer belongs to
  73540. * @param ratio How big is the buffer related to the main canvas.
  73541. */
  73542. constructor(scene: Scene, ratio?: number);
  73543. /**
  73544. * Checks wether everything is ready to render a submesh to the G buffer.
  73545. * @param subMesh the submesh to check readiness for
  73546. * @param useInstances is the mesh drawn using instance or not
  73547. * @returns true if ready otherwise false
  73548. */
  73549. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73550. /**
  73551. * Gets the current underlying G Buffer.
  73552. * @returns the buffer
  73553. */
  73554. getGBuffer(): MultiRenderTarget;
  73555. /**
  73556. * Gets the number of samples used to render the buffer (anti aliasing).
  73557. */
  73558. get samples(): number;
  73559. /**
  73560. * Sets the number of samples used to render the buffer (anti aliasing).
  73561. */
  73562. set samples(value: number);
  73563. /**
  73564. * Disposes the renderer and frees up associated resources.
  73565. */
  73566. dispose(): void;
  73567. protected _createRenderTargets(): void;
  73568. private _copyBonesTransformationMatrices;
  73569. }
  73570. }
  73571. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73572. import { Nullable } from "babylonjs/types";
  73573. import { Scene } from "babylonjs/scene";
  73574. import { ISceneComponent } from "babylonjs/sceneComponent";
  73575. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73576. module "babylonjs/scene" {
  73577. interface Scene {
  73578. /** @hidden (Backing field) */
  73579. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73580. /**
  73581. * Gets or Sets the current geometry buffer associated to the scene.
  73582. */
  73583. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73584. /**
  73585. * Enables a GeometryBufferRender and associates it with the scene
  73586. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73587. * @returns the GeometryBufferRenderer
  73588. */
  73589. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73590. /**
  73591. * Disables the GeometryBufferRender associated with the scene
  73592. */
  73593. disableGeometryBufferRenderer(): void;
  73594. }
  73595. }
  73596. /**
  73597. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73598. * in several rendering techniques.
  73599. */
  73600. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73601. /**
  73602. * The component name helpful to identify the component in the list of scene components.
  73603. */
  73604. readonly name: string;
  73605. /**
  73606. * The scene the component belongs to.
  73607. */
  73608. scene: Scene;
  73609. /**
  73610. * Creates a new instance of the component for the given scene
  73611. * @param scene Defines the scene to register the component in
  73612. */
  73613. constructor(scene: Scene);
  73614. /**
  73615. * Registers the component in a given scene
  73616. */
  73617. register(): void;
  73618. /**
  73619. * Rebuilds the elements related to this component in case of
  73620. * context lost for instance.
  73621. */
  73622. rebuild(): void;
  73623. /**
  73624. * Disposes the component and the associated ressources
  73625. */
  73626. dispose(): void;
  73627. private _gatherRenderTargets;
  73628. }
  73629. }
  73630. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73631. /** @hidden */
  73632. export var motionBlurPixelShader: {
  73633. name: string;
  73634. shader: string;
  73635. };
  73636. }
  73637. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73638. import { Nullable } from "babylonjs/types";
  73639. import { Camera } from "babylonjs/Cameras/camera";
  73640. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73641. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73642. import "babylonjs/Animations/animatable";
  73643. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73644. import "babylonjs/Shaders/motionBlur.fragment";
  73645. import { Engine } from "babylonjs/Engines/engine";
  73646. import { Scene } from "babylonjs/scene";
  73647. /**
  73648. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73649. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73650. * As an example, all you have to do is to create the post-process:
  73651. * var mb = new BABYLON.MotionBlurPostProcess(
  73652. * 'mb', // The name of the effect.
  73653. * scene, // The scene containing the objects to blur according to their velocity.
  73654. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73655. * camera // The camera to apply the render pass to.
  73656. * );
  73657. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73658. */
  73659. export class MotionBlurPostProcess extends PostProcess {
  73660. /**
  73661. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73662. */
  73663. motionStrength: number;
  73664. /**
  73665. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73666. */
  73667. get motionBlurSamples(): number;
  73668. /**
  73669. * Sets the number of iterations to be used for motion blur quality
  73670. */
  73671. set motionBlurSamples(samples: number);
  73672. private _motionBlurSamples;
  73673. private _geometryBufferRenderer;
  73674. /**
  73675. * Gets a string identifying the name of the class
  73676. * @returns "MotionBlurPostProcess" string
  73677. */
  73678. getClassName(): string;
  73679. /**
  73680. * Creates a new instance MotionBlurPostProcess
  73681. * @param name The name of the effect.
  73682. * @param scene The scene containing the objects to blur according to their velocity.
  73683. * @param options The required width/height ratio to downsize to before computing the render pass.
  73684. * @param camera The camera to apply the render pass to.
  73685. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73686. * @param engine The engine which the post process will be applied. (default: current engine)
  73687. * @param reusable If the post process can be reused on the same frame. (default: false)
  73688. * @param textureType Type of textures used when performing the post process. (default: 0)
  73689. * @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)
  73690. */
  73691. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73692. /**
  73693. * Excludes the given skinned mesh from computing bones velocities.
  73694. * 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.
  73695. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73696. */
  73697. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73698. /**
  73699. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73700. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73701. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73702. */
  73703. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73704. /**
  73705. * Disposes the post process.
  73706. * @param camera The camera to dispose the post process on.
  73707. */
  73708. dispose(camera?: Camera): void;
  73709. /** @hidden */
  73710. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73711. }
  73712. }
  73713. declare module "babylonjs/Shaders/refraction.fragment" {
  73714. /** @hidden */
  73715. export var refractionPixelShader: {
  73716. name: string;
  73717. shader: string;
  73718. };
  73719. }
  73720. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73721. import { Color3 } from "babylonjs/Maths/math.color";
  73722. import { Camera } from "babylonjs/Cameras/camera";
  73723. import { Texture } from "babylonjs/Materials/Textures/texture";
  73724. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73725. import { Engine } from "babylonjs/Engines/engine";
  73726. import "babylonjs/Shaders/refraction.fragment";
  73727. import { Scene } from "babylonjs/scene";
  73728. /**
  73729. * Post process which applies a refractin texture
  73730. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73731. */
  73732. export class RefractionPostProcess extends PostProcess {
  73733. private _refTexture;
  73734. private _ownRefractionTexture;
  73735. /** the base color of the refraction (used to taint the rendering) */
  73736. color: Color3;
  73737. /** simulated refraction depth */
  73738. depth: number;
  73739. /** the coefficient of the base color (0 to remove base color tainting) */
  73740. colorLevel: number;
  73741. /** Gets the url used to load the refraction texture */
  73742. refractionTextureUrl: string;
  73743. /**
  73744. * Gets or sets the refraction texture
  73745. * Please note that you are responsible for disposing the texture if you set it manually
  73746. */
  73747. get refractionTexture(): Texture;
  73748. set refractionTexture(value: Texture);
  73749. /**
  73750. * Gets a string identifying the name of the class
  73751. * @returns "RefractionPostProcess" string
  73752. */
  73753. getClassName(): string;
  73754. /**
  73755. * Initializes the RefractionPostProcess
  73756. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73757. * @param name The name of the effect.
  73758. * @param refractionTextureUrl Url of the refraction texture to use
  73759. * @param color the base color of the refraction (used to taint the rendering)
  73760. * @param depth simulated refraction depth
  73761. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73762. * @param camera The camera to apply the render pass to.
  73763. * @param options The required width/height ratio to downsize to before computing the render pass.
  73764. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73765. * @param engine The engine which the post process will be applied. (default: current engine)
  73766. * @param reusable If the post process can be reused on the same frame. (default: false)
  73767. */
  73768. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73769. /**
  73770. * Disposes of the post process
  73771. * @param camera Camera to dispose post process on
  73772. */
  73773. dispose(camera: Camera): void;
  73774. /** @hidden */
  73775. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  73776. }
  73777. }
  73778. declare module "babylonjs/Shaders/sharpen.fragment" {
  73779. /** @hidden */
  73780. export var sharpenPixelShader: {
  73781. name: string;
  73782. shader: string;
  73783. };
  73784. }
  73785. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73786. import { Nullable } from "babylonjs/types";
  73787. import { Camera } from "babylonjs/Cameras/camera";
  73788. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73789. import "babylonjs/Shaders/sharpen.fragment";
  73790. import { Engine } from "babylonjs/Engines/engine";
  73791. import { Scene } from "babylonjs/scene";
  73792. /**
  73793. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73794. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73795. */
  73796. export class SharpenPostProcess extends PostProcess {
  73797. /**
  73798. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73799. */
  73800. colorAmount: number;
  73801. /**
  73802. * How much sharpness should be applied (default: 0.3)
  73803. */
  73804. edgeAmount: number;
  73805. /**
  73806. * Gets a string identifying the name of the class
  73807. * @returns "SharpenPostProcess" string
  73808. */
  73809. getClassName(): string;
  73810. /**
  73811. * Creates a new instance ConvolutionPostProcess
  73812. * @param name The name of the effect.
  73813. * @param options The required width/height ratio to downsize to before computing the render pass.
  73814. * @param camera The camera to apply the render pass to.
  73815. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73816. * @param engine The engine which the post process will be applied. (default: current engine)
  73817. * @param reusable If the post process can be reused on the same frame. (default: false)
  73818. * @param textureType Type of textures used when performing the post process. (default: 0)
  73819. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  73820. */
  73821. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73822. /** @hidden */
  73823. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  73824. }
  73825. }
  73826. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73827. import { Nullable } from "babylonjs/types";
  73828. import { Camera } from "babylonjs/Cameras/camera";
  73829. import { Engine } from "babylonjs/Engines/engine";
  73830. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73831. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73832. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73833. /**
  73834. * PostProcessRenderPipeline
  73835. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73836. */
  73837. export class PostProcessRenderPipeline {
  73838. private engine;
  73839. private _renderEffects;
  73840. private _renderEffectsForIsolatedPass;
  73841. /**
  73842. * List of inspectable custom properties (used by the Inspector)
  73843. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73844. */
  73845. inspectableCustomProperties: IInspectable[];
  73846. /**
  73847. * @hidden
  73848. */
  73849. protected _cameras: Camera[];
  73850. /** @hidden */
  73851. _name: string;
  73852. /**
  73853. * Gets pipeline name
  73854. */
  73855. get name(): string;
  73856. /** Gets the list of attached cameras */
  73857. get cameras(): Camera[];
  73858. /**
  73859. * Initializes a PostProcessRenderPipeline
  73860. * @param engine engine to add the pipeline to
  73861. * @param name name of the pipeline
  73862. */
  73863. constructor(engine: Engine, name: string);
  73864. /**
  73865. * Gets the class name
  73866. * @returns "PostProcessRenderPipeline"
  73867. */
  73868. getClassName(): string;
  73869. /**
  73870. * If all the render effects in the pipeline are supported
  73871. */
  73872. get isSupported(): boolean;
  73873. /**
  73874. * Adds an effect to the pipeline
  73875. * @param renderEffect the effect to add
  73876. */
  73877. addEffect(renderEffect: PostProcessRenderEffect): void;
  73878. /** @hidden */
  73879. _rebuild(): void;
  73880. /** @hidden */
  73881. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73882. /** @hidden */
  73883. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73884. /** @hidden */
  73885. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73886. /** @hidden */
  73887. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73888. /** @hidden */
  73889. _attachCameras(cameras: Camera, unique: boolean): void;
  73890. /** @hidden */
  73891. _attachCameras(cameras: Camera[], unique: boolean): void;
  73892. /** @hidden */
  73893. _detachCameras(cameras: Camera): void;
  73894. /** @hidden */
  73895. _detachCameras(cameras: Nullable<Camera[]>): void;
  73896. /** @hidden */
  73897. _update(): void;
  73898. /** @hidden */
  73899. _reset(): void;
  73900. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  73901. /**
  73902. * Sets the required values to the prepass renderer.
  73903. * @param prePassRenderer defines the prepass renderer to setup.
  73904. * @returns true if the pre pass is needed.
  73905. */
  73906. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  73907. /**
  73908. * Disposes of the pipeline
  73909. */
  73910. dispose(): void;
  73911. }
  73912. }
  73913. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  73914. import { Camera } from "babylonjs/Cameras/camera";
  73915. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73916. /**
  73917. * PostProcessRenderPipelineManager class
  73918. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73919. */
  73920. export class PostProcessRenderPipelineManager {
  73921. private _renderPipelines;
  73922. /**
  73923. * Initializes a PostProcessRenderPipelineManager
  73924. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73925. */
  73926. constructor();
  73927. /**
  73928. * Gets the list of supported render pipelines
  73929. */
  73930. get supportedPipelines(): PostProcessRenderPipeline[];
  73931. /**
  73932. * Adds a pipeline to the manager
  73933. * @param renderPipeline The pipeline to add
  73934. */
  73935. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  73936. /**
  73937. * Attaches a camera to the pipeline
  73938. * @param renderPipelineName The name of the pipeline to attach to
  73939. * @param cameras the camera to attach
  73940. * @param unique if the camera can be attached multiple times to the pipeline
  73941. */
  73942. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  73943. /**
  73944. * Detaches a camera from the pipeline
  73945. * @param renderPipelineName The name of the pipeline to detach from
  73946. * @param cameras the camera to detach
  73947. */
  73948. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  73949. /**
  73950. * Enables an effect by name on a pipeline
  73951. * @param renderPipelineName the name of the pipeline to enable the effect in
  73952. * @param renderEffectName the name of the effect to enable
  73953. * @param cameras the cameras that the effect should be enabled on
  73954. */
  73955. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73956. /**
  73957. * Disables an effect by name on a pipeline
  73958. * @param renderPipelineName the name of the pipeline to disable the effect in
  73959. * @param renderEffectName the name of the effect to disable
  73960. * @param cameras the cameras that the effect should be disabled on
  73961. */
  73962. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73963. /**
  73964. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  73965. */
  73966. update(): void;
  73967. /** @hidden */
  73968. _rebuild(): void;
  73969. /**
  73970. * Disposes of the manager and pipelines
  73971. */
  73972. dispose(): void;
  73973. }
  73974. }
  73975. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  73976. import { ISceneComponent } from "babylonjs/sceneComponent";
  73977. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  73978. import { Scene } from "babylonjs/scene";
  73979. module "babylonjs/scene" {
  73980. interface Scene {
  73981. /** @hidden (Backing field) */
  73982. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73983. /**
  73984. * Gets the postprocess render pipeline manager
  73985. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73986. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73987. */
  73988. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73989. }
  73990. }
  73991. /**
  73992. * Defines the Render Pipeline scene component responsible to rendering pipelines
  73993. */
  73994. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  73995. /**
  73996. * The component name helpfull to identify the component in the list of scene components.
  73997. */
  73998. readonly name: string;
  73999. /**
  74000. * The scene the component belongs to.
  74001. */
  74002. scene: Scene;
  74003. /**
  74004. * Creates a new instance of the component for the given scene
  74005. * @param scene Defines the scene to register the component in
  74006. */
  74007. constructor(scene: Scene);
  74008. /**
  74009. * Registers the component in a given scene
  74010. */
  74011. register(): void;
  74012. /**
  74013. * Rebuilds the elements related to this component in case of
  74014. * context lost for instance.
  74015. */
  74016. rebuild(): void;
  74017. /**
  74018. * Disposes the component and the associated ressources
  74019. */
  74020. dispose(): void;
  74021. private _gatherRenderTargets;
  74022. }
  74023. }
  74024. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74025. import { Nullable } from "babylonjs/types";
  74026. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74027. import { Camera } from "babylonjs/Cameras/camera";
  74028. import { IDisposable } from "babylonjs/scene";
  74029. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74030. import { Scene } from "babylonjs/scene";
  74031. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74032. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74033. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74034. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74035. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74036. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74037. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74038. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74039. import { Animation } from "babylonjs/Animations/animation";
  74040. /**
  74041. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74042. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74043. */
  74044. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74045. private _scene;
  74046. private _camerasToBeAttached;
  74047. /**
  74048. * ID of the sharpen post process,
  74049. */
  74050. private readonly SharpenPostProcessId;
  74051. /**
  74052. * @ignore
  74053. * ID of the image processing post process;
  74054. */
  74055. readonly ImageProcessingPostProcessId: string;
  74056. /**
  74057. * @ignore
  74058. * ID of the Fast Approximate Anti-Aliasing post process;
  74059. */
  74060. readonly FxaaPostProcessId: string;
  74061. /**
  74062. * ID of the chromatic aberration post process,
  74063. */
  74064. private readonly ChromaticAberrationPostProcessId;
  74065. /**
  74066. * ID of the grain post process
  74067. */
  74068. private readonly GrainPostProcessId;
  74069. /**
  74070. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74071. */
  74072. sharpen: SharpenPostProcess;
  74073. private _sharpenEffect;
  74074. private bloom;
  74075. /**
  74076. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74077. */
  74078. depthOfField: DepthOfFieldEffect;
  74079. /**
  74080. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74081. */
  74082. fxaa: FxaaPostProcess;
  74083. /**
  74084. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74085. */
  74086. imageProcessing: ImageProcessingPostProcess;
  74087. /**
  74088. * Chromatic aberration post process which will shift rgb colors in the image
  74089. */
  74090. chromaticAberration: ChromaticAberrationPostProcess;
  74091. private _chromaticAberrationEffect;
  74092. /**
  74093. * Grain post process which add noise to the image
  74094. */
  74095. grain: GrainPostProcess;
  74096. private _grainEffect;
  74097. /**
  74098. * Glow post process which adds a glow to emissive areas of the image
  74099. */
  74100. private _glowLayer;
  74101. /**
  74102. * Animations which can be used to tweak settings over a period of time
  74103. */
  74104. animations: Animation[];
  74105. private _imageProcessingConfigurationObserver;
  74106. private _sharpenEnabled;
  74107. private _bloomEnabled;
  74108. private _depthOfFieldEnabled;
  74109. private _depthOfFieldBlurLevel;
  74110. private _fxaaEnabled;
  74111. private _imageProcessingEnabled;
  74112. private _defaultPipelineTextureType;
  74113. private _bloomScale;
  74114. private _chromaticAberrationEnabled;
  74115. private _grainEnabled;
  74116. private _buildAllowed;
  74117. /**
  74118. * Gets active scene
  74119. */
  74120. get scene(): Scene;
  74121. /**
  74122. * Enable or disable the sharpen process from the pipeline
  74123. */
  74124. set sharpenEnabled(enabled: boolean);
  74125. get sharpenEnabled(): boolean;
  74126. private _resizeObserver;
  74127. private _hardwareScaleLevel;
  74128. private _bloomKernel;
  74129. /**
  74130. * Specifies the size of the bloom blur kernel, relative to the final output size
  74131. */
  74132. get bloomKernel(): number;
  74133. set bloomKernel(value: number);
  74134. /**
  74135. * Specifies the weight of the bloom in the final rendering
  74136. */
  74137. private _bloomWeight;
  74138. /**
  74139. * Specifies the luma threshold for the area that will be blurred by the bloom
  74140. */
  74141. private _bloomThreshold;
  74142. private _hdr;
  74143. /**
  74144. * The strength of the bloom.
  74145. */
  74146. set bloomWeight(value: number);
  74147. get bloomWeight(): number;
  74148. /**
  74149. * The strength of the bloom.
  74150. */
  74151. set bloomThreshold(value: number);
  74152. get bloomThreshold(): number;
  74153. /**
  74154. * The scale of the bloom, lower value will provide better performance.
  74155. */
  74156. set bloomScale(value: number);
  74157. get bloomScale(): number;
  74158. /**
  74159. * Enable or disable the bloom from the pipeline
  74160. */
  74161. set bloomEnabled(enabled: boolean);
  74162. get bloomEnabled(): boolean;
  74163. private _rebuildBloom;
  74164. /**
  74165. * If the depth of field is enabled.
  74166. */
  74167. get depthOfFieldEnabled(): boolean;
  74168. set depthOfFieldEnabled(enabled: boolean);
  74169. /**
  74170. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74171. */
  74172. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74173. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74174. /**
  74175. * If the anti aliasing is enabled.
  74176. */
  74177. set fxaaEnabled(enabled: boolean);
  74178. get fxaaEnabled(): boolean;
  74179. private _samples;
  74180. /**
  74181. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74182. */
  74183. set samples(sampleCount: number);
  74184. get samples(): number;
  74185. /**
  74186. * If image processing is enabled.
  74187. */
  74188. set imageProcessingEnabled(enabled: boolean);
  74189. get imageProcessingEnabled(): boolean;
  74190. /**
  74191. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74192. */
  74193. set glowLayerEnabled(enabled: boolean);
  74194. get glowLayerEnabled(): boolean;
  74195. /**
  74196. * Gets the glow layer (or null if not defined)
  74197. */
  74198. get glowLayer(): Nullable<GlowLayer>;
  74199. /**
  74200. * Enable or disable the chromaticAberration process from the pipeline
  74201. */
  74202. set chromaticAberrationEnabled(enabled: boolean);
  74203. get chromaticAberrationEnabled(): boolean;
  74204. /**
  74205. * Enable or disable the grain process from the pipeline
  74206. */
  74207. set grainEnabled(enabled: boolean);
  74208. get grainEnabled(): boolean;
  74209. /**
  74210. * @constructor
  74211. * @param name - The rendering pipeline name (default: "")
  74212. * @param hdr - If high dynamic range textures should be used (default: true)
  74213. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74214. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74215. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74216. */
  74217. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74218. /**
  74219. * Get the class name
  74220. * @returns "DefaultRenderingPipeline"
  74221. */
  74222. getClassName(): string;
  74223. /**
  74224. * Force the compilation of the entire pipeline.
  74225. */
  74226. prepare(): void;
  74227. private _hasCleared;
  74228. private _prevPostProcess;
  74229. private _prevPrevPostProcess;
  74230. private _setAutoClearAndTextureSharing;
  74231. private _depthOfFieldSceneObserver;
  74232. private _buildPipeline;
  74233. private _disposePostProcesses;
  74234. /**
  74235. * Adds a camera to the pipeline
  74236. * @param camera the camera to be added
  74237. */
  74238. addCamera(camera: Camera): void;
  74239. /**
  74240. * Removes a camera from the pipeline
  74241. * @param camera the camera to remove
  74242. */
  74243. removeCamera(camera: Camera): void;
  74244. /**
  74245. * Dispose of the pipeline and stop all post processes
  74246. */
  74247. dispose(): void;
  74248. /**
  74249. * Serialize the rendering pipeline (Used when exporting)
  74250. * @returns the serialized object
  74251. */
  74252. serialize(): any;
  74253. /**
  74254. * Parse the serialized pipeline
  74255. * @param source Source pipeline.
  74256. * @param scene The scene to load the pipeline to.
  74257. * @param rootUrl The URL of the serialized pipeline.
  74258. * @returns An instantiated pipeline from the serialized object.
  74259. */
  74260. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74261. }
  74262. }
  74263. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74264. /** @hidden */
  74265. export var lensHighlightsPixelShader: {
  74266. name: string;
  74267. shader: string;
  74268. };
  74269. }
  74270. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74271. /** @hidden */
  74272. export var depthOfFieldPixelShader: {
  74273. name: string;
  74274. shader: string;
  74275. };
  74276. }
  74277. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74278. import { Camera } from "babylonjs/Cameras/camera";
  74279. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74280. import { Scene } from "babylonjs/scene";
  74281. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74282. import "babylonjs/Shaders/chromaticAberration.fragment";
  74283. import "babylonjs/Shaders/lensHighlights.fragment";
  74284. import "babylonjs/Shaders/depthOfField.fragment";
  74285. /**
  74286. * BABYLON.JS Chromatic Aberration GLSL Shader
  74287. * Author: Olivier Guyot
  74288. * Separates very slightly R, G and B colors on the edges of the screen
  74289. * Inspired by Francois Tarlier & Martins Upitis
  74290. */
  74291. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74292. /**
  74293. * @ignore
  74294. * The chromatic aberration PostProcess id in the pipeline
  74295. */
  74296. LensChromaticAberrationEffect: string;
  74297. /**
  74298. * @ignore
  74299. * The highlights enhancing PostProcess id in the pipeline
  74300. */
  74301. HighlightsEnhancingEffect: string;
  74302. /**
  74303. * @ignore
  74304. * The depth-of-field PostProcess id in the pipeline
  74305. */
  74306. LensDepthOfFieldEffect: string;
  74307. private _scene;
  74308. private _depthTexture;
  74309. private _grainTexture;
  74310. private _chromaticAberrationPostProcess;
  74311. private _highlightsPostProcess;
  74312. private _depthOfFieldPostProcess;
  74313. private _edgeBlur;
  74314. private _grainAmount;
  74315. private _chromaticAberration;
  74316. private _distortion;
  74317. private _highlightsGain;
  74318. private _highlightsThreshold;
  74319. private _dofDistance;
  74320. private _dofAperture;
  74321. private _dofDarken;
  74322. private _dofPentagon;
  74323. private _blurNoise;
  74324. /**
  74325. * @constructor
  74326. *
  74327. * Effect parameters are as follow:
  74328. * {
  74329. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74330. * edge_blur: number; // from 0 to x (1 for realism)
  74331. * distortion: number; // from 0 to x (1 for realism)
  74332. * grain_amount: number; // from 0 to 1
  74333. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74334. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74335. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74336. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74337. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74338. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74339. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74340. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74341. * }
  74342. * Note: if an effect parameter is unset, effect is disabled
  74343. *
  74344. * @param name The rendering pipeline name
  74345. * @param parameters - An object containing all parameters (see above)
  74346. * @param scene The scene linked to this pipeline
  74347. * @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)
  74348. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74349. */
  74350. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74351. /**
  74352. * Get the class name
  74353. * @returns "LensRenderingPipeline"
  74354. */
  74355. getClassName(): string;
  74356. /**
  74357. * Gets associated scene
  74358. */
  74359. get scene(): Scene;
  74360. /**
  74361. * Gets or sets the edge blur
  74362. */
  74363. get edgeBlur(): number;
  74364. set edgeBlur(value: number);
  74365. /**
  74366. * Gets or sets the grain amount
  74367. */
  74368. get grainAmount(): number;
  74369. set grainAmount(value: number);
  74370. /**
  74371. * Gets or sets the chromatic aberration amount
  74372. */
  74373. get chromaticAberration(): number;
  74374. set chromaticAberration(value: number);
  74375. /**
  74376. * Gets or sets the depth of field aperture
  74377. */
  74378. get dofAperture(): number;
  74379. set dofAperture(value: number);
  74380. /**
  74381. * Gets or sets the edge distortion
  74382. */
  74383. get edgeDistortion(): number;
  74384. set edgeDistortion(value: number);
  74385. /**
  74386. * Gets or sets the depth of field distortion
  74387. */
  74388. get dofDistortion(): number;
  74389. set dofDistortion(value: number);
  74390. /**
  74391. * Gets or sets the darken out of focus amount
  74392. */
  74393. get darkenOutOfFocus(): number;
  74394. set darkenOutOfFocus(value: number);
  74395. /**
  74396. * Gets or sets a boolean indicating if blur noise is enabled
  74397. */
  74398. get blurNoise(): boolean;
  74399. set blurNoise(value: boolean);
  74400. /**
  74401. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74402. */
  74403. get pentagonBokeh(): boolean;
  74404. set pentagonBokeh(value: boolean);
  74405. /**
  74406. * Gets or sets the highlight grain amount
  74407. */
  74408. get highlightsGain(): number;
  74409. set highlightsGain(value: number);
  74410. /**
  74411. * Gets or sets the highlight threshold
  74412. */
  74413. get highlightsThreshold(): number;
  74414. set highlightsThreshold(value: number);
  74415. /**
  74416. * Sets the amount of blur at the edges
  74417. * @param amount blur amount
  74418. */
  74419. setEdgeBlur(amount: number): void;
  74420. /**
  74421. * Sets edge blur to 0
  74422. */
  74423. disableEdgeBlur(): void;
  74424. /**
  74425. * Sets the amout of grain
  74426. * @param amount Amount of grain
  74427. */
  74428. setGrainAmount(amount: number): void;
  74429. /**
  74430. * Set grain amount to 0
  74431. */
  74432. disableGrain(): void;
  74433. /**
  74434. * Sets the chromatic aberration amount
  74435. * @param amount amount of chromatic aberration
  74436. */
  74437. setChromaticAberration(amount: number): void;
  74438. /**
  74439. * Sets chromatic aberration amount to 0
  74440. */
  74441. disableChromaticAberration(): void;
  74442. /**
  74443. * Sets the EdgeDistortion amount
  74444. * @param amount amount of EdgeDistortion
  74445. */
  74446. setEdgeDistortion(amount: number): void;
  74447. /**
  74448. * Sets edge distortion to 0
  74449. */
  74450. disableEdgeDistortion(): void;
  74451. /**
  74452. * Sets the FocusDistance amount
  74453. * @param amount amount of FocusDistance
  74454. */
  74455. setFocusDistance(amount: number): void;
  74456. /**
  74457. * Disables depth of field
  74458. */
  74459. disableDepthOfField(): void;
  74460. /**
  74461. * Sets the Aperture amount
  74462. * @param amount amount of Aperture
  74463. */
  74464. setAperture(amount: number): void;
  74465. /**
  74466. * Sets the DarkenOutOfFocus amount
  74467. * @param amount amount of DarkenOutOfFocus
  74468. */
  74469. setDarkenOutOfFocus(amount: number): void;
  74470. private _pentagonBokehIsEnabled;
  74471. /**
  74472. * Creates a pentagon bokeh effect
  74473. */
  74474. enablePentagonBokeh(): void;
  74475. /**
  74476. * Disables the pentagon bokeh effect
  74477. */
  74478. disablePentagonBokeh(): void;
  74479. /**
  74480. * Enables noise blur
  74481. */
  74482. enableNoiseBlur(): void;
  74483. /**
  74484. * Disables noise blur
  74485. */
  74486. disableNoiseBlur(): void;
  74487. /**
  74488. * Sets the HighlightsGain amount
  74489. * @param amount amount of HighlightsGain
  74490. */
  74491. setHighlightsGain(amount: number): void;
  74492. /**
  74493. * Sets the HighlightsThreshold amount
  74494. * @param amount amount of HighlightsThreshold
  74495. */
  74496. setHighlightsThreshold(amount: number): void;
  74497. /**
  74498. * Disables highlights
  74499. */
  74500. disableHighlights(): void;
  74501. /**
  74502. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74503. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74504. */
  74505. dispose(disableDepthRender?: boolean): void;
  74506. private _createChromaticAberrationPostProcess;
  74507. private _createHighlightsPostProcess;
  74508. private _createDepthOfFieldPostProcess;
  74509. private _createGrainTexture;
  74510. }
  74511. }
  74512. declare module "babylonjs/Shaders/ssao2.fragment" {
  74513. /** @hidden */
  74514. export var ssao2PixelShader: {
  74515. name: string;
  74516. shader: string;
  74517. };
  74518. }
  74519. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74520. /** @hidden */
  74521. export var ssaoCombinePixelShader: {
  74522. name: string;
  74523. shader: string;
  74524. };
  74525. }
  74526. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74527. import { Camera } from "babylonjs/Cameras/camera";
  74528. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74529. import { Scene } from "babylonjs/scene";
  74530. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74531. import "babylonjs/Shaders/ssao2.fragment";
  74532. import "babylonjs/Shaders/ssaoCombine.fragment";
  74533. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74534. /**
  74535. * Render pipeline to produce ssao effect
  74536. */
  74537. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74538. /**
  74539. * @ignore
  74540. * The PassPostProcess id in the pipeline that contains the original scene color
  74541. */
  74542. SSAOOriginalSceneColorEffect: string;
  74543. /**
  74544. * @ignore
  74545. * The SSAO PostProcess id in the pipeline
  74546. */
  74547. SSAORenderEffect: string;
  74548. /**
  74549. * @ignore
  74550. * The horizontal blur PostProcess id in the pipeline
  74551. */
  74552. SSAOBlurHRenderEffect: string;
  74553. /**
  74554. * @ignore
  74555. * The vertical blur PostProcess id in the pipeline
  74556. */
  74557. SSAOBlurVRenderEffect: string;
  74558. /**
  74559. * @ignore
  74560. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74561. */
  74562. SSAOCombineRenderEffect: string;
  74563. /**
  74564. * The output strength of the SSAO post-process. Default value is 1.0.
  74565. */
  74566. totalStrength: number;
  74567. /**
  74568. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74569. */
  74570. maxZ: number;
  74571. /**
  74572. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74573. */
  74574. minZAspect: number;
  74575. private _samples;
  74576. /**
  74577. * Number of samples used for the SSAO calculations. Default value is 8
  74578. */
  74579. set samples(n: number);
  74580. get samples(): number;
  74581. private _textureSamples;
  74582. /**
  74583. * Number of samples to use for antialiasing
  74584. */
  74585. set textureSamples(n: number);
  74586. get textureSamples(): number;
  74587. /**
  74588. * Force rendering the geometry through geometry buffer
  74589. */
  74590. private _forceGeometryBuffer;
  74591. /**
  74592. * Ratio object used for SSAO ratio and blur ratio
  74593. */
  74594. private _ratio;
  74595. /**
  74596. * Dynamically generated sphere sampler.
  74597. */
  74598. private _sampleSphere;
  74599. /**
  74600. * Blur filter offsets
  74601. */
  74602. private _samplerOffsets;
  74603. private _expensiveBlur;
  74604. /**
  74605. * If bilateral blur should be used
  74606. */
  74607. set expensiveBlur(b: boolean);
  74608. get expensiveBlur(): boolean;
  74609. /**
  74610. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74611. */
  74612. radius: number;
  74613. /**
  74614. * The base color of the SSAO post-process
  74615. * The final result is "base + ssao" between [0, 1]
  74616. */
  74617. base: number;
  74618. /**
  74619. * Support test.
  74620. */
  74621. static get IsSupported(): boolean;
  74622. private _scene;
  74623. private _randomTexture;
  74624. private _originalColorPostProcess;
  74625. private _ssaoPostProcess;
  74626. private _blurHPostProcess;
  74627. private _blurVPostProcess;
  74628. private _ssaoCombinePostProcess;
  74629. private _prePassRenderer;
  74630. /**
  74631. * Gets active scene
  74632. */
  74633. get scene(): Scene;
  74634. /**
  74635. * @constructor
  74636. * @param name The rendering pipeline name
  74637. * @param scene The scene linked to this pipeline
  74638. * @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 }
  74639. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74640. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74641. */
  74642. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74643. /**
  74644. * Get the class name
  74645. * @returns "SSAO2RenderingPipeline"
  74646. */
  74647. getClassName(): string;
  74648. /**
  74649. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74650. */
  74651. dispose(disableGeometryBufferRenderer?: boolean): void;
  74652. private _createBlurPostProcess;
  74653. /** @hidden */
  74654. _rebuild(): void;
  74655. private _bits;
  74656. private _radicalInverse_VdC;
  74657. private _hammersley;
  74658. private _hemisphereSample_uniform;
  74659. private _generateHemisphere;
  74660. private _getDefinesForSSAO;
  74661. private _createSSAOPostProcess;
  74662. private _createSSAOCombinePostProcess;
  74663. private _createRandomTexture;
  74664. /**
  74665. * Serialize the rendering pipeline (Used when exporting)
  74666. * @returns the serialized object
  74667. */
  74668. serialize(): any;
  74669. /**
  74670. * Parse the serialized pipeline
  74671. * @param source Source pipeline.
  74672. * @param scene The scene to load the pipeline to.
  74673. * @param rootUrl The URL of the serialized pipeline.
  74674. * @returns An instantiated pipeline from the serialized object.
  74675. */
  74676. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74677. /**
  74678. * Sets the required values to the prepass renderer.
  74679. * @param prePassRenderer defines the prepass renderer to setup
  74680. * @returns true if the pre pass is needed.
  74681. */
  74682. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74683. }
  74684. }
  74685. declare module "babylonjs/Shaders/ssao.fragment" {
  74686. /** @hidden */
  74687. export var ssaoPixelShader: {
  74688. name: string;
  74689. shader: string;
  74690. };
  74691. }
  74692. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74693. import { Camera } from "babylonjs/Cameras/camera";
  74694. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74695. import { Scene } from "babylonjs/scene";
  74696. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74697. import "babylonjs/Shaders/ssao.fragment";
  74698. import "babylonjs/Shaders/ssaoCombine.fragment";
  74699. /**
  74700. * Render pipeline to produce ssao effect
  74701. */
  74702. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74703. /**
  74704. * @ignore
  74705. * The PassPostProcess id in the pipeline that contains the original scene color
  74706. */
  74707. SSAOOriginalSceneColorEffect: string;
  74708. /**
  74709. * @ignore
  74710. * The SSAO PostProcess id in the pipeline
  74711. */
  74712. SSAORenderEffect: string;
  74713. /**
  74714. * @ignore
  74715. * The horizontal blur PostProcess id in the pipeline
  74716. */
  74717. SSAOBlurHRenderEffect: string;
  74718. /**
  74719. * @ignore
  74720. * The vertical blur PostProcess id in the pipeline
  74721. */
  74722. SSAOBlurVRenderEffect: string;
  74723. /**
  74724. * @ignore
  74725. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74726. */
  74727. SSAOCombineRenderEffect: string;
  74728. /**
  74729. * The output strength of the SSAO post-process. Default value is 1.0.
  74730. */
  74731. totalStrength: number;
  74732. /**
  74733. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74734. */
  74735. radius: number;
  74736. /**
  74737. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74738. * Must not be equal to fallOff and superior to fallOff.
  74739. * Default value is 0.0075
  74740. */
  74741. area: number;
  74742. /**
  74743. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74744. * Must not be equal to area and inferior to area.
  74745. * Default value is 0.000001
  74746. */
  74747. fallOff: number;
  74748. /**
  74749. * The base color of the SSAO post-process
  74750. * The final result is "base + ssao" between [0, 1]
  74751. */
  74752. base: number;
  74753. private _scene;
  74754. private _depthTexture;
  74755. private _randomTexture;
  74756. private _originalColorPostProcess;
  74757. private _ssaoPostProcess;
  74758. private _blurHPostProcess;
  74759. private _blurVPostProcess;
  74760. private _ssaoCombinePostProcess;
  74761. private _firstUpdate;
  74762. /**
  74763. * Gets active scene
  74764. */
  74765. get scene(): Scene;
  74766. /**
  74767. * @constructor
  74768. * @param name - The rendering pipeline name
  74769. * @param scene - The scene linked to this pipeline
  74770. * @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 }
  74771. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74772. */
  74773. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74774. /**
  74775. * Get the class name
  74776. * @returns "SSAORenderingPipeline"
  74777. */
  74778. getClassName(): string;
  74779. /**
  74780. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74781. */
  74782. dispose(disableDepthRender?: boolean): void;
  74783. private _createBlurPostProcess;
  74784. /** @hidden */
  74785. _rebuild(): void;
  74786. private _createSSAOPostProcess;
  74787. private _createSSAOCombinePostProcess;
  74788. private _createRandomTexture;
  74789. }
  74790. }
  74791. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74792. /** @hidden */
  74793. export var screenSpaceReflectionPixelShader: {
  74794. name: string;
  74795. shader: string;
  74796. };
  74797. }
  74798. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74799. import { Nullable } from "babylonjs/types";
  74800. import { Camera } from "babylonjs/Cameras/camera";
  74801. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74802. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74803. import { Engine } from "babylonjs/Engines/engine";
  74804. import { Scene } from "babylonjs/scene";
  74805. /**
  74806. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74807. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74808. */
  74809. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74810. /**
  74811. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74812. */
  74813. threshold: number;
  74814. /**
  74815. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74816. */
  74817. strength: number;
  74818. /**
  74819. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74820. */
  74821. reflectionSpecularFalloffExponent: number;
  74822. /**
  74823. * 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]
  74824. */
  74825. step: number;
  74826. /**
  74827. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74828. */
  74829. roughnessFactor: number;
  74830. private _geometryBufferRenderer;
  74831. private _enableSmoothReflections;
  74832. private _reflectionSamples;
  74833. private _smoothSteps;
  74834. /**
  74835. * Gets a string identifying the name of the class
  74836. * @returns "ScreenSpaceReflectionPostProcess" string
  74837. */
  74838. getClassName(): string;
  74839. /**
  74840. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74841. * @param name The name of the effect.
  74842. * @param scene The scene containing the objects to calculate reflections.
  74843. * @param options The required width/height ratio to downsize to before computing the render pass.
  74844. * @param camera The camera to apply the render pass to.
  74845. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74846. * @param engine The engine which the post process will be applied. (default: current engine)
  74847. * @param reusable If the post process can be reused on the same frame. (default: false)
  74848. * @param textureType Type of textures used when performing the post process. (default: 0)
  74849. * @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)
  74850. */
  74851. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74852. /**
  74853. * Gets wether or not smoothing reflections is enabled.
  74854. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74855. */
  74856. get enableSmoothReflections(): boolean;
  74857. /**
  74858. * Sets wether or not smoothing reflections is enabled.
  74859. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74860. */
  74861. set enableSmoothReflections(enabled: boolean);
  74862. /**
  74863. * Gets the number of samples taken while computing reflections. More samples count is high,
  74864. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74865. */
  74866. get reflectionSamples(): number;
  74867. /**
  74868. * Sets the number of samples taken while computing reflections. More samples count is high,
  74869. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74870. */
  74871. set reflectionSamples(samples: number);
  74872. /**
  74873. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74874. * more the post-process will require GPU power and can generate a drop in FPS.
  74875. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74876. */
  74877. get smoothSteps(): number;
  74878. set smoothSteps(steps: number);
  74879. private _updateEffectDefines;
  74880. /** @hidden */
  74881. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  74882. }
  74883. }
  74884. declare module "babylonjs/Shaders/standard.fragment" {
  74885. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74886. /** @hidden */
  74887. export var standardPixelShader: {
  74888. name: string;
  74889. shader: string;
  74890. };
  74891. }
  74892. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74893. import { Nullable } from "babylonjs/types";
  74894. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74895. import { Camera } from "babylonjs/Cameras/camera";
  74896. import { Texture } from "babylonjs/Materials/Textures/texture";
  74897. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74898. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74899. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  74900. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74901. import { IDisposable } from "babylonjs/scene";
  74902. import { SpotLight } from "babylonjs/Lights/spotLight";
  74903. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  74904. import { Scene } from "babylonjs/scene";
  74905. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74906. import { Animation } from "babylonjs/Animations/animation";
  74907. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74908. import "babylonjs/Shaders/standard.fragment";
  74909. /**
  74910. * Standard rendering pipeline
  74911. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74912. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  74913. */
  74914. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74915. /**
  74916. * Public members
  74917. */
  74918. /**
  74919. * Post-process which contains the original scene color before the pipeline applies all the effects
  74920. */
  74921. originalPostProcess: Nullable<PostProcess>;
  74922. /**
  74923. * Post-process used to down scale an image x4
  74924. */
  74925. downSampleX4PostProcess: Nullable<PostProcess>;
  74926. /**
  74927. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  74928. */
  74929. brightPassPostProcess: Nullable<PostProcess>;
  74930. /**
  74931. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  74932. */
  74933. blurHPostProcesses: PostProcess[];
  74934. /**
  74935. * Post-process array storing all the vertical blur post-processes used by the pipeline
  74936. */
  74937. blurVPostProcesses: PostProcess[];
  74938. /**
  74939. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  74940. */
  74941. textureAdderPostProcess: Nullable<PostProcess>;
  74942. /**
  74943. * Post-process used to create volumetric lighting effect
  74944. */
  74945. volumetricLightPostProcess: Nullable<PostProcess>;
  74946. /**
  74947. * Post-process used to smooth the previous volumetric light post-process on the X axis
  74948. */
  74949. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  74950. /**
  74951. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  74952. */
  74953. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  74954. /**
  74955. * Post-process used to merge the volumetric light effect and the real scene color
  74956. */
  74957. volumetricLightMergePostProces: Nullable<PostProcess>;
  74958. /**
  74959. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  74960. */
  74961. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  74962. /**
  74963. * Base post-process used to calculate the average luminance of the final image for HDR
  74964. */
  74965. luminancePostProcess: Nullable<PostProcess>;
  74966. /**
  74967. * Post-processes used to create down sample post-processes in order to get
  74968. * the average luminance of the final image for HDR
  74969. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  74970. */
  74971. luminanceDownSamplePostProcesses: PostProcess[];
  74972. /**
  74973. * Post-process used to create a HDR effect (light adaptation)
  74974. */
  74975. hdrPostProcess: Nullable<PostProcess>;
  74976. /**
  74977. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  74978. */
  74979. textureAdderFinalPostProcess: Nullable<PostProcess>;
  74980. /**
  74981. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  74982. */
  74983. lensFlareFinalPostProcess: Nullable<PostProcess>;
  74984. /**
  74985. * Post-process used to merge the final HDR post-process and the real scene color
  74986. */
  74987. hdrFinalPostProcess: Nullable<PostProcess>;
  74988. /**
  74989. * Post-process used to create a lens flare effect
  74990. */
  74991. lensFlarePostProcess: Nullable<PostProcess>;
  74992. /**
  74993. * Post-process that merges the result of the lens flare post-process and the real scene color
  74994. */
  74995. lensFlareComposePostProcess: Nullable<PostProcess>;
  74996. /**
  74997. * Post-process used to create a motion blur effect
  74998. */
  74999. motionBlurPostProcess: Nullable<PostProcess>;
  75000. /**
  75001. * Post-process used to create a depth of field effect
  75002. */
  75003. depthOfFieldPostProcess: Nullable<PostProcess>;
  75004. /**
  75005. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  75006. */
  75007. fxaaPostProcess: Nullable<FxaaPostProcess>;
  75008. /**
  75009. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  75010. */
  75011. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  75012. /**
  75013. * Represents the brightness threshold in order to configure the illuminated surfaces
  75014. */
  75015. brightThreshold: number;
  75016. /**
  75017. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75018. */
  75019. blurWidth: number;
  75020. /**
  75021. * Sets if the blur for highlighted surfaces must be only horizontal
  75022. */
  75023. horizontalBlur: boolean;
  75024. /**
  75025. * Gets the overall exposure used by the pipeline
  75026. */
  75027. get exposure(): number;
  75028. /**
  75029. * Sets the overall exposure used by the pipeline
  75030. */
  75031. set exposure(value: number);
  75032. /**
  75033. * Texture used typically to simulate "dirty" on camera lens
  75034. */
  75035. lensTexture: Nullable<Texture>;
  75036. /**
  75037. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75038. */
  75039. volumetricLightCoefficient: number;
  75040. /**
  75041. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75042. */
  75043. volumetricLightPower: number;
  75044. /**
  75045. * Used the set the blur intensity to smooth the volumetric lights
  75046. */
  75047. volumetricLightBlurScale: number;
  75048. /**
  75049. * Light (spot or directional) used to generate the volumetric lights rays
  75050. * The source light must have a shadow generate so the pipeline can get its
  75051. * depth map
  75052. */
  75053. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75054. /**
  75055. * For eye adaptation, represents the minimum luminance the eye can see
  75056. */
  75057. hdrMinimumLuminance: number;
  75058. /**
  75059. * For eye adaptation, represents the decrease luminance speed
  75060. */
  75061. hdrDecreaseRate: number;
  75062. /**
  75063. * For eye adaptation, represents the increase luminance speed
  75064. */
  75065. hdrIncreaseRate: number;
  75066. /**
  75067. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75068. */
  75069. get hdrAutoExposure(): boolean;
  75070. /**
  75071. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75072. */
  75073. set hdrAutoExposure(value: boolean);
  75074. /**
  75075. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75076. */
  75077. lensColorTexture: Nullable<Texture>;
  75078. /**
  75079. * The overall strengh for the lens flare effect
  75080. */
  75081. lensFlareStrength: number;
  75082. /**
  75083. * Dispersion coefficient for lens flare ghosts
  75084. */
  75085. lensFlareGhostDispersal: number;
  75086. /**
  75087. * Main lens flare halo width
  75088. */
  75089. lensFlareHaloWidth: number;
  75090. /**
  75091. * Based on the lens distortion effect, defines how much the lens flare result
  75092. * is distorted
  75093. */
  75094. lensFlareDistortionStrength: number;
  75095. /**
  75096. * Configures the blur intensity used for for lens flare (halo)
  75097. */
  75098. lensFlareBlurWidth: number;
  75099. /**
  75100. * Lens star texture must be used to simulate rays on the flares and is available
  75101. * in the documentation
  75102. */
  75103. lensStarTexture: Nullable<Texture>;
  75104. /**
  75105. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75106. * flare effect by taking account of the dirt texture
  75107. */
  75108. lensFlareDirtTexture: Nullable<Texture>;
  75109. /**
  75110. * Represents the focal length for the depth of field effect
  75111. */
  75112. depthOfFieldDistance: number;
  75113. /**
  75114. * Represents the blur intensity for the blurred part of the depth of field effect
  75115. */
  75116. depthOfFieldBlurWidth: number;
  75117. /**
  75118. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75119. */
  75120. get motionStrength(): number;
  75121. /**
  75122. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75123. */
  75124. set motionStrength(strength: number);
  75125. /**
  75126. * Gets wether or not the motion blur post-process is object based or screen based.
  75127. */
  75128. get objectBasedMotionBlur(): boolean;
  75129. /**
  75130. * Sets wether or not the motion blur post-process should be object based or screen based
  75131. */
  75132. set objectBasedMotionBlur(value: boolean);
  75133. /**
  75134. * List of animations for the pipeline (IAnimatable implementation)
  75135. */
  75136. animations: Animation[];
  75137. /**
  75138. * Private members
  75139. */
  75140. private _scene;
  75141. private _currentDepthOfFieldSource;
  75142. private _basePostProcess;
  75143. private _fixedExposure;
  75144. private _currentExposure;
  75145. private _hdrAutoExposure;
  75146. private _hdrCurrentLuminance;
  75147. private _motionStrength;
  75148. private _isObjectBasedMotionBlur;
  75149. private _floatTextureType;
  75150. private _camerasToBeAttached;
  75151. private _ratio;
  75152. private _bloomEnabled;
  75153. private _depthOfFieldEnabled;
  75154. private _vlsEnabled;
  75155. private _lensFlareEnabled;
  75156. private _hdrEnabled;
  75157. private _motionBlurEnabled;
  75158. private _fxaaEnabled;
  75159. private _screenSpaceReflectionsEnabled;
  75160. private _motionBlurSamples;
  75161. private _volumetricLightStepsCount;
  75162. private _samples;
  75163. /**
  75164. * @ignore
  75165. * Specifies if the bloom pipeline is enabled
  75166. */
  75167. get BloomEnabled(): boolean;
  75168. set BloomEnabled(enabled: boolean);
  75169. /**
  75170. * @ignore
  75171. * Specifies if the depth of field pipeline is enabed
  75172. */
  75173. get DepthOfFieldEnabled(): boolean;
  75174. set DepthOfFieldEnabled(enabled: boolean);
  75175. /**
  75176. * @ignore
  75177. * Specifies if the lens flare pipeline is enabed
  75178. */
  75179. get LensFlareEnabled(): boolean;
  75180. set LensFlareEnabled(enabled: boolean);
  75181. /**
  75182. * @ignore
  75183. * Specifies if the HDR pipeline is enabled
  75184. */
  75185. get HDREnabled(): boolean;
  75186. set HDREnabled(enabled: boolean);
  75187. /**
  75188. * @ignore
  75189. * Specifies if the volumetric lights scattering effect is enabled
  75190. */
  75191. get VLSEnabled(): boolean;
  75192. set VLSEnabled(enabled: boolean);
  75193. /**
  75194. * @ignore
  75195. * Specifies if the motion blur effect is enabled
  75196. */
  75197. get MotionBlurEnabled(): boolean;
  75198. set MotionBlurEnabled(enabled: boolean);
  75199. /**
  75200. * Specifies if anti-aliasing is enabled
  75201. */
  75202. get fxaaEnabled(): boolean;
  75203. set fxaaEnabled(enabled: boolean);
  75204. /**
  75205. * Specifies if screen space reflections are enabled.
  75206. */
  75207. get screenSpaceReflectionsEnabled(): boolean;
  75208. set screenSpaceReflectionsEnabled(enabled: boolean);
  75209. /**
  75210. * Specifies the number of steps used to calculate the volumetric lights
  75211. * Typically in interval [50, 200]
  75212. */
  75213. get volumetricLightStepsCount(): number;
  75214. set volumetricLightStepsCount(count: number);
  75215. /**
  75216. * Specifies the number of samples used for the motion blur effect
  75217. * Typically in interval [16, 64]
  75218. */
  75219. get motionBlurSamples(): number;
  75220. set motionBlurSamples(samples: number);
  75221. /**
  75222. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75223. */
  75224. get samples(): number;
  75225. set samples(sampleCount: number);
  75226. /**
  75227. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75228. * @constructor
  75229. * @param name The rendering pipeline name
  75230. * @param scene The scene linked to this pipeline
  75231. * @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)
  75232. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75233. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75234. */
  75235. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75236. private _buildPipeline;
  75237. private _createDownSampleX4PostProcess;
  75238. private _createBrightPassPostProcess;
  75239. private _createBlurPostProcesses;
  75240. private _createTextureAdderPostProcess;
  75241. private _createVolumetricLightPostProcess;
  75242. private _createLuminancePostProcesses;
  75243. private _createHdrPostProcess;
  75244. private _createLensFlarePostProcess;
  75245. private _createDepthOfFieldPostProcess;
  75246. private _createMotionBlurPostProcess;
  75247. private _getDepthTexture;
  75248. private _disposePostProcesses;
  75249. /**
  75250. * Dispose of the pipeline and stop all post processes
  75251. */
  75252. dispose(): void;
  75253. /**
  75254. * Serialize the rendering pipeline (Used when exporting)
  75255. * @returns the serialized object
  75256. */
  75257. serialize(): any;
  75258. /**
  75259. * Parse the serialized pipeline
  75260. * @param source Source pipeline.
  75261. * @param scene The scene to load the pipeline to.
  75262. * @param rootUrl The URL of the serialized pipeline.
  75263. * @returns An instantiated pipeline from the serialized object.
  75264. */
  75265. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75266. /**
  75267. * Luminance steps
  75268. */
  75269. static LuminanceSteps: number;
  75270. }
  75271. }
  75272. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75273. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75274. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75275. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75276. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75277. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75278. }
  75279. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75280. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75281. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75282. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75283. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75284. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75285. }
  75286. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75287. /** @hidden */
  75288. export var stereoscopicInterlacePixelShader: {
  75289. name: string;
  75290. shader: string;
  75291. };
  75292. }
  75293. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75294. import { Camera } from "babylonjs/Cameras/camera";
  75295. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75296. import { Engine } from "babylonjs/Engines/engine";
  75297. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75298. /**
  75299. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75300. */
  75301. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75302. private _stepSize;
  75303. private _passedProcess;
  75304. /**
  75305. * Gets a string identifying the name of the class
  75306. * @returns "StereoscopicInterlacePostProcessI" string
  75307. */
  75308. getClassName(): string;
  75309. /**
  75310. * Initializes a StereoscopicInterlacePostProcessI
  75311. * @param name The name of the effect.
  75312. * @param rigCameras The rig cameras to be appled to the post process
  75313. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75314. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75315. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75316. * @param engine The engine which the post process will be applied. (default: current engine)
  75317. * @param reusable If the post process can be reused on the same frame. (default: false)
  75318. */
  75319. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75320. }
  75321. /**
  75322. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75323. */
  75324. export class StereoscopicInterlacePostProcess extends PostProcess {
  75325. private _stepSize;
  75326. private _passedProcess;
  75327. /**
  75328. * Gets a string identifying the name of the class
  75329. * @returns "StereoscopicInterlacePostProcess" string
  75330. */
  75331. getClassName(): string;
  75332. /**
  75333. * Initializes a StereoscopicInterlacePostProcess
  75334. * @param name The name of the effect.
  75335. * @param rigCameras The rig cameras to be appled to the post process
  75336. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75337. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75338. * @param engine The engine which the post process will be applied. (default: current engine)
  75339. * @param reusable If the post process can be reused on the same frame. (default: false)
  75340. */
  75341. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75342. }
  75343. }
  75344. declare module "babylonjs/Shaders/tonemap.fragment" {
  75345. /** @hidden */
  75346. export var tonemapPixelShader: {
  75347. name: string;
  75348. shader: string;
  75349. };
  75350. }
  75351. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75352. import { Camera } from "babylonjs/Cameras/camera";
  75353. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75354. import "babylonjs/Shaders/tonemap.fragment";
  75355. import { Engine } from "babylonjs/Engines/engine";
  75356. /** Defines operator used for tonemapping */
  75357. export enum TonemappingOperator {
  75358. /** Hable */
  75359. Hable = 0,
  75360. /** Reinhard */
  75361. Reinhard = 1,
  75362. /** HejiDawson */
  75363. HejiDawson = 2,
  75364. /** Photographic */
  75365. Photographic = 3
  75366. }
  75367. /**
  75368. * Defines a post process to apply tone mapping
  75369. */
  75370. export class TonemapPostProcess extends PostProcess {
  75371. private _operator;
  75372. /** Defines the required exposure adjustement */
  75373. exposureAdjustment: number;
  75374. /**
  75375. * Gets a string identifying the name of the class
  75376. * @returns "TonemapPostProcess" string
  75377. */
  75378. getClassName(): string;
  75379. /**
  75380. * Creates a new TonemapPostProcess
  75381. * @param name defines the name of the postprocess
  75382. * @param _operator defines the operator to use
  75383. * @param exposureAdjustment defines the required exposure adjustement
  75384. * @param camera defines the camera to use (can be null)
  75385. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75386. * @param engine defines the hosting engine (can be ignore if camera is set)
  75387. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75388. */
  75389. constructor(name: string, _operator: TonemappingOperator,
  75390. /** Defines the required exposure adjustement */
  75391. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75392. }
  75393. }
  75394. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75395. /** @hidden */
  75396. export var volumetricLightScatteringPixelShader: {
  75397. name: string;
  75398. shader: string;
  75399. };
  75400. }
  75401. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75402. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75403. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75404. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75405. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75406. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75407. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75408. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75409. /** @hidden */
  75410. export var volumetricLightScatteringPassVertexShader: {
  75411. name: string;
  75412. shader: string;
  75413. };
  75414. }
  75415. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75416. /** @hidden */
  75417. export var volumetricLightScatteringPassPixelShader: {
  75418. name: string;
  75419. shader: string;
  75420. };
  75421. }
  75422. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75423. import { Vector3 } from "babylonjs/Maths/math.vector";
  75424. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75425. import { Mesh } from "babylonjs/Meshes/mesh";
  75426. import { Camera } from "babylonjs/Cameras/camera";
  75427. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75428. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75429. import { Scene } from "babylonjs/scene";
  75430. import "babylonjs/Meshes/Builders/planeBuilder";
  75431. import "babylonjs/Shaders/depth.vertex";
  75432. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75433. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75434. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75435. import { Engine } from "babylonjs/Engines/engine";
  75436. /**
  75437. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75438. */
  75439. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75440. private _volumetricLightScatteringPass;
  75441. private _volumetricLightScatteringRTT;
  75442. private _viewPort;
  75443. private _screenCoordinates;
  75444. private _cachedDefines;
  75445. /**
  75446. * If not undefined, the mesh position is computed from the attached node position
  75447. */
  75448. attachedNode: {
  75449. position: Vector3;
  75450. };
  75451. /**
  75452. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75453. */
  75454. customMeshPosition: Vector3;
  75455. /**
  75456. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75457. */
  75458. useCustomMeshPosition: boolean;
  75459. /**
  75460. * If the post-process should inverse the light scattering direction
  75461. */
  75462. invert: boolean;
  75463. /**
  75464. * The internal mesh used by the post-process
  75465. */
  75466. mesh: Mesh;
  75467. /**
  75468. * @hidden
  75469. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75470. */
  75471. get useDiffuseColor(): boolean;
  75472. set useDiffuseColor(useDiffuseColor: boolean);
  75473. /**
  75474. * Array containing the excluded meshes not rendered in the internal pass
  75475. */
  75476. excludedMeshes: AbstractMesh[];
  75477. /**
  75478. * Controls the overall intensity of the post-process
  75479. */
  75480. exposure: number;
  75481. /**
  75482. * Dissipates each sample's contribution in range [0, 1]
  75483. */
  75484. decay: number;
  75485. /**
  75486. * Controls the overall intensity of each sample
  75487. */
  75488. weight: number;
  75489. /**
  75490. * Controls the density of each sample
  75491. */
  75492. density: number;
  75493. /**
  75494. * @constructor
  75495. * @param name The post-process name
  75496. * @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)
  75497. * @param camera The camera that the post-process will be attached to
  75498. * @param mesh The mesh used to create the light scattering
  75499. * @param samples The post-process quality, default 100
  75500. * @param samplingModeThe post-process filtering mode
  75501. * @param engine The babylon engine
  75502. * @param reusable If the post-process is reusable
  75503. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75504. */
  75505. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75506. /**
  75507. * Returns the string "VolumetricLightScatteringPostProcess"
  75508. * @returns "VolumetricLightScatteringPostProcess"
  75509. */
  75510. getClassName(): string;
  75511. private _isReady;
  75512. /**
  75513. * Sets the new light position for light scattering effect
  75514. * @param position The new custom light position
  75515. */
  75516. setCustomMeshPosition(position: Vector3): void;
  75517. /**
  75518. * Returns the light position for light scattering effect
  75519. * @return Vector3 The custom light position
  75520. */
  75521. getCustomMeshPosition(): Vector3;
  75522. /**
  75523. * Disposes the internal assets and detaches the post-process from the camera
  75524. */
  75525. dispose(camera: Camera): void;
  75526. /**
  75527. * Returns the render target texture used by the post-process
  75528. * @return the render target texture used by the post-process
  75529. */
  75530. getPass(): RenderTargetTexture;
  75531. private _meshExcluded;
  75532. private _createPass;
  75533. private _updateMeshScreenCoordinates;
  75534. /**
  75535. * Creates a default mesh for the Volumeric Light Scattering post-process
  75536. * @param name The mesh name
  75537. * @param scene The scene where to create the mesh
  75538. * @return the default mesh
  75539. */
  75540. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75541. }
  75542. }
  75543. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75544. /** @hidden */
  75545. export var screenSpaceCurvaturePixelShader: {
  75546. name: string;
  75547. shader: string;
  75548. };
  75549. }
  75550. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75551. import { Nullable } from "babylonjs/types";
  75552. import { Camera } from "babylonjs/Cameras/camera";
  75553. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75554. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75555. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75556. import { Engine } from "babylonjs/Engines/engine";
  75557. import { Scene } from "babylonjs/scene";
  75558. /**
  75559. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75560. */
  75561. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75562. /**
  75563. * Defines how much ridge the curvature effect displays.
  75564. */
  75565. ridge: number;
  75566. /**
  75567. * Defines how much valley the curvature effect displays.
  75568. */
  75569. valley: number;
  75570. private _geometryBufferRenderer;
  75571. /**
  75572. * Gets a string identifying the name of the class
  75573. * @returns "ScreenSpaceCurvaturePostProcess" string
  75574. */
  75575. getClassName(): string;
  75576. /**
  75577. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75578. * @param name The name of the effect.
  75579. * @param scene The scene containing the objects to blur according to their velocity.
  75580. * @param options The required width/height ratio to downsize to before computing the render pass.
  75581. * @param camera The camera to apply the render pass to.
  75582. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75583. * @param engine The engine which the post process will be applied. (default: current engine)
  75584. * @param reusable If the post process can be reused on the same frame. (default: false)
  75585. * @param textureType Type of textures used when performing the post process. (default: 0)
  75586. * @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)
  75587. */
  75588. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75589. /**
  75590. * Support test.
  75591. */
  75592. static get IsSupported(): boolean;
  75593. /** @hidden */
  75594. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75595. }
  75596. }
  75597. declare module "babylonjs/PostProcesses/index" {
  75598. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75599. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75600. export * from "babylonjs/PostProcesses/bloomEffect";
  75601. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75602. export * from "babylonjs/PostProcesses/blurPostProcess";
  75603. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75604. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75605. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75606. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75607. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75608. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75609. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75610. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75611. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75612. export * from "babylonjs/PostProcesses/filterPostProcess";
  75613. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75614. export * from "babylonjs/PostProcesses/grainPostProcess";
  75615. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75616. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75617. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75618. export * from "babylonjs/PostProcesses/passPostProcess";
  75619. export * from "babylonjs/PostProcesses/postProcess";
  75620. export * from "babylonjs/PostProcesses/postProcessManager";
  75621. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75622. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75623. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75624. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75625. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75626. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75627. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75628. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75629. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75630. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75631. }
  75632. declare module "babylonjs/Probes/index" {
  75633. export * from "babylonjs/Probes/reflectionProbe";
  75634. }
  75635. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75636. import { Scene } from "babylonjs/scene";
  75637. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75638. import { SmartArray } from "babylonjs/Misc/smartArray";
  75639. import { ISceneComponent } from "babylonjs/sceneComponent";
  75640. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75641. import "babylonjs/Meshes/Builders/boxBuilder";
  75642. import "babylonjs/Shaders/color.fragment";
  75643. import "babylonjs/Shaders/color.vertex";
  75644. import { Color3 } from "babylonjs/Maths/math.color";
  75645. import { Observable } from "babylonjs/Misc/observable";
  75646. module "babylonjs/scene" {
  75647. interface Scene {
  75648. /** @hidden (Backing field) */
  75649. _boundingBoxRenderer: BoundingBoxRenderer;
  75650. /** @hidden (Backing field) */
  75651. _forceShowBoundingBoxes: boolean;
  75652. /**
  75653. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75654. */
  75655. forceShowBoundingBoxes: boolean;
  75656. /**
  75657. * Gets the bounding box renderer associated with the scene
  75658. * @returns a BoundingBoxRenderer
  75659. */
  75660. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75661. }
  75662. }
  75663. module "babylonjs/Meshes/abstractMesh" {
  75664. interface AbstractMesh {
  75665. /** @hidden (Backing field) */
  75666. _showBoundingBox: boolean;
  75667. /**
  75668. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75669. */
  75670. showBoundingBox: boolean;
  75671. }
  75672. }
  75673. /**
  75674. * Component responsible of rendering the bounding box of the meshes in a scene.
  75675. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75676. */
  75677. export class BoundingBoxRenderer implements ISceneComponent {
  75678. /**
  75679. * The component name helpfull to identify the component in the list of scene components.
  75680. */
  75681. readonly name: string;
  75682. /**
  75683. * The scene the component belongs to.
  75684. */
  75685. scene: Scene;
  75686. /**
  75687. * Color of the bounding box lines placed in front of an object
  75688. */
  75689. frontColor: Color3;
  75690. /**
  75691. * Color of the bounding box lines placed behind an object
  75692. */
  75693. backColor: Color3;
  75694. /**
  75695. * Defines if the renderer should show the back lines or not
  75696. */
  75697. showBackLines: boolean;
  75698. /**
  75699. * Observable raised before rendering a bounding box
  75700. */
  75701. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75702. /**
  75703. * Observable raised after rendering a bounding box
  75704. */
  75705. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75706. /**
  75707. * @hidden
  75708. */
  75709. renderList: SmartArray<BoundingBox>;
  75710. private _colorShader;
  75711. private _vertexBuffers;
  75712. private _indexBuffer;
  75713. private _fillIndexBuffer;
  75714. private _fillIndexData;
  75715. /**
  75716. * Instantiates a new bounding box renderer in a scene.
  75717. * @param scene the scene the renderer renders in
  75718. */
  75719. constructor(scene: Scene);
  75720. /**
  75721. * Registers the component in a given scene
  75722. */
  75723. register(): void;
  75724. private _evaluateSubMesh;
  75725. private _activeMesh;
  75726. private _prepareRessources;
  75727. private _createIndexBuffer;
  75728. /**
  75729. * Rebuilds the elements related to this component in case of
  75730. * context lost for instance.
  75731. */
  75732. rebuild(): void;
  75733. /**
  75734. * @hidden
  75735. */
  75736. reset(): void;
  75737. /**
  75738. * Render the bounding boxes of a specific rendering group
  75739. * @param renderingGroupId defines the rendering group to render
  75740. */
  75741. render(renderingGroupId: number): void;
  75742. /**
  75743. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75744. * @param mesh Define the mesh to render the occlusion bounding box for
  75745. */
  75746. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75747. /**
  75748. * Dispose and release the resources attached to this renderer.
  75749. */
  75750. dispose(): void;
  75751. }
  75752. }
  75753. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75754. import { Nullable } from "babylonjs/types";
  75755. import { Scene } from "babylonjs/scene";
  75756. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75757. import { Camera } from "babylonjs/Cameras/camera";
  75758. import { ISceneComponent } from "babylonjs/sceneComponent";
  75759. module "babylonjs/scene" {
  75760. interface Scene {
  75761. /** @hidden (Backing field) */
  75762. _depthRenderer: {
  75763. [id: string]: DepthRenderer;
  75764. };
  75765. /**
  75766. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75767. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75768. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75769. * @returns the created depth renderer
  75770. */
  75771. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75772. /**
  75773. * Disables a depth renderer for a given camera
  75774. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75775. */
  75776. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75777. }
  75778. }
  75779. /**
  75780. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75781. * in several rendering techniques.
  75782. */
  75783. export class DepthRendererSceneComponent implements ISceneComponent {
  75784. /**
  75785. * The component name helpfull to identify the component in the list of scene components.
  75786. */
  75787. readonly name: string;
  75788. /**
  75789. * The scene the component belongs to.
  75790. */
  75791. scene: Scene;
  75792. /**
  75793. * Creates a new instance of the component for the given scene
  75794. * @param scene Defines the scene to register the component in
  75795. */
  75796. constructor(scene: Scene);
  75797. /**
  75798. * Registers the component in a given scene
  75799. */
  75800. register(): void;
  75801. /**
  75802. * Rebuilds the elements related to this component in case of
  75803. * context lost for instance.
  75804. */
  75805. rebuild(): void;
  75806. /**
  75807. * Disposes the component and the associated ressources
  75808. */
  75809. dispose(): void;
  75810. private _gatherRenderTargets;
  75811. private _gatherActiveCameraRenderTargets;
  75812. }
  75813. }
  75814. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75815. import { Nullable } from "babylonjs/types";
  75816. import { Scene } from "babylonjs/scene";
  75817. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75818. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75819. import { AbstractScene } from "babylonjs/abstractScene";
  75820. module "babylonjs/abstractScene" {
  75821. interface AbstractScene {
  75822. /** @hidden (Backing field) */
  75823. _prePassRenderer: Nullable<PrePassRenderer>;
  75824. /**
  75825. * Gets or Sets the current prepass renderer associated to the scene.
  75826. */
  75827. prePassRenderer: Nullable<PrePassRenderer>;
  75828. /**
  75829. * Enables the prepass and associates it with the scene
  75830. * @returns the PrePassRenderer
  75831. */
  75832. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75833. /**
  75834. * Disables the prepass associated with the scene
  75835. */
  75836. disablePrePassRenderer(): void;
  75837. }
  75838. }
  75839. /**
  75840. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75841. * in several rendering techniques.
  75842. */
  75843. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75844. /**
  75845. * The component name helpful to identify the component in the list of scene components.
  75846. */
  75847. readonly name: string;
  75848. /**
  75849. * The scene the component belongs to.
  75850. */
  75851. scene: Scene;
  75852. /**
  75853. * Creates a new instance of the component for the given scene
  75854. * @param scene Defines the scene to register the component in
  75855. */
  75856. constructor(scene: Scene);
  75857. /**
  75858. * Registers the component in a given scene
  75859. */
  75860. register(): void;
  75861. private _beforeCameraDraw;
  75862. private _afterCameraDraw;
  75863. private _beforeClearStage;
  75864. /**
  75865. * Serializes the component data to the specified json object
  75866. * @param serializationObject The object to serialize to
  75867. */
  75868. serialize(serializationObject: any): void;
  75869. /**
  75870. * Adds all the elements from the container to the scene
  75871. * @param container the container holding the elements
  75872. */
  75873. addFromContainer(container: AbstractScene): void;
  75874. /**
  75875. * Removes all the elements in the container from the scene
  75876. * @param container contains the elements to remove
  75877. * @param dispose if the removed element should be disposed (default: false)
  75878. */
  75879. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75880. /**
  75881. * Rebuilds the elements related to this component in case of
  75882. * context lost for instance.
  75883. */
  75884. rebuild(): void;
  75885. /**
  75886. * Disposes the component and the associated ressources
  75887. */
  75888. dispose(): void;
  75889. }
  75890. }
  75891. declare module "babylonjs/Shaders/outline.fragment" {
  75892. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75893. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75894. /** @hidden */
  75895. export var outlinePixelShader: {
  75896. name: string;
  75897. shader: string;
  75898. };
  75899. }
  75900. declare module "babylonjs/Shaders/outline.vertex" {
  75901. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75902. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75903. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75904. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75905. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75906. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75907. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75908. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75909. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  75910. /** @hidden */
  75911. export var outlineVertexShader: {
  75912. name: string;
  75913. shader: string;
  75914. };
  75915. }
  75916. declare module "babylonjs/Rendering/outlineRenderer" {
  75917. import { SubMesh } from "babylonjs/Meshes/subMesh";
  75918. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  75919. import { Scene } from "babylonjs/scene";
  75920. import { ISceneComponent } from "babylonjs/sceneComponent";
  75921. import "babylonjs/Shaders/outline.fragment";
  75922. import "babylonjs/Shaders/outline.vertex";
  75923. module "babylonjs/scene" {
  75924. interface Scene {
  75925. /** @hidden */
  75926. _outlineRenderer: OutlineRenderer;
  75927. /**
  75928. * Gets the outline renderer associated with the scene
  75929. * @returns a OutlineRenderer
  75930. */
  75931. getOutlineRenderer(): OutlineRenderer;
  75932. }
  75933. }
  75934. module "babylonjs/Meshes/abstractMesh" {
  75935. interface AbstractMesh {
  75936. /** @hidden (Backing field) */
  75937. _renderOutline: boolean;
  75938. /**
  75939. * Gets or sets a boolean indicating if the outline must be rendered as well
  75940. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  75941. */
  75942. renderOutline: boolean;
  75943. /** @hidden (Backing field) */
  75944. _renderOverlay: boolean;
  75945. /**
  75946. * Gets or sets a boolean indicating if the overlay must be rendered as well
  75947. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  75948. */
  75949. renderOverlay: boolean;
  75950. }
  75951. }
  75952. /**
  75953. * This class is responsible to draw bothe outline/overlay of meshes.
  75954. * It should not be used directly but through the available method on mesh.
  75955. */
  75956. export class OutlineRenderer implements ISceneComponent {
  75957. /**
  75958. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  75959. */
  75960. private static _StencilReference;
  75961. /**
  75962. * The name of the component. Each component must have a unique name.
  75963. */
  75964. name: string;
  75965. /**
  75966. * The scene the component belongs to.
  75967. */
  75968. scene: Scene;
  75969. /**
  75970. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  75971. */
  75972. zOffset: number;
  75973. private _engine;
  75974. private _effect;
  75975. private _cachedDefines;
  75976. private _savedDepthWrite;
  75977. /**
  75978. * Instantiates a new outline renderer. (There could be only one per scene).
  75979. * @param scene Defines the scene it belongs to
  75980. */
  75981. constructor(scene: Scene);
  75982. /**
  75983. * Register the component to one instance of a scene.
  75984. */
  75985. register(): void;
  75986. /**
  75987. * Rebuilds the elements related to this component in case of
  75988. * context lost for instance.
  75989. */
  75990. rebuild(): void;
  75991. /**
  75992. * Disposes the component and the associated ressources.
  75993. */
  75994. dispose(): void;
  75995. /**
  75996. * Renders the outline in the canvas.
  75997. * @param subMesh Defines the sumesh to render
  75998. * @param batch Defines the batch of meshes in case of instances
  75999. * @param useOverlay Defines if the rendering is for the overlay or the outline
  76000. */
  76001. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  76002. /**
  76003. * Returns whether or not the outline renderer is ready for a given submesh.
  76004. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  76005. * @param subMesh Defines the submesh to check readyness for
  76006. * @param useInstances Defines wheter wee are trying to render instances or not
  76007. * @returns true if ready otherwise false
  76008. */
  76009. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  76010. private _beforeRenderingMesh;
  76011. private _afterRenderingMesh;
  76012. }
  76013. }
  76014. declare module "babylonjs/Rendering/index" {
  76015. export * from "babylonjs/Rendering/boundingBoxRenderer";
  76016. export * from "babylonjs/Rendering/depthRenderer";
  76017. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  76018. export * from "babylonjs/Rendering/edgesRenderer";
  76019. export * from "babylonjs/Rendering/geometryBufferRenderer";
  76020. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76021. export * from "babylonjs/Rendering/prePassRenderer";
  76022. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  76023. export * from "babylonjs/Rendering/outlineRenderer";
  76024. export * from "babylonjs/Rendering/renderingGroup";
  76025. export * from "babylonjs/Rendering/renderingManager";
  76026. export * from "babylonjs/Rendering/utilityLayerRenderer";
  76027. }
  76028. declare module "babylonjs/Sprites/ISprites" {
  76029. /**
  76030. * Defines the basic options interface of a Sprite Frame Source Size.
  76031. */
  76032. export interface ISpriteJSONSpriteSourceSize {
  76033. /**
  76034. * number of the original width of the Frame
  76035. */
  76036. w: number;
  76037. /**
  76038. * number of the original height of the Frame
  76039. */
  76040. h: number;
  76041. }
  76042. /**
  76043. * Defines the basic options interface of a Sprite Frame Data.
  76044. */
  76045. export interface ISpriteJSONSpriteFrameData {
  76046. /**
  76047. * number of the x offset of the Frame
  76048. */
  76049. x: number;
  76050. /**
  76051. * number of the y offset of the Frame
  76052. */
  76053. y: number;
  76054. /**
  76055. * number of the width of the Frame
  76056. */
  76057. w: number;
  76058. /**
  76059. * number of the height of the Frame
  76060. */
  76061. h: number;
  76062. }
  76063. /**
  76064. * Defines the basic options interface of a JSON Sprite.
  76065. */
  76066. export interface ISpriteJSONSprite {
  76067. /**
  76068. * string name of the Frame
  76069. */
  76070. filename: string;
  76071. /**
  76072. * ISpriteJSONSpriteFrame basic object of the frame data
  76073. */
  76074. frame: ISpriteJSONSpriteFrameData;
  76075. /**
  76076. * boolean to flag is the frame was rotated.
  76077. */
  76078. rotated: boolean;
  76079. /**
  76080. * boolean to flag is the frame was trimmed.
  76081. */
  76082. trimmed: boolean;
  76083. /**
  76084. * ISpriteJSONSpriteFrame basic object of the source data
  76085. */
  76086. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76087. /**
  76088. * ISpriteJSONSpriteFrame basic object of the source data
  76089. */
  76090. sourceSize: ISpriteJSONSpriteSourceSize;
  76091. }
  76092. /**
  76093. * Defines the basic options interface of a JSON atlas.
  76094. */
  76095. export interface ISpriteJSONAtlas {
  76096. /**
  76097. * Array of objects that contain the frame data.
  76098. */
  76099. frames: Array<ISpriteJSONSprite>;
  76100. /**
  76101. * object basic object containing the sprite meta data.
  76102. */
  76103. meta?: object;
  76104. }
  76105. }
  76106. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76107. /** @hidden */
  76108. export var spriteMapPixelShader: {
  76109. name: string;
  76110. shader: string;
  76111. };
  76112. }
  76113. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76114. /** @hidden */
  76115. export var spriteMapVertexShader: {
  76116. name: string;
  76117. shader: string;
  76118. };
  76119. }
  76120. declare module "babylonjs/Sprites/spriteMap" {
  76121. import { IDisposable, Scene } from "babylonjs/scene";
  76122. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76123. import { Texture } from "babylonjs/Materials/Textures/texture";
  76124. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76125. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76126. import "babylonjs/Meshes/Builders/planeBuilder";
  76127. import "babylonjs/Shaders/spriteMap.fragment";
  76128. import "babylonjs/Shaders/spriteMap.vertex";
  76129. /**
  76130. * Defines the basic options interface of a SpriteMap
  76131. */
  76132. export interface ISpriteMapOptions {
  76133. /**
  76134. * Vector2 of the number of cells in the grid.
  76135. */
  76136. stageSize?: Vector2;
  76137. /**
  76138. * Vector2 of the size of the output plane in World Units.
  76139. */
  76140. outputSize?: Vector2;
  76141. /**
  76142. * Vector3 of the position of the output plane in World Units.
  76143. */
  76144. outputPosition?: Vector3;
  76145. /**
  76146. * Vector3 of the rotation of the output plane.
  76147. */
  76148. outputRotation?: Vector3;
  76149. /**
  76150. * number of layers that the system will reserve in resources.
  76151. */
  76152. layerCount?: number;
  76153. /**
  76154. * number of max animation frames a single cell will reserve in resources.
  76155. */
  76156. maxAnimationFrames?: number;
  76157. /**
  76158. * number cell index of the base tile when the system compiles.
  76159. */
  76160. baseTile?: number;
  76161. /**
  76162. * boolean flip the sprite after its been repositioned by the framing data.
  76163. */
  76164. flipU?: boolean;
  76165. /**
  76166. * Vector3 scalar of the global RGB values of the SpriteMap.
  76167. */
  76168. colorMultiply?: Vector3;
  76169. }
  76170. /**
  76171. * Defines the IDisposable interface in order to be cleanable from resources.
  76172. */
  76173. export interface ISpriteMap extends IDisposable {
  76174. /**
  76175. * String name of the SpriteMap.
  76176. */
  76177. name: string;
  76178. /**
  76179. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76180. */
  76181. atlasJSON: ISpriteJSONAtlas;
  76182. /**
  76183. * Texture of the SpriteMap.
  76184. */
  76185. spriteSheet: Texture;
  76186. /**
  76187. * The parameters to initialize the SpriteMap with.
  76188. */
  76189. options: ISpriteMapOptions;
  76190. }
  76191. /**
  76192. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76193. */
  76194. export class SpriteMap implements ISpriteMap {
  76195. /** The Name of the spriteMap */
  76196. name: string;
  76197. /** The JSON file with the frame and meta data */
  76198. atlasJSON: ISpriteJSONAtlas;
  76199. /** The systems Sprite Sheet Texture */
  76200. spriteSheet: Texture;
  76201. /** Arguments passed with the Constructor */
  76202. options: ISpriteMapOptions;
  76203. /** Public Sprite Storage array, parsed from atlasJSON */
  76204. sprites: Array<ISpriteJSONSprite>;
  76205. /** Returns the Number of Sprites in the System */
  76206. get spriteCount(): number;
  76207. /** Returns the Position of Output Plane*/
  76208. get position(): Vector3;
  76209. /** Returns the Position of Output Plane*/
  76210. set position(v: Vector3);
  76211. /** Returns the Rotation of Output Plane*/
  76212. get rotation(): Vector3;
  76213. /** Returns the Rotation of Output Plane*/
  76214. set rotation(v: Vector3);
  76215. /** Sets the AnimationMap*/
  76216. get animationMap(): RawTexture;
  76217. /** Sets the AnimationMap*/
  76218. set animationMap(v: RawTexture);
  76219. /** Scene that the SpriteMap was created in */
  76220. private _scene;
  76221. /** Texture Buffer of Float32 that holds tile frame data*/
  76222. private _frameMap;
  76223. /** Texture Buffers of Float32 that holds tileMap data*/
  76224. private _tileMaps;
  76225. /** Texture Buffer of Float32 that holds Animation Data*/
  76226. private _animationMap;
  76227. /** Custom ShaderMaterial Central to the System*/
  76228. private _material;
  76229. /** Custom ShaderMaterial Central to the System*/
  76230. private _output;
  76231. /** Systems Time Ticker*/
  76232. private _time;
  76233. /**
  76234. * Creates a new SpriteMap
  76235. * @param name defines the SpriteMaps Name
  76236. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76237. * @param spriteSheet is the Texture that the Sprites are on.
  76238. * @param options a basic deployment configuration
  76239. * @param scene The Scene that the map is deployed on
  76240. */
  76241. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76242. /**
  76243. * Returns tileID location
  76244. * @returns Vector2 the cell position ID
  76245. */
  76246. getTileID(): Vector2;
  76247. /**
  76248. * Gets the UV location of the mouse over the SpriteMap.
  76249. * @returns Vector2 the UV position of the mouse interaction
  76250. */
  76251. getMousePosition(): Vector2;
  76252. /**
  76253. * Creates the "frame" texture Buffer
  76254. * -------------------------------------
  76255. * Structure of frames
  76256. * "filename": "Falling-Water-2.png",
  76257. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76258. * "rotated": true,
  76259. * "trimmed": true,
  76260. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76261. * "sourceSize": {"w":32,"h":32}
  76262. * @returns RawTexture of the frameMap
  76263. */
  76264. private _createFrameBuffer;
  76265. /**
  76266. * Creates the tileMap texture Buffer
  76267. * @param buffer normally and array of numbers, or a false to generate from scratch
  76268. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76269. * @returns RawTexture of the tileMap
  76270. */
  76271. private _createTileBuffer;
  76272. /**
  76273. * Modifies the data of the tileMaps
  76274. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76275. * @param pos is the iVector2 Coordinates of the Tile
  76276. * @param tile The SpriteIndex of the new Tile
  76277. */
  76278. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76279. /**
  76280. * Creates the animationMap texture Buffer
  76281. * @param buffer normally and array of numbers, or a false to generate from scratch
  76282. * @returns RawTexture of the animationMap
  76283. */
  76284. private _createTileAnimationBuffer;
  76285. /**
  76286. * Modifies the data of the animationMap
  76287. * @param cellID is the Index of the Sprite
  76288. * @param _frame is the target Animation frame
  76289. * @param toCell is the Target Index of the next frame of the animation
  76290. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76291. * @param speed is a global scalar of the time variable on the map.
  76292. */
  76293. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76294. /**
  76295. * Exports the .tilemaps file
  76296. */
  76297. saveTileMaps(): void;
  76298. /**
  76299. * Imports the .tilemaps file
  76300. * @param url of the .tilemaps file
  76301. */
  76302. loadTileMaps(url: string): void;
  76303. /**
  76304. * Release associated resources
  76305. */
  76306. dispose(): void;
  76307. }
  76308. }
  76309. declare module "babylonjs/Sprites/spritePackedManager" {
  76310. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76311. import { Scene } from "babylonjs/scene";
  76312. /**
  76313. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76314. * @see https://doc.babylonjs.com/babylon101/sprites
  76315. */
  76316. export class SpritePackedManager extends SpriteManager {
  76317. /** defines the packed manager's name */
  76318. name: string;
  76319. /**
  76320. * Creates a new sprite manager from a packed sprite sheet
  76321. * @param name defines the manager's name
  76322. * @param imgUrl defines the sprite sheet url
  76323. * @param capacity defines the maximum allowed number of sprites
  76324. * @param scene defines the hosting scene
  76325. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76326. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76327. * @param samplingMode defines the smapling mode to use with spritesheet
  76328. * @param fromPacked set to true; do not alter
  76329. */
  76330. constructor(
  76331. /** defines the packed manager's name */
  76332. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76333. }
  76334. }
  76335. declare module "babylonjs/Sprites/index" {
  76336. export * from "babylonjs/Sprites/sprite";
  76337. export * from "babylonjs/Sprites/ISprites";
  76338. export * from "babylonjs/Sprites/spriteManager";
  76339. export * from "babylonjs/Sprites/spriteMap";
  76340. export * from "babylonjs/Sprites/spritePackedManager";
  76341. export * from "babylonjs/Sprites/spriteSceneComponent";
  76342. }
  76343. declare module "babylonjs/States/index" {
  76344. export * from "babylonjs/States/alphaCullingState";
  76345. export * from "babylonjs/States/depthCullingState";
  76346. export * from "babylonjs/States/stencilState";
  76347. }
  76348. declare module "babylonjs/Misc/assetsManager" {
  76349. import { Scene } from "babylonjs/scene";
  76350. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76351. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76352. import { Skeleton } from "babylonjs/Bones/skeleton";
  76353. import { Observable } from "babylonjs/Misc/observable";
  76354. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76355. import { Texture } from "babylonjs/Materials/Textures/texture";
  76356. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76357. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76358. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76359. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76360. import { AssetContainer } from "babylonjs/assetContainer";
  76361. /**
  76362. * Defines the list of states available for a task inside a AssetsManager
  76363. */
  76364. export enum AssetTaskState {
  76365. /**
  76366. * Initialization
  76367. */
  76368. INIT = 0,
  76369. /**
  76370. * Running
  76371. */
  76372. RUNNING = 1,
  76373. /**
  76374. * Done
  76375. */
  76376. DONE = 2,
  76377. /**
  76378. * Error
  76379. */
  76380. ERROR = 3
  76381. }
  76382. /**
  76383. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76384. */
  76385. export abstract class AbstractAssetTask {
  76386. /**
  76387. * Task name
  76388. */ name: string;
  76389. /**
  76390. * Callback called when the task is successful
  76391. */
  76392. onSuccess: (task: any) => void;
  76393. /**
  76394. * Callback called when the task is not successful
  76395. */
  76396. onError: (task: any, message?: string, exception?: any) => void;
  76397. /**
  76398. * Creates a new AssetsManager
  76399. * @param name defines the name of the task
  76400. */
  76401. constructor(
  76402. /**
  76403. * Task name
  76404. */ name: string);
  76405. private _isCompleted;
  76406. private _taskState;
  76407. private _errorObject;
  76408. /**
  76409. * Get if the task is completed
  76410. */
  76411. get isCompleted(): boolean;
  76412. /**
  76413. * Gets the current state of the task
  76414. */
  76415. get taskState(): AssetTaskState;
  76416. /**
  76417. * Gets the current error object (if task is in error)
  76418. */
  76419. get errorObject(): {
  76420. message?: string;
  76421. exception?: any;
  76422. };
  76423. /**
  76424. * Internal only
  76425. * @hidden
  76426. */
  76427. _setErrorObject(message?: string, exception?: any): void;
  76428. /**
  76429. * Execute the current task
  76430. * @param scene defines the scene where you want your assets to be loaded
  76431. * @param onSuccess is a callback called when the task is successfully executed
  76432. * @param onError is a callback called if an error occurs
  76433. */
  76434. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76435. /**
  76436. * Execute the current task
  76437. * @param scene defines the scene where you want your assets to be loaded
  76438. * @param onSuccess is a callback called when the task is successfully executed
  76439. * @param onError is a callback called if an error occurs
  76440. */
  76441. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76442. /**
  76443. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76444. * This can be used with failed tasks that have the reason for failure fixed.
  76445. */
  76446. reset(): void;
  76447. private onErrorCallback;
  76448. private onDoneCallback;
  76449. }
  76450. /**
  76451. * Define the interface used by progress events raised during assets loading
  76452. */
  76453. export interface IAssetsProgressEvent {
  76454. /**
  76455. * Defines the number of remaining tasks to process
  76456. */
  76457. remainingCount: number;
  76458. /**
  76459. * Defines the total number of tasks
  76460. */
  76461. totalCount: number;
  76462. /**
  76463. * Defines the task that was just processed
  76464. */
  76465. task: AbstractAssetTask;
  76466. }
  76467. /**
  76468. * Class used to share progress information about assets loading
  76469. */
  76470. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76471. /**
  76472. * Defines the number of remaining tasks to process
  76473. */
  76474. remainingCount: number;
  76475. /**
  76476. * Defines the total number of tasks
  76477. */
  76478. totalCount: number;
  76479. /**
  76480. * Defines the task that was just processed
  76481. */
  76482. task: AbstractAssetTask;
  76483. /**
  76484. * Creates a AssetsProgressEvent
  76485. * @param remainingCount defines the number of remaining tasks to process
  76486. * @param totalCount defines the total number of tasks
  76487. * @param task defines the task that was just processed
  76488. */
  76489. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76490. }
  76491. /**
  76492. * Define a task used by AssetsManager to load assets into a container
  76493. */
  76494. export class ContainerAssetTask extends AbstractAssetTask {
  76495. /**
  76496. * Defines the name of the task
  76497. */
  76498. name: string;
  76499. /**
  76500. * Defines the list of mesh's names you want to load
  76501. */
  76502. meshesNames: any;
  76503. /**
  76504. * Defines the root url to use as a base to load your meshes and associated resources
  76505. */
  76506. rootUrl: string;
  76507. /**
  76508. * Defines the filename or File of the scene to load from
  76509. */
  76510. sceneFilename: string | File;
  76511. /**
  76512. * Get the loaded asset container
  76513. */
  76514. loadedContainer: AssetContainer;
  76515. /**
  76516. * Gets the list of loaded meshes
  76517. */
  76518. loadedMeshes: Array<AbstractMesh>;
  76519. /**
  76520. * Gets the list of loaded particle systems
  76521. */
  76522. loadedParticleSystems: Array<IParticleSystem>;
  76523. /**
  76524. * Gets the list of loaded skeletons
  76525. */
  76526. loadedSkeletons: Array<Skeleton>;
  76527. /**
  76528. * Gets the list of loaded animation groups
  76529. */
  76530. loadedAnimationGroups: Array<AnimationGroup>;
  76531. /**
  76532. * Callback called when the task is successful
  76533. */
  76534. onSuccess: (task: ContainerAssetTask) => void;
  76535. /**
  76536. * Callback called when the task is successful
  76537. */
  76538. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  76539. /**
  76540. * Creates a new ContainerAssetTask
  76541. * @param name defines the name of the task
  76542. * @param meshesNames defines the list of mesh's names you want to load
  76543. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76544. * @param sceneFilename defines the filename or File of the scene to load from
  76545. */
  76546. constructor(
  76547. /**
  76548. * Defines the name of the task
  76549. */
  76550. name: string,
  76551. /**
  76552. * Defines the list of mesh's names you want to load
  76553. */
  76554. meshesNames: any,
  76555. /**
  76556. * Defines the root url to use as a base to load your meshes and associated resources
  76557. */
  76558. rootUrl: string,
  76559. /**
  76560. * Defines the filename or File of the scene to load from
  76561. */
  76562. sceneFilename: string | File);
  76563. /**
  76564. * Execute the current task
  76565. * @param scene defines the scene where you want your assets to be loaded
  76566. * @param onSuccess is a callback called when the task is successfully executed
  76567. * @param onError is a callback called if an error occurs
  76568. */
  76569. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76570. }
  76571. /**
  76572. * Define a task used by AssetsManager to load meshes
  76573. */
  76574. export class MeshAssetTask extends AbstractAssetTask {
  76575. /**
  76576. * Defines the name of the task
  76577. */
  76578. name: string;
  76579. /**
  76580. * Defines the list of mesh's names you want to load
  76581. */
  76582. meshesNames: any;
  76583. /**
  76584. * Defines the root url to use as a base to load your meshes and associated resources
  76585. */
  76586. rootUrl: string;
  76587. /**
  76588. * Defines the filename or File of the scene to load from
  76589. */
  76590. sceneFilename: string | File;
  76591. /**
  76592. * Gets the list of loaded meshes
  76593. */
  76594. loadedMeshes: Array<AbstractMesh>;
  76595. /**
  76596. * Gets the list of loaded particle systems
  76597. */
  76598. loadedParticleSystems: Array<IParticleSystem>;
  76599. /**
  76600. * Gets the list of loaded skeletons
  76601. */
  76602. loadedSkeletons: Array<Skeleton>;
  76603. /**
  76604. * Gets the list of loaded animation groups
  76605. */
  76606. loadedAnimationGroups: Array<AnimationGroup>;
  76607. /**
  76608. * Callback called when the task is successful
  76609. */
  76610. onSuccess: (task: MeshAssetTask) => void;
  76611. /**
  76612. * Callback called when the task is successful
  76613. */
  76614. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  76615. /**
  76616. * Creates a new MeshAssetTask
  76617. * @param name defines the name of the task
  76618. * @param meshesNames defines the list of mesh's names you want to load
  76619. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76620. * @param sceneFilename defines the filename or File of the scene to load from
  76621. */
  76622. constructor(
  76623. /**
  76624. * Defines the name of the task
  76625. */
  76626. name: string,
  76627. /**
  76628. * Defines the list of mesh's names you want to load
  76629. */
  76630. meshesNames: any,
  76631. /**
  76632. * Defines the root url to use as a base to load your meshes and associated resources
  76633. */
  76634. rootUrl: string,
  76635. /**
  76636. * Defines the filename or File of the scene to load from
  76637. */
  76638. sceneFilename: string | File);
  76639. /**
  76640. * Execute the current task
  76641. * @param scene defines the scene where you want your assets to be loaded
  76642. * @param onSuccess is a callback called when the task is successfully executed
  76643. * @param onError is a callback called if an error occurs
  76644. */
  76645. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76646. }
  76647. /**
  76648. * Define a task used by AssetsManager to load text content
  76649. */
  76650. export class TextFileAssetTask extends AbstractAssetTask {
  76651. /**
  76652. * Defines the name of the task
  76653. */
  76654. name: string;
  76655. /**
  76656. * Defines the location of the file to load
  76657. */
  76658. url: string;
  76659. /**
  76660. * Gets the loaded text string
  76661. */
  76662. text: string;
  76663. /**
  76664. * Callback called when the task is successful
  76665. */
  76666. onSuccess: (task: TextFileAssetTask) => void;
  76667. /**
  76668. * Callback called when the task is successful
  76669. */
  76670. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76671. /**
  76672. * Creates a new TextFileAssetTask object
  76673. * @param name defines the name of the task
  76674. * @param url defines the location of the file to load
  76675. */
  76676. constructor(
  76677. /**
  76678. * Defines the name of the task
  76679. */
  76680. name: string,
  76681. /**
  76682. * Defines the location of the file to load
  76683. */
  76684. url: string);
  76685. /**
  76686. * Execute the current task
  76687. * @param scene defines the scene where you want your assets to be loaded
  76688. * @param onSuccess is a callback called when the task is successfully executed
  76689. * @param onError is a callback called if an error occurs
  76690. */
  76691. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76692. }
  76693. /**
  76694. * Define a task used by AssetsManager to load binary data
  76695. */
  76696. export class BinaryFileAssetTask extends AbstractAssetTask {
  76697. /**
  76698. * Defines the name of the task
  76699. */
  76700. name: string;
  76701. /**
  76702. * Defines the location of the file to load
  76703. */
  76704. url: string;
  76705. /**
  76706. * Gets the lodaded data (as an array buffer)
  76707. */
  76708. data: ArrayBuffer;
  76709. /**
  76710. * Callback called when the task is successful
  76711. */
  76712. onSuccess: (task: BinaryFileAssetTask) => void;
  76713. /**
  76714. * Callback called when the task is successful
  76715. */
  76716. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76717. /**
  76718. * Creates a new BinaryFileAssetTask object
  76719. * @param name defines the name of the new task
  76720. * @param url defines the location of the file to load
  76721. */
  76722. constructor(
  76723. /**
  76724. * Defines the name of the task
  76725. */
  76726. name: string,
  76727. /**
  76728. * Defines the location of the file to load
  76729. */
  76730. url: string);
  76731. /**
  76732. * Execute the current task
  76733. * @param scene defines the scene where you want your assets to be loaded
  76734. * @param onSuccess is a callback called when the task is successfully executed
  76735. * @param onError is a callback called if an error occurs
  76736. */
  76737. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76738. }
  76739. /**
  76740. * Define a task used by AssetsManager to load images
  76741. */
  76742. export class ImageAssetTask extends AbstractAssetTask {
  76743. /**
  76744. * Defines the name of the task
  76745. */
  76746. name: string;
  76747. /**
  76748. * Defines the location of the image to load
  76749. */
  76750. url: string;
  76751. /**
  76752. * Gets the loaded images
  76753. */
  76754. image: HTMLImageElement;
  76755. /**
  76756. * Callback called when the task is successful
  76757. */
  76758. onSuccess: (task: ImageAssetTask) => void;
  76759. /**
  76760. * Callback called when the task is successful
  76761. */
  76762. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76763. /**
  76764. * Creates a new ImageAssetTask
  76765. * @param name defines the name of the task
  76766. * @param url defines the location of the image to load
  76767. */
  76768. constructor(
  76769. /**
  76770. * Defines the name of the task
  76771. */
  76772. name: string,
  76773. /**
  76774. * Defines the location of the image to load
  76775. */
  76776. url: string);
  76777. /**
  76778. * Execute the current task
  76779. * @param scene defines the scene where you want your assets to be loaded
  76780. * @param onSuccess is a callback called when the task is successfully executed
  76781. * @param onError is a callback called if an error occurs
  76782. */
  76783. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76784. }
  76785. /**
  76786. * Defines the interface used by texture loading tasks
  76787. */
  76788. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76789. /**
  76790. * Gets the loaded texture
  76791. */
  76792. texture: TEX;
  76793. }
  76794. /**
  76795. * Define a task used by AssetsManager to load 2D textures
  76796. */
  76797. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76798. /**
  76799. * Defines the name of the task
  76800. */
  76801. name: string;
  76802. /**
  76803. * Defines the location of the file to load
  76804. */
  76805. url: string;
  76806. /**
  76807. * Defines if mipmap should not be generated (default is false)
  76808. */
  76809. noMipmap?: boolean | undefined;
  76810. /**
  76811. * Defines if texture must be inverted on Y axis (default is true)
  76812. */
  76813. invertY: boolean;
  76814. /**
  76815. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76816. */
  76817. samplingMode: number;
  76818. /**
  76819. * Gets the loaded texture
  76820. */
  76821. texture: Texture;
  76822. /**
  76823. * Callback called when the task is successful
  76824. */
  76825. onSuccess: (task: TextureAssetTask) => void;
  76826. /**
  76827. * Callback called when the task is successful
  76828. */
  76829. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76830. /**
  76831. * Creates a new TextureAssetTask object
  76832. * @param name defines the name of the task
  76833. * @param url defines the location of the file to load
  76834. * @param noMipmap defines if mipmap should not be generated (default is false)
  76835. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76836. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76837. */
  76838. constructor(
  76839. /**
  76840. * Defines the name of the task
  76841. */
  76842. name: string,
  76843. /**
  76844. * Defines the location of the file to load
  76845. */
  76846. url: string,
  76847. /**
  76848. * Defines if mipmap should not be generated (default is false)
  76849. */
  76850. noMipmap?: boolean | undefined,
  76851. /**
  76852. * Defines if texture must be inverted on Y axis (default is true)
  76853. */
  76854. invertY?: boolean,
  76855. /**
  76856. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76857. */
  76858. samplingMode?: number);
  76859. /**
  76860. * Execute the current task
  76861. * @param scene defines the scene where you want your assets to be loaded
  76862. * @param onSuccess is a callback called when the task is successfully executed
  76863. * @param onError is a callback called if an error occurs
  76864. */
  76865. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76866. }
  76867. /**
  76868. * Define a task used by AssetsManager to load cube textures
  76869. */
  76870. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76871. /**
  76872. * Defines the name of the task
  76873. */
  76874. name: string;
  76875. /**
  76876. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76877. */
  76878. url: string;
  76879. /**
  76880. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76881. */
  76882. extensions?: string[] | undefined;
  76883. /**
  76884. * Defines if mipmaps should not be generated (default is false)
  76885. */
  76886. noMipmap?: boolean | undefined;
  76887. /**
  76888. * Defines the explicit list of files (undefined by default)
  76889. */
  76890. files?: string[] | undefined;
  76891. /**
  76892. * Gets the loaded texture
  76893. */
  76894. texture: CubeTexture;
  76895. /**
  76896. * Callback called when the task is successful
  76897. */
  76898. onSuccess: (task: CubeTextureAssetTask) => void;
  76899. /**
  76900. * Callback called when the task is successful
  76901. */
  76902. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  76903. /**
  76904. * Creates a new CubeTextureAssetTask
  76905. * @param name defines the name of the task
  76906. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76907. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76908. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76909. * @param files defines the explicit list of files (undefined by default)
  76910. */
  76911. constructor(
  76912. /**
  76913. * Defines the name of the task
  76914. */
  76915. name: string,
  76916. /**
  76917. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76918. */
  76919. url: string,
  76920. /**
  76921. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76922. */
  76923. extensions?: string[] | undefined,
  76924. /**
  76925. * Defines if mipmaps should not be generated (default is false)
  76926. */
  76927. noMipmap?: boolean | undefined,
  76928. /**
  76929. * Defines the explicit list of files (undefined by default)
  76930. */
  76931. files?: string[] | undefined);
  76932. /**
  76933. * Execute the current task
  76934. * @param scene defines the scene where you want your assets to be loaded
  76935. * @param onSuccess is a callback called when the task is successfully executed
  76936. * @param onError is a callback called if an error occurs
  76937. */
  76938. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76939. }
  76940. /**
  76941. * Define a task used by AssetsManager to load HDR cube textures
  76942. */
  76943. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  76944. /**
  76945. * Defines the name of the task
  76946. */
  76947. name: string;
  76948. /**
  76949. * Defines the location of the file to load
  76950. */
  76951. url: string;
  76952. /**
  76953. * Defines the desired size (the more it increases the longer the generation will be)
  76954. */
  76955. size: number;
  76956. /**
  76957. * Defines if mipmaps should not be generated (default is false)
  76958. */
  76959. noMipmap: boolean;
  76960. /**
  76961. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76962. */
  76963. generateHarmonics: boolean;
  76964. /**
  76965. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  76966. */
  76967. gammaSpace: boolean;
  76968. /**
  76969. * Internal Use Only
  76970. */
  76971. reserved: boolean;
  76972. /**
  76973. * Gets the loaded texture
  76974. */
  76975. texture: HDRCubeTexture;
  76976. /**
  76977. * Callback called when the task is successful
  76978. */
  76979. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  76980. /**
  76981. * Callback called when the task is successful
  76982. */
  76983. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  76984. /**
  76985. * Creates a new HDRCubeTextureAssetTask object
  76986. * @param name defines the name of the task
  76987. * @param url defines the location of the file to load
  76988. * @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.
  76989. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76990. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76991. * @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)
  76992. * @param reserved Internal use only
  76993. */
  76994. constructor(
  76995. /**
  76996. * Defines the name of the task
  76997. */
  76998. name: string,
  76999. /**
  77000. * Defines the location of the file to load
  77001. */
  77002. url: string,
  77003. /**
  77004. * Defines the desired size (the more it increases the longer the generation will be)
  77005. */
  77006. size: number,
  77007. /**
  77008. * Defines if mipmaps should not be generated (default is false)
  77009. */
  77010. noMipmap?: boolean,
  77011. /**
  77012. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77013. */
  77014. generateHarmonics?: boolean,
  77015. /**
  77016. * 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)
  77017. */
  77018. gammaSpace?: boolean,
  77019. /**
  77020. * Internal Use Only
  77021. */
  77022. reserved?: boolean);
  77023. /**
  77024. * Execute the current task
  77025. * @param scene defines the scene where you want your assets to be loaded
  77026. * @param onSuccess is a callback called when the task is successfully executed
  77027. * @param onError is a callback called if an error occurs
  77028. */
  77029. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77030. }
  77031. /**
  77032. * Define a task used by AssetsManager to load Equirectangular cube textures
  77033. */
  77034. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  77035. /**
  77036. * Defines the name of the task
  77037. */
  77038. name: string;
  77039. /**
  77040. * Defines the location of the file to load
  77041. */
  77042. url: string;
  77043. /**
  77044. * Defines the desired size (the more it increases the longer the generation will be)
  77045. */
  77046. size: number;
  77047. /**
  77048. * Defines if mipmaps should not be generated (default is false)
  77049. */
  77050. noMipmap: boolean;
  77051. /**
  77052. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77053. * but the standard material would require them in Gamma space) (default is true)
  77054. */
  77055. gammaSpace: boolean;
  77056. /**
  77057. * Gets the loaded texture
  77058. */
  77059. texture: EquiRectangularCubeTexture;
  77060. /**
  77061. * Callback called when the task is successful
  77062. */
  77063. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77064. /**
  77065. * Callback called when the task is successful
  77066. */
  77067. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77068. /**
  77069. * Creates a new EquiRectangularCubeTextureAssetTask object
  77070. * @param name defines the name of the task
  77071. * @param url defines the location of the file to load
  77072. * @param size defines the desired size (the more it increases the longer the generation will be)
  77073. * If the size is omitted this implies you are using a preprocessed cubemap.
  77074. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77075. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77076. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77077. * (default is true)
  77078. */
  77079. constructor(
  77080. /**
  77081. * Defines the name of the task
  77082. */
  77083. name: string,
  77084. /**
  77085. * Defines the location of the file to load
  77086. */
  77087. url: string,
  77088. /**
  77089. * Defines the desired size (the more it increases the longer the generation will be)
  77090. */
  77091. size: number,
  77092. /**
  77093. * Defines if mipmaps should not be generated (default is false)
  77094. */
  77095. noMipmap?: boolean,
  77096. /**
  77097. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77098. * but the standard material would require them in Gamma space) (default is true)
  77099. */
  77100. gammaSpace?: boolean);
  77101. /**
  77102. * Execute the current task
  77103. * @param scene defines the scene where you want your assets to be loaded
  77104. * @param onSuccess is a callback called when the task is successfully executed
  77105. * @param onError is a callback called if an error occurs
  77106. */
  77107. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77108. }
  77109. /**
  77110. * This class can be used to easily import assets into a scene
  77111. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77112. */
  77113. export class AssetsManager {
  77114. private _scene;
  77115. private _isLoading;
  77116. protected _tasks: AbstractAssetTask[];
  77117. protected _waitingTasksCount: number;
  77118. protected _totalTasksCount: number;
  77119. /**
  77120. * Callback called when all tasks are processed
  77121. */
  77122. onFinish: (tasks: AbstractAssetTask[]) => void;
  77123. /**
  77124. * Callback called when a task is successful
  77125. */
  77126. onTaskSuccess: (task: AbstractAssetTask) => void;
  77127. /**
  77128. * Callback called when a task had an error
  77129. */
  77130. onTaskError: (task: AbstractAssetTask) => void;
  77131. /**
  77132. * Callback called when a task is done (whatever the result is)
  77133. */
  77134. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77135. /**
  77136. * Observable called when all tasks are processed
  77137. */
  77138. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77139. /**
  77140. * Observable called when a task had an error
  77141. */
  77142. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77143. /**
  77144. * Observable called when all tasks were executed
  77145. */
  77146. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77147. /**
  77148. * Observable called when a task is done (whatever the result is)
  77149. */
  77150. onProgressObservable: Observable<IAssetsProgressEvent>;
  77151. /**
  77152. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77153. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77154. */
  77155. useDefaultLoadingScreen: boolean;
  77156. /**
  77157. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77158. * when all assets have been downloaded.
  77159. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77160. */
  77161. autoHideLoadingUI: boolean;
  77162. /**
  77163. * Creates a new AssetsManager
  77164. * @param scene defines the scene to work on
  77165. */
  77166. constructor(scene: Scene);
  77167. /**
  77168. * Add a ContainerAssetTask to the list of active tasks
  77169. * @param taskName defines the name of the new task
  77170. * @param meshesNames defines the name of meshes to load
  77171. * @param rootUrl defines the root url to use to locate files
  77172. * @param sceneFilename defines the filename of the scene file
  77173. * @returns a new ContainerAssetTask object
  77174. */
  77175. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77176. /**
  77177. * Add a MeshAssetTask to the list of active tasks
  77178. * @param taskName defines the name of the new task
  77179. * @param meshesNames defines the name of meshes to load
  77180. * @param rootUrl defines the root url to use to locate files
  77181. * @param sceneFilename defines the filename of the scene file
  77182. * @returns a new MeshAssetTask object
  77183. */
  77184. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77185. /**
  77186. * Add a TextFileAssetTask to the list of active tasks
  77187. * @param taskName defines the name of the new task
  77188. * @param url defines the url of the file to load
  77189. * @returns a new TextFileAssetTask object
  77190. */
  77191. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77192. /**
  77193. * Add a BinaryFileAssetTask to the list of active tasks
  77194. * @param taskName defines the name of the new task
  77195. * @param url defines the url of the file to load
  77196. * @returns a new BinaryFileAssetTask object
  77197. */
  77198. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77199. /**
  77200. * Add a ImageAssetTask to the list of active tasks
  77201. * @param taskName defines the name of the new task
  77202. * @param url defines the url of the file to load
  77203. * @returns a new ImageAssetTask object
  77204. */
  77205. addImageTask(taskName: string, url: string): ImageAssetTask;
  77206. /**
  77207. * Add a TextureAssetTask to the list of active tasks
  77208. * @param taskName defines the name of the new task
  77209. * @param url defines the url of the file to load
  77210. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77211. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77212. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77213. * @returns a new TextureAssetTask object
  77214. */
  77215. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77216. /**
  77217. * Add a CubeTextureAssetTask to the list of active tasks
  77218. * @param taskName defines the name of the new task
  77219. * @param url defines the url of the file to load
  77220. * @param extensions defines the extension to use to load the cube map (can be null)
  77221. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77222. * @param files defines the list of files to load (can be null)
  77223. * @returns a new CubeTextureAssetTask object
  77224. */
  77225. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77226. /**
  77227. *
  77228. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77229. * @param taskName defines the name of the new task
  77230. * @param url defines the url of the file to load
  77231. * @param size defines the size you want for the cubemap (can be null)
  77232. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77233. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77234. * @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)
  77235. * @param reserved Internal use only
  77236. * @returns a new HDRCubeTextureAssetTask object
  77237. */
  77238. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77239. /**
  77240. *
  77241. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77242. * @param taskName defines the name of the new task
  77243. * @param url defines the url of the file to load
  77244. * @param size defines the size you want for the cubemap (can be null)
  77245. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77246. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77247. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77248. * @returns a new EquiRectangularCubeTextureAssetTask object
  77249. */
  77250. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77251. /**
  77252. * Remove a task from the assets manager.
  77253. * @param task the task to remove
  77254. */
  77255. removeTask(task: AbstractAssetTask): void;
  77256. private _decreaseWaitingTasksCount;
  77257. private _runTask;
  77258. /**
  77259. * Reset the AssetsManager and remove all tasks
  77260. * @return the current instance of the AssetsManager
  77261. */
  77262. reset(): AssetsManager;
  77263. /**
  77264. * Start the loading process
  77265. * @return the current instance of the AssetsManager
  77266. */
  77267. load(): AssetsManager;
  77268. /**
  77269. * Start the loading process as an async operation
  77270. * @return a promise returning the list of failed tasks
  77271. */
  77272. loadAsync(): Promise<void>;
  77273. }
  77274. }
  77275. declare module "babylonjs/Misc/deferred" {
  77276. /**
  77277. * Wrapper class for promise with external resolve and reject.
  77278. */
  77279. export class Deferred<T> {
  77280. /**
  77281. * The promise associated with this deferred object.
  77282. */
  77283. readonly promise: Promise<T>;
  77284. private _resolve;
  77285. private _reject;
  77286. /**
  77287. * The resolve method of the promise associated with this deferred object.
  77288. */
  77289. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77290. /**
  77291. * The reject method of the promise associated with this deferred object.
  77292. */
  77293. get reject(): (reason?: any) => void;
  77294. /**
  77295. * Constructor for this deferred object.
  77296. */
  77297. constructor();
  77298. }
  77299. }
  77300. declare module "babylonjs/Misc/meshExploder" {
  77301. import { Mesh } from "babylonjs/Meshes/mesh";
  77302. /**
  77303. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77304. */
  77305. export class MeshExploder {
  77306. private _centerMesh;
  77307. private _meshes;
  77308. private _meshesOrigins;
  77309. private _toCenterVectors;
  77310. private _scaledDirection;
  77311. private _newPosition;
  77312. private _centerPosition;
  77313. /**
  77314. * Explodes meshes from a center mesh.
  77315. * @param meshes The meshes to explode.
  77316. * @param centerMesh The mesh to be center of explosion.
  77317. */
  77318. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77319. private _setCenterMesh;
  77320. /**
  77321. * Get class name
  77322. * @returns "MeshExploder"
  77323. */
  77324. getClassName(): string;
  77325. /**
  77326. * "Exploded meshes"
  77327. * @returns Array of meshes with the centerMesh at index 0.
  77328. */
  77329. getMeshes(): Array<Mesh>;
  77330. /**
  77331. * Explodes meshes giving a specific direction
  77332. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77333. */
  77334. explode(direction?: number): void;
  77335. }
  77336. }
  77337. declare module "babylonjs/Misc/filesInput" {
  77338. import { Engine } from "babylonjs/Engines/engine";
  77339. import { Scene } from "babylonjs/scene";
  77340. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77341. import { Nullable } from "babylonjs/types";
  77342. /**
  77343. * Class used to help managing file picking and drag'n'drop
  77344. */
  77345. export class FilesInput {
  77346. /**
  77347. * List of files ready to be loaded
  77348. */
  77349. static get FilesToLoad(): {
  77350. [key: string]: File;
  77351. };
  77352. /**
  77353. * Callback called when a file is processed
  77354. */
  77355. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77356. private _engine;
  77357. private _currentScene;
  77358. private _sceneLoadedCallback;
  77359. private _progressCallback;
  77360. private _additionalRenderLoopLogicCallback;
  77361. private _textureLoadingCallback;
  77362. private _startingProcessingFilesCallback;
  77363. private _onReloadCallback;
  77364. private _errorCallback;
  77365. private _elementToMonitor;
  77366. private _sceneFileToLoad;
  77367. private _filesToLoad;
  77368. /**
  77369. * Creates a new FilesInput
  77370. * @param engine defines the rendering engine
  77371. * @param scene defines the hosting scene
  77372. * @param sceneLoadedCallback callback called when scene is loaded
  77373. * @param progressCallback callback called to track progress
  77374. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77375. * @param textureLoadingCallback callback called when a texture is loading
  77376. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77377. * @param onReloadCallback callback called when a reload is requested
  77378. * @param errorCallback callback call if an error occurs
  77379. */
  77380. 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>);
  77381. private _dragEnterHandler;
  77382. private _dragOverHandler;
  77383. private _dropHandler;
  77384. /**
  77385. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77386. * @param elementToMonitor defines the DOM element to track
  77387. */
  77388. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77389. /** Gets the current list of files to load */
  77390. get filesToLoad(): File[];
  77391. /**
  77392. * Release all associated resources
  77393. */
  77394. dispose(): void;
  77395. private renderFunction;
  77396. private drag;
  77397. private drop;
  77398. private _traverseFolder;
  77399. private _processFiles;
  77400. /**
  77401. * Load files from a drop event
  77402. * @param event defines the drop event to use as source
  77403. */
  77404. loadFiles(event: any): void;
  77405. private _processReload;
  77406. /**
  77407. * Reload the current scene from the loaded files
  77408. */
  77409. reload(): void;
  77410. }
  77411. }
  77412. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77413. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77414. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77415. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77416. }
  77417. declare module "babylonjs/Misc/sceneOptimizer" {
  77418. import { Scene, IDisposable } from "babylonjs/scene";
  77419. import { Observable } from "babylonjs/Misc/observable";
  77420. /**
  77421. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77422. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77423. */
  77424. export class SceneOptimization {
  77425. /**
  77426. * Defines the priority of this optimization (0 by default which means first in the list)
  77427. */
  77428. priority: number;
  77429. /**
  77430. * Gets a string describing the action executed by the current optimization
  77431. * @returns description string
  77432. */
  77433. getDescription(): string;
  77434. /**
  77435. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77436. * @param scene defines the current scene where to apply this optimization
  77437. * @param optimizer defines the current optimizer
  77438. * @returns true if everything that can be done was applied
  77439. */
  77440. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77441. /**
  77442. * Creates the SceneOptimization object
  77443. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77444. * @param desc defines the description associated with the optimization
  77445. */
  77446. constructor(
  77447. /**
  77448. * Defines the priority of this optimization (0 by default which means first in the list)
  77449. */
  77450. priority?: number);
  77451. }
  77452. /**
  77453. * Defines an optimization used to reduce the size of render target textures
  77454. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77455. */
  77456. export class TextureOptimization extends SceneOptimization {
  77457. /**
  77458. * Defines the priority of this optimization (0 by default which means first in the list)
  77459. */
  77460. priority: number;
  77461. /**
  77462. * 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
  77463. */
  77464. maximumSize: number;
  77465. /**
  77466. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77467. */
  77468. step: number;
  77469. /**
  77470. * Gets a string describing the action executed by the current optimization
  77471. * @returns description string
  77472. */
  77473. getDescription(): string;
  77474. /**
  77475. * Creates the TextureOptimization object
  77476. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77477. * @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
  77478. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77479. */
  77480. constructor(
  77481. /**
  77482. * Defines the priority of this optimization (0 by default which means first in the list)
  77483. */
  77484. priority?: number,
  77485. /**
  77486. * Defines the maximum sized allowed for textures (1024 is the default value). If a texture is bigger, it will be scaled down using a factor defined by the step parameter
  77487. */
  77488. maximumSize?: number,
  77489. /**
  77490. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77491. */
  77492. step?: number);
  77493. /**
  77494. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77495. * @param scene defines the current scene where to apply this optimization
  77496. * @param optimizer defines the current optimizer
  77497. * @returns true if everything that can be done was applied
  77498. */
  77499. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77500. }
  77501. /**
  77502. * Defines an optimization used to increase or decrease the rendering resolution
  77503. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77504. */
  77505. export class HardwareScalingOptimization extends SceneOptimization {
  77506. /**
  77507. * Defines the priority of this optimization (0 by default which means first in the list)
  77508. */
  77509. priority: number;
  77510. /**
  77511. * Defines the maximum scale to use (2 by default)
  77512. */
  77513. maximumScale: number;
  77514. /**
  77515. * Defines the step to use between two passes (0.5 by default)
  77516. */
  77517. step: number;
  77518. private _currentScale;
  77519. private _directionOffset;
  77520. /**
  77521. * Gets a string describing the action executed by the current optimization
  77522. * @return description string
  77523. */
  77524. getDescription(): string;
  77525. /**
  77526. * Creates the HardwareScalingOptimization object
  77527. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77528. * @param maximumScale defines the maximum scale to use (2 by default)
  77529. * @param step defines the step to use between two passes (0.5 by default)
  77530. */
  77531. constructor(
  77532. /**
  77533. * Defines the priority of this optimization (0 by default which means first in the list)
  77534. */
  77535. priority?: number,
  77536. /**
  77537. * Defines the maximum scale to use (2 by default)
  77538. */
  77539. maximumScale?: number,
  77540. /**
  77541. * Defines the step to use between two passes (0.5 by default)
  77542. */
  77543. step?: number);
  77544. /**
  77545. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77546. * @param scene defines the current scene where to apply this optimization
  77547. * @param optimizer defines the current optimizer
  77548. * @returns true if everything that can be done was applied
  77549. */
  77550. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77551. }
  77552. /**
  77553. * Defines an optimization used to remove shadows
  77554. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77555. */
  77556. export class ShadowsOptimization extends SceneOptimization {
  77557. /**
  77558. * Gets a string describing the action executed by the current optimization
  77559. * @return description string
  77560. */
  77561. getDescription(): string;
  77562. /**
  77563. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77564. * @param scene defines the current scene where to apply this optimization
  77565. * @param optimizer defines the current optimizer
  77566. * @returns true if everything that can be done was applied
  77567. */
  77568. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77569. }
  77570. /**
  77571. * Defines an optimization used to turn post-processes off
  77572. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77573. */
  77574. export class PostProcessesOptimization extends SceneOptimization {
  77575. /**
  77576. * Gets a string describing the action executed by the current optimization
  77577. * @return description string
  77578. */
  77579. getDescription(): string;
  77580. /**
  77581. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77582. * @param scene defines the current scene where to apply this optimization
  77583. * @param optimizer defines the current optimizer
  77584. * @returns true if everything that can be done was applied
  77585. */
  77586. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77587. }
  77588. /**
  77589. * Defines an optimization used to turn lens flares off
  77590. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77591. */
  77592. export class LensFlaresOptimization extends SceneOptimization {
  77593. /**
  77594. * Gets a string describing the action executed by the current optimization
  77595. * @return description string
  77596. */
  77597. getDescription(): string;
  77598. /**
  77599. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77600. * @param scene defines the current scene where to apply this optimization
  77601. * @param optimizer defines the current optimizer
  77602. * @returns true if everything that can be done was applied
  77603. */
  77604. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77605. }
  77606. /**
  77607. * Defines an optimization based on user defined callback.
  77608. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77609. */
  77610. export class CustomOptimization extends SceneOptimization {
  77611. /**
  77612. * Callback called to apply the custom optimization.
  77613. */
  77614. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  77615. /**
  77616. * Callback called to get custom description
  77617. */
  77618. onGetDescription: () => string;
  77619. /**
  77620. * Gets a string describing the action executed by the current optimization
  77621. * @returns description string
  77622. */
  77623. getDescription(): string;
  77624. /**
  77625. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77626. * @param scene defines the current scene where to apply this optimization
  77627. * @param optimizer defines the current optimizer
  77628. * @returns true if everything that can be done was applied
  77629. */
  77630. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77631. }
  77632. /**
  77633. * Defines an optimization used to turn particles off
  77634. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77635. */
  77636. export class ParticlesOptimization extends SceneOptimization {
  77637. /**
  77638. * Gets a string describing the action executed by the current optimization
  77639. * @return description string
  77640. */
  77641. getDescription(): string;
  77642. /**
  77643. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77644. * @param scene defines the current scene where to apply this optimization
  77645. * @param optimizer defines the current optimizer
  77646. * @returns true if everything that can be done was applied
  77647. */
  77648. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77649. }
  77650. /**
  77651. * Defines an optimization used to turn render targets off
  77652. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77653. */
  77654. export class RenderTargetsOptimization extends SceneOptimization {
  77655. /**
  77656. * Gets a string describing the action executed by the current optimization
  77657. * @return description string
  77658. */
  77659. getDescription(): string;
  77660. /**
  77661. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77662. * @param scene defines the current scene where to apply this optimization
  77663. * @param optimizer defines the current optimizer
  77664. * @returns true if everything that can be done was applied
  77665. */
  77666. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77667. }
  77668. /**
  77669. * Defines an optimization used to merge meshes with compatible materials
  77670. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77671. */
  77672. export class MergeMeshesOptimization extends SceneOptimization {
  77673. private static _UpdateSelectionTree;
  77674. /**
  77675. * Gets or sets a boolean which defines if optimization octree has to be updated
  77676. */
  77677. static get UpdateSelectionTree(): boolean;
  77678. /**
  77679. * Gets or sets a boolean which defines if optimization octree has to be updated
  77680. */
  77681. static set UpdateSelectionTree(value: boolean);
  77682. /**
  77683. * Gets a string describing the action executed by the current optimization
  77684. * @return description string
  77685. */
  77686. getDescription(): string;
  77687. private _canBeMerged;
  77688. /**
  77689. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77690. * @param scene defines the current scene where to apply this optimization
  77691. * @param optimizer defines the current optimizer
  77692. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77693. * @returns true if everything that can be done was applied
  77694. */
  77695. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77696. }
  77697. /**
  77698. * Defines a list of options used by SceneOptimizer
  77699. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77700. */
  77701. export class SceneOptimizerOptions {
  77702. /**
  77703. * Defines the target frame rate to reach (60 by default)
  77704. */
  77705. targetFrameRate: number;
  77706. /**
  77707. * Defines the interval between two checkes (2000ms by default)
  77708. */
  77709. trackerDuration: number;
  77710. /**
  77711. * Gets the list of optimizations to apply
  77712. */
  77713. optimizations: SceneOptimization[];
  77714. /**
  77715. * Creates a new list of options used by SceneOptimizer
  77716. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77717. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77718. */
  77719. constructor(
  77720. /**
  77721. * Defines the target frame rate to reach (60 by default)
  77722. */
  77723. targetFrameRate?: number,
  77724. /**
  77725. * Defines the interval between two checkes (2000ms by default)
  77726. */
  77727. trackerDuration?: number);
  77728. /**
  77729. * Add a new optimization
  77730. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77731. * @returns the current SceneOptimizerOptions
  77732. */
  77733. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77734. /**
  77735. * Add a new custom optimization
  77736. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77737. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77738. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77739. * @returns the current SceneOptimizerOptions
  77740. */
  77741. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77742. /**
  77743. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77744. * @param targetFrameRate defines the target frame rate (60 by default)
  77745. * @returns a SceneOptimizerOptions object
  77746. */
  77747. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77748. /**
  77749. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77750. * @param targetFrameRate defines the target frame rate (60 by default)
  77751. * @returns a SceneOptimizerOptions object
  77752. */
  77753. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77754. /**
  77755. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77756. * @param targetFrameRate defines the target frame rate (60 by default)
  77757. * @returns a SceneOptimizerOptions object
  77758. */
  77759. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77760. }
  77761. /**
  77762. * Class used to run optimizations in order to reach a target frame rate
  77763. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77764. */
  77765. export class SceneOptimizer implements IDisposable {
  77766. private _isRunning;
  77767. private _options;
  77768. private _scene;
  77769. private _currentPriorityLevel;
  77770. private _targetFrameRate;
  77771. private _trackerDuration;
  77772. private _currentFrameRate;
  77773. private _sceneDisposeObserver;
  77774. private _improvementMode;
  77775. /**
  77776. * Defines an observable called when the optimizer reaches the target frame rate
  77777. */
  77778. onSuccessObservable: Observable<SceneOptimizer>;
  77779. /**
  77780. * Defines an observable called when the optimizer enables an optimization
  77781. */
  77782. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77783. /**
  77784. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77785. */
  77786. onFailureObservable: Observable<SceneOptimizer>;
  77787. /**
  77788. * Gets a boolean indicating if the optimizer is in improvement mode
  77789. */
  77790. get isInImprovementMode(): boolean;
  77791. /**
  77792. * Gets the current priority level (0 at start)
  77793. */
  77794. get currentPriorityLevel(): number;
  77795. /**
  77796. * Gets the current frame rate checked by the SceneOptimizer
  77797. */
  77798. get currentFrameRate(): number;
  77799. /**
  77800. * Gets or sets the current target frame rate (60 by default)
  77801. */
  77802. get targetFrameRate(): number;
  77803. /**
  77804. * Gets or sets the current target frame rate (60 by default)
  77805. */
  77806. set targetFrameRate(value: number);
  77807. /**
  77808. * Gets or sets the current interval between two checks (every 2000ms by default)
  77809. */
  77810. get trackerDuration(): number;
  77811. /**
  77812. * Gets or sets the current interval between two checks (every 2000ms by default)
  77813. */
  77814. set trackerDuration(value: number);
  77815. /**
  77816. * Gets the list of active optimizations
  77817. */
  77818. get optimizations(): SceneOptimization[];
  77819. /**
  77820. * Creates a new SceneOptimizer
  77821. * @param scene defines the scene to work on
  77822. * @param options defines the options to use with the SceneOptimizer
  77823. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77824. * @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)
  77825. */
  77826. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77827. /**
  77828. * Stops the current optimizer
  77829. */
  77830. stop(): void;
  77831. /**
  77832. * Reset the optimizer to initial step (current priority level = 0)
  77833. */
  77834. reset(): void;
  77835. /**
  77836. * Start the optimizer. By default it will try to reach a specific framerate
  77837. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77838. */
  77839. start(): void;
  77840. private _checkCurrentState;
  77841. /**
  77842. * Release all resources
  77843. */
  77844. dispose(): void;
  77845. /**
  77846. * Helper function to create a SceneOptimizer with one single line of code
  77847. * @param scene defines the scene to work on
  77848. * @param options defines the options to use with the SceneOptimizer
  77849. * @param onSuccess defines a callback to call on success
  77850. * @param onFailure defines a callback to call on failure
  77851. * @returns the new SceneOptimizer object
  77852. */
  77853. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77854. }
  77855. }
  77856. declare module "babylonjs/Misc/sceneSerializer" {
  77857. import { Scene } from "babylonjs/scene";
  77858. /**
  77859. * Class used to serialize a scene into a string
  77860. */
  77861. export class SceneSerializer {
  77862. /**
  77863. * Clear cache used by a previous serialization
  77864. */
  77865. static ClearCache(): void;
  77866. /**
  77867. * Serialize a scene into a JSON compatible object
  77868. * @param scene defines the scene to serialize
  77869. * @returns a JSON compatible object
  77870. */
  77871. static Serialize(scene: Scene): any;
  77872. /**
  77873. * Serialize a mesh into a JSON compatible object
  77874. * @param toSerialize defines the mesh to serialize
  77875. * @param withParents defines if parents must be serialized as well
  77876. * @param withChildren defines if children must be serialized as well
  77877. * @returns a JSON compatible object
  77878. */
  77879. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77880. }
  77881. }
  77882. declare module "babylonjs/Misc/textureTools" {
  77883. import { Texture } from "babylonjs/Materials/Textures/texture";
  77884. /**
  77885. * Class used to host texture specific utilities
  77886. */
  77887. export class TextureTools {
  77888. /**
  77889. * Uses the GPU to create a copy texture rescaled at a given size
  77890. * @param texture Texture to copy from
  77891. * @param width defines the desired width
  77892. * @param height defines the desired height
  77893. * @param useBilinearMode defines if bilinear mode has to be used
  77894. * @return the generated texture
  77895. */
  77896. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  77897. }
  77898. }
  77899. declare module "babylonjs/Misc/videoRecorder" {
  77900. import { Nullable } from "babylonjs/types";
  77901. import { Engine } from "babylonjs/Engines/engine";
  77902. /**
  77903. * This represents the different options available for the video capture.
  77904. */
  77905. export interface VideoRecorderOptions {
  77906. /** Defines the mime type of the video. */
  77907. mimeType: string;
  77908. /** Defines the FPS the video should be recorded at. */
  77909. fps: number;
  77910. /** Defines the chunk size for the recording data. */
  77911. recordChunckSize: number;
  77912. /** The audio tracks to attach to the recording. */
  77913. audioTracks?: MediaStreamTrack[];
  77914. }
  77915. /**
  77916. * This can help with recording videos from BabylonJS.
  77917. * This is based on the available WebRTC functionalities of the browser.
  77918. *
  77919. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  77920. */
  77921. export class VideoRecorder {
  77922. private static readonly _defaultOptions;
  77923. /**
  77924. * Returns whether or not the VideoRecorder is available in your browser.
  77925. * @param engine Defines the Babylon Engine.
  77926. * @returns true if supported otherwise false.
  77927. */
  77928. static IsSupported(engine: Engine): boolean;
  77929. private readonly _options;
  77930. private _canvas;
  77931. private _mediaRecorder;
  77932. private _recordedChunks;
  77933. private _fileName;
  77934. private _resolve;
  77935. private _reject;
  77936. /**
  77937. * True when a recording is already in progress.
  77938. */
  77939. get isRecording(): boolean;
  77940. /**
  77941. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  77942. * @param engine Defines the BabylonJS Engine you wish to record.
  77943. * @param options Defines options that can be used to customize the capture.
  77944. */
  77945. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  77946. /**
  77947. * Stops the current recording before the default capture timeout passed in the startRecording function.
  77948. */
  77949. stopRecording(): void;
  77950. /**
  77951. * Starts recording the canvas for a max duration specified in parameters.
  77952. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  77953. * If null no automatic download will start and you can rely on the promise to get the data back.
  77954. * @param maxDuration Defines the maximum recording time in seconds.
  77955. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  77956. * @return A promise callback at the end of the recording with the video data in Blob.
  77957. */
  77958. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  77959. /**
  77960. * Releases internal resources used during the recording.
  77961. */
  77962. dispose(): void;
  77963. private _handleDataAvailable;
  77964. private _handleError;
  77965. private _handleStop;
  77966. }
  77967. }
  77968. declare module "babylonjs/Misc/screenshotTools" {
  77969. import { Camera } from "babylonjs/Cameras/camera";
  77970. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  77971. import { Engine } from "babylonjs/Engines/engine";
  77972. /**
  77973. * Class containing a set of static utilities functions for screenshots
  77974. */
  77975. export class ScreenshotTools {
  77976. /**
  77977. * Captures a screenshot of the current rendering
  77978. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77979. * @param engine defines the rendering engine
  77980. * @param camera defines the source camera
  77981. * @param size This parameter can be set to a single number or to an object with the
  77982. * following (optional) properties: precision, width, height. If a single number is passed,
  77983. * it will be used for both width and height. If an object is passed, the screenshot size
  77984. * will be derived from the parameters. The precision property is a multiplier allowing
  77985. * rendering at a higher or lower resolution
  77986. * @param successCallback defines the callback receives a single parameter which contains the
  77987. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77988. * src parameter of an <img> to display it
  77989. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77990. * Check your browser for supported MIME types
  77991. */
  77992. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  77993. /**
  77994. * Captures a screenshot of the current rendering
  77995. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77996. * @param engine defines the rendering engine
  77997. * @param camera defines the source camera
  77998. * @param size This parameter can be set to a single number or to an object with the
  77999. * following (optional) properties: precision, width, height. If a single number is passed,
  78000. * it will be used for both width and height. If an object is passed, the screenshot size
  78001. * will be derived from the parameters. The precision property is a multiplier allowing
  78002. * rendering at a higher or lower resolution
  78003. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78004. * Check your browser for supported MIME types
  78005. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78006. * to the src parameter of an <img> to display it
  78007. */
  78008. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  78009. /**
  78010. * Generates an image screenshot from the specified camera.
  78011. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78012. * @param engine The engine to use for rendering
  78013. * @param camera The camera to use for rendering
  78014. * @param size This parameter can be set to a single number or to an object with the
  78015. * following (optional) properties: precision, width, height. If a single number is passed,
  78016. * it will be used for both width and height. If an object is passed, the screenshot size
  78017. * will be derived from the parameters. The precision property is a multiplier allowing
  78018. * rendering at a higher or lower resolution
  78019. * @param successCallback The callback receives a single parameter which contains the
  78020. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78021. * src parameter of an <img> to display it
  78022. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78023. * Check your browser for supported MIME types
  78024. * @param samples Texture samples (default: 1)
  78025. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78026. * @param fileName A name for for the downloaded file.
  78027. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78028. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  78029. */
  78030. 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;
  78031. /**
  78032. * Generates an image screenshot from the specified camera.
  78033. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78034. * @param engine The engine to use for rendering
  78035. * @param camera The camera to use for rendering
  78036. * @param size This parameter can be set to a single number or to an object with the
  78037. * following (optional) properties: precision, width, height. If a single number is passed,
  78038. * it will be used for both width and height. If an object is passed, the screenshot size
  78039. * will be derived from the parameters. The precision property is a multiplier allowing
  78040. * rendering at a higher or lower resolution
  78041. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78042. * Check your browser for supported MIME types
  78043. * @param samples Texture samples (default: 1)
  78044. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78045. * @param fileName A name for for the downloaded file.
  78046. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78047. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78048. * to the src parameter of an <img> to display it
  78049. */
  78050. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78051. /**
  78052. * Gets height and width for screenshot size
  78053. * @private
  78054. */
  78055. private static _getScreenshotSize;
  78056. }
  78057. }
  78058. declare module "babylonjs/Misc/dataReader" {
  78059. /**
  78060. * Interface for a data buffer
  78061. */
  78062. export interface IDataBuffer {
  78063. /**
  78064. * Reads bytes from the data buffer.
  78065. * @param byteOffset The byte offset to read
  78066. * @param byteLength The byte length to read
  78067. * @returns A promise that resolves when the bytes are read
  78068. */
  78069. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78070. /**
  78071. * The byte length of the buffer.
  78072. */
  78073. readonly byteLength: number;
  78074. }
  78075. /**
  78076. * Utility class for reading from a data buffer
  78077. */
  78078. export class DataReader {
  78079. /**
  78080. * The data buffer associated with this data reader.
  78081. */
  78082. readonly buffer: IDataBuffer;
  78083. /**
  78084. * The current byte offset from the beginning of the data buffer.
  78085. */
  78086. byteOffset: number;
  78087. private _dataView;
  78088. private _dataByteOffset;
  78089. /**
  78090. * Constructor
  78091. * @param buffer The buffer to read
  78092. */
  78093. constructor(buffer: IDataBuffer);
  78094. /**
  78095. * Loads the given byte length.
  78096. * @param byteLength The byte length to load
  78097. * @returns A promise that resolves when the load is complete
  78098. */
  78099. loadAsync(byteLength: number): Promise<void>;
  78100. /**
  78101. * Read a unsigned 32-bit integer from the currently loaded data range.
  78102. * @returns The 32-bit integer read
  78103. */
  78104. readUint32(): number;
  78105. /**
  78106. * Read a byte array from the currently loaded data range.
  78107. * @param byteLength The byte length to read
  78108. * @returns The byte array read
  78109. */
  78110. readUint8Array(byteLength: number): Uint8Array;
  78111. /**
  78112. * Read a string from the currently loaded data range.
  78113. * @param byteLength The byte length to read
  78114. * @returns The string read
  78115. */
  78116. readString(byteLength: number): string;
  78117. /**
  78118. * Skips the given byte length the currently loaded data range.
  78119. * @param byteLength The byte length to skip
  78120. */
  78121. skipBytes(byteLength: number): void;
  78122. }
  78123. }
  78124. declare module "babylonjs/Misc/dataStorage" {
  78125. /**
  78126. * Class for storing data to local storage if available or in-memory storage otherwise
  78127. */
  78128. export class DataStorage {
  78129. private static _Storage;
  78130. private static _GetStorage;
  78131. /**
  78132. * Reads a string from the data storage
  78133. * @param key The key to read
  78134. * @param defaultValue The value if the key doesn't exist
  78135. * @returns The string value
  78136. */
  78137. static ReadString(key: string, defaultValue: string): string;
  78138. /**
  78139. * Writes a string to the data storage
  78140. * @param key The key to write
  78141. * @param value The value to write
  78142. */
  78143. static WriteString(key: string, value: string): void;
  78144. /**
  78145. * Reads a boolean from the data storage
  78146. * @param key The key to read
  78147. * @param defaultValue The value if the key doesn't exist
  78148. * @returns The boolean value
  78149. */
  78150. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78151. /**
  78152. * Writes a boolean to the data storage
  78153. * @param key The key to write
  78154. * @param value The value to write
  78155. */
  78156. static WriteBoolean(key: string, value: boolean): void;
  78157. /**
  78158. * Reads a number from the data storage
  78159. * @param key The key to read
  78160. * @param defaultValue The value if the key doesn't exist
  78161. * @returns The number value
  78162. */
  78163. static ReadNumber(key: string, defaultValue: number): number;
  78164. /**
  78165. * Writes a number to the data storage
  78166. * @param key The key to write
  78167. * @param value The value to write
  78168. */
  78169. static WriteNumber(key: string, value: number): void;
  78170. }
  78171. }
  78172. declare module "babylonjs/Misc/sceneRecorder" {
  78173. import { Scene } from "babylonjs/scene";
  78174. /**
  78175. * Class used to record delta files between 2 scene states
  78176. */
  78177. export class SceneRecorder {
  78178. private _trackedScene;
  78179. private _savedJSON;
  78180. /**
  78181. * Track a given scene. This means the current scene state will be considered the original state
  78182. * @param scene defines the scene to track
  78183. */
  78184. track(scene: Scene): void;
  78185. /**
  78186. * Get the delta between current state and original state
  78187. * @returns a string containing the delta
  78188. */
  78189. getDelta(): any;
  78190. private _compareArray;
  78191. private _compareObjects;
  78192. private _compareCollections;
  78193. private static GetShadowGeneratorById;
  78194. /**
  78195. * Apply a given delta to a given scene
  78196. * @param deltaJSON defines the JSON containing the delta
  78197. * @param scene defines the scene to apply the delta to
  78198. */
  78199. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78200. private static _ApplyPropertiesToEntity;
  78201. private static _ApplyDeltaForEntity;
  78202. }
  78203. }
  78204. declare module "babylonjs/Misc/index" {
  78205. export * from "babylonjs/Misc/andOrNotEvaluator";
  78206. export * from "babylonjs/Misc/assetsManager";
  78207. export * from "babylonjs/Misc/basis";
  78208. export * from "babylonjs/Misc/dds";
  78209. export * from "babylonjs/Misc/decorators";
  78210. export * from "babylonjs/Misc/deferred";
  78211. export * from "babylonjs/Misc/environmentTextureTools";
  78212. export * from "babylonjs/Misc/meshExploder";
  78213. export * from "babylonjs/Misc/filesInput";
  78214. export * from "babylonjs/Misc/HighDynamicRange/index";
  78215. export * from "babylonjs/Misc/khronosTextureContainer";
  78216. export * from "babylonjs/Misc/observable";
  78217. export * from "babylonjs/Misc/performanceMonitor";
  78218. export * from "babylonjs/Misc/promise";
  78219. export * from "babylonjs/Misc/sceneOptimizer";
  78220. export * from "babylonjs/Misc/sceneSerializer";
  78221. export * from "babylonjs/Misc/smartArray";
  78222. export * from "babylonjs/Misc/stringDictionary";
  78223. export * from "babylonjs/Misc/tags";
  78224. export * from "babylonjs/Misc/textureTools";
  78225. export * from "babylonjs/Misc/tga";
  78226. export * from "babylonjs/Misc/tools";
  78227. export * from "babylonjs/Misc/videoRecorder";
  78228. export * from "babylonjs/Misc/virtualJoystick";
  78229. export * from "babylonjs/Misc/workerPool";
  78230. export * from "babylonjs/Misc/logger";
  78231. export * from "babylonjs/Misc/typeStore";
  78232. export * from "babylonjs/Misc/filesInputStore";
  78233. export * from "babylonjs/Misc/deepCopier";
  78234. export * from "babylonjs/Misc/pivotTools";
  78235. export * from "babylonjs/Misc/precisionDate";
  78236. export * from "babylonjs/Misc/screenshotTools";
  78237. export * from "babylonjs/Misc/typeStore";
  78238. export * from "babylonjs/Misc/webRequest";
  78239. export * from "babylonjs/Misc/iInspectable";
  78240. export * from "babylonjs/Misc/brdfTextureTools";
  78241. export * from "babylonjs/Misc/rgbdTextureTools";
  78242. export * from "babylonjs/Misc/gradients";
  78243. export * from "babylonjs/Misc/perfCounter";
  78244. export * from "babylonjs/Misc/fileRequest";
  78245. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78246. export * from "babylonjs/Misc/retryStrategy";
  78247. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78248. export * from "babylonjs/Misc/canvasGenerator";
  78249. export * from "babylonjs/Misc/fileTools";
  78250. export * from "babylonjs/Misc/stringTools";
  78251. export * from "babylonjs/Misc/dataReader";
  78252. export * from "babylonjs/Misc/minMaxReducer";
  78253. export * from "babylonjs/Misc/depthReducer";
  78254. export * from "babylonjs/Misc/dataStorage";
  78255. export * from "babylonjs/Misc/sceneRecorder";
  78256. }
  78257. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78258. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78259. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78260. import { Observable } from "babylonjs/Misc/observable";
  78261. import { Matrix } from "babylonjs/Maths/math.vector";
  78262. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78263. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78264. /**
  78265. * An interface for all Hit test features
  78266. */
  78267. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78268. /**
  78269. * Triggered when new babylon (transformed) hit test results are available
  78270. */
  78271. onHitTestResultObservable: Observable<T[]>;
  78272. }
  78273. /**
  78274. * Options used for hit testing
  78275. */
  78276. export interface IWebXRLegacyHitTestOptions {
  78277. /**
  78278. * Only test when user interacted with the scene. Default - hit test every frame
  78279. */
  78280. testOnPointerDownOnly?: boolean;
  78281. /**
  78282. * The node to use to transform the local results to world coordinates
  78283. */
  78284. worldParentNode?: TransformNode;
  78285. }
  78286. /**
  78287. * Interface defining the babylon result of raycasting/hit-test
  78288. */
  78289. export interface IWebXRLegacyHitResult {
  78290. /**
  78291. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78292. */
  78293. transformationMatrix: Matrix;
  78294. /**
  78295. * The native hit test result
  78296. */
  78297. xrHitResult: XRHitResult | XRHitTestResult;
  78298. }
  78299. /**
  78300. * The currently-working hit-test module.
  78301. * Hit test (or Ray-casting) is used to interact with the real world.
  78302. * For further information read here - https://github.com/immersive-web/hit-test
  78303. */
  78304. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78305. /**
  78306. * options to use when constructing this feature
  78307. */
  78308. readonly options: IWebXRLegacyHitTestOptions;
  78309. private _direction;
  78310. private _mat;
  78311. private _onSelectEnabled;
  78312. private _origin;
  78313. /**
  78314. * The module's name
  78315. */
  78316. static readonly Name: string;
  78317. /**
  78318. * The (Babylon) version of this module.
  78319. * This is an integer representing the implementation version.
  78320. * This number does not correspond to the WebXR specs version
  78321. */
  78322. static readonly Version: number;
  78323. /**
  78324. * Populated with the last native XR Hit Results
  78325. */
  78326. lastNativeXRHitResults: XRHitResult[];
  78327. /**
  78328. * Triggered when new babylon (transformed) hit test results are available
  78329. */
  78330. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78331. /**
  78332. * Creates a new instance of the (legacy version) hit test feature
  78333. * @param _xrSessionManager an instance of WebXRSessionManager
  78334. * @param options options to use when constructing this feature
  78335. */
  78336. constructor(_xrSessionManager: WebXRSessionManager,
  78337. /**
  78338. * options to use when constructing this feature
  78339. */
  78340. options?: IWebXRLegacyHitTestOptions);
  78341. /**
  78342. * execute a hit test with an XR Ray
  78343. *
  78344. * @param xrSession a native xrSession that will execute this hit test
  78345. * @param xrRay the ray (position and direction) to use for ray-casting
  78346. * @param referenceSpace native XR reference space to use for the hit-test
  78347. * @param filter filter function that will filter the results
  78348. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78349. */
  78350. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78351. /**
  78352. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78353. * @param event the (select) event to use to select with
  78354. * @param referenceSpace the reference space to use for this hit test
  78355. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78356. */
  78357. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78358. /**
  78359. * attach this feature
  78360. * Will usually be called by the features manager
  78361. *
  78362. * @returns true if successful.
  78363. */
  78364. attach(): boolean;
  78365. /**
  78366. * detach this feature.
  78367. * Will usually be called by the features manager
  78368. *
  78369. * @returns true if successful.
  78370. */
  78371. detach(): boolean;
  78372. /**
  78373. * Dispose this feature and all of the resources attached
  78374. */
  78375. dispose(): void;
  78376. protected _onXRFrame(frame: XRFrame): void;
  78377. private _onHitTestResults;
  78378. private _onSelect;
  78379. }
  78380. }
  78381. declare module "babylonjs/XR/features/WebXRHitTest" {
  78382. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78383. import { Observable } from "babylonjs/Misc/observable";
  78384. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78385. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78386. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  78387. /**
  78388. * Options used for hit testing (version 2)
  78389. */
  78390. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  78391. /**
  78392. * Do not create a permanent hit test. Will usually be used when only
  78393. * transient inputs are needed.
  78394. */
  78395. disablePermanentHitTest?: boolean;
  78396. /**
  78397. * Enable transient (for example touch-based) hit test inspections
  78398. */
  78399. enableTransientHitTest?: boolean;
  78400. /**
  78401. * Offset ray for the permanent hit test
  78402. */
  78403. offsetRay?: Vector3;
  78404. /**
  78405. * Offset ray for the transient hit test
  78406. */
  78407. transientOffsetRay?: Vector3;
  78408. /**
  78409. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  78410. */
  78411. useReferenceSpace?: boolean;
  78412. /**
  78413. * Override the default entity type(s) of the hit-test result
  78414. */
  78415. entityTypes?: XRHitTestTrackableType[];
  78416. }
  78417. /**
  78418. * Interface defining the babylon result of hit-test
  78419. */
  78420. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  78421. /**
  78422. * The input source that generated this hit test (if transient)
  78423. */
  78424. inputSource?: XRInputSource;
  78425. /**
  78426. * Is this a transient hit test
  78427. */
  78428. isTransient?: boolean;
  78429. /**
  78430. * Position of the hit test result
  78431. */
  78432. position: Vector3;
  78433. /**
  78434. * Rotation of the hit test result
  78435. */
  78436. rotationQuaternion: Quaternion;
  78437. /**
  78438. * The native hit test result
  78439. */
  78440. xrHitResult: XRHitTestResult;
  78441. }
  78442. /**
  78443. * The currently-working hit-test module.
  78444. * Hit test (or Ray-casting) is used to interact with the real world.
  78445. * For further information read here - https://github.com/immersive-web/hit-test
  78446. *
  78447. * Tested on chrome (mobile) 80.
  78448. */
  78449. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  78450. /**
  78451. * options to use when constructing this feature
  78452. */
  78453. readonly options: IWebXRHitTestOptions;
  78454. private _tmpMat;
  78455. private _tmpPos;
  78456. private _tmpQuat;
  78457. private _transientXrHitTestSource;
  78458. private _xrHitTestSource;
  78459. private initHitTestSource;
  78460. /**
  78461. * The module's name
  78462. */
  78463. static readonly Name: string;
  78464. /**
  78465. * The (Babylon) version of this module.
  78466. * This is an integer representing the implementation version.
  78467. * This number does not correspond to the WebXR specs version
  78468. */
  78469. static readonly Version: number;
  78470. /**
  78471. * When set to true, each hit test will have its own position/rotation objects
  78472. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  78473. * the developers will clone them or copy them as they see fit.
  78474. */
  78475. autoCloneTransformation: boolean;
  78476. /**
  78477. * Triggered when new babylon (transformed) hit test results are available
  78478. */
  78479. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  78480. /**
  78481. * Use this to temporarily pause hit test checks.
  78482. */
  78483. paused: boolean;
  78484. /**
  78485. * Creates a new instance of the hit test feature
  78486. * @param _xrSessionManager an instance of WebXRSessionManager
  78487. * @param options options to use when constructing this feature
  78488. */
  78489. constructor(_xrSessionManager: WebXRSessionManager,
  78490. /**
  78491. * options to use when constructing this feature
  78492. */
  78493. options?: IWebXRHitTestOptions);
  78494. /**
  78495. * attach this feature
  78496. * Will usually be called by the features manager
  78497. *
  78498. * @returns true if successful.
  78499. */
  78500. attach(): boolean;
  78501. /**
  78502. * detach this feature.
  78503. * Will usually be called by the features manager
  78504. *
  78505. * @returns true if successful.
  78506. */
  78507. detach(): boolean;
  78508. /**
  78509. * Dispose this feature and all of the resources attached
  78510. */
  78511. dispose(): void;
  78512. protected _onXRFrame(frame: XRFrame): void;
  78513. private _processWebXRHitTestResult;
  78514. }
  78515. }
  78516. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  78517. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78518. import { Observable } from "babylonjs/Misc/observable";
  78519. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78520. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78521. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78522. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  78523. /**
  78524. * Configuration options of the anchor system
  78525. */
  78526. export interface IWebXRAnchorSystemOptions {
  78527. /**
  78528. * a node that will be used to convert local to world coordinates
  78529. */
  78530. worldParentNode?: TransformNode;
  78531. /**
  78532. * If set to true a reference of the created anchors will be kept until the next session starts
  78533. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  78534. */
  78535. doNotRemoveAnchorsOnSessionEnded?: boolean;
  78536. }
  78537. /**
  78538. * A babylon container for an XR Anchor
  78539. */
  78540. export interface IWebXRAnchor {
  78541. /**
  78542. * A babylon-assigned ID for this anchor
  78543. */
  78544. id: number;
  78545. /**
  78546. * Transformation matrix to apply to an object attached to this anchor
  78547. */
  78548. transformationMatrix: Matrix;
  78549. /**
  78550. * The native anchor object
  78551. */
  78552. xrAnchor: XRAnchor;
  78553. /**
  78554. * if defined, this object will be constantly updated by the anchor's position and rotation
  78555. */
  78556. attachedNode?: TransformNode;
  78557. }
  78558. /**
  78559. * An implementation of the anchor system for WebXR.
  78560. * For further information see https://github.com/immersive-web/anchors/
  78561. */
  78562. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  78563. private _options;
  78564. private _lastFrameDetected;
  78565. private _trackedAnchors;
  78566. private _referenceSpaceForFrameAnchors;
  78567. private _futureAnchors;
  78568. /**
  78569. * The module's name
  78570. */
  78571. static readonly Name: string;
  78572. /**
  78573. * The (Babylon) version of this module.
  78574. * This is an integer representing the implementation version.
  78575. * This number does not correspond to the WebXR specs version
  78576. */
  78577. static readonly Version: number;
  78578. /**
  78579. * Observers registered here will be executed when a new anchor was added to the session
  78580. */
  78581. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  78582. /**
  78583. * Observers registered here will be executed when an anchor was removed from the session
  78584. */
  78585. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  78586. /**
  78587. * Observers registered here will be executed when an existing anchor updates
  78588. * This can execute N times every frame
  78589. */
  78590. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  78591. /**
  78592. * Set the reference space to use for anchor creation, when not using a hit test.
  78593. * Will default to the session's reference space if not defined
  78594. */
  78595. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  78596. /**
  78597. * constructs a new anchor system
  78598. * @param _xrSessionManager an instance of WebXRSessionManager
  78599. * @param _options configuration object for this feature
  78600. */
  78601. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  78602. private _tmpVector;
  78603. private _tmpQuaternion;
  78604. private _populateTmpTransformation;
  78605. /**
  78606. * Create a new anchor point using a hit test result at a specific point in the scene
  78607. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78608. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78609. *
  78610. * @param hitTestResult The hit test result to use for this anchor creation
  78611. * @param position an optional position offset for this anchor
  78612. * @param rotationQuaternion an optional rotation offset for this anchor
  78613. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78614. */
  78615. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  78616. /**
  78617. * Add a new anchor at a specific position and rotation
  78618. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  78619. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  78620. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78621. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78622. *
  78623. * @param position the position in which to add an anchor
  78624. * @param rotationQuaternion an optional rotation for the anchor transformation
  78625. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  78626. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78627. */
  78628. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  78629. /**
  78630. * detach this feature.
  78631. * Will usually be called by the features manager
  78632. *
  78633. * @returns true if successful.
  78634. */
  78635. detach(): boolean;
  78636. /**
  78637. * Dispose this feature and all of the resources attached
  78638. */
  78639. dispose(): void;
  78640. protected _onXRFrame(frame: XRFrame): void;
  78641. /**
  78642. * avoiding using Array.find for global support.
  78643. * @param xrAnchor the plane to find in the array
  78644. */
  78645. private _findIndexInAnchorArray;
  78646. private _updateAnchorWithXRFrame;
  78647. private _createAnchorAtTransformation;
  78648. }
  78649. }
  78650. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  78651. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78652. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78653. import { Observable } from "babylonjs/Misc/observable";
  78654. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  78655. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78656. /**
  78657. * Options used in the plane detector module
  78658. */
  78659. export interface IWebXRPlaneDetectorOptions {
  78660. /**
  78661. * The node to use to transform the local results to world coordinates
  78662. */
  78663. worldParentNode?: TransformNode;
  78664. /**
  78665. * If set to true a reference of the created planes will be kept until the next session starts
  78666. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  78667. */
  78668. doNotRemovePlanesOnSessionEnded?: boolean;
  78669. }
  78670. /**
  78671. * A babylon interface for a WebXR plane.
  78672. * A Plane is actually a polygon, built from N points in space
  78673. *
  78674. * Supported in chrome 79, not supported in canary 81 ATM
  78675. */
  78676. export interface IWebXRPlane {
  78677. /**
  78678. * a babylon-assigned ID for this polygon
  78679. */
  78680. id: number;
  78681. /**
  78682. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78683. */
  78684. polygonDefinition: Array<Vector3>;
  78685. /**
  78686. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78687. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78688. */
  78689. transformationMatrix: Matrix;
  78690. /**
  78691. * the native xr-plane object
  78692. */
  78693. xrPlane: XRPlane;
  78694. }
  78695. /**
  78696. * The plane detector is used to detect planes in the real world when in AR
  78697. * For more information see https://github.com/immersive-web/real-world-geometry/
  78698. */
  78699. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78700. private _options;
  78701. private _detectedPlanes;
  78702. private _enabled;
  78703. private _lastFrameDetected;
  78704. /**
  78705. * The module's name
  78706. */
  78707. static readonly Name: string;
  78708. /**
  78709. * The (Babylon) version of this module.
  78710. * This is an integer representing the implementation version.
  78711. * This number does not correspond to the WebXR specs version
  78712. */
  78713. static readonly Version: number;
  78714. /**
  78715. * Observers registered here will be executed when a new plane was added to the session
  78716. */
  78717. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78718. /**
  78719. * Observers registered here will be executed when a plane is no longer detected in the session
  78720. */
  78721. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78722. /**
  78723. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78724. * This can execute N times every frame
  78725. */
  78726. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78727. /**
  78728. * construct a new Plane Detector
  78729. * @param _xrSessionManager an instance of xr Session manager
  78730. * @param _options configuration to use when constructing this feature
  78731. */
  78732. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78733. /**
  78734. * detach this feature.
  78735. * Will usually be called by the features manager
  78736. *
  78737. * @returns true if successful.
  78738. */
  78739. detach(): boolean;
  78740. /**
  78741. * Dispose this feature and all of the resources attached
  78742. */
  78743. dispose(): void;
  78744. protected _onXRFrame(frame: XRFrame): void;
  78745. private _init;
  78746. private _updatePlaneWithXRPlane;
  78747. /**
  78748. * avoiding using Array.find for global support.
  78749. * @param xrPlane the plane to find in the array
  78750. */
  78751. private findIndexInPlaneArray;
  78752. }
  78753. }
  78754. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78755. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78756. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78757. import { Observable } from "babylonjs/Misc/observable";
  78758. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78759. /**
  78760. * Options interface for the background remover plugin
  78761. */
  78762. export interface IWebXRBackgroundRemoverOptions {
  78763. /**
  78764. * Further background meshes to disable when entering AR
  78765. */
  78766. backgroundMeshes?: AbstractMesh[];
  78767. /**
  78768. * flags to configure the removal of the environment helper.
  78769. * If not set, the entire background will be removed. If set, flags should be set as well.
  78770. */
  78771. environmentHelperRemovalFlags?: {
  78772. /**
  78773. * Should the skybox be removed (default false)
  78774. */
  78775. skyBox?: boolean;
  78776. /**
  78777. * Should the ground be removed (default false)
  78778. */
  78779. ground?: boolean;
  78780. };
  78781. /**
  78782. * don't disable the environment helper
  78783. */
  78784. ignoreEnvironmentHelper?: boolean;
  78785. }
  78786. /**
  78787. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78788. */
  78789. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78790. /**
  78791. * read-only options to be used in this module
  78792. */
  78793. readonly options: IWebXRBackgroundRemoverOptions;
  78794. /**
  78795. * The module's name
  78796. */
  78797. static readonly Name: string;
  78798. /**
  78799. * The (Babylon) version of this module.
  78800. * This is an integer representing the implementation version.
  78801. * This number does not correspond to the WebXR specs version
  78802. */
  78803. static readonly Version: number;
  78804. /**
  78805. * registered observers will be triggered when the background state changes
  78806. */
  78807. onBackgroundStateChangedObservable: Observable<boolean>;
  78808. /**
  78809. * constructs a new background remover module
  78810. * @param _xrSessionManager the session manager for this module
  78811. * @param options read-only options to be used in this module
  78812. */
  78813. constructor(_xrSessionManager: WebXRSessionManager,
  78814. /**
  78815. * read-only options to be used in this module
  78816. */
  78817. options?: IWebXRBackgroundRemoverOptions);
  78818. /**
  78819. * attach this feature
  78820. * Will usually be called by the features manager
  78821. *
  78822. * @returns true if successful.
  78823. */
  78824. attach(): boolean;
  78825. /**
  78826. * detach this feature.
  78827. * Will usually be called by the features manager
  78828. *
  78829. * @returns true if successful.
  78830. */
  78831. detach(): boolean;
  78832. /**
  78833. * Dispose this feature and all of the resources attached
  78834. */
  78835. dispose(): void;
  78836. protected _onXRFrame(_xrFrame: XRFrame): void;
  78837. private _setBackgroundState;
  78838. }
  78839. }
  78840. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78841. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78842. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78843. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78844. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78845. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78846. import { Nullable } from "babylonjs/types";
  78847. /**
  78848. * Options for the controller physics feature
  78849. */
  78850. export class IWebXRControllerPhysicsOptions {
  78851. /**
  78852. * Should the headset get its own impostor
  78853. */
  78854. enableHeadsetImpostor?: boolean;
  78855. /**
  78856. * Optional parameters for the headset impostor
  78857. */
  78858. headsetImpostorParams?: {
  78859. /**
  78860. * The type of impostor to create. Default is sphere
  78861. */
  78862. impostorType: number;
  78863. /**
  78864. * the size of the impostor. Defaults to 10cm
  78865. */
  78866. impostorSize?: number | {
  78867. width: number;
  78868. height: number;
  78869. depth: number;
  78870. };
  78871. /**
  78872. * Friction definitions
  78873. */
  78874. friction?: number;
  78875. /**
  78876. * Restitution
  78877. */
  78878. restitution?: number;
  78879. };
  78880. /**
  78881. * The physics properties of the future impostors
  78882. */
  78883. physicsProperties?: {
  78884. /**
  78885. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78886. * Note that this requires a physics engine that supports mesh impostors!
  78887. */
  78888. useControllerMesh?: boolean;
  78889. /**
  78890. * The type of impostor to create. Default is sphere
  78891. */
  78892. impostorType?: number;
  78893. /**
  78894. * the size of the impostor. Defaults to 10cm
  78895. */
  78896. impostorSize?: number | {
  78897. width: number;
  78898. height: number;
  78899. depth: number;
  78900. };
  78901. /**
  78902. * Friction definitions
  78903. */
  78904. friction?: number;
  78905. /**
  78906. * Restitution
  78907. */
  78908. restitution?: number;
  78909. };
  78910. /**
  78911. * the xr input to use with this pointer selection
  78912. */
  78913. xrInput: WebXRInput;
  78914. }
  78915. /**
  78916. * Add physics impostor to your webxr controllers,
  78917. * including naive calculation of their linear and angular velocity
  78918. */
  78919. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  78920. private readonly _options;
  78921. private _attachController;
  78922. private _controllers;
  78923. private _debugMode;
  78924. private _delta;
  78925. private _headsetImpostor?;
  78926. private _headsetMesh?;
  78927. private _lastTimestamp;
  78928. private _tmpQuaternion;
  78929. private _tmpVector;
  78930. /**
  78931. * The module's name
  78932. */
  78933. static readonly Name: string;
  78934. /**
  78935. * The (Babylon) version of this module.
  78936. * This is an integer representing the implementation version.
  78937. * This number does not correspond to the webxr specs version
  78938. */
  78939. static readonly Version: number;
  78940. /**
  78941. * Construct a new Controller Physics Feature
  78942. * @param _xrSessionManager the corresponding xr session manager
  78943. * @param _options options to create this feature with
  78944. */
  78945. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  78946. /**
  78947. * @hidden
  78948. * enable debugging - will show console outputs and the impostor mesh
  78949. */
  78950. _enablePhysicsDebug(): void;
  78951. /**
  78952. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  78953. * @param xrController the controller to add
  78954. */
  78955. addController(xrController: WebXRInputSource): void;
  78956. /**
  78957. * attach this feature
  78958. * Will usually be called by the features manager
  78959. *
  78960. * @returns true if successful.
  78961. */
  78962. attach(): boolean;
  78963. /**
  78964. * detach this feature.
  78965. * Will usually be called by the features manager
  78966. *
  78967. * @returns true if successful.
  78968. */
  78969. detach(): boolean;
  78970. /**
  78971. * Get the headset impostor, if enabled
  78972. * @returns the impostor
  78973. */
  78974. getHeadsetImpostor(): PhysicsImpostor | undefined;
  78975. /**
  78976. * Get the physics impostor of a specific controller.
  78977. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  78978. * @param controller the controller or the controller id of which to get the impostor
  78979. * @returns the impostor or null
  78980. */
  78981. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  78982. /**
  78983. * Update the physics properties provided in the constructor
  78984. * @param newProperties the new properties object
  78985. */
  78986. setPhysicsProperties(newProperties: {
  78987. impostorType?: number;
  78988. impostorSize?: number | {
  78989. width: number;
  78990. height: number;
  78991. depth: number;
  78992. };
  78993. friction?: number;
  78994. restitution?: number;
  78995. }): void;
  78996. protected _onXRFrame(_xrFrame: any): void;
  78997. private _detachController;
  78998. }
  78999. }
  79000. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  79001. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79002. import { Observable } from "babylonjs/Misc/observable";
  79003. import { Vector3 } from "babylonjs/Maths/math.vector";
  79004. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79005. /**
  79006. * A babylon interface for a "WebXR" feature point.
  79007. * Represents the position and confidence value of a given feature point.
  79008. */
  79009. export interface IWebXRFeaturePoint {
  79010. /**
  79011. * Represents the position of the feature point in world space.
  79012. */
  79013. position: Vector3;
  79014. /**
  79015. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  79016. */
  79017. confidenceValue: number;
  79018. }
  79019. /**
  79020. * The feature point system is used to detect feature points from real world geometry.
  79021. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  79022. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  79023. */
  79024. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  79025. private _enabled;
  79026. private _featurePointCloud;
  79027. /**
  79028. * The module's name
  79029. */
  79030. static readonly Name: string;
  79031. /**
  79032. * The (Babylon) version of this module.
  79033. * This is an integer representing the implementation version.
  79034. * This number does not correspond to the WebXR specs version
  79035. */
  79036. static readonly Version: number;
  79037. /**
  79038. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  79039. * Will notify the observers about which feature points have been added.
  79040. */
  79041. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  79042. /**
  79043. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  79044. * Will notify the observers about which feature points have been updated.
  79045. */
  79046. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79047. /**
  79048. * The current feature point cloud maintained across frames.
  79049. */
  79050. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79051. /**
  79052. * construct the feature point system
  79053. * @param _xrSessionManager an instance of xr Session manager
  79054. */
  79055. constructor(_xrSessionManager: WebXRSessionManager);
  79056. /**
  79057. * Detach this feature.
  79058. * Will usually be called by the features manager
  79059. *
  79060. * @returns true if successful.
  79061. */
  79062. detach(): boolean;
  79063. /**
  79064. * Dispose this feature and all of the resources attached
  79065. */
  79066. dispose(): void;
  79067. /**
  79068. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79069. */
  79070. protected _onXRFrame(frame: XRFrame): void;
  79071. /**
  79072. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79073. */
  79074. private _init;
  79075. }
  79076. }
  79077. declare module "babylonjs/XR/features/WebXRHandTracking" {
  79078. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79079. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79080. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79081. import { Mesh } from "babylonjs/Meshes/mesh";
  79082. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79083. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79084. import { Nullable } from "babylonjs/types";
  79085. import { IDisposable } from "babylonjs/scene";
  79086. import { Observable } from "babylonjs/Misc/observable";
  79087. /**
  79088. * Configuration interface for the hand tracking feature
  79089. */
  79090. export interface IWebXRHandTrackingOptions {
  79091. /**
  79092. * The xrInput that will be used as source for new hands
  79093. */
  79094. xrInput: WebXRInput;
  79095. /**
  79096. * Configuration object for the joint meshes
  79097. */
  79098. jointMeshes?: {
  79099. /**
  79100. * Should the meshes created be invisible (defaults to false)
  79101. */
  79102. invisible?: boolean;
  79103. /**
  79104. * A source mesh to be used to create instances. Defaults to a sphere.
  79105. * This mesh will be the source for all other (25) meshes.
  79106. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  79107. */
  79108. sourceMesh?: Mesh;
  79109. /**
  79110. * Should the source mesh stay visible. Defaults to false
  79111. */
  79112. keepOriginalVisible?: boolean;
  79113. /**
  79114. * Scale factor for all instances (defaults to 2)
  79115. */
  79116. scaleFactor?: number;
  79117. /**
  79118. * Should each instance have its own physics impostor
  79119. */
  79120. enablePhysics?: boolean;
  79121. /**
  79122. * If enabled, override default physics properties
  79123. */
  79124. physicsProps?: {
  79125. friction?: number;
  79126. restitution?: number;
  79127. impostorType?: number;
  79128. };
  79129. /**
  79130. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  79131. */
  79132. handMesh?: AbstractMesh;
  79133. };
  79134. }
  79135. /**
  79136. * Parts of the hands divided to writs and finger names
  79137. */
  79138. export const enum HandPart {
  79139. /**
  79140. * HandPart - Wrist
  79141. */
  79142. WRIST = "wrist",
  79143. /**
  79144. * HandPart - The THumb
  79145. */
  79146. THUMB = "thumb",
  79147. /**
  79148. * HandPart - Index finger
  79149. */
  79150. INDEX = "index",
  79151. /**
  79152. * HandPart - Middle finger
  79153. */
  79154. MIDDLE = "middle",
  79155. /**
  79156. * HandPart - Ring finger
  79157. */
  79158. RING = "ring",
  79159. /**
  79160. * HandPart - Little finger
  79161. */
  79162. LITTLE = "little"
  79163. }
  79164. /**
  79165. * Representing a single hand (with its corresponding native XRHand object)
  79166. */
  79167. export class WebXRHand implements IDisposable {
  79168. /** the controller to which the hand correlates */
  79169. readonly xrController: WebXRInputSource;
  79170. /** the meshes to be used to track the hand joints */
  79171. readonly trackedMeshes: AbstractMesh[];
  79172. /**
  79173. * Hand-parts definition (key is HandPart)
  79174. */
  79175. static HandPartsDefinition: {
  79176. [key: string]: number[];
  79177. };
  79178. /**
  79179. * Populate the HandPartsDefinition object.
  79180. * This is called as a side effect since certain browsers don't have XRHand defined.
  79181. */
  79182. static _PopulateHandPartsDefinition(): void;
  79183. /**
  79184. * Construct a new hand object
  79185. * @param xrController the controller to which the hand correlates
  79186. * @param trackedMeshes the meshes to be used to track the hand joints
  79187. */
  79188. constructor(
  79189. /** the controller to which the hand correlates */
  79190. xrController: WebXRInputSource,
  79191. /** the meshes to be used to track the hand joints */
  79192. trackedMeshes: AbstractMesh[]);
  79193. /**
  79194. * Update this hand from the latest xr frame
  79195. * @param xrFrame xrFrame to update from
  79196. * @param referenceSpace The current viewer reference space
  79197. * @param scaleFactor optional scale factor for the meshes
  79198. */
  79199. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  79200. /**
  79201. * Get meshes of part of the hand
  79202. * @param part the part of hand to get
  79203. * @returns An array of meshes that correlate to the hand part requested
  79204. */
  79205. getHandPartMeshes(part: HandPart): AbstractMesh[];
  79206. /**
  79207. * Dispose this Hand object
  79208. */
  79209. dispose(): void;
  79210. }
  79211. /**
  79212. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  79213. */
  79214. export class WebXRHandTracking extends WebXRAbstractFeature {
  79215. /**
  79216. * options to use when constructing this feature
  79217. */
  79218. readonly options: IWebXRHandTrackingOptions;
  79219. private static _idCounter;
  79220. /**
  79221. * The module's name
  79222. */
  79223. static readonly Name: string;
  79224. /**
  79225. * The (Babylon) version of this module.
  79226. * This is an integer representing the implementation version.
  79227. * This number does not correspond to the WebXR specs version
  79228. */
  79229. static readonly Version: number;
  79230. /**
  79231. * This observable will notify registered observers when a new hand object was added and initialized
  79232. */
  79233. onHandAddedObservable: Observable<WebXRHand>;
  79234. /**
  79235. * This observable will notify its observers right before the hand object is disposed
  79236. */
  79237. onHandRemovedObservable: Observable<WebXRHand>;
  79238. private _hands;
  79239. /**
  79240. * Creates a new instance of the hit test feature
  79241. * @param _xrSessionManager an instance of WebXRSessionManager
  79242. * @param options options to use when constructing this feature
  79243. */
  79244. constructor(_xrSessionManager: WebXRSessionManager,
  79245. /**
  79246. * options to use when constructing this feature
  79247. */
  79248. options: IWebXRHandTrackingOptions);
  79249. /**
  79250. * Check if the needed objects are defined.
  79251. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  79252. */
  79253. isCompatible(): boolean;
  79254. /**
  79255. * attach this feature
  79256. * Will usually be called by the features manager
  79257. *
  79258. * @returns true if successful.
  79259. */
  79260. attach(): boolean;
  79261. /**
  79262. * detach this feature.
  79263. * Will usually be called by the features manager
  79264. *
  79265. * @returns true if successful.
  79266. */
  79267. detach(): boolean;
  79268. /**
  79269. * Dispose this feature and all of the resources attached
  79270. */
  79271. dispose(): void;
  79272. /**
  79273. * Get the hand object according to the controller id
  79274. * @param controllerId the controller id to which we want to get the hand
  79275. * @returns null if not found or the WebXRHand object if found
  79276. */
  79277. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  79278. /**
  79279. * Get a hand object according to the requested handedness
  79280. * @param handedness the handedness to request
  79281. * @returns null if not found or the WebXRHand object if found
  79282. */
  79283. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  79284. protected _onXRFrame(_xrFrame: XRFrame): void;
  79285. private _attachHand;
  79286. private _detachHand;
  79287. }
  79288. }
  79289. declare module "babylonjs/XR/features/index" {
  79290. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79291. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79292. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79293. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79294. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79295. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79296. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79297. export * from "babylonjs/XR/features/WebXRHitTest";
  79298. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79299. export * from "babylonjs/XR/features/WebXRHandTracking";
  79300. }
  79301. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79302. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79303. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79304. import { Scene } from "babylonjs/scene";
  79305. /**
  79306. * The motion controller class for all microsoft mixed reality controllers
  79307. */
  79308. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79309. protected readonly _mapping: {
  79310. defaultButton: {
  79311. valueNodeName: string;
  79312. unpressedNodeName: string;
  79313. pressedNodeName: string;
  79314. };
  79315. defaultAxis: {
  79316. valueNodeName: string;
  79317. minNodeName: string;
  79318. maxNodeName: string;
  79319. };
  79320. buttons: {
  79321. "xr-standard-trigger": {
  79322. rootNodeName: string;
  79323. componentProperty: string;
  79324. states: string[];
  79325. };
  79326. "xr-standard-squeeze": {
  79327. rootNodeName: string;
  79328. componentProperty: string;
  79329. states: string[];
  79330. };
  79331. "xr-standard-touchpad": {
  79332. rootNodeName: string;
  79333. labelAnchorNodeName: string;
  79334. touchPointNodeName: string;
  79335. };
  79336. "xr-standard-thumbstick": {
  79337. rootNodeName: string;
  79338. componentProperty: string;
  79339. states: string[];
  79340. };
  79341. };
  79342. axes: {
  79343. "xr-standard-touchpad": {
  79344. "x-axis": {
  79345. rootNodeName: string;
  79346. };
  79347. "y-axis": {
  79348. rootNodeName: string;
  79349. };
  79350. };
  79351. "xr-standard-thumbstick": {
  79352. "x-axis": {
  79353. rootNodeName: string;
  79354. };
  79355. "y-axis": {
  79356. rootNodeName: string;
  79357. };
  79358. };
  79359. };
  79360. };
  79361. /**
  79362. * The base url used to load the left and right controller models
  79363. */
  79364. static MODEL_BASE_URL: string;
  79365. /**
  79366. * The name of the left controller model file
  79367. */
  79368. static MODEL_LEFT_FILENAME: string;
  79369. /**
  79370. * The name of the right controller model file
  79371. */
  79372. static MODEL_RIGHT_FILENAME: string;
  79373. profileId: string;
  79374. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79375. protected _getFilenameAndPath(): {
  79376. filename: string;
  79377. path: string;
  79378. };
  79379. protected _getModelLoadingConstraints(): boolean;
  79380. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79381. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79382. protected _updateModel(): void;
  79383. }
  79384. }
  79385. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  79386. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79387. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79388. import { Scene } from "babylonjs/scene";
  79389. /**
  79390. * The motion controller class for oculus touch (quest, rift).
  79391. * This class supports legacy mapping as well the standard xr mapping
  79392. */
  79393. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  79394. private _forceLegacyControllers;
  79395. private _modelRootNode;
  79396. /**
  79397. * The base url used to load the left and right controller models
  79398. */
  79399. static MODEL_BASE_URL: string;
  79400. /**
  79401. * The name of the left controller model file
  79402. */
  79403. static MODEL_LEFT_FILENAME: string;
  79404. /**
  79405. * The name of the right controller model file
  79406. */
  79407. static MODEL_RIGHT_FILENAME: string;
  79408. /**
  79409. * Base Url for the Quest controller model.
  79410. */
  79411. static QUEST_MODEL_BASE_URL: string;
  79412. profileId: string;
  79413. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  79414. protected _getFilenameAndPath(): {
  79415. filename: string;
  79416. path: string;
  79417. };
  79418. protected _getModelLoadingConstraints(): boolean;
  79419. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79420. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79421. protected _updateModel(): void;
  79422. /**
  79423. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  79424. * between the touch and touch 2.
  79425. */
  79426. private _isQuest;
  79427. }
  79428. }
  79429. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  79430. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79431. import { Scene } from "babylonjs/scene";
  79432. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79433. /**
  79434. * The motion controller class for the standard HTC-Vive controllers
  79435. */
  79436. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  79437. private _modelRootNode;
  79438. /**
  79439. * The base url used to load the left and right controller models
  79440. */
  79441. static MODEL_BASE_URL: string;
  79442. /**
  79443. * File name for the controller model.
  79444. */
  79445. static MODEL_FILENAME: string;
  79446. profileId: string;
  79447. /**
  79448. * Create a new Vive motion controller object
  79449. * @param scene the scene to use to create this controller
  79450. * @param gamepadObject the corresponding gamepad object
  79451. * @param handedness the handedness of the controller
  79452. */
  79453. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79454. protected _getFilenameAndPath(): {
  79455. filename: string;
  79456. path: string;
  79457. };
  79458. protected _getModelLoadingConstraints(): boolean;
  79459. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79460. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79461. protected _updateModel(): void;
  79462. }
  79463. }
  79464. declare module "babylonjs/XR/motionController/index" {
  79465. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79466. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  79467. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  79468. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  79469. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  79470. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  79471. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  79472. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  79473. }
  79474. declare module "babylonjs/XR/index" {
  79475. export * from "babylonjs/XR/webXRCamera";
  79476. export * from "babylonjs/XR/webXREnterExitUI";
  79477. export * from "babylonjs/XR/webXRExperienceHelper";
  79478. export * from "babylonjs/XR/webXRInput";
  79479. export * from "babylonjs/XR/webXRInputSource";
  79480. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  79481. export * from "babylonjs/XR/webXRTypes";
  79482. export * from "babylonjs/XR/webXRSessionManager";
  79483. export * from "babylonjs/XR/webXRDefaultExperience";
  79484. export * from "babylonjs/XR/webXRFeaturesManager";
  79485. export * from "babylonjs/XR/features/index";
  79486. export * from "babylonjs/XR/motionController/index";
  79487. }
  79488. declare module "babylonjs/index" {
  79489. export * from "babylonjs/abstractScene";
  79490. export * from "babylonjs/Actions/index";
  79491. export * from "babylonjs/Animations/index";
  79492. export * from "babylonjs/assetContainer";
  79493. export * from "babylonjs/Audio/index";
  79494. export * from "babylonjs/Behaviors/index";
  79495. export * from "babylonjs/Bones/index";
  79496. export * from "babylonjs/Cameras/index";
  79497. export * from "babylonjs/Collisions/index";
  79498. export * from "babylonjs/Culling/index";
  79499. export * from "babylonjs/Debug/index";
  79500. export * from "babylonjs/DeviceInput/index";
  79501. export * from "babylonjs/Engines/index";
  79502. export * from "babylonjs/Events/index";
  79503. export * from "babylonjs/Gamepads/index";
  79504. export * from "babylonjs/Gizmos/index";
  79505. export * from "babylonjs/Helpers/index";
  79506. export * from "babylonjs/Instrumentation/index";
  79507. export * from "babylonjs/Layers/index";
  79508. export * from "babylonjs/LensFlares/index";
  79509. export * from "babylonjs/Lights/index";
  79510. export * from "babylonjs/Loading/index";
  79511. export * from "babylonjs/Materials/index";
  79512. export * from "babylonjs/Maths/index";
  79513. export * from "babylonjs/Meshes/index";
  79514. export * from "babylonjs/Morph/index";
  79515. export * from "babylonjs/Navigation/index";
  79516. export * from "babylonjs/node";
  79517. export * from "babylonjs/Offline/index";
  79518. export * from "babylonjs/Particles/index";
  79519. export * from "babylonjs/Physics/index";
  79520. export * from "babylonjs/PostProcesses/index";
  79521. export * from "babylonjs/Probes/index";
  79522. export * from "babylonjs/Rendering/index";
  79523. export * from "babylonjs/scene";
  79524. export * from "babylonjs/sceneComponent";
  79525. export * from "babylonjs/Sprites/index";
  79526. export * from "babylonjs/States/index";
  79527. export * from "babylonjs/Misc/index";
  79528. export * from "babylonjs/XR/index";
  79529. export * from "babylonjs/types";
  79530. }
  79531. declare module "babylonjs/Animations/pathCursor" {
  79532. import { Vector3 } from "babylonjs/Maths/math.vector";
  79533. import { Path2 } from "babylonjs/Maths/math.path";
  79534. /**
  79535. * A cursor which tracks a point on a path
  79536. */
  79537. export class PathCursor {
  79538. private path;
  79539. /**
  79540. * Stores path cursor callbacks for when an onchange event is triggered
  79541. */
  79542. private _onchange;
  79543. /**
  79544. * The value of the path cursor
  79545. */
  79546. value: number;
  79547. /**
  79548. * The animation array of the path cursor
  79549. */
  79550. animations: Animation[];
  79551. /**
  79552. * Initializes the path cursor
  79553. * @param path The path to track
  79554. */
  79555. constructor(path: Path2);
  79556. /**
  79557. * Gets the cursor point on the path
  79558. * @returns A point on the path cursor at the cursor location
  79559. */
  79560. getPoint(): Vector3;
  79561. /**
  79562. * Moves the cursor ahead by the step amount
  79563. * @param step The amount to move the cursor forward
  79564. * @returns This path cursor
  79565. */
  79566. moveAhead(step?: number): PathCursor;
  79567. /**
  79568. * Moves the cursor behind by the step amount
  79569. * @param step The amount to move the cursor back
  79570. * @returns This path cursor
  79571. */
  79572. moveBack(step?: number): PathCursor;
  79573. /**
  79574. * Moves the cursor by the step amount
  79575. * If the step amount is greater than one, an exception is thrown
  79576. * @param step The amount to move the cursor
  79577. * @returns This path cursor
  79578. */
  79579. move(step: number): PathCursor;
  79580. /**
  79581. * Ensures that the value is limited between zero and one
  79582. * @returns This path cursor
  79583. */
  79584. private ensureLimits;
  79585. /**
  79586. * Runs onchange callbacks on change (used by the animation engine)
  79587. * @returns This path cursor
  79588. */
  79589. private raiseOnChange;
  79590. /**
  79591. * Executes a function on change
  79592. * @param f A path cursor onchange callback
  79593. * @returns This path cursor
  79594. */
  79595. onchange(f: (cursor: PathCursor) => void): PathCursor;
  79596. }
  79597. }
  79598. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  79599. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  79600. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  79601. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  79602. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  79603. }
  79604. declare module "babylonjs/Engines/Processors/Expressions/index" {
  79605. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  79606. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  79607. }
  79608. declare module "babylonjs/Engines/Processors/index" {
  79609. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  79610. export * from "babylonjs/Engines/Processors/Expressions/index";
  79611. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  79612. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  79613. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  79614. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  79615. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  79616. export * from "babylonjs/Engines/Processors/shaderProcessor";
  79617. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  79618. }
  79619. declare module "babylonjs/Legacy/legacy" {
  79620. import * as Babylon from "babylonjs/index";
  79621. export * from "babylonjs/index";
  79622. }
  79623. declare module "babylonjs/Shaders/blur.fragment" {
  79624. /** @hidden */
  79625. export var blurPixelShader: {
  79626. name: string;
  79627. shader: string;
  79628. };
  79629. }
  79630. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  79631. /** @hidden */
  79632. export var pointCloudVertexDeclaration: {
  79633. name: string;
  79634. shader: string;
  79635. };
  79636. }
  79637. declare module "babylonjs" {
  79638. export * from "babylonjs/Legacy/legacy";
  79639. }
  79640. declare module BABYLON {
  79641. /** Alias type for value that can be null */
  79642. export type Nullable<T> = T | null;
  79643. /**
  79644. * Alias type for number that are floats
  79645. * @ignorenaming
  79646. */
  79647. export type float = number;
  79648. /**
  79649. * Alias type for number that are doubles.
  79650. * @ignorenaming
  79651. */
  79652. export type double = number;
  79653. /**
  79654. * Alias type for number that are integer
  79655. * @ignorenaming
  79656. */
  79657. export type int = number;
  79658. /** Alias type for number array or Float32Array */
  79659. export type FloatArray = number[] | Float32Array;
  79660. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  79661. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  79662. /**
  79663. * Alias for types that can be used by a Buffer or VertexBuffer.
  79664. */
  79665. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  79666. /**
  79667. * Alias type for primitive types
  79668. * @ignorenaming
  79669. */
  79670. type Primitive = undefined | null | boolean | string | number | Function;
  79671. /**
  79672. * Type modifier to make all the properties of an object Readonly
  79673. */
  79674. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  79675. /**
  79676. * Type modifier to make all the properties of an object Readonly recursively
  79677. */
  79678. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  79679. /**
  79680. * Type modifier to make object properties readonly.
  79681. */
  79682. export type DeepImmutableObject<T> = {
  79683. readonly [K in keyof T]: DeepImmutable<T[K]>;
  79684. };
  79685. /** @hidden */
  79686. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  79687. }
  79688. }
  79689. declare module BABYLON {
  79690. /**
  79691. * A class serves as a medium between the observable and its observers
  79692. */
  79693. export class EventState {
  79694. /**
  79695. * Create a new EventState
  79696. * @param mask defines the mask associated with this state
  79697. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79698. * @param target defines the original target of the state
  79699. * @param currentTarget defines the current target of the state
  79700. */
  79701. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  79702. /**
  79703. * Initialize the current event state
  79704. * @param mask defines the mask associated with this state
  79705. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79706. * @param target defines the original target of the state
  79707. * @param currentTarget defines the current target of the state
  79708. * @returns the current event state
  79709. */
  79710. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  79711. /**
  79712. * An Observer can set this property to true to prevent subsequent observers of being notified
  79713. */
  79714. skipNextObservers: boolean;
  79715. /**
  79716. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79717. */
  79718. mask: number;
  79719. /**
  79720. * The object that originally notified the event
  79721. */
  79722. target?: any;
  79723. /**
  79724. * The current object in the bubbling phase
  79725. */
  79726. currentTarget?: any;
  79727. /**
  79728. * This will be populated with the return value of the last function that was executed.
  79729. * If it is the first function in the callback chain it will be the event data.
  79730. */
  79731. lastReturnValue?: any;
  79732. }
  79733. /**
  79734. * Represent an Observer registered to a given Observable object.
  79735. */
  79736. export class Observer<T> {
  79737. /**
  79738. * Defines the callback to call when the observer is notified
  79739. */
  79740. callback: (eventData: T, eventState: EventState) => void;
  79741. /**
  79742. * Defines the mask of the observer (used to filter notifications)
  79743. */
  79744. mask: number;
  79745. /**
  79746. * Defines the current scope used to restore the JS context
  79747. */
  79748. scope: any;
  79749. /** @hidden */
  79750. _willBeUnregistered: boolean;
  79751. /**
  79752. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  79753. */
  79754. unregisterOnNextCall: boolean;
  79755. /**
  79756. * Creates a new observer
  79757. * @param callback defines the callback to call when the observer is notified
  79758. * @param mask defines the mask of the observer (used to filter notifications)
  79759. * @param scope defines the current scope used to restore the JS context
  79760. */
  79761. constructor(
  79762. /**
  79763. * Defines the callback to call when the observer is notified
  79764. */
  79765. callback: (eventData: T, eventState: EventState) => void,
  79766. /**
  79767. * Defines the mask of the observer (used to filter notifications)
  79768. */
  79769. mask: number,
  79770. /**
  79771. * Defines the current scope used to restore the JS context
  79772. */
  79773. scope?: any);
  79774. }
  79775. /**
  79776. * Represent a list of observers registered to multiple Observables object.
  79777. */
  79778. export class MultiObserver<T> {
  79779. private _observers;
  79780. private _observables;
  79781. /**
  79782. * Release associated resources
  79783. */
  79784. dispose(): void;
  79785. /**
  79786. * Raise a callback when one of the observable will notify
  79787. * @param observables defines a list of observables to watch
  79788. * @param callback defines the callback to call on notification
  79789. * @param mask defines the mask used to filter notifications
  79790. * @param scope defines the current scope used to restore the JS context
  79791. * @returns the new MultiObserver
  79792. */
  79793. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  79794. }
  79795. /**
  79796. * The Observable class is a simple implementation of the Observable pattern.
  79797. *
  79798. * 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.
  79799. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  79800. * 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).
  79801. * 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.
  79802. */
  79803. export class Observable<T> {
  79804. private _observers;
  79805. private _eventState;
  79806. private _onObserverAdded;
  79807. /**
  79808. * Gets the list of observers
  79809. */
  79810. get observers(): Array<Observer<T>>;
  79811. /**
  79812. * Creates a new observable
  79813. * @param onObserverAdded defines a callback to call when a new observer is added
  79814. */
  79815. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  79816. /**
  79817. * Create a new Observer with the specified callback
  79818. * @param callback the callback that will be executed for that Observer
  79819. * @param mask the mask used to filter observers
  79820. * @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.
  79821. * @param scope optional scope for the callback to be called from
  79822. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  79823. * @returns the new observer created for the callback
  79824. */
  79825. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  79826. /**
  79827. * Create a new Observer with the specified callback and unregisters after the next notification
  79828. * @param callback the callback that will be executed for that Observer
  79829. * @returns the new observer created for the callback
  79830. */
  79831. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  79832. /**
  79833. * Remove an Observer from the Observable object
  79834. * @param observer the instance of the Observer to remove
  79835. * @returns false if it doesn't belong to this Observable
  79836. */
  79837. remove(observer: Nullable<Observer<T>>): boolean;
  79838. /**
  79839. * Remove a callback from the Observable object
  79840. * @param callback the callback to remove
  79841. * @param scope optional scope. If used only the callbacks with this scope will be removed
  79842. * @returns false if it doesn't belong to this Observable
  79843. */
  79844. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  79845. private _deferUnregister;
  79846. private _remove;
  79847. /**
  79848. * Moves the observable to the top of the observer list making it get called first when notified
  79849. * @param observer the observer to move
  79850. */
  79851. makeObserverTopPriority(observer: Observer<T>): void;
  79852. /**
  79853. * Moves the observable to the bottom of the observer list making it get called last when notified
  79854. * @param observer the observer to move
  79855. */
  79856. makeObserverBottomPriority(observer: Observer<T>): void;
  79857. /**
  79858. * Notify all Observers by calling their respective callback with the given data
  79859. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  79860. * @param eventData defines the data to send to all observers
  79861. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  79862. * @param target defines the original target of the state
  79863. * @param currentTarget defines the current target of the state
  79864. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  79865. */
  79866. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  79867. /**
  79868. * Calling this will execute each callback, expecting it to be a promise or return a value.
  79869. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  79870. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  79871. * and it is crucial that all callbacks will be executed.
  79872. * The order of the callbacks is kept, callbacks are not executed parallel.
  79873. *
  79874. * @param eventData The data to be sent to each callback
  79875. * @param mask is used to filter observers defaults to -1
  79876. * @param target defines the callback target (see EventState)
  79877. * @param currentTarget defines he current object in the bubbling phase
  79878. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  79879. */
  79880. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  79881. /**
  79882. * Notify a specific observer
  79883. * @param observer defines the observer to notify
  79884. * @param eventData defines the data to be sent to each callback
  79885. * @param mask is used to filter observers defaults to -1
  79886. */
  79887. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  79888. /**
  79889. * Gets a boolean indicating if the observable has at least one observer
  79890. * @returns true is the Observable has at least one Observer registered
  79891. */
  79892. hasObservers(): boolean;
  79893. /**
  79894. * Clear the list of observers
  79895. */
  79896. clear(): void;
  79897. /**
  79898. * Clone the current observable
  79899. * @returns a new observable
  79900. */
  79901. clone(): Observable<T>;
  79902. /**
  79903. * Does this observable handles observer registered with a given mask
  79904. * @param mask defines the mask to be tested
  79905. * @return whether or not one observer registered with the given mask is handeled
  79906. **/
  79907. hasSpecificMask(mask?: number): boolean;
  79908. }
  79909. }
  79910. declare module BABYLON {
  79911. /**
  79912. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  79913. * Babylon.js
  79914. */
  79915. export class DomManagement {
  79916. /**
  79917. * Checks if the window object exists
  79918. * @returns true if the window object exists
  79919. */
  79920. static IsWindowObjectExist(): boolean;
  79921. /**
  79922. * Checks if the navigator object exists
  79923. * @returns true if the navigator object exists
  79924. */
  79925. static IsNavigatorAvailable(): boolean;
  79926. /**
  79927. * Check if the document object exists
  79928. * @returns true if the document object exists
  79929. */
  79930. static IsDocumentAvailable(): boolean;
  79931. /**
  79932. * Extracts text content from a DOM element hierarchy
  79933. * @param element defines the root element
  79934. * @returns a string
  79935. */
  79936. static GetDOMTextContent(element: HTMLElement): string;
  79937. }
  79938. }
  79939. declare module BABYLON {
  79940. /**
  79941. * Logger used througouht the application to allow configuration of
  79942. * the log level required for the messages.
  79943. */
  79944. export class Logger {
  79945. /**
  79946. * No log
  79947. */
  79948. static readonly NoneLogLevel: number;
  79949. /**
  79950. * Only message logs
  79951. */
  79952. static readonly MessageLogLevel: number;
  79953. /**
  79954. * Only warning logs
  79955. */
  79956. static readonly WarningLogLevel: number;
  79957. /**
  79958. * Only error logs
  79959. */
  79960. static readonly ErrorLogLevel: number;
  79961. /**
  79962. * All logs
  79963. */
  79964. static readonly AllLogLevel: number;
  79965. private static _LogCache;
  79966. /**
  79967. * Gets a value indicating the number of loading errors
  79968. * @ignorenaming
  79969. */
  79970. static errorsCount: number;
  79971. /**
  79972. * Callback called when a new log is added
  79973. */
  79974. static OnNewCacheEntry: (entry: string) => void;
  79975. private static _AddLogEntry;
  79976. private static _FormatMessage;
  79977. private static _LogDisabled;
  79978. private static _LogEnabled;
  79979. private static _WarnDisabled;
  79980. private static _WarnEnabled;
  79981. private static _ErrorDisabled;
  79982. private static _ErrorEnabled;
  79983. /**
  79984. * Log a message to the console
  79985. */
  79986. static Log: (message: string) => void;
  79987. /**
  79988. * Write a warning message to the console
  79989. */
  79990. static Warn: (message: string) => void;
  79991. /**
  79992. * Write an error message to the console
  79993. */
  79994. static Error: (message: string) => void;
  79995. /**
  79996. * Gets current log cache (list of logs)
  79997. */
  79998. static get LogCache(): string;
  79999. /**
  80000. * Clears the log cache
  80001. */
  80002. static ClearLogCache(): void;
  80003. /**
  80004. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  80005. */
  80006. static set LogLevels(level: number);
  80007. }
  80008. }
  80009. declare module BABYLON {
  80010. /** @hidden */
  80011. export class _TypeStore {
  80012. /** @hidden */
  80013. static RegisteredTypes: {
  80014. [key: string]: Object;
  80015. };
  80016. /** @hidden */
  80017. static GetClass(fqdn: string): any;
  80018. }
  80019. }
  80020. declare module BABYLON {
  80021. /**
  80022. * Helper to manipulate strings
  80023. */
  80024. export class StringTools {
  80025. /**
  80026. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  80027. * @param str Source string
  80028. * @param suffix Suffix to search for in the source string
  80029. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80030. */
  80031. static EndsWith(str: string, suffix: string): boolean;
  80032. /**
  80033. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  80034. * @param str Source string
  80035. * @param suffix Suffix to search for in the source string
  80036. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80037. */
  80038. static StartsWith(str: string, suffix: string): boolean;
  80039. /**
  80040. * Decodes a buffer into a string
  80041. * @param buffer The buffer to decode
  80042. * @returns The decoded string
  80043. */
  80044. static Decode(buffer: Uint8Array | Uint16Array): string;
  80045. /**
  80046. * Encode a buffer to a base64 string
  80047. * @param buffer defines the buffer to encode
  80048. * @returns the encoded string
  80049. */
  80050. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  80051. /**
  80052. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  80053. * @param num the number to convert and pad
  80054. * @param length the expected length of the string
  80055. * @returns the padded string
  80056. */
  80057. static PadNumber(num: number, length: number): string;
  80058. }
  80059. }
  80060. declare module BABYLON {
  80061. /**
  80062. * Class containing a set of static utilities functions for deep copy.
  80063. */
  80064. export class DeepCopier {
  80065. /**
  80066. * Tries to copy an object by duplicating every property
  80067. * @param source defines the source object
  80068. * @param destination defines the target object
  80069. * @param doNotCopyList defines a list of properties to avoid
  80070. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  80071. */
  80072. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  80073. }
  80074. }
  80075. declare module BABYLON {
  80076. /**
  80077. * Class containing a set of static utilities functions for precision date
  80078. */
  80079. export class PrecisionDate {
  80080. /**
  80081. * Gets either window.performance.now() if supported or Date.now() else
  80082. */
  80083. static get Now(): number;
  80084. }
  80085. }
  80086. declare module BABYLON {
  80087. /** @hidden */
  80088. export class _DevTools {
  80089. static WarnImport(name: string): string;
  80090. }
  80091. }
  80092. declare module BABYLON {
  80093. /**
  80094. * Interface used to define the mechanism to get data from the network
  80095. */
  80096. export interface IWebRequest {
  80097. /**
  80098. * Returns client's response url
  80099. */
  80100. responseURL: string;
  80101. /**
  80102. * Returns client's status
  80103. */
  80104. status: number;
  80105. /**
  80106. * Returns client's status as a text
  80107. */
  80108. statusText: string;
  80109. }
  80110. }
  80111. declare module BABYLON {
  80112. /**
  80113. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  80114. */
  80115. export class WebRequest implements IWebRequest {
  80116. private _xhr;
  80117. /**
  80118. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  80119. * i.e. when loading files, where the server/service expects an Authorization header
  80120. */
  80121. static CustomRequestHeaders: {
  80122. [key: string]: string;
  80123. };
  80124. /**
  80125. * Add callback functions in this array to update all the requests before they get sent to the network
  80126. */
  80127. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  80128. private _injectCustomRequestHeaders;
  80129. /**
  80130. * Gets or sets a function to be called when loading progress changes
  80131. */
  80132. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  80133. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  80134. /**
  80135. * Returns client's state
  80136. */
  80137. get readyState(): number;
  80138. /**
  80139. * Returns client's status
  80140. */
  80141. get status(): number;
  80142. /**
  80143. * Returns client's status as a text
  80144. */
  80145. get statusText(): string;
  80146. /**
  80147. * Returns client's response
  80148. */
  80149. get response(): any;
  80150. /**
  80151. * Returns client's response url
  80152. */
  80153. get responseURL(): string;
  80154. /**
  80155. * Returns client's response as text
  80156. */
  80157. get responseText(): string;
  80158. /**
  80159. * Gets or sets the expected response type
  80160. */
  80161. get responseType(): XMLHttpRequestResponseType;
  80162. set responseType(value: XMLHttpRequestResponseType);
  80163. /** @hidden */
  80164. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  80165. /** @hidden */
  80166. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  80167. /**
  80168. * Cancels any network activity
  80169. */
  80170. abort(): void;
  80171. /**
  80172. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  80173. * @param body defines an optional request body
  80174. */
  80175. send(body?: Document | BodyInit | null): void;
  80176. /**
  80177. * Sets the request method, request URL
  80178. * @param method defines the method to use (GET, POST, etc..)
  80179. * @param url defines the url to connect with
  80180. */
  80181. open(method: string, url: string): void;
  80182. /**
  80183. * Sets the value of a request header.
  80184. * @param name The name of the header whose value is to be set
  80185. * @param value The value to set as the body of the header
  80186. */
  80187. setRequestHeader(name: string, value: string): void;
  80188. /**
  80189. * Get the string containing the text of a particular header's value.
  80190. * @param name The name of the header
  80191. * @returns The string containing the text of the given header name
  80192. */
  80193. getResponseHeader(name: string): Nullable<string>;
  80194. }
  80195. }
  80196. declare module BABYLON {
  80197. /**
  80198. * File request interface
  80199. */
  80200. export interface IFileRequest {
  80201. /**
  80202. * Raised when the request is complete (success or error).
  80203. */
  80204. onCompleteObservable: Observable<IFileRequest>;
  80205. /**
  80206. * Aborts the request for a file.
  80207. */
  80208. abort: () => void;
  80209. }
  80210. }
  80211. declare module BABYLON {
  80212. /**
  80213. * Define options used to create a render target texture
  80214. */
  80215. export class RenderTargetCreationOptions {
  80216. /**
  80217. * Specifies is mipmaps must be generated
  80218. */
  80219. generateMipMaps?: boolean;
  80220. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  80221. generateDepthBuffer?: boolean;
  80222. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  80223. generateStencilBuffer?: boolean;
  80224. /** Defines texture type (int by default) */
  80225. type?: number;
  80226. /** Defines sampling mode (trilinear by default) */
  80227. samplingMode?: number;
  80228. /** Defines format (RGBA by default) */
  80229. format?: number;
  80230. }
  80231. }
  80232. declare module BABYLON {
  80233. /** Defines the cross module used constants to avoid circular dependncies */
  80234. export class Constants {
  80235. /** Defines that alpha blending is disabled */
  80236. static readonly ALPHA_DISABLE: number;
  80237. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  80238. static readonly ALPHA_ADD: number;
  80239. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  80240. static readonly ALPHA_COMBINE: number;
  80241. /** Defines that alpha blending is DEST - SRC * DEST */
  80242. static readonly ALPHA_SUBTRACT: number;
  80243. /** Defines that alpha blending is SRC * DEST */
  80244. static readonly ALPHA_MULTIPLY: number;
  80245. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  80246. static readonly ALPHA_MAXIMIZED: number;
  80247. /** Defines that alpha blending is SRC + DEST */
  80248. static readonly ALPHA_ONEONE: number;
  80249. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  80250. static readonly ALPHA_PREMULTIPLIED: number;
  80251. /**
  80252. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  80253. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  80254. */
  80255. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  80256. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  80257. static readonly ALPHA_INTERPOLATE: number;
  80258. /**
  80259. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80260. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80261. */
  80262. static readonly ALPHA_SCREENMODE: number;
  80263. /**
  80264. * Defines that alpha blending is SRC + DST
  80265. * Alpha will be set to SRC ALPHA + DST ALPHA
  80266. */
  80267. static readonly ALPHA_ONEONE_ONEONE: number;
  80268. /**
  80269. * Defines that alpha blending is SRC * DST ALPHA + DST
  80270. * Alpha will be set to 0
  80271. */
  80272. static readonly ALPHA_ALPHATOCOLOR: number;
  80273. /**
  80274. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80275. */
  80276. static readonly ALPHA_REVERSEONEMINUS: number;
  80277. /**
  80278. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80279. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80280. */
  80281. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80282. /**
  80283. * Defines that alpha blending is SRC + DST
  80284. * Alpha will be set to SRC ALPHA
  80285. */
  80286. static readonly ALPHA_ONEONE_ONEZERO: number;
  80287. /**
  80288. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80289. * Alpha will be set to DST ALPHA
  80290. */
  80291. static readonly ALPHA_EXCLUSION: number;
  80292. /** Defines that alpha blending equation a SUM */
  80293. static readonly ALPHA_EQUATION_ADD: number;
  80294. /** Defines that alpha blending equation a SUBSTRACTION */
  80295. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80296. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80297. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80298. /** Defines that alpha blending equation a MAX operation */
  80299. static readonly ALPHA_EQUATION_MAX: number;
  80300. /** Defines that alpha blending equation a MIN operation */
  80301. static readonly ALPHA_EQUATION_MIN: number;
  80302. /**
  80303. * Defines that alpha blending equation a DARKEN operation:
  80304. * It takes the min of the src and sums the alpha channels.
  80305. */
  80306. static readonly ALPHA_EQUATION_DARKEN: number;
  80307. /** Defines that the ressource is not delayed*/
  80308. static readonly DELAYLOADSTATE_NONE: number;
  80309. /** Defines that the ressource was successfully delay loaded */
  80310. static readonly DELAYLOADSTATE_LOADED: number;
  80311. /** Defines that the ressource is currently delay loading */
  80312. static readonly DELAYLOADSTATE_LOADING: number;
  80313. /** Defines that the ressource is delayed and has not started loading */
  80314. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80315. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80316. static readonly NEVER: number;
  80317. /** 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 */
  80318. static readonly ALWAYS: number;
  80319. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80320. static readonly LESS: number;
  80321. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80322. static readonly EQUAL: number;
  80323. /** 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 */
  80324. static readonly LEQUAL: number;
  80325. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80326. static readonly GREATER: number;
  80327. /** 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 */
  80328. static readonly GEQUAL: number;
  80329. /** 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 */
  80330. static readonly NOTEQUAL: number;
  80331. /** Passed to stencilOperation to specify that stencil value must be kept */
  80332. static readonly KEEP: number;
  80333. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80334. static readonly REPLACE: number;
  80335. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80336. static readonly INCR: number;
  80337. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80338. static readonly DECR: number;
  80339. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80340. static readonly INVERT: number;
  80341. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80342. static readonly INCR_WRAP: number;
  80343. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80344. static readonly DECR_WRAP: number;
  80345. /** Texture is not repeating outside of 0..1 UVs */
  80346. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80347. /** Texture is repeating outside of 0..1 UVs */
  80348. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80349. /** Texture is repeating and mirrored */
  80350. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80351. /** ALPHA */
  80352. static readonly TEXTUREFORMAT_ALPHA: number;
  80353. /** LUMINANCE */
  80354. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80355. /** LUMINANCE_ALPHA */
  80356. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80357. /** RGB */
  80358. static readonly TEXTUREFORMAT_RGB: number;
  80359. /** RGBA */
  80360. static readonly TEXTUREFORMAT_RGBA: number;
  80361. /** RED */
  80362. static readonly TEXTUREFORMAT_RED: number;
  80363. /** RED (2nd reference) */
  80364. static readonly TEXTUREFORMAT_R: number;
  80365. /** RG */
  80366. static readonly TEXTUREFORMAT_RG: number;
  80367. /** RED_INTEGER */
  80368. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  80369. /** RED_INTEGER (2nd reference) */
  80370. static readonly TEXTUREFORMAT_R_INTEGER: number;
  80371. /** RG_INTEGER */
  80372. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  80373. /** RGB_INTEGER */
  80374. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  80375. /** RGBA_INTEGER */
  80376. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  80377. /** UNSIGNED_BYTE */
  80378. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  80379. /** UNSIGNED_BYTE (2nd reference) */
  80380. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  80381. /** FLOAT */
  80382. static readonly TEXTURETYPE_FLOAT: number;
  80383. /** HALF_FLOAT */
  80384. static readonly TEXTURETYPE_HALF_FLOAT: number;
  80385. /** BYTE */
  80386. static readonly TEXTURETYPE_BYTE: number;
  80387. /** SHORT */
  80388. static readonly TEXTURETYPE_SHORT: number;
  80389. /** UNSIGNED_SHORT */
  80390. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  80391. /** INT */
  80392. static readonly TEXTURETYPE_INT: number;
  80393. /** UNSIGNED_INT */
  80394. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  80395. /** UNSIGNED_SHORT_4_4_4_4 */
  80396. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  80397. /** UNSIGNED_SHORT_5_5_5_1 */
  80398. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  80399. /** UNSIGNED_SHORT_5_6_5 */
  80400. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  80401. /** UNSIGNED_INT_2_10_10_10_REV */
  80402. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  80403. /** UNSIGNED_INT_24_8 */
  80404. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  80405. /** UNSIGNED_INT_10F_11F_11F_REV */
  80406. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  80407. /** UNSIGNED_INT_5_9_9_9_REV */
  80408. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  80409. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  80410. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  80411. /** nearest is mag = nearest and min = nearest and no mip */
  80412. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  80413. /** mag = nearest and min = nearest and mip = none */
  80414. static readonly TEXTURE_NEAREST_NEAREST: number;
  80415. /** Bilinear is mag = linear and min = linear and no mip */
  80416. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  80417. /** mag = linear and min = linear and mip = none */
  80418. static readonly TEXTURE_LINEAR_LINEAR: number;
  80419. /** Trilinear is mag = linear and min = linear and mip = linear */
  80420. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  80421. /** Trilinear is mag = linear and min = linear and mip = linear */
  80422. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  80423. /** mag = nearest and min = nearest and mip = nearest */
  80424. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  80425. /** mag = nearest and min = linear and mip = nearest */
  80426. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  80427. /** mag = nearest and min = linear and mip = linear */
  80428. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  80429. /** mag = nearest and min = linear and mip = none */
  80430. static readonly TEXTURE_NEAREST_LINEAR: number;
  80431. /** nearest is mag = nearest and min = nearest and mip = linear */
  80432. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  80433. /** mag = linear and min = nearest and mip = nearest */
  80434. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  80435. /** mag = linear and min = nearest and mip = linear */
  80436. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  80437. /** Bilinear is mag = linear and min = linear and mip = nearest */
  80438. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  80439. /** mag = linear and min = nearest and mip = none */
  80440. static readonly TEXTURE_LINEAR_NEAREST: number;
  80441. /** Explicit coordinates mode */
  80442. static readonly TEXTURE_EXPLICIT_MODE: number;
  80443. /** Spherical coordinates mode */
  80444. static readonly TEXTURE_SPHERICAL_MODE: number;
  80445. /** Planar coordinates mode */
  80446. static readonly TEXTURE_PLANAR_MODE: number;
  80447. /** Cubic coordinates mode */
  80448. static readonly TEXTURE_CUBIC_MODE: number;
  80449. /** Projection coordinates mode */
  80450. static readonly TEXTURE_PROJECTION_MODE: number;
  80451. /** Skybox coordinates mode */
  80452. static readonly TEXTURE_SKYBOX_MODE: number;
  80453. /** Inverse Cubic coordinates mode */
  80454. static readonly TEXTURE_INVCUBIC_MODE: number;
  80455. /** Equirectangular coordinates mode */
  80456. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  80457. /** Equirectangular Fixed coordinates mode */
  80458. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  80459. /** Equirectangular Fixed Mirrored coordinates mode */
  80460. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  80461. /** Offline (baking) quality for texture filtering */
  80462. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  80463. /** High quality for texture filtering */
  80464. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  80465. /** Medium quality for texture filtering */
  80466. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  80467. /** Low quality for texture filtering */
  80468. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  80469. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  80470. static readonly SCALEMODE_FLOOR: number;
  80471. /** Defines that texture rescaling will look for the nearest power of 2 size */
  80472. static readonly SCALEMODE_NEAREST: number;
  80473. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  80474. static readonly SCALEMODE_CEILING: number;
  80475. /**
  80476. * The dirty texture flag value
  80477. */
  80478. static readonly MATERIAL_TextureDirtyFlag: number;
  80479. /**
  80480. * The dirty light flag value
  80481. */
  80482. static readonly MATERIAL_LightDirtyFlag: number;
  80483. /**
  80484. * The dirty fresnel flag value
  80485. */
  80486. static readonly MATERIAL_FresnelDirtyFlag: number;
  80487. /**
  80488. * The dirty attribute flag value
  80489. */
  80490. static readonly MATERIAL_AttributesDirtyFlag: number;
  80491. /**
  80492. * The dirty misc flag value
  80493. */
  80494. static readonly MATERIAL_MiscDirtyFlag: number;
  80495. /**
  80496. * The all dirty flag value
  80497. */
  80498. static readonly MATERIAL_AllDirtyFlag: number;
  80499. /**
  80500. * Returns the triangle fill mode
  80501. */
  80502. static readonly MATERIAL_TriangleFillMode: number;
  80503. /**
  80504. * Returns the wireframe mode
  80505. */
  80506. static readonly MATERIAL_WireFrameFillMode: number;
  80507. /**
  80508. * Returns the point fill mode
  80509. */
  80510. static readonly MATERIAL_PointFillMode: number;
  80511. /**
  80512. * Returns the point list draw mode
  80513. */
  80514. static readonly MATERIAL_PointListDrawMode: number;
  80515. /**
  80516. * Returns the line list draw mode
  80517. */
  80518. static readonly MATERIAL_LineListDrawMode: number;
  80519. /**
  80520. * Returns the line loop draw mode
  80521. */
  80522. static readonly MATERIAL_LineLoopDrawMode: number;
  80523. /**
  80524. * Returns the line strip draw mode
  80525. */
  80526. static readonly MATERIAL_LineStripDrawMode: number;
  80527. /**
  80528. * Returns the triangle strip draw mode
  80529. */
  80530. static readonly MATERIAL_TriangleStripDrawMode: number;
  80531. /**
  80532. * Returns the triangle fan draw mode
  80533. */
  80534. static readonly MATERIAL_TriangleFanDrawMode: number;
  80535. /**
  80536. * Stores the clock-wise side orientation
  80537. */
  80538. static readonly MATERIAL_ClockWiseSideOrientation: number;
  80539. /**
  80540. * Stores the counter clock-wise side orientation
  80541. */
  80542. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  80543. /**
  80544. * Nothing
  80545. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80546. */
  80547. static readonly ACTION_NothingTrigger: number;
  80548. /**
  80549. * On pick
  80550. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80551. */
  80552. static readonly ACTION_OnPickTrigger: number;
  80553. /**
  80554. * On left pick
  80555. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80556. */
  80557. static readonly ACTION_OnLeftPickTrigger: number;
  80558. /**
  80559. * On right pick
  80560. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80561. */
  80562. static readonly ACTION_OnRightPickTrigger: number;
  80563. /**
  80564. * On center pick
  80565. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80566. */
  80567. static readonly ACTION_OnCenterPickTrigger: number;
  80568. /**
  80569. * On pick down
  80570. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80571. */
  80572. static readonly ACTION_OnPickDownTrigger: number;
  80573. /**
  80574. * On double pick
  80575. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80576. */
  80577. static readonly ACTION_OnDoublePickTrigger: number;
  80578. /**
  80579. * On pick up
  80580. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80581. */
  80582. static readonly ACTION_OnPickUpTrigger: number;
  80583. /**
  80584. * On pick out.
  80585. * This trigger will only be raised if you also declared a OnPickDown
  80586. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80587. */
  80588. static readonly ACTION_OnPickOutTrigger: number;
  80589. /**
  80590. * On long press
  80591. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80592. */
  80593. static readonly ACTION_OnLongPressTrigger: number;
  80594. /**
  80595. * On pointer over
  80596. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80597. */
  80598. static readonly ACTION_OnPointerOverTrigger: number;
  80599. /**
  80600. * On pointer out
  80601. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80602. */
  80603. static readonly ACTION_OnPointerOutTrigger: number;
  80604. /**
  80605. * On every frame
  80606. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80607. */
  80608. static readonly ACTION_OnEveryFrameTrigger: number;
  80609. /**
  80610. * On intersection enter
  80611. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80612. */
  80613. static readonly ACTION_OnIntersectionEnterTrigger: number;
  80614. /**
  80615. * On intersection exit
  80616. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80617. */
  80618. static readonly ACTION_OnIntersectionExitTrigger: number;
  80619. /**
  80620. * On key down
  80621. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80622. */
  80623. static readonly ACTION_OnKeyDownTrigger: number;
  80624. /**
  80625. * On key up
  80626. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80627. */
  80628. static readonly ACTION_OnKeyUpTrigger: number;
  80629. /**
  80630. * Billboard mode will only apply to Y axis
  80631. */
  80632. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  80633. /**
  80634. * Billboard mode will apply to all axes
  80635. */
  80636. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  80637. /**
  80638. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80639. */
  80640. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  80641. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  80642. * Test order :
  80643. * Is the bounding sphere outside the frustum ?
  80644. * If not, are the bounding box vertices outside the frustum ?
  80645. * It not, then the cullable object is in the frustum.
  80646. */
  80647. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  80648. /** Culling strategy : Bounding Sphere Only.
  80649. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  80650. * It's also less accurate than the standard because some not visible objects can still be selected.
  80651. * Test : is the bounding sphere outside the frustum ?
  80652. * If not, then the cullable object is in the frustum.
  80653. */
  80654. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  80655. /** Culling strategy : Optimistic Inclusion.
  80656. * This in an inclusion test first, then the standard exclusion test.
  80657. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  80658. * 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.
  80659. * Anyway, it's as accurate as the standard strategy.
  80660. * Test :
  80661. * Is the cullable object bounding sphere center in the frustum ?
  80662. * If not, apply the default culling strategy.
  80663. */
  80664. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  80665. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  80666. * This in an inclusion test first, then the bounding sphere only exclusion test.
  80667. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  80668. * 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.
  80669. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  80670. * Test :
  80671. * Is the cullable object bounding sphere center in the frustum ?
  80672. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  80673. */
  80674. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  80675. /**
  80676. * No logging while loading
  80677. */
  80678. static readonly SCENELOADER_NO_LOGGING: number;
  80679. /**
  80680. * Minimal logging while loading
  80681. */
  80682. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  80683. /**
  80684. * Summary logging while loading
  80685. */
  80686. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  80687. /**
  80688. * Detailled logging while loading
  80689. */
  80690. static readonly SCENELOADER_DETAILED_LOGGING: number;
  80691. /**
  80692. * Prepass texture index for color
  80693. */
  80694. static readonly PREPASS_COLOR_INDEX: number;
  80695. /**
  80696. * Prepass texture index for irradiance
  80697. */
  80698. static readonly PREPASS_IRRADIANCE_INDEX: number;
  80699. /**
  80700. * Prepass texture index for depth + normal
  80701. */
  80702. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  80703. /**
  80704. * Prepass texture index for albedo
  80705. */
  80706. static readonly PREPASS_ALBEDO_INDEX: number;
  80707. }
  80708. }
  80709. declare module BABYLON {
  80710. /**
  80711. * This represents the required contract to create a new type of texture loader.
  80712. */
  80713. export interface IInternalTextureLoader {
  80714. /**
  80715. * Defines wether the loader supports cascade loading the different faces.
  80716. */
  80717. supportCascades: boolean;
  80718. /**
  80719. * This returns if the loader support the current file information.
  80720. * @param extension defines the file extension of the file being loaded
  80721. * @param mimeType defines the optional mime type of the file being loaded
  80722. * @returns true if the loader can load the specified file
  80723. */
  80724. canLoad(extension: string, mimeType?: string): boolean;
  80725. /**
  80726. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  80727. * @param data contains the texture data
  80728. * @param texture defines the BabylonJS internal texture
  80729. * @param createPolynomials will be true if polynomials have been requested
  80730. * @param onLoad defines the callback to trigger once the texture is ready
  80731. * @param onError defines the callback to trigger in case of error
  80732. */
  80733. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  80734. /**
  80735. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  80736. * @param data contains the texture data
  80737. * @param texture defines the BabylonJS internal texture
  80738. * @param callback defines the method to call once ready to upload
  80739. */
  80740. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  80741. }
  80742. }
  80743. declare module BABYLON {
  80744. /**
  80745. * Class used to store and describe the pipeline context associated with an effect
  80746. */
  80747. export interface IPipelineContext {
  80748. /**
  80749. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  80750. */
  80751. isAsync: boolean;
  80752. /**
  80753. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  80754. */
  80755. isReady: boolean;
  80756. /** @hidden */
  80757. _getVertexShaderCode(): string | null;
  80758. /** @hidden */
  80759. _getFragmentShaderCode(): string | null;
  80760. /** @hidden */
  80761. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  80762. }
  80763. }
  80764. declare module BABYLON {
  80765. /**
  80766. * Class used to store gfx data (like WebGLBuffer)
  80767. */
  80768. export class DataBuffer {
  80769. /**
  80770. * Gets or sets the number of objects referencing this buffer
  80771. */
  80772. references: number;
  80773. /** Gets or sets the size of the underlying buffer */
  80774. capacity: number;
  80775. /**
  80776. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  80777. */
  80778. is32Bits: boolean;
  80779. /**
  80780. * Gets the underlying buffer
  80781. */
  80782. get underlyingResource(): any;
  80783. }
  80784. }
  80785. declare module BABYLON {
  80786. /** @hidden */
  80787. export interface IShaderProcessor {
  80788. attributeProcessor?: (attribute: string) => string;
  80789. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  80790. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  80791. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  80792. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  80793. lineProcessor?: (line: string, isFragment: boolean) => string;
  80794. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80795. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80796. }
  80797. }
  80798. declare module BABYLON {
  80799. /** @hidden */
  80800. export interface ProcessingOptions {
  80801. defines: string[];
  80802. indexParameters: any;
  80803. isFragment: boolean;
  80804. shouldUseHighPrecisionShader: boolean;
  80805. supportsUniformBuffers: boolean;
  80806. shadersRepository: string;
  80807. includesShadersStore: {
  80808. [key: string]: string;
  80809. };
  80810. processor?: IShaderProcessor;
  80811. version: string;
  80812. platformName: string;
  80813. lookForClosingBracketForUniformBuffer?: boolean;
  80814. }
  80815. }
  80816. declare module BABYLON {
  80817. /** @hidden */
  80818. export class ShaderCodeNode {
  80819. line: string;
  80820. children: ShaderCodeNode[];
  80821. additionalDefineKey?: string;
  80822. additionalDefineValue?: string;
  80823. isValid(preprocessors: {
  80824. [key: string]: string;
  80825. }): boolean;
  80826. process(preprocessors: {
  80827. [key: string]: string;
  80828. }, options: ProcessingOptions): string;
  80829. }
  80830. }
  80831. declare module BABYLON {
  80832. /** @hidden */
  80833. export class ShaderCodeCursor {
  80834. private _lines;
  80835. lineIndex: number;
  80836. get currentLine(): string;
  80837. get canRead(): boolean;
  80838. set lines(value: string[]);
  80839. }
  80840. }
  80841. declare module BABYLON {
  80842. /** @hidden */
  80843. export class ShaderCodeConditionNode extends ShaderCodeNode {
  80844. process(preprocessors: {
  80845. [key: string]: string;
  80846. }, options: ProcessingOptions): string;
  80847. }
  80848. }
  80849. declare module BABYLON {
  80850. /** @hidden */
  80851. export class ShaderDefineExpression {
  80852. isTrue(preprocessors: {
  80853. [key: string]: string;
  80854. }): boolean;
  80855. private static _OperatorPriority;
  80856. private static _Stack;
  80857. static postfixToInfix(postfix: string[]): string;
  80858. static infixToPostfix(infix: string): string[];
  80859. }
  80860. }
  80861. declare module BABYLON {
  80862. /** @hidden */
  80863. export class ShaderCodeTestNode extends ShaderCodeNode {
  80864. testExpression: ShaderDefineExpression;
  80865. isValid(preprocessors: {
  80866. [key: string]: string;
  80867. }): boolean;
  80868. }
  80869. }
  80870. declare module BABYLON {
  80871. /** @hidden */
  80872. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  80873. define: string;
  80874. not: boolean;
  80875. constructor(define: string, not?: boolean);
  80876. isTrue(preprocessors: {
  80877. [key: string]: string;
  80878. }): boolean;
  80879. }
  80880. }
  80881. declare module BABYLON {
  80882. /** @hidden */
  80883. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  80884. leftOperand: ShaderDefineExpression;
  80885. rightOperand: ShaderDefineExpression;
  80886. isTrue(preprocessors: {
  80887. [key: string]: string;
  80888. }): boolean;
  80889. }
  80890. }
  80891. declare module BABYLON {
  80892. /** @hidden */
  80893. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  80894. leftOperand: ShaderDefineExpression;
  80895. rightOperand: ShaderDefineExpression;
  80896. isTrue(preprocessors: {
  80897. [key: string]: string;
  80898. }): boolean;
  80899. }
  80900. }
  80901. declare module BABYLON {
  80902. /** @hidden */
  80903. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  80904. define: string;
  80905. operand: string;
  80906. testValue: string;
  80907. constructor(define: string, operand: string, testValue: string);
  80908. isTrue(preprocessors: {
  80909. [key: string]: string;
  80910. }): boolean;
  80911. }
  80912. }
  80913. declare module BABYLON {
  80914. /**
  80915. * Class used to enable access to offline support
  80916. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  80917. */
  80918. export interface IOfflineProvider {
  80919. /**
  80920. * Gets a boolean indicating if scene must be saved in the database
  80921. */
  80922. enableSceneOffline: boolean;
  80923. /**
  80924. * Gets a boolean indicating if textures must be saved in the database
  80925. */
  80926. enableTexturesOffline: boolean;
  80927. /**
  80928. * Open the offline support and make it available
  80929. * @param successCallback defines the callback to call on success
  80930. * @param errorCallback defines the callback to call on error
  80931. */
  80932. open(successCallback: () => void, errorCallback: () => void): void;
  80933. /**
  80934. * Loads an image from the offline support
  80935. * @param url defines the url to load from
  80936. * @param image defines the target DOM image
  80937. */
  80938. loadImage(url: string, image: HTMLImageElement): void;
  80939. /**
  80940. * Loads a file from offline support
  80941. * @param url defines the URL to load from
  80942. * @param sceneLoaded defines a callback to call on success
  80943. * @param progressCallBack defines a callback to call when progress changed
  80944. * @param errorCallback defines a callback to call on error
  80945. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  80946. */
  80947. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  80948. }
  80949. }
  80950. declare module BABYLON {
  80951. /**
  80952. * Class used to help managing file picking and drag'n'drop
  80953. * File Storage
  80954. */
  80955. export class FilesInputStore {
  80956. /**
  80957. * List of files ready to be loaded
  80958. */
  80959. static FilesToLoad: {
  80960. [key: string]: File;
  80961. };
  80962. }
  80963. }
  80964. declare module BABYLON {
  80965. /**
  80966. * Class used to define a retry strategy when error happens while loading assets
  80967. */
  80968. export class RetryStrategy {
  80969. /**
  80970. * Function used to defines an exponential back off strategy
  80971. * @param maxRetries defines the maximum number of retries (3 by default)
  80972. * @param baseInterval defines the interval between retries
  80973. * @returns the strategy function to use
  80974. */
  80975. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  80976. }
  80977. }
  80978. declare module BABYLON {
  80979. /**
  80980. * @ignore
  80981. * Application error to support additional information when loading a file
  80982. */
  80983. export abstract class BaseError extends Error {
  80984. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  80985. }
  80986. }
  80987. declare module BABYLON {
  80988. /** @ignore */
  80989. export class LoadFileError extends BaseError {
  80990. request?: WebRequest;
  80991. file?: File;
  80992. /**
  80993. * Creates a new LoadFileError
  80994. * @param message defines the message of the error
  80995. * @param request defines the optional web request
  80996. * @param file defines the optional file
  80997. */
  80998. constructor(message: string, object?: WebRequest | File);
  80999. }
  81000. /** @ignore */
  81001. export class RequestFileError extends BaseError {
  81002. request: WebRequest;
  81003. /**
  81004. * Creates a new LoadFileError
  81005. * @param message defines the message of the error
  81006. * @param request defines the optional web request
  81007. */
  81008. constructor(message: string, request: WebRequest);
  81009. }
  81010. /** @ignore */
  81011. export class ReadFileError extends BaseError {
  81012. file: File;
  81013. /**
  81014. * Creates a new ReadFileError
  81015. * @param message defines the message of the error
  81016. * @param file defines the optional file
  81017. */
  81018. constructor(message: string, file: File);
  81019. }
  81020. /**
  81021. * @hidden
  81022. */
  81023. export class FileTools {
  81024. /**
  81025. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  81026. */
  81027. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  81028. /**
  81029. * Gets or sets the base URL to use to load assets
  81030. */
  81031. static BaseUrl: string;
  81032. /**
  81033. * Default behaviour for cors in the application.
  81034. * It can be a string if the expected behavior is identical in the entire app.
  81035. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  81036. */
  81037. static CorsBehavior: string | ((url: string | string[]) => string);
  81038. /**
  81039. * Gets or sets a function used to pre-process url before using them to load assets
  81040. */
  81041. static PreprocessUrl: (url: string) => string;
  81042. /**
  81043. * Removes unwanted characters from an url
  81044. * @param url defines the url to clean
  81045. * @returns the cleaned url
  81046. */
  81047. private static _CleanUrl;
  81048. /**
  81049. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  81050. * @param url define the url we are trying
  81051. * @param element define the dom element where to configure the cors policy
  81052. */
  81053. static SetCorsBehavior(url: string | string[], element: {
  81054. crossOrigin: string | null;
  81055. }): void;
  81056. /**
  81057. * Loads an image as an HTMLImageElement.
  81058. * @param input url string, ArrayBuffer, or Blob to load
  81059. * @param onLoad callback called when the image successfully loads
  81060. * @param onError callback called when the image fails to load
  81061. * @param offlineProvider offline provider for caching
  81062. * @param mimeType optional mime type
  81063. * @returns the HTMLImageElement of the loaded image
  81064. */
  81065. 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>;
  81066. /**
  81067. * Reads a file from a File object
  81068. * @param file defines the file to load
  81069. * @param onSuccess defines the callback to call when data is loaded
  81070. * @param onProgress defines the callback to call during loading process
  81071. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  81072. * @param onError defines the callback to call when an error occurs
  81073. * @returns a file request object
  81074. */
  81075. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  81076. /**
  81077. * Loads a file from a url
  81078. * @param url url to load
  81079. * @param onSuccess callback called when the file successfully loads
  81080. * @param onProgress callback called while file is loading (if the server supports this mode)
  81081. * @param offlineProvider defines the offline provider for caching
  81082. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81083. * @param onError callback called when the file fails to load
  81084. * @returns a file request object
  81085. */
  81086. 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;
  81087. /**
  81088. * Loads a file
  81089. * @param url url to load
  81090. * @param onSuccess callback called when the file successfully loads
  81091. * @param onProgress callback called while file is loading (if the server supports this mode)
  81092. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81093. * @param onError callback called when the file fails to load
  81094. * @param onOpened callback called when the web request is opened
  81095. * @returns a file request object
  81096. */
  81097. 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;
  81098. /**
  81099. * Checks if the loaded document was accessed via `file:`-Protocol.
  81100. * @returns boolean
  81101. */
  81102. static IsFileURL(): boolean;
  81103. }
  81104. }
  81105. declare module BABYLON {
  81106. /** @hidden */
  81107. export class ShaderProcessor {
  81108. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  81109. private static _ProcessPrecision;
  81110. private static _ExtractOperation;
  81111. private static _BuildSubExpression;
  81112. private static _BuildExpression;
  81113. private static _MoveCursorWithinIf;
  81114. private static _MoveCursor;
  81115. private static _EvaluatePreProcessors;
  81116. private static _PreparePreProcessors;
  81117. private static _ProcessShaderConversion;
  81118. private static _ProcessIncludes;
  81119. /**
  81120. * Loads a file from a url
  81121. * @param url url to load
  81122. * @param onSuccess callback called when the file successfully loads
  81123. * @param onProgress callback called while file is loading (if the server supports this mode)
  81124. * @param offlineProvider defines the offline provider for caching
  81125. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81126. * @param onError callback called when the file fails to load
  81127. * @returns a file request object
  81128. * @hidden
  81129. */
  81130. 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;
  81131. }
  81132. }
  81133. declare module BABYLON {
  81134. /**
  81135. * @hidden
  81136. */
  81137. export interface IColor4Like {
  81138. r: float;
  81139. g: float;
  81140. b: float;
  81141. a: float;
  81142. }
  81143. /**
  81144. * @hidden
  81145. */
  81146. export interface IColor3Like {
  81147. r: float;
  81148. g: float;
  81149. b: float;
  81150. }
  81151. /**
  81152. * @hidden
  81153. */
  81154. export interface IVector4Like {
  81155. x: float;
  81156. y: float;
  81157. z: float;
  81158. w: float;
  81159. }
  81160. /**
  81161. * @hidden
  81162. */
  81163. export interface IVector3Like {
  81164. x: float;
  81165. y: float;
  81166. z: float;
  81167. }
  81168. /**
  81169. * @hidden
  81170. */
  81171. export interface IVector2Like {
  81172. x: float;
  81173. y: float;
  81174. }
  81175. /**
  81176. * @hidden
  81177. */
  81178. export interface IMatrixLike {
  81179. toArray(): DeepImmutable<Float32Array | Array<number>>;
  81180. updateFlag: int;
  81181. }
  81182. /**
  81183. * @hidden
  81184. */
  81185. export interface IViewportLike {
  81186. x: float;
  81187. y: float;
  81188. width: float;
  81189. height: float;
  81190. }
  81191. /**
  81192. * @hidden
  81193. */
  81194. export interface IPlaneLike {
  81195. normal: IVector3Like;
  81196. d: float;
  81197. normalize(): void;
  81198. }
  81199. }
  81200. declare module BABYLON {
  81201. /**
  81202. * Interface used to define common properties for effect fallbacks
  81203. */
  81204. export interface IEffectFallbacks {
  81205. /**
  81206. * Removes the defines that should be removed when falling back.
  81207. * @param currentDefines defines the current define statements for the shader.
  81208. * @param effect defines the current effect we try to compile
  81209. * @returns The resulting defines with defines of the current rank removed.
  81210. */
  81211. reduce(currentDefines: string, effect: Effect): string;
  81212. /**
  81213. * Removes the fallback from the bound mesh.
  81214. */
  81215. unBindMesh(): void;
  81216. /**
  81217. * Checks to see if more fallbacks are still availible.
  81218. */
  81219. hasMoreFallbacks: boolean;
  81220. }
  81221. }
  81222. declare module BABYLON {
  81223. /**
  81224. * Class used to evalaute queries containing `and` and `or` operators
  81225. */
  81226. export class AndOrNotEvaluator {
  81227. /**
  81228. * Evaluate a query
  81229. * @param query defines the query to evaluate
  81230. * @param evaluateCallback defines the callback used to filter result
  81231. * @returns true if the query matches
  81232. */
  81233. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  81234. private static _HandleParenthesisContent;
  81235. private static _SimplifyNegation;
  81236. }
  81237. }
  81238. declare module BABYLON {
  81239. /**
  81240. * Class used to store custom tags
  81241. */
  81242. export class Tags {
  81243. /**
  81244. * Adds support for tags on the given object
  81245. * @param obj defines the object to use
  81246. */
  81247. static EnableFor(obj: any): void;
  81248. /**
  81249. * Removes tags support
  81250. * @param obj defines the object to use
  81251. */
  81252. static DisableFor(obj: any): void;
  81253. /**
  81254. * Gets a boolean indicating if the given object has tags
  81255. * @param obj defines the object to use
  81256. * @returns a boolean
  81257. */
  81258. static HasTags(obj: any): boolean;
  81259. /**
  81260. * Gets the tags available on a given object
  81261. * @param obj defines the object to use
  81262. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81263. * @returns the tags
  81264. */
  81265. static GetTags(obj: any, asString?: boolean): any;
  81266. /**
  81267. * Adds tags to an object
  81268. * @param obj defines the object to use
  81269. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81270. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81271. */
  81272. static AddTagsTo(obj: any, tagsString: string): void;
  81273. /**
  81274. * @hidden
  81275. */
  81276. static _AddTagTo(obj: any, tag: string): void;
  81277. /**
  81278. * Removes specific tags from a specific object
  81279. * @param obj defines the object to use
  81280. * @param tagsString defines the tags to remove
  81281. */
  81282. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81283. /**
  81284. * @hidden
  81285. */
  81286. static _RemoveTagFrom(obj: any, tag: string): void;
  81287. /**
  81288. * Defines if tags hosted on an object match a given query
  81289. * @param obj defines the object to use
  81290. * @param tagsQuery defines the tag query
  81291. * @returns a boolean
  81292. */
  81293. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81294. }
  81295. }
  81296. declare module BABYLON {
  81297. /**
  81298. * Scalar computation library
  81299. */
  81300. export class Scalar {
  81301. /**
  81302. * Two pi constants convenient for computation.
  81303. */
  81304. static TwoPi: number;
  81305. /**
  81306. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81307. * @param a number
  81308. * @param b number
  81309. * @param epsilon (default = 1.401298E-45)
  81310. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81311. */
  81312. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81313. /**
  81314. * Returns a string : the upper case translation of the number i to hexadecimal.
  81315. * @param i number
  81316. * @returns the upper case translation of the number i to hexadecimal.
  81317. */
  81318. static ToHex(i: number): string;
  81319. /**
  81320. * Returns -1 if value is negative and +1 is value is positive.
  81321. * @param value the value
  81322. * @returns the value itself if it's equal to zero.
  81323. */
  81324. static Sign(value: number): number;
  81325. /**
  81326. * Returns the value itself if it's between min and max.
  81327. * Returns min if the value is lower than min.
  81328. * Returns max if the value is greater than max.
  81329. * @param value the value to clmap
  81330. * @param min the min value to clamp to (default: 0)
  81331. * @param max the max value to clamp to (default: 1)
  81332. * @returns the clamped value
  81333. */
  81334. static Clamp(value: number, min?: number, max?: number): number;
  81335. /**
  81336. * the log2 of value.
  81337. * @param value the value to compute log2 of
  81338. * @returns the log2 of value.
  81339. */
  81340. static Log2(value: number): number;
  81341. /**
  81342. * Loops the value, so that it is never larger than length and never smaller than 0.
  81343. *
  81344. * This is similar to the modulo operator but it works with floating point numbers.
  81345. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81346. * With t = 5 and length = 2.5, the result would be 0.0.
  81347. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  81348. * @param value the value
  81349. * @param length the length
  81350. * @returns the looped value
  81351. */
  81352. static Repeat(value: number, length: number): number;
  81353. /**
  81354. * Normalize the value between 0.0 and 1.0 using min and max values
  81355. * @param value value to normalize
  81356. * @param min max to normalize between
  81357. * @param max min to normalize between
  81358. * @returns the normalized value
  81359. */
  81360. static Normalize(value: number, min: number, max: number): number;
  81361. /**
  81362. * Denormalize the value from 0.0 and 1.0 using min and max values
  81363. * @param normalized value to denormalize
  81364. * @param min max to denormalize between
  81365. * @param max min to denormalize between
  81366. * @returns the denormalized value
  81367. */
  81368. static Denormalize(normalized: number, min: number, max: number): number;
  81369. /**
  81370. * Calculates the shortest difference between two given angles given in degrees.
  81371. * @param current current angle in degrees
  81372. * @param target target angle in degrees
  81373. * @returns the delta
  81374. */
  81375. static DeltaAngle(current: number, target: number): number;
  81376. /**
  81377. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  81378. * @param tx value
  81379. * @param length length
  81380. * @returns The returned value will move back and forth between 0 and length
  81381. */
  81382. static PingPong(tx: number, length: number): number;
  81383. /**
  81384. * Interpolates between min and max with smoothing at the limits.
  81385. *
  81386. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  81387. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  81388. * @param from from
  81389. * @param to to
  81390. * @param tx value
  81391. * @returns the smooth stepped value
  81392. */
  81393. static SmoothStep(from: number, to: number, tx: number): number;
  81394. /**
  81395. * Moves a value current towards target.
  81396. *
  81397. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  81398. * Negative values of maxDelta pushes the value away from target.
  81399. * @param current current value
  81400. * @param target target value
  81401. * @param maxDelta max distance to move
  81402. * @returns resulting value
  81403. */
  81404. static MoveTowards(current: number, target: number, maxDelta: number): number;
  81405. /**
  81406. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81407. *
  81408. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  81409. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  81410. * @param current current value
  81411. * @param target target value
  81412. * @param maxDelta max distance to move
  81413. * @returns resulting angle
  81414. */
  81415. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  81416. /**
  81417. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  81418. * @param start start value
  81419. * @param end target value
  81420. * @param amount amount to lerp between
  81421. * @returns the lerped value
  81422. */
  81423. static Lerp(start: number, end: number, amount: number): number;
  81424. /**
  81425. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81426. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  81427. * @param start start value
  81428. * @param end target value
  81429. * @param amount amount to lerp between
  81430. * @returns the lerped value
  81431. */
  81432. static LerpAngle(start: number, end: number, amount: number): number;
  81433. /**
  81434. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  81435. * @param a start value
  81436. * @param b target value
  81437. * @param value value between a and b
  81438. * @returns the inverseLerp value
  81439. */
  81440. static InverseLerp(a: number, b: number, value: number): number;
  81441. /**
  81442. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  81443. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  81444. * @param value1 spline value
  81445. * @param tangent1 spline value
  81446. * @param value2 spline value
  81447. * @param tangent2 spline value
  81448. * @param amount input value
  81449. * @returns hermite result
  81450. */
  81451. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  81452. /**
  81453. * Returns a random float number between and min and max values
  81454. * @param min min value of random
  81455. * @param max max value of random
  81456. * @returns random value
  81457. */
  81458. static RandomRange(min: number, max: number): number;
  81459. /**
  81460. * This function returns percentage of a number in a given range.
  81461. *
  81462. * RangeToPercent(40,20,60) will return 0.5 (50%)
  81463. * RangeToPercent(34,0,100) will return 0.34 (34%)
  81464. * @param number to convert to percentage
  81465. * @param min min range
  81466. * @param max max range
  81467. * @returns the percentage
  81468. */
  81469. static RangeToPercent(number: number, min: number, max: number): number;
  81470. /**
  81471. * This function returns number that corresponds to the percentage in a given range.
  81472. *
  81473. * PercentToRange(0.34,0,100) will return 34.
  81474. * @param percent to convert to number
  81475. * @param min min range
  81476. * @param max max range
  81477. * @returns the number
  81478. */
  81479. static PercentToRange(percent: number, min: number, max: number): number;
  81480. /**
  81481. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  81482. * @param angle The angle to normalize in radian.
  81483. * @return The converted angle.
  81484. */
  81485. static NormalizeRadians(angle: number): number;
  81486. }
  81487. }
  81488. declare module BABYLON {
  81489. /**
  81490. * Constant used to convert a value to gamma space
  81491. * @ignorenaming
  81492. */
  81493. export const ToGammaSpace: number;
  81494. /**
  81495. * Constant used to convert a value to linear space
  81496. * @ignorenaming
  81497. */
  81498. export const ToLinearSpace = 2.2;
  81499. /**
  81500. * Constant used to define the minimal number value in Babylon.js
  81501. * @ignorenaming
  81502. */
  81503. let Epsilon: number;
  81504. }
  81505. declare module BABYLON {
  81506. /**
  81507. * Class used to represent a viewport on screen
  81508. */
  81509. export class Viewport {
  81510. /** viewport left coordinate */
  81511. x: number;
  81512. /** viewport top coordinate */
  81513. y: number;
  81514. /**viewport width */
  81515. width: number;
  81516. /** viewport height */
  81517. height: number;
  81518. /**
  81519. * Creates a Viewport object located at (x, y) and sized (width, height)
  81520. * @param x defines viewport left coordinate
  81521. * @param y defines viewport top coordinate
  81522. * @param width defines the viewport width
  81523. * @param height defines the viewport height
  81524. */
  81525. constructor(
  81526. /** viewport left coordinate */
  81527. x: number,
  81528. /** viewport top coordinate */
  81529. y: number,
  81530. /**viewport width */
  81531. width: number,
  81532. /** viewport height */
  81533. height: number);
  81534. /**
  81535. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  81536. * @param renderWidth defines the rendering width
  81537. * @param renderHeight defines the rendering height
  81538. * @returns a new Viewport
  81539. */
  81540. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  81541. /**
  81542. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  81543. * @param renderWidth defines the rendering width
  81544. * @param renderHeight defines the rendering height
  81545. * @param ref defines the target viewport
  81546. * @returns the current viewport
  81547. */
  81548. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  81549. /**
  81550. * Returns a new Viewport copied from the current one
  81551. * @returns a new Viewport
  81552. */
  81553. clone(): Viewport;
  81554. }
  81555. }
  81556. declare module BABYLON {
  81557. /**
  81558. * Class containing a set of static utilities functions for arrays.
  81559. */
  81560. export class ArrayTools {
  81561. /**
  81562. * Returns an array of the given size filled with element built from the given constructor and the paramters
  81563. * @param size the number of element to construct and put in the array
  81564. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  81565. * @returns a new array filled with new objects
  81566. */
  81567. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  81568. }
  81569. }
  81570. declare module BABYLON {
  81571. /**
  81572. * Represents a plane by the equation ax + by + cz + d = 0
  81573. */
  81574. export class Plane {
  81575. private static _TmpMatrix;
  81576. /**
  81577. * Normal of the plane (a,b,c)
  81578. */
  81579. normal: Vector3;
  81580. /**
  81581. * d component of the plane
  81582. */
  81583. d: number;
  81584. /**
  81585. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  81586. * @param a a component of the plane
  81587. * @param b b component of the plane
  81588. * @param c c component of the plane
  81589. * @param d d component of the plane
  81590. */
  81591. constructor(a: number, b: number, c: number, d: number);
  81592. /**
  81593. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  81594. */
  81595. asArray(): number[];
  81596. /**
  81597. * @returns a new plane copied from the current Plane.
  81598. */
  81599. clone(): Plane;
  81600. /**
  81601. * @returns the string "Plane".
  81602. */
  81603. getClassName(): string;
  81604. /**
  81605. * @returns the Plane hash code.
  81606. */
  81607. getHashCode(): number;
  81608. /**
  81609. * Normalize the current Plane in place.
  81610. * @returns the updated Plane.
  81611. */
  81612. normalize(): Plane;
  81613. /**
  81614. * Applies a transformation the plane and returns the result
  81615. * @param transformation the transformation matrix to be applied to the plane
  81616. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  81617. */
  81618. transform(transformation: DeepImmutable<Matrix>): Plane;
  81619. /**
  81620. * Compute the dot product between the point and the plane normal
  81621. * @param point point to calculate the dot product with
  81622. * @returns the dot product (float) of the point coordinates and the plane normal.
  81623. */
  81624. dotCoordinate(point: DeepImmutable<Vector3>): number;
  81625. /**
  81626. * Updates the current Plane from the plane defined by the three given points.
  81627. * @param point1 one of the points used to contruct the plane
  81628. * @param point2 one of the points used to contruct the plane
  81629. * @param point3 one of the points used to contruct the plane
  81630. * @returns the updated Plane.
  81631. */
  81632. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81633. /**
  81634. * Checks if the plane is facing a given direction
  81635. * @param direction the direction to check if the plane is facing
  81636. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  81637. * @returns True is the vector "direction" is the same side than the plane normal.
  81638. */
  81639. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  81640. /**
  81641. * Calculates the distance to a point
  81642. * @param point point to calculate distance to
  81643. * @returns the signed distance (float) from the given point to the Plane.
  81644. */
  81645. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  81646. /**
  81647. * Creates a plane from an array
  81648. * @param array the array to create a plane from
  81649. * @returns a new Plane from the given array.
  81650. */
  81651. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  81652. /**
  81653. * Creates a plane from three points
  81654. * @param point1 point used to create the plane
  81655. * @param point2 point used to create the plane
  81656. * @param point3 point used to create the plane
  81657. * @returns a new Plane defined by the three given points.
  81658. */
  81659. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81660. /**
  81661. * Creates a plane from an origin point and a normal
  81662. * @param origin origin of the plane to be constructed
  81663. * @param normal normal of the plane to be constructed
  81664. * @returns a new Plane the normal vector to this plane at the given origin point.
  81665. * Note : the vector "normal" is updated because normalized.
  81666. */
  81667. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  81668. /**
  81669. * Calculates the distance from a plane and a point
  81670. * @param origin origin of the plane to be constructed
  81671. * @param normal normal of the plane to be constructed
  81672. * @param point point to calculate distance to
  81673. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  81674. */
  81675. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  81676. }
  81677. }
  81678. declare module BABYLON {
  81679. /** @hidden */
  81680. export class PerformanceConfigurator {
  81681. /** @hidden */
  81682. static MatrixUse64Bits: boolean;
  81683. /** @hidden */
  81684. static MatrixTrackPrecisionChange: boolean;
  81685. /** @hidden */
  81686. static MatrixCurrentType: any;
  81687. /** @hidden */
  81688. static MatrixTrackedMatrices: Array<any> | null;
  81689. /** @hidden */
  81690. static SetMatrixPrecision(use64bits: boolean): void;
  81691. }
  81692. }
  81693. declare module BABYLON {
  81694. /**
  81695. * Class representing a vector containing 2 coordinates
  81696. */
  81697. export class Vector2 {
  81698. /** defines the first coordinate */
  81699. x: number;
  81700. /** defines the second coordinate */
  81701. y: number;
  81702. /**
  81703. * Creates a new Vector2 from the given x and y coordinates
  81704. * @param x defines the first coordinate
  81705. * @param y defines the second coordinate
  81706. */
  81707. constructor(
  81708. /** defines the first coordinate */
  81709. x?: number,
  81710. /** defines the second coordinate */
  81711. y?: number);
  81712. /**
  81713. * Gets a string with the Vector2 coordinates
  81714. * @returns a string with the Vector2 coordinates
  81715. */
  81716. toString(): string;
  81717. /**
  81718. * Gets class name
  81719. * @returns the string "Vector2"
  81720. */
  81721. getClassName(): string;
  81722. /**
  81723. * Gets current vector hash code
  81724. * @returns the Vector2 hash code as a number
  81725. */
  81726. getHashCode(): number;
  81727. /**
  81728. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  81729. * @param array defines the source array
  81730. * @param index defines the offset in source array
  81731. * @returns the current Vector2
  81732. */
  81733. toArray(array: FloatArray, index?: number): Vector2;
  81734. /**
  81735. * Update the current vector from an array
  81736. * @param array defines the destination array
  81737. * @param index defines the offset in the destination array
  81738. * @returns the current Vector3
  81739. */
  81740. fromArray(array: FloatArray, index?: number): Vector2;
  81741. /**
  81742. * Copy the current vector to an array
  81743. * @returns a new array with 2 elements: the Vector2 coordinates.
  81744. */
  81745. asArray(): number[];
  81746. /**
  81747. * Sets the Vector2 coordinates with the given Vector2 coordinates
  81748. * @param source defines the source Vector2
  81749. * @returns the current updated Vector2
  81750. */
  81751. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  81752. /**
  81753. * Sets the Vector2 coordinates with the given floats
  81754. * @param x defines the first coordinate
  81755. * @param y defines the second coordinate
  81756. * @returns the current updated Vector2
  81757. */
  81758. copyFromFloats(x: number, y: number): Vector2;
  81759. /**
  81760. * Sets the Vector2 coordinates with the given floats
  81761. * @param x defines the first coordinate
  81762. * @param y defines the second coordinate
  81763. * @returns the current updated Vector2
  81764. */
  81765. set(x: number, y: number): Vector2;
  81766. /**
  81767. * Add another vector with the current one
  81768. * @param otherVector defines the other vector
  81769. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  81770. */
  81771. add(otherVector: DeepImmutable<Vector2>): Vector2;
  81772. /**
  81773. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  81774. * @param otherVector defines the other vector
  81775. * @param result defines the target vector
  81776. * @returns the unmodified current Vector2
  81777. */
  81778. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81779. /**
  81780. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  81781. * @param otherVector defines the other vector
  81782. * @returns the current updated Vector2
  81783. */
  81784. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81785. /**
  81786. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  81787. * @param otherVector defines the other vector
  81788. * @returns a new Vector2
  81789. */
  81790. addVector3(otherVector: Vector3): Vector2;
  81791. /**
  81792. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  81793. * @param otherVector defines the other vector
  81794. * @returns a new Vector2
  81795. */
  81796. subtract(otherVector: Vector2): Vector2;
  81797. /**
  81798. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  81799. * @param otherVector defines the other vector
  81800. * @param result defines the target vector
  81801. * @returns the unmodified current Vector2
  81802. */
  81803. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81804. /**
  81805. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  81806. * @param otherVector defines the other vector
  81807. * @returns the current updated Vector2
  81808. */
  81809. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81810. /**
  81811. * Multiplies in place the current Vector2 coordinates by the given ones
  81812. * @param otherVector defines the other vector
  81813. * @returns the current updated Vector2
  81814. */
  81815. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81816. /**
  81817. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  81818. * @param otherVector defines the other vector
  81819. * @returns a new Vector2
  81820. */
  81821. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  81822. /**
  81823. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  81824. * @param otherVector defines the other vector
  81825. * @param result defines the target vector
  81826. * @returns the unmodified current Vector2
  81827. */
  81828. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81829. /**
  81830. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  81831. * @param x defines the first coordinate
  81832. * @param y defines the second coordinate
  81833. * @returns a new Vector2
  81834. */
  81835. multiplyByFloats(x: number, y: number): Vector2;
  81836. /**
  81837. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  81838. * @param otherVector defines the other vector
  81839. * @returns a new Vector2
  81840. */
  81841. divide(otherVector: Vector2): Vector2;
  81842. /**
  81843. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  81844. * @param otherVector defines the other vector
  81845. * @param result defines the target vector
  81846. * @returns the unmodified current Vector2
  81847. */
  81848. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81849. /**
  81850. * Divides the current Vector2 coordinates by the given ones
  81851. * @param otherVector defines the other vector
  81852. * @returns the current updated Vector2
  81853. */
  81854. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81855. /**
  81856. * Gets a new Vector2 with current Vector2 negated coordinates
  81857. * @returns a new Vector2
  81858. */
  81859. negate(): Vector2;
  81860. /**
  81861. * Negate this vector in place
  81862. * @returns this
  81863. */
  81864. negateInPlace(): Vector2;
  81865. /**
  81866. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  81867. * @param result defines the Vector3 object where to store the result
  81868. * @returns the current Vector2
  81869. */
  81870. negateToRef(result: Vector2): Vector2;
  81871. /**
  81872. * Multiply the Vector2 coordinates by scale
  81873. * @param scale defines the scaling factor
  81874. * @returns the current updated Vector2
  81875. */
  81876. scaleInPlace(scale: number): Vector2;
  81877. /**
  81878. * Returns a new Vector2 scaled by "scale" from the current Vector2
  81879. * @param scale defines the scaling factor
  81880. * @returns a new Vector2
  81881. */
  81882. scale(scale: number): Vector2;
  81883. /**
  81884. * Scale the current Vector2 values by a factor to a given Vector2
  81885. * @param scale defines the scale factor
  81886. * @param result defines the Vector2 object where to store the result
  81887. * @returns the unmodified current Vector2
  81888. */
  81889. scaleToRef(scale: number, result: Vector2): Vector2;
  81890. /**
  81891. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  81892. * @param scale defines the scale factor
  81893. * @param result defines the Vector2 object where to store the result
  81894. * @returns the unmodified current Vector2
  81895. */
  81896. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  81897. /**
  81898. * Gets a boolean if two vectors are equals
  81899. * @param otherVector defines the other vector
  81900. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  81901. */
  81902. equals(otherVector: DeepImmutable<Vector2>): boolean;
  81903. /**
  81904. * Gets a boolean if two vectors are equals (using an epsilon value)
  81905. * @param otherVector defines the other vector
  81906. * @param epsilon defines the minimal distance to consider equality
  81907. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  81908. */
  81909. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  81910. /**
  81911. * Gets a new Vector2 from current Vector2 floored values
  81912. * @returns a new Vector2
  81913. */
  81914. floor(): Vector2;
  81915. /**
  81916. * Gets a new Vector2 from current Vector2 floored values
  81917. * @returns a new Vector2
  81918. */
  81919. fract(): Vector2;
  81920. /**
  81921. * Gets the length of the vector
  81922. * @returns the vector length (float)
  81923. */
  81924. length(): number;
  81925. /**
  81926. * Gets the vector squared length
  81927. * @returns the vector squared length (float)
  81928. */
  81929. lengthSquared(): number;
  81930. /**
  81931. * Normalize the vector
  81932. * @returns the current updated Vector2
  81933. */
  81934. normalize(): Vector2;
  81935. /**
  81936. * Gets a new Vector2 copied from the Vector2
  81937. * @returns a new Vector2
  81938. */
  81939. clone(): Vector2;
  81940. /**
  81941. * Gets a new Vector2(0, 0)
  81942. * @returns a new Vector2
  81943. */
  81944. static Zero(): Vector2;
  81945. /**
  81946. * Gets a new Vector2(1, 1)
  81947. * @returns a new Vector2
  81948. */
  81949. static One(): Vector2;
  81950. /**
  81951. * Gets a new Vector2 set from the given index element of the given array
  81952. * @param array defines the data source
  81953. * @param offset defines the offset in the data source
  81954. * @returns a new Vector2
  81955. */
  81956. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  81957. /**
  81958. * Sets "result" from the given index element of the given array
  81959. * @param array defines the data source
  81960. * @param offset defines the offset in the data source
  81961. * @param result defines the target vector
  81962. */
  81963. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  81964. /**
  81965. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  81966. * @param value1 defines 1st point of control
  81967. * @param value2 defines 2nd point of control
  81968. * @param value3 defines 3rd point of control
  81969. * @param value4 defines 4th point of control
  81970. * @param amount defines the interpolation factor
  81971. * @returns a new Vector2
  81972. */
  81973. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  81974. /**
  81975. * 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".
  81976. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  81977. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  81978. * @param value defines the value to clamp
  81979. * @param min defines the lower limit
  81980. * @param max defines the upper limit
  81981. * @returns a new Vector2
  81982. */
  81983. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  81984. /**
  81985. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  81986. * @param value1 defines the 1st control point
  81987. * @param tangent1 defines the outgoing tangent
  81988. * @param value2 defines the 2nd control point
  81989. * @param tangent2 defines the incoming tangent
  81990. * @param amount defines the interpolation factor
  81991. * @returns a new Vector2
  81992. */
  81993. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  81994. /**
  81995. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  81996. * @param start defines the start vector
  81997. * @param end defines the end vector
  81998. * @param amount defines the interpolation factor
  81999. * @returns a new Vector2
  82000. */
  82001. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  82002. /**
  82003. * Gets the dot product of the vector "left" and the vector "right"
  82004. * @param left defines first vector
  82005. * @param right defines second vector
  82006. * @returns the dot product (float)
  82007. */
  82008. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  82009. /**
  82010. * Returns a new Vector2 equal to the normalized given vector
  82011. * @param vector defines the vector to normalize
  82012. * @returns a new Vector2
  82013. */
  82014. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  82015. /**
  82016. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  82017. * @param left defines 1st vector
  82018. * @param right defines 2nd vector
  82019. * @returns a new Vector2
  82020. */
  82021. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82022. /**
  82023. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  82024. * @param left defines 1st vector
  82025. * @param right defines 2nd vector
  82026. * @returns a new Vector2
  82027. */
  82028. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82029. /**
  82030. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  82031. * @param vector defines the vector to transform
  82032. * @param transformation defines the matrix to apply
  82033. * @returns a new Vector2
  82034. */
  82035. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  82036. /**
  82037. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  82038. * @param vector defines the vector to transform
  82039. * @param transformation defines the matrix to apply
  82040. * @param result defines the target vector
  82041. */
  82042. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  82043. /**
  82044. * Determines if a given vector is included in a triangle
  82045. * @param p defines the vector to test
  82046. * @param p0 defines 1st triangle point
  82047. * @param p1 defines 2nd triangle point
  82048. * @param p2 defines 3rd triangle point
  82049. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  82050. */
  82051. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  82052. /**
  82053. * Gets the distance between the vectors "value1" and "value2"
  82054. * @param value1 defines first vector
  82055. * @param value2 defines second vector
  82056. * @returns the distance between vectors
  82057. */
  82058. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82059. /**
  82060. * Returns the squared distance between the vectors "value1" and "value2"
  82061. * @param value1 defines first vector
  82062. * @param value2 defines second vector
  82063. * @returns the squared distance between vectors
  82064. */
  82065. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82066. /**
  82067. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  82068. * @param value1 defines first vector
  82069. * @param value2 defines second vector
  82070. * @returns a new Vector2
  82071. */
  82072. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  82073. /**
  82074. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  82075. * @param p defines the middle point
  82076. * @param segA defines one point of the segment
  82077. * @param segB defines the other point of the segment
  82078. * @returns the shortest distance
  82079. */
  82080. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  82081. }
  82082. /**
  82083. * Class used to store (x,y,z) vector representation
  82084. * A Vector3 is the main object used in 3D geometry
  82085. * It can represent etiher the coordinates of a point the space, either a direction
  82086. * Reminder: js uses a left handed forward facing system
  82087. */
  82088. export class Vector3 {
  82089. private static _UpReadOnly;
  82090. private static _ZeroReadOnly;
  82091. /** @hidden */
  82092. _x: number;
  82093. /** @hidden */
  82094. _y: number;
  82095. /** @hidden */
  82096. _z: number;
  82097. /** @hidden */
  82098. _isDirty: boolean;
  82099. /** Gets or sets the x coordinate */
  82100. get x(): number;
  82101. set x(value: number);
  82102. /** Gets or sets the y coordinate */
  82103. get y(): number;
  82104. set y(value: number);
  82105. /** Gets or sets the z coordinate */
  82106. get z(): number;
  82107. set z(value: number);
  82108. /**
  82109. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  82110. * @param x defines the first coordinates (on X axis)
  82111. * @param y defines the second coordinates (on Y axis)
  82112. * @param z defines the third coordinates (on Z axis)
  82113. */
  82114. constructor(x?: number, y?: number, z?: number);
  82115. /**
  82116. * Creates a string representation of the Vector3
  82117. * @returns a string with the Vector3 coordinates.
  82118. */
  82119. toString(): string;
  82120. /**
  82121. * Gets the class name
  82122. * @returns the string "Vector3"
  82123. */
  82124. getClassName(): string;
  82125. /**
  82126. * Creates the Vector3 hash code
  82127. * @returns a number which tends to be unique between Vector3 instances
  82128. */
  82129. getHashCode(): number;
  82130. /**
  82131. * Creates an array containing three elements : the coordinates of the Vector3
  82132. * @returns a new array of numbers
  82133. */
  82134. asArray(): number[];
  82135. /**
  82136. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  82137. * @param array defines the destination array
  82138. * @param index defines the offset in the destination array
  82139. * @returns the current Vector3
  82140. */
  82141. toArray(array: FloatArray, index?: number): Vector3;
  82142. /**
  82143. * Update the current vector from an array
  82144. * @param array defines the destination array
  82145. * @param index defines the offset in the destination array
  82146. * @returns the current Vector3
  82147. */
  82148. fromArray(array: FloatArray, index?: number): Vector3;
  82149. /**
  82150. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  82151. * @returns a new Quaternion object, computed from the Vector3 coordinates
  82152. */
  82153. toQuaternion(): Quaternion;
  82154. /**
  82155. * Adds the given vector to the current Vector3
  82156. * @param otherVector defines the second operand
  82157. * @returns the current updated Vector3
  82158. */
  82159. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82160. /**
  82161. * Adds the given coordinates to the current Vector3
  82162. * @param x defines the x coordinate of the operand
  82163. * @param y defines the y coordinate of the operand
  82164. * @param z defines the z coordinate of the operand
  82165. * @returns the current updated Vector3
  82166. */
  82167. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82168. /**
  82169. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  82170. * @param otherVector defines the second operand
  82171. * @returns the resulting Vector3
  82172. */
  82173. add(otherVector: DeepImmutable<Vector3>): Vector3;
  82174. /**
  82175. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  82176. * @param otherVector defines the second operand
  82177. * @param result defines the Vector3 object where to store the result
  82178. * @returns the current Vector3
  82179. */
  82180. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82181. /**
  82182. * Subtract the given vector from the current Vector3
  82183. * @param otherVector defines the second operand
  82184. * @returns the current updated Vector3
  82185. */
  82186. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82187. /**
  82188. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  82189. * @param otherVector defines the second operand
  82190. * @returns the resulting Vector3
  82191. */
  82192. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  82193. /**
  82194. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  82195. * @param otherVector defines the second operand
  82196. * @param result defines the Vector3 object where to store the result
  82197. * @returns the current Vector3
  82198. */
  82199. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82200. /**
  82201. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  82202. * @param x defines the x coordinate of the operand
  82203. * @param y defines the y coordinate of the operand
  82204. * @param z defines the z coordinate of the operand
  82205. * @returns the resulting Vector3
  82206. */
  82207. subtractFromFloats(x: number, y: number, z: number): Vector3;
  82208. /**
  82209. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  82210. * @param x defines the x coordinate of the operand
  82211. * @param y defines the y coordinate of the operand
  82212. * @param z defines the z coordinate of the operand
  82213. * @param result defines the Vector3 object where to store the result
  82214. * @returns the current Vector3
  82215. */
  82216. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  82217. /**
  82218. * Gets a new Vector3 set with the current Vector3 negated coordinates
  82219. * @returns a new Vector3
  82220. */
  82221. negate(): Vector3;
  82222. /**
  82223. * Negate this vector in place
  82224. * @returns this
  82225. */
  82226. negateInPlace(): Vector3;
  82227. /**
  82228. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  82229. * @param result defines the Vector3 object where to store the result
  82230. * @returns the current Vector3
  82231. */
  82232. negateToRef(result: Vector3): Vector3;
  82233. /**
  82234. * Multiplies the Vector3 coordinates by the float "scale"
  82235. * @param scale defines the multiplier factor
  82236. * @returns the current updated Vector3
  82237. */
  82238. scaleInPlace(scale: number): Vector3;
  82239. /**
  82240. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  82241. * @param scale defines the multiplier factor
  82242. * @returns a new Vector3
  82243. */
  82244. scale(scale: number): Vector3;
  82245. /**
  82246. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  82247. * @param scale defines the multiplier factor
  82248. * @param result defines the Vector3 object where to store the result
  82249. * @returns the current Vector3
  82250. */
  82251. scaleToRef(scale: number, result: Vector3): Vector3;
  82252. /**
  82253. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  82254. * @param scale defines the scale factor
  82255. * @param result defines the Vector3 object where to store the result
  82256. * @returns the unmodified current Vector3
  82257. */
  82258. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  82259. /**
  82260. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82261. * @param origin defines the origin of the projection ray
  82262. * @param plane defines the plane to project to
  82263. * @returns the projected vector3
  82264. */
  82265. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82266. /**
  82267. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82268. * @param origin defines the origin of the projection ray
  82269. * @param plane defines the plane to project to
  82270. * @param result defines the Vector3 where to store the result
  82271. */
  82272. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82273. /**
  82274. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82275. * @param otherVector defines the second operand
  82276. * @returns true if both vectors are equals
  82277. */
  82278. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82279. /**
  82280. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82281. * @param otherVector defines the second operand
  82282. * @param epsilon defines the minimal distance to define values as equals
  82283. * @returns true if both vectors are distant less than epsilon
  82284. */
  82285. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82286. /**
  82287. * Returns true if the current Vector3 coordinates equals the given floats
  82288. * @param x defines the x coordinate of the operand
  82289. * @param y defines the y coordinate of the operand
  82290. * @param z defines the z coordinate of the operand
  82291. * @returns true if both vectors are equals
  82292. */
  82293. equalsToFloats(x: number, y: number, z: number): boolean;
  82294. /**
  82295. * Multiplies the current Vector3 coordinates by the given ones
  82296. * @param otherVector defines the second operand
  82297. * @returns the current updated Vector3
  82298. */
  82299. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82300. /**
  82301. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82302. * @param otherVector defines the second operand
  82303. * @returns the new Vector3
  82304. */
  82305. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82306. /**
  82307. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82308. * @param otherVector defines the second operand
  82309. * @param result defines the Vector3 object where to store the result
  82310. * @returns the current Vector3
  82311. */
  82312. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82313. /**
  82314. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82315. * @param x defines the x coordinate of the operand
  82316. * @param y defines the y coordinate of the operand
  82317. * @param z defines the z coordinate of the operand
  82318. * @returns the new Vector3
  82319. */
  82320. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82321. /**
  82322. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82323. * @param otherVector defines the second operand
  82324. * @returns the new Vector3
  82325. */
  82326. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82327. /**
  82328. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82329. * @param otherVector defines the second operand
  82330. * @param result defines the Vector3 object where to store the result
  82331. * @returns the current Vector3
  82332. */
  82333. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82334. /**
  82335. * Divides the current Vector3 coordinates by the given ones.
  82336. * @param otherVector defines the second operand
  82337. * @returns the current updated Vector3
  82338. */
  82339. divideInPlace(otherVector: Vector3): Vector3;
  82340. /**
  82341. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  82342. * @param other defines the second operand
  82343. * @returns the current updated Vector3
  82344. */
  82345. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82346. /**
  82347. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  82348. * @param other defines the second operand
  82349. * @returns the current updated Vector3
  82350. */
  82351. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82352. /**
  82353. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  82354. * @param x defines the x coordinate of the operand
  82355. * @param y defines the y coordinate of the operand
  82356. * @param z defines the z coordinate of the operand
  82357. * @returns the current updated Vector3
  82358. */
  82359. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82360. /**
  82361. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  82362. * @param x defines the x coordinate of the operand
  82363. * @param y defines the y coordinate of the operand
  82364. * @param z defines the z coordinate of the operand
  82365. * @returns the current updated Vector3
  82366. */
  82367. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82368. /**
  82369. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  82370. * Check if is non uniform within a certain amount of decimal places to account for this
  82371. * @param epsilon the amount the values can differ
  82372. * @returns if the the vector is non uniform to a certain number of decimal places
  82373. */
  82374. isNonUniformWithinEpsilon(epsilon: number): boolean;
  82375. /**
  82376. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  82377. */
  82378. get isNonUniform(): boolean;
  82379. /**
  82380. * Gets a new Vector3 from current Vector3 floored values
  82381. * @returns a new Vector3
  82382. */
  82383. floor(): Vector3;
  82384. /**
  82385. * Gets a new Vector3 from current Vector3 floored values
  82386. * @returns a new Vector3
  82387. */
  82388. fract(): Vector3;
  82389. /**
  82390. * Gets the length of the Vector3
  82391. * @returns the length of the Vector3
  82392. */
  82393. length(): number;
  82394. /**
  82395. * Gets the squared length of the Vector3
  82396. * @returns squared length of the Vector3
  82397. */
  82398. lengthSquared(): number;
  82399. /**
  82400. * Normalize the current Vector3.
  82401. * Please note that this is an in place operation.
  82402. * @returns the current updated Vector3
  82403. */
  82404. normalize(): Vector3;
  82405. /**
  82406. * Reorders the x y z properties of the vector in place
  82407. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  82408. * @returns the current updated vector
  82409. */
  82410. reorderInPlace(order: string): this;
  82411. /**
  82412. * Rotates the vector around 0,0,0 by a quaternion
  82413. * @param quaternion the rotation quaternion
  82414. * @param result vector to store the result
  82415. * @returns the resulting vector
  82416. */
  82417. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  82418. /**
  82419. * Rotates a vector around a given point
  82420. * @param quaternion the rotation quaternion
  82421. * @param point the point to rotate around
  82422. * @param result vector to store the result
  82423. * @returns the resulting vector
  82424. */
  82425. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  82426. /**
  82427. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  82428. * The cross product is then orthogonal to both current and "other"
  82429. * @param other defines the right operand
  82430. * @returns the cross product
  82431. */
  82432. cross(other: Vector3): Vector3;
  82433. /**
  82434. * Normalize the current Vector3 with the given input length.
  82435. * Please note that this is an in place operation.
  82436. * @param len the length of the vector
  82437. * @returns the current updated Vector3
  82438. */
  82439. normalizeFromLength(len: number): Vector3;
  82440. /**
  82441. * Normalize the current Vector3 to a new vector
  82442. * @returns the new Vector3
  82443. */
  82444. normalizeToNew(): Vector3;
  82445. /**
  82446. * Normalize the current Vector3 to the reference
  82447. * @param reference define the Vector3 to update
  82448. * @returns the updated Vector3
  82449. */
  82450. normalizeToRef(reference: Vector3): Vector3;
  82451. /**
  82452. * Creates a new Vector3 copied from the current Vector3
  82453. * @returns the new Vector3
  82454. */
  82455. clone(): Vector3;
  82456. /**
  82457. * Copies the given vector coordinates to the current Vector3 ones
  82458. * @param source defines the source Vector3
  82459. * @returns the current updated Vector3
  82460. */
  82461. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  82462. /**
  82463. * Copies the given floats to the current Vector3 coordinates
  82464. * @param x defines the x coordinate of the operand
  82465. * @param y defines the y coordinate of the operand
  82466. * @param z defines the z coordinate of the operand
  82467. * @returns the current updated Vector3
  82468. */
  82469. copyFromFloats(x: number, y: number, z: number): Vector3;
  82470. /**
  82471. * Copies the given floats to the current Vector3 coordinates
  82472. * @param x defines the x coordinate of the operand
  82473. * @param y defines the y coordinate of the operand
  82474. * @param z defines the z coordinate of the operand
  82475. * @returns the current updated Vector3
  82476. */
  82477. set(x: number, y: number, z: number): Vector3;
  82478. /**
  82479. * Copies the given float to the current Vector3 coordinates
  82480. * @param v defines the x, y and z coordinates of the operand
  82481. * @returns the current updated Vector3
  82482. */
  82483. setAll(v: number): Vector3;
  82484. /**
  82485. * Get the clip factor between two vectors
  82486. * @param vector0 defines the first operand
  82487. * @param vector1 defines the second operand
  82488. * @param axis defines the axis to use
  82489. * @param size defines the size along the axis
  82490. * @returns the clip factor
  82491. */
  82492. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  82493. /**
  82494. * Get angle between two vectors
  82495. * @param vector0 angle between vector0 and vector1
  82496. * @param vector1 angle between vector0 and vector1
  82497. * @param normal direction of the normal
  82498. * @return the angle between vector0 and vector1
  82499. */
  82500. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  82501. /**
  82502. * Returns a new Vector3 set from the index "offset" of the given array
  82503. * @param array defines the source array
  82504. * @param offset defines the offset in the source array
  82505. * @returns the new Vector3
  82506. */
  82507. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  82508. /**
  82509. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  82510. * @param array defines the source array
  82511. * @param offset defines the offset in the source array
  82512. * @returns the new Vector3
  82513. * @deprecated Please use FromArray instead.
  82514. */
  82515. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  82516. /**
  82517. * Sets the given vector "result" with the element values from the index "offset" of the given array
  82518. * @param array defines the source array
  82519. * @param offset defines the offset in the source array
  82520. * @param result defines the Vector3 where to store the result
  82521. */
  82522. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  82523. /**
  82524. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  82525. * @param array defines the source array
  82526. * @param offset defines the offset in the source array
  82527. * @param result defines the Vector3 where to store the result
  82528. * @deprecated Please use FromArrayToRef instead.
  82529. */
  82530. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  82531. /**
  82532. * Sets the given vector "result" with the given floats.
  82533. * @param x defines the x coordinate of the source
  82534. * @param y defines the y coordinate of the source
  82535. * @param z defines the z coordinate of the source
  82536. * @param result defines the Vector3 where to store the result
  82537. */
  82538. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  82539. /**
  82540. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  82541. * @returns a new empty Vector3
  82542. */
  82543. static Zero(): Vector3;
  82544. /**
  82545. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  82546. * @returns a new unit Vector3
  82547. */
  82548. static One(): Vector3;
  82549. /**
  82550. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  82551. * @returns a new up Vector3
  82552. */
  82553. static Up(): Vector3;
  82554. /**
  82555. * Gets a up Vector3 that must not be updated
  82556. */
  82557. static get UpReadOnly(): DeepImmutable<Vector3>;
  82558. /**
  82559. * Gets a zero Vector3 that must not be updated
  82560. */
  82561. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  82562. /**
  82563. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  82564. * @returns a new down Vector3
  82565. */
  82566. static Down(): Vector3;
  82567. /**
  82568. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  82569. * @param rightHandedSystem is the scene right-handed (negative z)
  82570. * @returns a new forward Vector3
  82571. */
  82572. static Forward(rightHandedSystem?: boolean): Vector3;
  82573. /**
  82574. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  82575. * @param rightHandedSystem is the scene right-handed (negative-z)
  82576. * @returns a new forward Vector3
  82577. */
  82578. static Backward(rightHandedSystem?: boolean): Vector3;
  82579. /**
  82580. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  82581. * @returns a new right Vector3
  82582. */
  82583. static Right(): Vector3;
  82584. /**
  82585. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  82586. * @returns a new left Vector3
  82587. */
  82588. static Left(): Vector3;
  82589. /**
  82590. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  82591. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82592. * @param vector defines the Vector3 to transform
  82593. * @param transformation defines the transformation matrix
  82594. * @returns the transformed Vector3
  82595. */
  82596. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82597. /**
  82598. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  82599. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82600. * @param vector defines the Vector3 to transform
  82601. * @param transformation defines the transformation matrix
  82602. * @param result defines the Vector3 where to store the result
  82603. */
  82604. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82605. /**
  82606. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  82607. * This method computes tranformed coordinates only, not transformed direction vectors
  82608. * @param x define the x coordinate of the source vector
  82609. * @param y define the y coordinate of the source vector
  82610. * @param z define the z coordinate of the source vector
  82611. * @param transformation defines the transformation matrix
  82612. * @param result defines the Vector3 where to store the result
  82613. */
  82614. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82615. /**
  82616. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  82617. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82618. * @param vector defines the Vector3 to transform
  82619. * @param transformation defines the transformation matrix
  82620. * @returns the new Vector3
  82621. */
  82622. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82623. /**
  82624. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  82625. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82626. * @param vector defines the Vector3 to transform
  82627. * @param transformation defines the transformation matrix
  82628. * @param result defines the Vector3 where to store the result
  82629. */
  82630. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82631. /**
  82632. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  82633. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82634. * @param x define the x coordinate of the source vector
  82635. * @param y define the y coordinate of the source vector
  82636. * @param z define the z coordinate of the source vector
  82637. * @param transformation defines the transformation matrix
  82638. * @param result defines the Vector3 where to store the result
  82639. */
  82640. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82641. /**
  82642. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  82643. * @param value1 defines the first control point
  82644. * @param value2 defines the second control point
  82645. * @param value3 defines the third control point
  82646. * @param value4 defines the fourth control point
  82647. * @param amount defines the amount on the spline to use
  82648. * @returns the new Vector3
  82649. */
  82650. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  82651. /**
  82652. * 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"
  82653. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82654. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82655. * @param value defines the current value
  82656. * @param min defines the lower range value
  82657. * @param max defines the upper range value
  82658. * @returns the new Vector3
  82659. */
  82660. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  82661. /**
  82662. * 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"
  82663. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82664. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82665. * @param value defines the current value
  82666. * @param min defines the lower range value
  82667. * @param max defines the upper range value
  82668. * @param result defines the Vector3 where to store the result
  82669. */
  82670. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  82671. /**
  82672. * Checks if a given vector is inside a specific range
  82673. * @param v defines the vector to test
  82674. * @param min defines the minimum range
  82675. * @param max defines the maximum range
  82676. */
  82677. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  82678. /**
  82679. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  82680. * @param value1 defines the first control point
  82681. * @param tangent1 defines the first tangent vector
  82682. * @param value2 defines the second control point
  82683. * @param tangent2 defines the second tangent vector
  82684. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  82685. * @returns the new Vector3
  82686. */
  82687. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  82688. /**
  82689. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  82690. * @param start defines the start value
  82691. * @param end defines the end value
  82692. * @param amount max defines amount between both (between 0 and 1)
  82693. * @returns the new Vector3
  82694. */
  82695. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  82696. /**
  82697. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  82698. * @param start defines the start value
  82699. * @param end defines the end value
  82700. * @param amount max defines amount between both (between 0 and 1)
  82701. * @param result defines the Vector3 where to store the result
  82702. */
  82703. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  82704. /**
  82705. * Returns the dot product (float) between the vectors "left" and "right"
  82706. * @param left defines the left operand
  82707. * @param right defines the right operand
  82708. * @returns the dot product
  82709. */
  82710. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  82711. /**
  82712. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  82713. * The cross product is then orthogonal to both "left" and "right"
  82714. * @param left defines the left operand
  82715. * @param right defines the right operand
  82716. * @returns the cross product
  82717. */
  82718. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82719. /**
  82720. * Sets the given vector "result" with the cross product of "left" and "right"
  82721. * The cross product is then orthogonal to both "left" and "right"
  82722. * @param left defines the left operand
  82723. * @param right defines the right operand
  82724. * @param result defines the Vector3 where to store the result
  82725. */
  82726. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  82727. /**
  82728. * Returns a new Vector3 as the normalization of the given vector
  82729. * @param vector defines the Vector3 to normalize
  82730. * @returns the new Vector3
  82731. */
  82732. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  82733. /**
  82734. * Sets the given vector "result" with the normalization of the given first vector
  82735. * @param vector defines the Vector3 to normalize
  82736. * @param result defines the Vector3 where to store the result
  82737. */
  82738. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  82739. /**
  82740. * Project a Vector3 onto screen space
  82741. * @param vector defines the Vector3 to project
  82742. * @param world defines the world matrix to use
  82743. * @param transform defines the transform (view x projection) matrix to use
  82744. * @param viewport defines the screen viewport to use
  82745. * @returns the new Vector3
  82746. */
  82747. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  82748. /** @hidden */
  82749. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  82750. /**
  82751. * Unproject from screen space to object space
  82752. * @param source defines the screen space Vector3 to use
  82753. * @param viewportWidth defines the current width of the viewport
  82754. * @param viewportHeight defines the current height of the viewport
  82755. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82756. * @param transform defines the transform (view x projection) matrix to use
  82757. * @returns the new Vector3
  82758. */
  82759. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  82760. /**
  82761. * Unproject from screen space to object space
  82762. * @param source defines the screen space Vector3 to use
  82763. * @param viewportWidth defines the current width of the viewport
  82764. * @param viewportHeight defines the current height of the viewport
  82765. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82766. * @param view defines the view matrix to use
  82767. * @param projection defines the projection matrix to use
  82768. * @returns the new Vector3
  82769. */
  82770. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  82771. /**
  82772. * Unproject from screen space to object space
  82773. * @param source defines the screen space Vector3 to use
  82774. * @param viewportWidth defines the current width of the viewport
  82775. * @param viewportHeight defines the current height of the viewport
  82776. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82777. * @param view defines the view matrix to use
  82778. * @param projection defines the projection matrix to use
  82779. * @param result defines the Vector3 where to store the result
  82780. */
  82781. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82782. /**
  82783. * Unproject from screen space to object space
  82784. * @param sourceX defines the screen space x coordinate to use
  82785. * @param sourceY defines the screen space y coordinate to use
  82786. * @param sourceZ defines the screen space z coordinate to use
  82787. * @param viewportWidth defines the current width of the viewport
  82788. * @param viewportHeight defines the current height of the viewport
  82789. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82790. * @param view defines the view matrix to use
  82791. * @param projection defines the projection matrix to use
  82792. * @param result defines the Vector3 where to store the result
  82793. */
  82794. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82795. /**
  82796. * Gets the minimal coordinate values between two Vector3
  82797. * @param left defines the first operand
  82798. * @param right defines the second operand
  82799. * @returns the new Vector3
  82800. */
  82801. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82802. /**
  82803. * Gets the maximal coordinate values between two Vector3
  82804. * @param left defines the first operand
  82805. * @param right defines the second operand
  82806. * @returns the new Vector3
  82807. */
  82808. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82809. /**
  82810. * Returns the distance between the vectors "value1" and "value2"
  82811. * @param value1 defines the first operand
  82812. * @param value2 defines the second operand
  82813. * @returns the distance
  82814. */
  82815. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82816. /**
  82817. * Returns the squared distance between the vectors "value1" and "value2"
  82818. * @param value1 defines the first operand
  82819. * @param value2 defines the second operand
  82820. * @returns the squared distance
  82821. */
  82822. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82823. /**
  82824. * Returns a new Vector3 located at the center between "value1" and "value2"
  82825. * @param value1 defines the first operand
  82826. * @param value2 defines the second operand
  82827. * @returns the new Vector3
  82828. */
  82829. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  82830. /**
  82831. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  82832. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  82833. * to something in order to rotate it from its local system to the given target system
  82834. * Note: axis1, axis2 and axis3 are normalized during this operation
  82835. * @param axis1 defines the first axis
  82836. * @param axis2 defines the second axis
  82837. * @param axis3 defines the third axis
  82838. * @returns a new Vector3
  82839. */
  82840. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  82841. /**
  82842. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  82843. * @param axis1 defines the first axis
  82844. * @param axis2 defines the second axis
  82845. * @param axis3 defines the third axis
  82846. * @param ref defines the Vector3 where to store the result
  82847. */
  82848. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  82849. }
  82850. /**
  82851. * Vector4 class created for EulerAngle class conversion to Quaternion
  82852. */
  82853. export class Vector4 {
  82854. /** x value of the vector */
  82855. x: number;
  82856. /** y value of the vector */
  82857. y: number;
  82858. /** z value of the vector */
  82859. z: number;
  82860. /** w value of the vector */
  82861. w: number;
  82862. /**
  82863. * Creates a Vector4 object from the given floats.
  82864. * @param x x value of the vector
  82865. * @param y y value of the vector
  82866. * @param z z value of the vector
  82867. * @param w w value of the vector
  82868. */
  82869. constructor(
  82870. /** x value of the vector */
  82871. x: number,
  82872. /** y value of the vector */
  82873. y: number,
  82874. /** z value of the vector */
  82875. z: number,
  82876. /** w value of the vector */
  82877. w: number);
  82878. /**
  82879. * Returns the string with the Vector4 coordinates.
  82880. * @returns a string containing all the vector values
  82881. */
  82882. toString(): string;
  82883. /**
  82884. * Returns the string "Vector4".
  82885. * @returns "Vector4"
  82886. */
  82887. getClassName(): string;
  82888. /**
  82889. * Returns the Vector4 hash code.
  82890. * @returns a unique hash code
  82891. */
  82892. getHashCode(): number;
  82893. /**
  82894. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  82895. * @returns the resulting array
  82896. */
  82897. asArray(): number[];
  82898. /**
  82899. * Populates the given array from the given index with the Vector4 coordinates.
  82900. * @param array array to populate
  82901. * @param index index of the array to start at (default: 0)
  82902. * @returns the Vector4.
  82903. */
  82904. toArray(array: FloatArray, index?: number): Vector4;
  82905. /**
  82906. * Update the current vector from an array
  82907. * @param array defines the destination array
  82908. * @param index defines the offset in the destination array
  82909. * @returns the current Vector3
  82910. */
  82911. fromArray(array: FloatArray, index?: number): Vector4;
  82912. /**
  82913. * Adds the given vector to the current Vector4.
  82914. * @param otherVector the vector to add
  82915. * @returns the updated Vector4.
  82916. */
  82917. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82918. /**
  82919. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  82920. * @param otherVector the vector to add
  82921. * @returns the resulting vector
  82922. */
  82923. add(otherVector: DeepImmutable<Vector4>): Vector4;
  82924. /**
  82925. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  82926. * @param otherVector the vector to add
  82927. * @param result the vector to store the result
  82928. * @returns the current Vector4.
  82929. */
  82930. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82931. /**
  82932. * Subtract in place the given vector from the current Vector4.
  82933. * @param otherVector the vector to subtract
  82934. * @returns the updated Vector4.
  82935. */
  82936. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82937. /**
  82938. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  82939. * @param otherVector the vector to add
  82940. * @returns the new vector with the result
  82941. */
  82942. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  82943. /**
  82944. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  82945. * @param otherVector the vector to subtract
  82946. * @param result the vector to store the result
  82947. * @returns the current Vector4.
  82948. */
  82949. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82950. /**
  82951. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82952. */
  82953. /**
  82954. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82955. * @param x value to subtract
  82956. * @param y value to subtract
  82957. * @param z value to subtract
  82958. * @param w value to subtract
  82959. * @returns new vector containing the result
  82960. */
  82961. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82962. /**
  82963. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82964. * @param x value to subtract
  82965. * @param y value to subtract
  82966. * @param z value to subtract
  82967. * @param w value to subtract
  82968. * @param result the vector to store the result in
  82969. * @returns the current Vector4.
  82970. */
  82971. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  82972. /**
  82973. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  82974. * @returns a new vector with the negated values
  82975. */
  82976. negate(): Vector4;
  82977. /**
  82978. * Negate this vector in place
  82979. * @returns this
  82980. */
  82981. negateInPlace(): Vector4;
  82982. /**
  82983. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  82984. * @param result defines the Vector3 object where to store the result
  82985. * @returns the current Vector4
  82986. */
  82987. negateToRef(result: Vector4): Vector4;
  82988. /**
  82989. * Multiplies the current Vector4 coordinates by scale (float).
  82990. * @param scale the number to scale with
  82991. * @returns the updated Vector4.
  82992. */
  82993. scaleInPlace(scale: number): Vector4;
  82994. /**
  82995. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  82996. * @param scale the number to scale with
  82997. * @returns a new vector with the result
  82998. */
  82999. scale(scale: number): Vector4;
  83000. /**
  83001. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  83002. * @param scale the number to scale with
  83003. * @param result a vector to store the result in
  83004. * @returns the current Vector4.
  83005. */
  83006. scaleToRef(scale: number, result: Vector4): Vector4;
  83007. /**
  83008. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  83009. * @param scale defines the scale factor
  83010. * @param result defines the Vector4 object where to store the result
  83011. * @returns the unmodified current Vector4
  83012. */
  83013. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  83014. /**
  83015. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  83016. * @param otherVector the vector to compare against
  83017. * @returns true if they are equal
  83018. */
  83019. equals(otherVector: DeepImmutable<Vector4>): boolean;
  83020. /**
  83021. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  83022. * @param otherVector vector to compare against
  83023. * @param epsilon (Default: very small number)
  83024. * @returns true if they are equal
  83025. */
  83026. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  83027. /**
  83028. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  83029. * @param x x value to compare against
  83030. * @param y y value to compare against
  83031. * @param z z value to compare against
  83032. * @param w w value to compare against
  83033. * @returns true if equal
  83034. */
  83035. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  83036. /**
  83037. * Multiplies in place the current Vector4 by the given one.
  83038. * @param otherVector vector to multiple with
  83039. * @returns the updated Vector4.
  83040. */
  83041. multiplyInPlace(otherVector: Vector4): Vector4;
  83042. /**
  83043. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  83044. * @param otherVector vector to multiple with
  83045. * @returns resulting new vector
  83046. */
  83047. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  83048. /**
  83049. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  83050. * @param otherVector vector to multiple with
  83051. * @param result vector to store the result
  83052. * @returns the current Vector4.
  83053. */
  83054. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83055. /**
  83056. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  83057. * @param x x value multiply with
  83058. * @param y y value multiply with
  83059. * @param z z value multiply with
  83060. * @param w w value multiply with
  83061. * @returns resulting new vector
  83062. */
  83063. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  83064. /**
  83065. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  83066. * @param otherVector vector to devide with
  83067. * @returns resulting new vector
  83068. */
  83069. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  83070. /**
  83071. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  83072. * @param otherVector vector to devide with
  83073. * @param result vector to store the result
  83074. * @returns the current Vector4.
  83075. */
  83076. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83077. /**
  83078. * Divides the current Vector3 coordinates by the given ones.
  83079. * @param otherVector vector to devide with
  83080. * @returns the updated Vector3.
  83081. */
  83082. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83083. /**
  83084. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  83085. * @param other defines the second operand
  83086. * @returns the current updated Vector4
  83087. */
  83088. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83089. /**
  83090. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  83091. * @param other defines the second operand
  83092. * @returns the current updated Vector4
  83093. */
  83094. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83095. /**
  83096. * Gets a new Vector4 from current Vector4 floored values
  83097. * @returns a new Vector4
  83098. */
  83099. floor(): Vector4;
  83100. /**
  83101. * Gets a new Vector4 from current Vector3 floored values
  83102. * @returns a new Vector4
  83103. */
  83104. fract(): Vector4;
  83105. /**
  83106. * Returns the Vector4 length (float).
  83107. * @returns the length
  83108. */
  83109. length(): number;
  83110. /**
  83111. * Returns the Vector4 squared length (float).
  83112. * @returns the length squared
  83113. */
  83114. lengthSquared(): number;
  83115. /**
  83116. * Normalizes in place the Vector4.
  83117. * @returns the updated Vector4.
  83118. */
  83119. normalize(): Vector4;
  83120. /**
  83121. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  83122. * @returns this converted to a new vector3
  83123. */
  83124. toVector3(): Vector3;
  83125. /**
  83126. * Returns a new Vector4 copied from the current one.
  83127. * @returns the new cloned vector
  83128. */
  83129. clone(): Vector4;
  83130. /**
  83131. * Updates the current Vector4 with the given one coordinates.
  83132. * @param source the source vector to copy from
  83133. * @returns the updated Vector4.
  83134. */
  83135. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  83136. /**
  83137. * Updates the current Vector4 coordinates with the given floats.
  83138. * @param x float to copy from
  83139. * @param y float to copy from
  83140. * @param z float to copy from
  83141. * @param w float to copy from
  83142. * @returns the updated Vector4.
  83143. */
  83144. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83145. /**
  83146. * Updates the current Vector4 coordinates with the given floats.
  83147. * @param x float to set from
  83148. * @param y float to set from
  83149. * @param z float to set from
  83150. * @param w float to set from
  83151. * @returns the updated Vector4.
  83152. */
  83153. set(x: number, y: number, z: number, w: number): Vector4;
  83154. /**
  83155. * Copies the given float to the current Vector3 coordinates
  83156. * @param v defines the x, y, z and w coordinates of the operand
  83157. * @returns the current updated Vector3
  83158. */
  83159. setAll(v: number): Vector4;
  83160. /**
  83161. * Returns a new Vector4 set from the starting index of the given array.
  83162. * @param array the array to pull values from
  83163. * @param offset the offset into the array to start at
  83164. * @returns the new vector
  83165. */
  83166. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  83167. /**
  83168. * Updates the given vector "result" from the starting index of the given array.
  83169. * @param array the array to pull values from
  83170. * @param offset the offset into the array to start at
  83171. * @param result the vector to store the result in
  83172. */
  83173. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  83174. /**
  83175. * Updates the given vector "result" from the starting index of the given Float32Array.
  83176. * @param array the array to pull values from
  83177. * @param offset the offset into the array to start at
  83178. * @param result the vector to store the result in
  83179. */
  83180. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  83181. /**
  83182. * Updates the given vector "result" coordinates from the given floats.
  83183. * @param x float to set from
  83184. * @param y float to set from
  83185. * @param z float to set from
  83186. * @param w float to set from
  83187. * @param result the vector to the floats in
  83188. */
  83189. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  83190. /**
  83191. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  83192. * @returns the new vector
  83193. */
  83194. static Zero(): Vector4;
  83195. /**
  83196. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  83197. * @returns the new vector
  83198. */
  83199. static One(): Vector4;
  83200. /**
  83201. * Returns a new normalized Vector4 from the given one.
  83202. * @param vector the vector to normalize
  83203. * @returns the vector
  83204. */
  83205. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  83206. /**
  83207. * Updates the given vector "result" from the normalization of the given one.
  83208. * @param vector the vector to normalize
  83209. * @param result the vector to store the result in
  83210. */
  83211. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  83212. /**
  83213. * Returns a vector with the minimum values from the left and right vectors
  83214. * @param left left vector to minimize
  83215. * @param right right vector to minimize
  83216. * @returns a new vector with the minimum of the left and right vector values
  83217. */
  83218. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83219. /**
  83220. * Returns a vector with the maximum values from the left and right vectors
  83221. * @param left left vector to maximize
  83222. * @param right right vector to maximize
  83223. * @returns a new vector with the maximum of the left and right vector values
  83224. */
  83225. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83226. /**
  83227. * Returns the distance (float) between the vectors "value1" and "value2".
  83228. * @param value1 value to calulate the distance between
  83229. * @param value2 value to calulate the distance between
  83230. * @return the distance between the two vectors
  83231. */
  83232. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83233. /**
  83234. * Returns the squared distance (float) between the vectors "value1" and "value2".
  83235. * @param value1 value to calulate the distance between
  83236. * @param value2 value to calulate the distance between
  83237. * @return the distance between the two vectors squared
  83238. */
  83239. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83240. /**
  83241. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  83242. * @param value1 value to calulate the center between
  83243. * @param value2 value to calulate the center between
  83244. * @return the center between the two vectors
  83245. */
  83246. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  83247. /**
  83248. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  83249. * This methods computes transformed normalized direction vectors only.
  83250. * @param vector the vector to transform
  83251. * @param transformation the transformation matrix to apply
  83252. * @returns the new vector
  83253. */
  83254. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  83255. /**
  83256. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  83257. * This methods computes transformed normalized direction vectors only.
  83258. * @param vector the vector to transform
  83259. * @param transformation the transformation matrix to apply
  83260. * @param result the vector to store the result in
  83261. */
  83262. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83263. /**
  83264. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83265. * This methods computes transformed normalized direction vectors only.
  83266. * @param x value to transform
  83267. * @param y value to transform
  83268. * @param z value to transform
  83269. * @param w value to transform
  83270. * @param transformation the transformation matrix to apply
  83271. * @param result the vector to store the results in
  83272. */
  83273. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83274. /**
  83275. * Creates a new Vector4 from a Vector3
  83276. * @param source defines the source data
  83277. * @param w defines the 4th component (default is 0)
  83278. * @returns a new Vector4
  83279. */
  83280. static FromVector3(source: Vector3, w?: number): Vector4;
  83281. }
  83282. /**
  83283. * Class used to store quaternion data
  83284. * @see https://en.wikipedia.org/wiki/Quaternion
  83285. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83286. */
  83287. export class Quaternion {
  83288. /** @hidden */
  83289. _x: number;
  83290. /** @hidden */
  83291. _y: number;
  83292. /** @hidden */
  83293. _z: number;
  83294. /** @hidden */
  83295. _w: number;
  83296. /** @hidden */
  83297. _isDirty: boolean;
  83298. /** Gets or sets the x coordinate */
  83299. get x(): number;
  83300. set x(value: number);
  83301. /** Gets or sets the y coordinate */
  83302. get y(): number;
  83303. set y(value: number);
  83304. /** Gets or sets the z coordinate */
  83305. get z(): number;
  83306. set z(value: number);
  83307. /** Gets or sets the w coordinate */
  83308. get w(): number;
  83309. set w(value: number);
  83310. /**
  83311. * Creates a new Quaternion from the given floats
  83312. * @param x defines the first component (0 by default)
  83313. * @param y defines the second component (0 by default)
  83314. * @param z defines the third component (0 by default)
  83315. * @param w defines the fourth component (1.0 by default)
  83316. */
  83317. constructor(x?: number, y?: number, z?: number, w?: number);
  83318. /**
  83319. * Gets a string representation for the current quaternion
  83320. * @returns a string with the Quaternion coordinates
  83321. */
  83322. toString(): string;
  83323. /**
  83324. * Gets the class name of the quaternion
  83325. * @returns the string "Quaternion"
  83326. */
  83327. getClassName(): string;
  83328. /**
  83329. * Gets a hash code for this quaternion
  83330. * @returns the quaternion hash code
  83331. */
  83332. getHashCode(): number;
  83333. /**
  83334. * Copy the quaternion to an array
  83335. * @returns a new array populated with 4 elements from the quaternion coordinates
  83336. */
  83337. asArray(): number[];
  83338. /**
  83339. * Check if two quaternions are equals
  83340. * @param otherQuaternion defines the second operand
  83341. * @return true if the current quaternion and the given one coordinates are strictly equals
  83342. */
  83343. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83344. /**
  83345. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83346. * @param otherQuaternion defines the other quaternion
  83347. * @param epsilon defines the minimal distance to consider equality
  83348. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  83349. */
  83350. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  83351. /**
  83352. * Clone the current quaternion
  83353. * @returns a new quaternion copied from the current one
  83354. */
  83355. clone(): Quaternion;
  83356. /**
  83357. * Copy a quaternion to the current one
  83358. * @param other defines the other quaternion
  83359. * @returns the updated current quaternion
  83360. */
  83361. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  83362. /**
  83363. * Updates the current quaternion with the given float coordinates
  83364. * @param x defines the x coordinate
  83365. * @param y defines the y coordinate
  83366. * @param z defines the z coordinate
  83367. * @param w defines the w coordinate
  83368. * @returns the updated current quaternion
  83369. */
  83370. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  83371. /**
  83372. * Updates the current quaternion from the given float coordinates
  83373. * @param x defines the x coordinate
  83374. * @param y defines the y coordinate
  83375. * @param z defines the z coordinate
  83376. * @param w defines the w coordinate
  83377. * @returns the updated current quaternion
  83378. */
  83379. set(x: number, y: number, z: number, w: number): Quaternion;
  83380. /**
  83381. * Adds two quaternions
  83382. * @param other defines the second operand
  83383. * @returns a new quaternion as the addition result of the given one and the current quaternion
  83384. */
  83385. add(other: DeepImmutable<Quaternion>): Quaternion;
  83386. /**
  83387. * Add a quaternion to the current one
  83388. * @param other defines the quaternion to add
  83389. * @returns the current quaternion
  83390. */
  83391. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  83392. /**
  83393. * Subtract two quaternions
  83394. * @param other defines the second operand
  83395. * @returns a new quaternion as the subtraction result of the given one from the current one
  83396. */
  83397. subtract(other: Quaternion): Quaternion;
  83398. /**
  83399. * Multiplies the current quaternion by a scale factor
  83400. * @param value defines the scale factor
  83401. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  83402. */
  83403. scale(value: number): Quaternion;
  83404. /**
  83405. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  83406. * @param scale defines the scale factor
  83407. * @param result defines the Quaternion object where to store the result
  83408. * @returns the unmodified current quaternion
  83409. */
  83410. scaleToRef(scale: number, result: Quaternion): Quaternion;
  83411. /**
  83412. * Multiplies in place the current quaternion by a scale factor
  83413. * @param value defines the scale factor
  83414. * @returns the current modified quaternion
  83415. */
  83416. scaleInPlace(value: number): Quaternion;
  83417. /**
  83418. * Scale the current quaternion values by a factor and add the result to a given quaternion
  83419. * @param scale defines the scale factor
  83420. * @param result defines the Quaternion object where to store the result
  83421. * @returns the unmodified current quaternion
  83422. */
  83423. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  83424. /**
  83425. * Multiplies two quaternions
  83426. * @param q1 defines the second operand
  83427. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  83428. */
  83429. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  83430. /**
  83431. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  83432. * @param q1 defines the second operand
  83433. * @param result defines the target quaternion
  83434. * @returns the current quaternion
  83435. */
  83436. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  83437. /**
  83438. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  83439. * @param q1 defines the second operand
  83440. * @returns the currentupdated quaternion
  83441. */
  83442. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  83443. /**
  83444. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  83445. * @param ref defines the target quaternion
  83446. * @returns the current quaternion
  83447. */
  83448. conjugateToRef(ref: Quaternion): Quaternion;
  83449. /**
  83450. * Conjugates in place (1-q) the current quaternion
  83451. * @returns the current updated quaternion
  83452. */
  83453. conjugateInPlace(): Quaternion;
  83454. /**
  83455. * Conjugates in place (1-q) the current quaternion
  83456. * @returns a new quaternion
  83457. */
  83458. conjugate(): Quaternion;
  83459. /**
  83460. * Gets length of current quaternion
  83461. * @returns the quaternion length (float)
  83462. */
  83463. length(): number;
  83464. /**
  83465. * Normalize in place the current quaternion
  83466. * @returns the current updated quaternion
  83467. */
  83468. normalize(): Quaternion;
  83469. /**
  83470. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  83471. * @param order is a reserved parameter and is ignore for now
  83472. * @returns a new Vector3 containing the Euler angles
  83473. */
  83474. toEulerAngles(order?: string): Vector3;
  83475. /**
  83476. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  83477. * @param result defines the vector which will be filled with the Euler angles
  83478. * @param order is a reserved parameter and is ignore for now
  83479. * @returns the current unchanged quaternion
  83480. */
  83481. toEulerAnglesToRef(result: Vector3): Quaternion;
  83482. /**
  83483. * Updates the given rotation matrix with the current quaternion values
  83484. * @param result defines the target matrix
  83485. * @returns the current unchanged quaternion
  83486. */
  83487. toRotationMatrix(result: Matrix): Quaternion;
  83488. /**
  83489. * Updates the current quaternion from the given rotation matrix values
  83490. * @param matrix defines the source matrix
  83491. * @returns the current updated quaternion
  83492. */
  83493. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83494. /**
  83495. * Creates a new quaternion from a rotation matrix
  83496. * @param matrix defines the source matrix
  83497. * @returns a new quaternion created from the given rotation matrix values
  83498. */
  83499. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83500. /**
  83501. * Updates the given quaternion with the given rotation matrix values
  83502. * @param matrix defines the source matrix
  83503. * @param result defines the target quaternion
  83504. */
  83505. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  83506. /**
  83507. * Returns the dot product (float) between the quaternions "left" and "right"
  83508. * @param left defines the left operand
  83509. * @param right defines the right operand
  83510. * @returns the dot product
  83511. */
  83512. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  83513. /**
  83514. * Checks if the two quaternions are close to each other
  83515. * @param quat0 defines the first quaternion to check
  83516. * @param quat1 defines the second quaternion to check
  83517. * @returns true if the two quaternions are close to each other
  83518. */
  83519. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  83520. /**
  83521. * Creates an empty quaternion
  83522. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  83523. */
  83524. static Zero(): Quaternion;
  83525. /**
  83526. * Inverse a given quaternion
  83527. * @param q defines the source quaternion
  83528. * @returns a new quaternion as the inverted current quaternion
  83529. */
  83530. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  83531. /**
  83532. * Inverse a given quaternion
  83533. * @param q defines the source quaternion
  83534. * @param result the quaternion the result will be stored in
  83535. * @returns the result quaternion
  83536. */
  83537. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  83538. /**
  83539. * Creates an identity quaternion
  83540. * @returns the identity quaternion
  83541. */
  83542. static Identity(): Quaternion;
  83543. /**
  83544. * Gets a boolean indicating if the given quaternion is identity
  83545. * @param quaternion defines the quaternion to check
  83546. * @returns true if the quaternion is identity
  83547. */
  83548. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  83549. /**
  83550. * Creates a quaternion from a rotation around an axis
  83551. * @param axis defines the axis to use
  83552. * @param angle defines the angle to use
  83553. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  83554. */
  83555. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  83556. /**
  83557. * Creates a rotation around an axis and stores it into the given quaternion
  83558. * @param axis defines the axis to use
  83559. * @param angle defines the angle to use
  83560. * @param result defines the target quaternion
  83561. * @returns the target quaternion
  83562. */
  83563. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  83564. /**
  83565. * Creates a new quaternion from data stored into an array
  83566. * @param array defines the data source
  83567. * @param offset defines the offset in the source array where the data starts
  83568. * @returns a new quaternion
  83569. */
  83570. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  83571. /**
  83572. * Updates the given quaternion "result" from the starting index of the given array.
  83573. * @param array the array to pull values from
  83574. * @param offset the offset into the array to start at
  83575. * @param result the quaternion to store the result in
  83576. */
  83577. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  83578. /**
  83579. * Create a quaternion from Euler rotation angles
  83580. * @param x Pitch
  83581. * @param y Yaw
  83582. * @param z Roll
  83583. * @returns the new Quaternion
  83584. */
  83585. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  83586. /**
  83587. * Updates a quaternion from Euler rotation angles
  83588. * @param x Pitch
  83589. * @param y Yaw
  83590. * @param z Roll
  83591. * @param result the quaternion to store the result
  83592. * @returns the updated quaternion
  83593. */
  83594. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  83595. /**
  83596. * Create a quaternion from Euler rotation vector
  83597. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83598. * @returns the new Quaternion
  83599. */
  83600. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  83601. /**
  83602. * Updates a quaternion from Euler rotation vector
  83603. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83604. * @param result the quaternion to store the result
  83605. * @returns the updated quaternion
  83606. */
  83607. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  83608. /**
  83609. * Creates a new quaternion from the given Euler float angles (y, x, z)
  83610. * @param yaw defines the rotation around Y axis
  83611. * @param pitch defines the rotation around X axis
  83612. * @param roll defines the rotation around Z axis
  83613. * @returns the new quaternion
  83614. */
  83615. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  83616. /**
  83617. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  83618. * @param yaw defines the rotation around Y axis
  83619. * @param pitch defines the rotation around X axis
  83620. * @param roll defines the rotation around Z axis
  83621. * @param result defines the target quaternion
  83622. */
  83623. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  83624. /**
  83625. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  83626. * @param alpha defines the rotation around first axis
  83627. * @param beta defines the rotation around second axis
  83628. * @param gamma defines the rotation around third axis
  83629. * @returns the new quaternion
  83630. */
  83631. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  83632. /**
  83633. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  83634. * @param alpha defines the rotation around first axis
  83635. * @param beta defines the rotation around second axis
  83636. * @param gamma defines the rotation around third axis
  83637. * @param result defines the target quaternion
  83638. */
  83639. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  83640. /**
  83641. * 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)
  83642. * @param axis1 defines the first axis
  83643. * @param axis2 defines the second axis
  83644. * @param axis3 defines the third axis
  83645. * @returns the new quaternion
  83646. */
  83647. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  83648. /**
  83649. * 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
  83650. * @param axis1 defines the first axis
  83651. * @param axis2 defines the second axis
  83652. * @param axis3 defines the third axis
  83653. * @param ref defines the target quaternion
  83654. */
  83655. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  83656. /**
  83657. * Interpolates between two quaternions
  83658. * @param left defines first quaternion
  83659. * @param right defines second quaternion
  83660. * @param amount defines the gradient to use
  83661. * @returns the new interpolated quaternion
  83662. */
  83663. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83664. /**
  83665. * Interpolates between two quaternions and stores it into a target quaternion
  83666. * @param left defines first quaternion
  83667. * @param right defines second quaternion
  83668. * @param amount defines the gradient to use
  83669. * @param result defines the target quaternion
  83670. */
  83671. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  83672. /**
  83673. * Interpolate between two quaternions using Hermite interpolation
  83674. * @param value1 defines first quaternion
  83675. * @param tangent1 defines the incoming tangent
  83676. * @param value2 defines second quaternion
  83677. * @param tangent2 defines the outgoing tangent
  83678. * @param amount defines the target quaternion
  83679. * @returns the new interpolated quaternion
  83680. */
  83681. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83682. }
  83683. /**
  83684. * Class used to store matrix data (4x4)
  83685. */
  83686. export class Matrix {
  83687. /**
  83688. * Gets the precision of matrix computations
  83689. */
  83690. static get Use64Bits(): boolean;
  83691. private static _updateFlagSeed;
  83692. private static _identityReadOnly;
  83693. private _isIdentity;
  83694. private _isIdentityDirty;
  83695. private _isIdentity3x2;
  83696. private _isIdentity3x2Dirty;
  83697. /**
  83698. * Gets the update flag of the matrix which is an unique number for the matrix.
  83699. * It will be incremented every time the matrix data change.
  83700. * You can use it to speed the comparison between two versions of the same matrix.
  83701. */
  83702. updateFlag: number;
  83703. private readonly _m;
  83704. /**
  83705. * Gets the internal data of the matrix
  83706. */
  83707. get m(): DeepImmutable<Float32Array | Array<number>>;
  83708. /** @hidden */
  83709. _markAsUpdated(): void;
  83710. /** @hidden */
  83711. private _updateIdentityStatus;
  83712. /**
  83713. * Creates an empty matrix (filled with zeros)
  83714. */
  83715. constructor();
  83716. /**
  83717. * Check if the current matrix is identity
  83718. * @returns true is the matrix is the identity matrix
  83719. */
  83720. isIdentity(): boolean;
  83721. /**
  83722. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  83723. * @returns true is the matrix is the identity matrix
  83724. */
  83725. isIdentityAs3x2(): boolean;
  83726. /**
  83727. * Gets the determinant of the matrix
  83728. * @returns the matrix determinant
  83729. */
  83730. determinant(): number;
  83731. /**
  83732. * Returns the matrix as a Float32Array or Array<number>
  83733. * @returns the matrix underlying array
  83734. */
  83735. toArray(): DeepImmutable<Float32Array | Array<number>>;
  83736. /**
  83737. * Returns the matrix as a Float32Array or Array<number>
  83738. * @returns the matrix underlying array.
  83739. */
  83740. asArray(): DeepImmutable<Float32Array | Array<number>>;
  83741. /**
  83742. * Inverts the current matrix in place
  83743. * @returns the current inverted matrix
  83744. */
  83745. invert(): Matrix;
  83746. /**
  83747. * Sets all the matrix elements to zero
  83748. * @returns the current matrix
  83749. */
  83750. reset(): Matrix;
  83751. /**
  83752. * Adds the current matrix with a second one
  83753. * @param other defines the matrix to add
  83754. * @returns a new matrix as the addition of the current matrix and the given one
  83755. */
  83756. add(other: DeepImmutable<Matrix>): Matrix;
  83757. /**
  83758. * Sets the given matrix "result" to the addition of the current matrix and the given one
  83759. * @param other defines the matrix to add
  83760. * @param result defines the target matrix
  83761. * @returns the current matrix
  83762. */
  83763. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83764. /**
  83765. * Adds in place the given matrix to the current matrix
  83766. * @param other defines the second operand
  83767. * @returns the current updated matrix
  83768. */
  83769. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  83770. /**
  83771. * Sets the given matrix to the current inverted Matrix
  83772. * @param other defines the target matrix
  83773. * @returns the unmodified current matrix
  83774. */
  83775. invertToRef(other: Matrix): Matrix;
  83776. /**
  83777. * add a value at the specified position in the current Matrix
  83778. * @param index the index of the value within the matrix. between 0 and 15.
  83779. * @param value the value to be added
  83780. * @returns the current updated matrix
  83781. */
  83782. addAtIndex(index: number, value: number): Matrix;
  83783. /**
  83784. * mutiply the specified position in the current Matrix by a value
  83785. * @param index the index of the value within the matrix. between 0 and 15.
  83786. * @param value the value to be added
  83787. * @returns the current updated matrix
  83788. */
  83789. multiplyAtIndex(index: number, value: number): Matrix;
  83790. /**
  83791. * Inserts the translation vector (using 3 floats) in the current matrix
  83792. * @param x defines the 1st component of the translation
  83793. * @param y defines the 2nd component of the translation
  83794. * @param z defines the 3rd component of the translation
  83795. * @returns the current updated matrix
  83796. */
  83797. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83798. /**
  83799. * Adds the translation vector (using 3 floats) in the current matrix
  83800. * @param x defines the 1st component of the translation
  83801. * @param y defines the 2nd component of the translation
  83802. * @param z defines the 3rd component of the translation
  83803. * @returns the current updated matrix
  83804. */
  83805. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83806. /**
  83807. * Inserts the translation vector in the current matrix
  83808. * @param vector3 defines the translation to insert
  83809. * @returns the current updated matrix
  83810. */
  83811. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  83812. /**
  83813. * Gets the translation value of the current matrix
  83814. * @returns a new Vector3 as the extracted translation from the matrix
  83815. */
  83816. getTranslation(): Vector3;
  83817. /**
  83818. * Fill a Vector3 with the extracted translation from the matrix
  83819. * @param result defines the Vector3 where to store the translation
  83820. * @returns the current matrix
  83821. */
  83822. getTranslationToRef(result: Vector3): Matrix;
  83823. /**
  83824. * Remove rotation and scaling part from the matrix
  83825. * @returns the updated matrix
  83826. */
  83827. removeRotationAndScaling(): Matrix;
  83828. /**
  83829. * Multiply two matrices
  83830. * @param other defines the second operand
  83831. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  83832. */
  83833. multiply(other: DeepImmutable<Matrix>): Matrix;
  83834. /**
  83835. * Copy the current matrix from the given one
  83836. * @param other defines the source matrix
  83837. * @returns the current updated matrix
  83838. */
  83839. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  83840. /**
  83841. * Populates the given array from the starting index with the current matrix values
  83842. * @param array defines the target array
  83843. * @param offset defines the offset in the target array where to start storing values
  83844. * @returns the current matrix
  83845. */
  83846. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  83847. /**
  83848. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  83849. * @param other defines the second operand
  83850. * @param result defines the matrix where to store the multiplication
  83851. * @returns the current matrix
  83852. */
  83853. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83854. /**
  83855. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  83856. * @param other defines the second operand
  83857. * @param result defines the array where to store the multiplication
  83858. * @param offset defines the offset in the target array where to start storing values
  83859. * @returns the current matrix
  83860. */
  83861. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  83862. /**
  83863. * Check equality between this matrix and a second one
  83864. * @param value defines the second matrix to compare
  83865. * @returns true is the current matrix and the given one values are strictly equal
  83866. */
  83867. equals(value: DeepImmutable<Matrix>): boolean;
  83868. /**
  83869. * Clone the current matrix
  83870. * @returns a new matrix from the current matrix
  83871. */
  83872. clone(): Matrix;
  83873. /**
  83874. * Returns the name of the current matrix class
  83875. * @returns the string "Matrix"
  83876. */
  83877. getClassName(): string;
  83878. /**
  83879. * Gets the hash code of the current matrix
  83880. * @returns the hash code
  83881. */
  83882. getHashCode(): number;
  83883. /**
  83884. * Decomposes the current Matrix into a translation, rotation and scaling components
  83885. * @param scale defines the scale vector3 given as a reference to update
  83886. * @param rotation defines the rotation quaternion given as a reference to update
  83887. * @param translation defines the translation vector3 given as a reference to update
  83888. * @returns true if operation was successful
  83889. */
  83890. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  83891. /**
  83892. * Gets specific row of the matrix
  83893. * @param index defines the number of the row to get
  83894. * @returns the index-th row of the current matrix as a new Vector4
  83895. */
  83896. getRow(index: number): Nullable<Vector4>;
  83897. /**
  83898. * Sets the index-th row of the current matrix to the vector4 values
  83899. * @param index defines the number of the row to set
  83900. * @param row defines the target vector4
  83901. * @returns the updated current matrix
  83902. */
  83903. setRow(index: number, row: Vector4): Matrix;
  83904. /**
  83905. * Compute the transpose of the matrix
  83906. * @returns the new transposed matrix
  83907. */
  83908. transpose(): Matrix;
  83909. /**
  83910. * Compute the transpose of the matrix and store it in a given matrix
  83911. * @param result defines the target matrix
  83912. * @returns the current matrix
  83913. */
  83914. transposeToRef(result: Matrix): Matrix;
  83915. /**
  83916. * Sets the index-th row of the current matrix with the given 4 x float values
  83917. * @param index defines the row index
  83918. * @param x defines the x component to set
  83919. * @param y defines the y component to set
  83920. * @param z defines the z component to set
  83921. * @param w defines the w component to set
  83922. * @returns the updated current matrix
  83923. */
  83924. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  83925. /**
  83926. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  83927. * @param scale defines the scale factor
  83928. * @returns a new matrix
  83929. */
  83930. scale(scale: number): Matrix;
  83931. /**
  83932. * Scale the current matrix values by a factor to a given result matrix
  83933. * @param scale defines the scale factor
  83934. * @param result defines the matrix to store the result
  83935. * @returns the current matrix
  83936. */
  83937. scaleToRef(scale: number, result: Matrix): Matrix;
  83938. /**
  83939. * Scale the current matrix values by a factor and add the result to a given matrix
  83940. * @param scale defines the scale factor
  83941. * @param result defines the Matrix to store the result
  83942. * @returns the current matrix
  83943. */
  83944. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  83945. /**
  83946. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  83947. * @param ref matrix to store the result
  83948. */
  83949. toNormalMatrix(ref: Matrix): void;
  83950. /**
  83951. * Gets only rotation part of the current matrix
  83952. * @returns a new matrix sets to the extracted rotation matrix from the current one
  83953. */
  83954. getRotationMatrix(): Matrix;
  83955. /**
  83956. * Extracts the rotation matrix from the current one and sets it as the given "result"
  83957. * @param result defines the target matrix to store data to
  83958. * @returns the current matrix
  83959. */
  83960. getRotationMatrixToRef(result: Matrix): Matrix;
  83961. /**
  83962. * Toggles model matrix from being right handed to left handed in place and vice versa
  83963. */
  83964. toggleModelMatrixHandInPlace(): void;
  83965. /**
  83966. * Toggles projection matrix from being right handed to left handed in place and vice versa
  83967. */
  83968. toggleProjectionMatrixHandInPlace(): void;
  83969. /**
  83970. * Creates a matrix from an array
  83971. * @param array defines the source array
  83972. * @param offset defines an offset in the source array
  83973. * @returns a new Matrix set from the starting index of the given array
  83974. */
  83975. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  83976. /**
  83977. * Copy the content of an array into a given matrix
  83978. * @param array defines the source array
  83979. * @param offset defines an offset in the source array
  83980. * @param result defines the target matrix
  83981. */
  83982. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  83983. /**
  83984. * Stores an array into a matrix after having multiplied each component by a given factor
  83985. * @param array defines the source array
  83986. * @param offset defines the offset in the source array
  83987. * @param scale defines the scaling factor
  83988. * @param result defines the target matrix
  83989. */
  83990. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  83991. /**
  83992. * Gets an identity matrix that must not be updated
  83993. */
  83994. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  83995. /**
  83996. * Stores a list of values (16) inside a given matrix
  83997. * @param initialM11 defines 1st value of 1st row
  83998. * @param initialM12 defines 2nd value of 1st row
  83999. * @param initialM13 defines 3rd value of 1st row
  84000. * @param initialM14 defines 4th value of 1st row
  84001. * @param initialM21 defines 1st value of 2nd row
  84002. * @param initialM22 defines 2nd value of 2nd row
  84003. * @param initialM23 defines 3rd value of 2nd row
  84004. * @param initialM24 defines 4th value of 2nd row
  84005. * @param initialM31 defines 1st value of 3rd row
  84006. * @param initialM32 defines 2nd value of 3rd row
  84007. * @param initialM33 defines 3rd value of 3rd row
  84008. * @param initialM34 defines 4th value of 3rd row
  84009. * @param initialM41 defines 1st value of 4th row
  84010. * @param initialM42 defines 2nd value of 4th row
  84011. * @param initialM43 defines 3rd value of 4th row
  84012. * @param initialM44 defines 4th value of 4th row
  84013. * @param result defines the target matrix
  84014. */
  84015. 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;
  84016. /**
  84017. * Creates new matrix from a list of values (16)
  84018. * @param initialM11 defines 1st value of 1st row
  84019. * @param initialM12 defines 2nd value of 1st row
  84020. * @param initialM13 defines 3rd value of 1st row
  84021. * @param initialM14 defines 4th value of 1st row
  84022. * @param initialM21 defines 1st value of 2nd row
  84023. * @param initialM22 defines 2nd value of 2nd row
  84024. * @param initialM23 defines 3rd value of 2nd row
  84025. * @param initialM24 defines 4th value of 2nd row
  84026. * @param initialM31 defines 1st value of 3rd row
  84027. * @param initialM32 defines 2nd value of 3rd row
  84028. * @param initialM33 defines 3rd value of 3rd row
  84029. * @param initialM34 defines 4th value of 3rd row
  84030. * @param initialM41 defines 1st value of 4th row
  84031. * @param initialM42 defines 2nd value of 4th row
  84032. * @param initialM43 defines 3rd value of 4th row
  84033. * @param initialM44 defines 4th value of 4th row
  84034. * @returns the new matrix
  84035. */
  84036. 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;
  84037. /**
  84038. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84039. * @param scale defines the scale vector3
  84040. * @param rotation defines the rotation quaternion
  84041. * @param translation defines the translation vector3
  84042. * @returns a new matrix
  84043. */
  84044. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  84045. /**
  84046. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84047. * @param scale defines the scale vector3
  84048. * @param rotation defines the rotation quaternion
  84049. * @param translation defines the translation vector3
  84050. * @param result defines the target matrix
  84051. */
  84052. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  84053. /**
  84054. * Creates a new identity matrix
  84055. * @returns a new identity matrix
  84056. */
  84057. static Identity(): Matrix;
  84058. /**
  84059. * Creates a new identity matrix and stores the result in a given matrix
  84060. * @param result defines the target matrix
  84061. */
  84062. static IdentityToRef(result: Matrix): void;
  84063. /**
  84064. * Creates a new zero matrix
  84065. * @returns a new zero matrix
  84066. */
  84067. static Zero(): Matrix;
  84068. /**
  84069. * Creates a new rotation matrix for "angle" radians around the X axis
  84070. * @param angle defines the angle (in radians) to use
  84071. * @return the new matrix
  84072. */
  84073. static RotationX(angle: number): Matrix;
  84074. /**
  84075. * Creates a new matrix as the invert of a given matrix
  84076. * @param source defines the source matrix
  84077. * @returns the new matrix
  84078. */
  84079. static Invert(source: DeepImmutable<Matrix>): Matrix;
  84080. /**
  84081. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  84082. * @param angle defines the angle (in radians) to use
  84083. * @param result defines the target matrix
  84084. */
  84085. static RotationXToRef(angle: number, result: Matrix): void;
  84086. /**
  84087. * Creates a new rotation matrix for "angle" radians around the Y axis
  84088. * @param angle defines the angle (in radians) to use
  84089. * @return the new matrix
  84090. */
  84091. static RotationY(angle: number): Matrix;
  84092. /**
  84093. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  84094. * @param angle defines the angle (in radians) to use
  84095. * @param result defines the target matrix
  84096. */
  84097. static RotationYToRef(angle: number, result: Matrix): void;
  84098. /**
  84099. * Creates a new rotation matrix for "angle" radians around the Z axis
  84100. * @param angle defines the angle (in radians) to use
  84101. * @return the new matrix
  84102. */
  84103. static RotationZ(angle: number): Matrix;
  84104. /**
  84105. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  84106. * @param angle defines the angle (in radians) to use
  84107. * @param result defines the target matrix
  84108. */
  84109. static RotationZToRef(angle: number, result: Matrix): void;
  84110. /**
  84111. * Creates a new rotation matrix for "angle" radians around the given axis
  84112. * @param axis defines the axis to use
  84113. * @param angle defines the angle (in radians) to use
  84114. * @return the new matrix
  84115. */
  84116. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  84117. /**
  84118. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  84119. * @param axis defines the axis to use
  84120. * @param angle defines the angle (in radians) to use
  84121. * @param result defines the target matrix
  84122. */
  84123. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  84124. /**
  84125. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  84126. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  84127. * @param from defines the vector to align
  84128. * @param to defines the vector to align to
  84129. * @param result defines the target matrix
  84130. */
  84131. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  84132. /**
  84133. * Creates a rotation matrix
  84134. * @param yaw defines the yaw angle in radians (Y axis)
  84135. * @param pitch defines the pitch angle in radians (X axis)
  84136. * @param roll defines the roll angle in radians (Z axis)
  84137. * @returns the new rotation matrix
  84138. */
  84139. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  84140. /**
  84141. * Creates a rotation matrix and stores it in a given matrix
  84142. * @param yaw defines the yaw angle in radians (Y axis)
  84143. * @param pitch defines the pitch angle in radians (X axis)
  84144. * @param roll defines the roll angle in radians (Z axis)
  84145. * @param result defines the target matrix
  84146. */
  84147. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  84148. /**
  84149. * Creates a scaling matrix
  84150. * @param x defines the scale factor on X axis
  84151. * @param y defines the scale factor on Y axis
  84152. * @param z defines the scale factor on Z axis
  84153. * @returns the new matrix
  84154. */
  84155. static Scaling(x: number, y: number, z: number): Matrix;
  84156. /**
  84157. * Creates a scaling matrix and stores it in a given matrix
  84158. * @param x defines the scale factor on X axis
  84159. * @param y defines the scale factor on Y axis
  84160. * @param z defines the scale factor on Z axis
  84161. * @param result defines the target matrix
  84162. */
  84163. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  84164. /**
  84165. * Creates a translation matrix
  84166. * @param x defines the translation on X axis
  84167. * @param y defines the translation on Y axis
  84168. * @param z defines the translationon Z axis
  84169. * @returns the new matrix
  84170. */
  84171. static Translation(x: number, y: number, z: number): Matrix;
  84172. /**
  84173. * Creates a translation matrix and stores it in a given matrix
  84174. * @param x defines the translation on X axis
  84175. * @param y defines the translation on Y axis
  84176. * @param z defines the translationon Z axis
  84177. * @param result defines the target matrix
  84178. */
  84179. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  84180. /**
  84181. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84182. * @param startValue defines the start value
  84183. * @param endValue defines the end value
  84184. * @param gradient defines the gradient factor
  84185. * @returns the new matrix
  84186. */
  84187. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84188. /**
  84189. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84190. * @param startValue defines the start value
  84191. * @param endValue defines the end value
  84192. * @param gradient defines the gradient factor
  84193. * @param result defines the Matrix object where to store data
  84194. */
  84195. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84196. /**
  84197. * Builds a new matrix whose values are computed by:
  84198. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84199. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84200. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84201. * @param startValue defines the first matrix
  84202. * @param endValue defines the second matrix
  84203. * @param gradient defines the gradient between the two matrices
  84204. * @returns the new matrix
  84205. */
  84206. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84207. /**
  84208. * Update a matrix to values which are computed by:
  84209. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84210. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84211. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84212. * @param startValue defines the first matrix
  84213. * @param endValue defines the second matrix
  84214. * @param gradient defines the gradient between the two matrices
  84215. * @param result defines the target matrix
  84216. */
  84217. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84218. /**
  84219. * 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"
  84220. * This function works in left handed mode
  84221. * @param eye defines the final position of the entity
  84222. * @param target defines where the entity should look at
  84223. * @param up defines the up vector for the entity
  84224. * @returns the new matrix
  84225. */
  84226. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84227. /**
  84228. * 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".
  84229. * This function works in left handed mode
  84230. * @param eye defines the final position of the entity
  84231. * @param target defines where the entity should look at
  84232. * @param up defines the up vector for the entity
  84233. * @param result defines the target matrix
  84234. */
  84235. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84236. /**
  84237. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  84238. * This function works in right handed mode
  84239. * @param eye defines the final position of the entity
  84240. * @param target defines where the entity should look at
  84241. * @param up defines the up vector for the entity
  84242. * @returns the new matrix
  84243. */
  84244. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84245. /**
  84246. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  84247. * This function works in right handed mode
  84248. * @param eye defines the final position of the entity
  84249. * @param target defines where the entity should look at
  84250. * @param up defines the up vector for the entity
  84251. * @param result defines the target matrix
  84252. */
  84253. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84254. /**
  84255. * Create a left-handed orthographic projection matrix
  84256. * @param width defines the viewport width
  84257. * @param height defines the viewport height
  84258. * @param znear defines the near clip plane
  84259. * @param zfar defines the far clip plane
  84260. * @returns a new matrix as a left-handed orthographic projection matrix
  84261. */
  84262. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84263. /**
  84264. * Store a left-handed orthographic projection to a given matrix
  84265. * @param width defines the viewport width
  84266. * @param height defines the viewport height
  84267. * @param znear defines the near clip plane
  84268. * @param zfar defines the far clip plane
  84269. * @param result defines the target matrix
  84270. */
  84271. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84272. /**
  84273. * Create a left-handed orthographic projection matrix
  84274. * @param left defines the viewport left coordinate
  84275. * @param right defines the viewport right coordinate
  84276. * @param bottom defines the viewport bottom coordinate
  84277. * @param top defines the viewport top coordinate
  84278. * @param znear defines the near clip plane
  84279. * @param zfar defines the far clip plane
  84280. * @returns a new matrix as a left-handed orthographic projection matrix
  84281. */
  84282. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84283. /**
  84284. * Stores a left-handed orthographic projection into a given matrix
  84285. * @param left defines the viewport left coordinate
  84286. * @param right defines the viewport right coordinate
  84287. * @param bottom defines the viewport bottom coordinate
  84288. * @param top defines the viewport top coordinate
  84289. * @param znear defines the near clip plane
  84290. * @param zfar defines the far clip plane
  84291. * @param result defines the target matrix
  84292. */
  84293. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84294. /**
  84295. * Creates a right-handed orthographic projection matrix
  84296. * @param left defines the viewport left coordinate
  84297. * @param right defines the viewport right coordinate
  84298. * @param bottom defines the viewport bottom coordinate
  84299. * @param top defines the viewport top coordinate
  84300. * @param znear defines the near clip plane
  84301. * @param zfar defines the far clip plane
  84302. * @returns a new matrix as a right-handed orthographic projection matrix
  84303. */
  84304. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84305. /**
  84306. * Stores a right-handed orthographic projection into a given matrix
  84307. * @param left defines the viewport left coordinate
  84308. * @param right defines the viewport right coordinate
  84309. * @param bottom defines the viewport bottom coordinate
  84310. * @param top defines the viewport top coordinate
  84311. * @param znear defines the near clip plane
  84312. * @param zfar defines the far clip plane
  84313. * @param result defines the target matrix
  84314. */
  84315. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84316. /**
  84317. * Creates a left-handed perspective projection matrix
  84318. * @param width defines the viewport width
  84319. * @param height defines the viewport height
  84320. * @param znear defines the near clip plane
  84321. * @param zfar defines the far clip plane
  84322. * @returns a new matrix as a left-handed perspective projection matrix
  84323. */
  84324. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84325. /**
  84326. * Creates a left-handed perspective projection matrix
  84327. * @param fov defines the horizontal field of view
  84328. * @param aspect defines the aspect ratio
  84329. * @param znear defines the near clip plane
  84330. * @param zfar defines the far clip plane
  84331. * @returns a new matrix as a left-handed perspective projection matrix
  84332. */
  84333. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84334. /**
  84335. * Stores a left-handed perspective projection into a given matrix
  84336. * @param fov defines the horizontal field of view
  84337. * @param aspect defines the aspect ratio
  84338. * @param znear defines the near clip plane
  84339. * @param zfar defines the far clip plane
  84340. * @param result defines the target matrix
  84341. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84342. */
  84343. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84344. /**
  84345. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84346. * @param fov defines the horizontal field of view
  84347. * @param aspect defines the aspect ratio
  84348. * @param znear defines the near clip plane
  84349. * @param zfar not used as infinity is used as far clip
  84350. * @param result defines the target matrix
  84351. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84352. */
  84353. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84354. /**
  84355. * Creates a right-handed perspective projection matrix
  84356. * @param fov defines the horizontal field of view
  84357. * @param aspect defines the aspect ratio
  84358. * @param znear defines the near clip plane
  84359. * @param zfar defines the far clip plane
  84360. * @returns a new matrix as a right-handed perspective projection matrix
  84361. */
  84362. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84363. /**
  84364. * Stores a right-handed perspective projection into a given matrix
  84365. * @param fov defines the horizontal field of view
  84366. * @param aspect defines the aspect ratio
  84367. * @param znear defines the near clip plane
  84368. * @param zfar defines the far clip plane
  84369. * @param result defines the target matrix
  84370. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84371. */
  84372. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84373. /**
  84374. * Stores a right-handed perspective projection into a given matrix
  84375. * @param fov defines the horizontal field of view
  84376. * @param aspect defines the aspect ratio
  84377. * @param znear defines the near clip plane
  84378. * @param zfar not used as infinity is used as far clip
  84379. * @param result defines the target matrix
  84380. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84381. */
  84382. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84383. /**
  84384. * Stores a perspective projection for WebVR info a given matrix
  84385. * @param fov defines the field of view
  84386. * @param znear defines the near clip plane
  84387. * @param zfar defines the far clip plane
  84388. * @param result defines the target matrix
  84389. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  84390. */
  84391. static PerspectiveFovWebVRToRef(fov: {
  84392. upDegrees: number;
  84393. downDegrees: number;
  84394. leftDegrees: number;
  84395. rightDegrees: number;
  84396. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  84397. /**
  84398. * Computes a complete transformation matrix
  84399. * @param viewport defines the viewport to use
  84400. * @param world defines the world matrix
  84401. * @param view defines the view matrix
  84402. * @param projection defines the projection matrix
  84403. * @param zmin defines the near clip plane
  84404. * @param zmax defines the far clip plane
  84405. * @returns the transformation matrix
  84406. */
  84407. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  84408. /**
  84409. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  84410. * @param matrix defines the matrix to use
  84411. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  84412. */
  84413. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84414. /**
  84415. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  84416. * @param matrix defines the matrix to use
  84417. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  84418. */
  84419. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84420. /**
  84421. * Compute the transpose of a given matrix
  84422. * @param matrix defines the matrix to transpose
  84423. * @returns the new matrix
  84424. */
  84425. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  84426. /**
  84427. * Compute the transpose of a matrix and store it in a target matrix
  84428. * @param matrix defines the matrix to transpose
  84429. * @param result defines the target matrix
  84430. */
  84431. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  84432. /**
  84433. * Computes a reflection matrix from a plane
  84434. * @param plane defines the reflection plane
  84435. * @returns a new matrix
  84436. */
  84437. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  84438. /**
  84439. * Computes a reflection matrix from a plane
  84440. * @param plane defines the reflection plane
  84441. * @param result defines the target matrix
  84442. */
  84443. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  84444. /**
  84445. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  84446. * @param xaxis defines the value of the 1st axis
  84447. * @param yaxis defines the value of the 2nd axis
  84448. * @param zaxis defines the value of the 3rd axis
  84449. * @param result defines the target matrix
  84450. */
  84451. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  84452. /**
  84453. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  84454. * @param quat defines the quaternion to use
  84455. * @param result defines the target matrix
  84456. */
  84457. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  84458. }
  84459. /**
  84460. * @hidden
  84461. */
  84462. export class TmpVectors {
  84463. static Vector2: Vector2[];
  84464. static Vector3: Vector3[];
  84465. static Vector4: Vector4[];
  84466. static Quaternion: Quaternion[];
  84467. static Matrix: Matrix[];
  84468. }
  84469. }
  84470. declare module BABYLON {
  84471. /**
  84472. * Defines potential orientation for back face culling
  84473. */
  84474. export enum Orientation {
  84475. /**
  84476. * Clockwise
  84477. */
  84478. CW = 0,
  84479. /** Counter clockwise */
  84480. CCW = 1
  84481. }
  84482. /** Class used to represent a Bezier curve */
  84483. export class BezierCurve {
  84484. /**
  84485. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  84486. * @param t defines the time
  84487. * @param x1 defines the left coordinate on X axis
  84488. * @param y1 defines the left coordinate on Y axis
  84489. * @param x2 defines the right coordinate on X axis
  84490. * @param y2 defines the right coordinate on Y axis
  84491. * @returns the interpolated value
  84492. */
  84493. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  84494. }
  84495. /**
  84496. * Defines angle representation
  84497. */
  84498. export class Angle {
  84499. private _radians;
  84500. /**
  84501. * Creates an Angle object of "radians" radians (float).
  84502. * @param radians the angle in radians
  84503. */
  84504. constructor(radians: number);
  84505. /**
  84506. * Get value in degrees
  84507. * @returns the Angle value in degrees (float)
  84508. */
  84509. degrees(): number;
  84510. /**
  84511. * Get value in radians
  84512. * @returns the Angle value in radians (float)
  84513. */
  84514. radians(): number;
  84515. /**
  84516. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  84517. * @param a defines first point as the origin
  84518. * @param b defines point
  84519. * @returns a new Angle
  84520. */
  84521. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  84522. /**
  84523. * Gets a new Angle object from the given float in radians
  84524. * @param radians defines the angle value in radians
  84525. * @returns a new Angle
  84526. */
  84527. static FromRadians(radians: number): Angle;
  84528. /**
  84529. * Gets a new Angle object from the given float in degrees
  84530. * @param degrees defines the angle value in degrees
  84531. * @returns a new Angle
  84532. */
  84533. static FromDegrees(degrees: number): Angle;
  84534. }
  84535. /**
  84536. * This represents an arc in a 2d space.
  84537. */
  84538. export class Arc2 {
  84539. /** Defines the start point of the arc */
  84540. startPoint: Vector2;
  84541. /** Defines the mid point of the arc */
  84542. midPoint: Vector2;
  84543. /** Defines the end point of the arc */
  84544. endPoint: Vector2;
  84545. /**
  84546. * Defines the center point of the arc.
  84547. */
  84548. centerPoint: Vector2;
  84549. /**
  84550. * Defines the radius of the arc.
  84551. */
  84552. radius: number;
  84553. /**
  84554. * Defines the angle of the arc (from mid point to end point).
  84555. */
  84556. angle: Angle;
  84557. /**
  84558. * Defines the start angle of the arc (from start point to middle point).
  84559. */
  84560. startAngle: Angle;
  84561. /**
  84562. * Defines the orientation of the arc (clock wise/counter clock wise).
  84563. */
  84564. orientation: Orientation;
  84565. /**
  84566. * Creates an Arc object from the three given points : start, middle and end.
  84567. * @param startPoint Defines the start point of the arc
  84568. * @param midPoint Defines the midlle point of the arc
  84569. * @param endPoint Defines the end point of the arc
  84570. */
  84571. constructor(
  84572. /** Defines the start point of the arc */
  84573. startPoint: Vector2,
  84574. /** Defines the mid point of the arc */
  84575. midPoint: Vector2,
  84576. /** Defines the end point of the arc */
  84577. endPoint: Vector2);
  84578. }
  84579. /**
  84580. * Represents a 2D path made up of multiple 2D points
  84581. */
  84582. export class Path2 {
  84583. private _points;
  84584. private _length;
  84585. /**
  84586. * If the path start and end point are the same
  84587. */
  84588. closed: boolean;
  84589. /**
  84590. * Creates a Path2 object from the starting 2D coordinates x and y.
  84591. * @param x the starting points x value
  84592. * @param y the starting points y value
  84593. */
  84594. constructor(x: number, y: number);
  84595. /**
  84596. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  84597. * @param x the added points x value
  84598. * @param y the added points y value
  84599. * @returns the updated Path2.
  84600. */
  84601. addLineTo(x: number, y: number): Path2;
  84602. /**
  84603. * 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.
  84604. * @param midX middle point x value
  84605. * @param midY middle point y value
  84606. * @param endX end point x value
  84607. * @param endY end point y value
  84608. * @param numberOfSegments (default: 36)
  84609. * @returns the updated Path2.
  84610. */
  84611. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  84612. /**
  84613. * Closes the Path2.
  84614. * @returns the Path2.
  84615. */
  84616. close(): Path2;
  84617. /**
  84618. * Gets the sum of the distance between each sequential point in the path
  84619. * @returns the Path2 total length (float).
  84620. */
  84621. length(): number;
  84622. /**
  84623. * Gets the points which construct the path
  84624. * @returns the Path2 internal array of points.
  84625. */
  84626. getPoints(): Vector2[];
  84627. /**
  84628. * Retreives the point at the distance aways from the starting point
  84629. * @param normalizedLengthPosition the length along the path to retreive the point from
  84630. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  84631. */
  84632. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  84633. /**
  84634. * Creates a new path starting from an x and y position
  84635. * @param x starting x value
  84636. * @param y starting y value
  84637. * @returns a new Path2 starting at the coordinates (x, y).
  84638. */
  84639. static StartingAt(x: number, y: number): Path2;
  84640. }
  84641. /**
  84642. * Represents a 3D path made up of multiple 3D points
  84643. */
  84644. export class Path3D {
  84645. /**
  84646. * an array of Vector3, the curve axis of the Path3D
  84647. */
  84648. path: Vector3[];
  84649. private _curve;
  84650. private _distances;
  84651. private _tangents;
  84652. private _normals;
  84653. private _binormals;
  84654. private _raw;
  84655. private _alignTangentsWithPath;
  84656. private readonly _pointAtData;
  84657. /**
  84658. * new Path3D(path, normal, raw)
  84659. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  84660. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  84661. * @param path an array of Vector3, the curve axis of the Path3D
  84662. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  84663. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  84664. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  84665. */
  84666. constructor(
  84667. /**
  84668. * an array of Vector3, the curve axis of the Path3D
  84669. */
  84670. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  84671. /**
  84672. * Returns the Path3D array of successive Vector3 designing its curve.
  84673. * @returns the Path3D array of successive Vector3 designing its curve.
  84674. */
  84675. getCurve(): Vector3[];
  84676. /**
  84677. * Returns the Path3D array of successive Vector3 designing its curve.
  84678. * @returns the Path3D array of successive Vector3 designing its curve.
  84679. */
  84680. getPoints(): Vector3[];
  84681. /**
  84682. * @returns the computed length (float) of the path.
  84683. */
  84684. length(): number;
  84685. /**
  84686. * Returns an array populated with tangent vectors on each Path3D curve point.
  84687. * @returns an array populated with tangent vectors on each Path3D curve point.
  84688. */
  84689. getTangents(): Vector3[];
  84690. /**
  84691. * Returns an array populated with normal vectors on each Path3D curve point.
  84692. * @returns an array populated with normal vectors on each Path3D curve point.
  84693. */
  84694. getNormals(): Vector3[];
  84695. /**
  84696. * Returns an array populated with binormal vectors on each Path3D curve point.
  84697. * @returns an array populated with binormal vectors on each Path3D curve point.
  84698. */
  84699. getBinormals(): Vector3[];
  84700. /**
  84701. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  84702. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  84703. */
  84704. getDistances(): number[];
  84705. /**
  84706. * Returns an interpolated point along this path
  84707. * @param position the position of the point along this path, from 0.0 to 1.0
  84708. * @returns a new Vector3 as the point
  84709. */
  84710. getPointAt(position: number): Vector3;
  84711. /**
  84712. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84713. * @param position the position of the point along this path, from 0.0 to 1.0
  84714. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  84715. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  84716. */
  84717. getTangentAt(position: number, interpolated?: boolean): Vector3;
  84718. /**
  84719. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84720. * @param position the position of the point along this path, from 0.0 to 1.0
  84721. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  84722. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  84723. */
  84724. getNormalAt(position: number, interpolated?: boolean): Vector3;
  84725. /**
  84726. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  84727. * @param position the position of the point along this path, from 0.0 to 1.0
  84728. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  84729. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  84730. */
  84731. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  84732. /**
  84733. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  84734. * @param position the position of the point along this path, from 0.0 to 1.0
  84735. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  84736. */
  84737. getDistanceAt(position: number): number;
  84738. /**
  84739. * Returns the array index of the previous point of an interpolated point along this path
  84740. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84741. * @returns the array index
  84742. */
  84743. getPreviousPointIndexAt(position: number): number;
  84744. /**
  84745. * 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)
  84746. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84747. * @returns the sub position
  84748. */
  84749. getSubPositionAt(position: number): number;
  84750. /**
  84751. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  84752. * @param target the vector of which to get the closest position to
  84753. * @returns the position of the closest virtual point on this path to the target vector
  84754. */
  84755. getClosestPositionTo(target: Vector3): number;
  84756. /**
  84757. * Returns a sub path (slice) of this path
  84758. * @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
  84759. * @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
  84760. * @returns a sub path (slice) of this path
  84761. */
  84762. slice(start?: number, end?: number): Path3D;
  84763. /**
  84764. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  84765. * @param path path which all values are copied into the curves points
  84766. * @param firstNormal which should be projected onto the curve
  84767. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  84768. * @returns the same object updated.
  84769. */
  84770. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  84771. private _compute;
  84772. private _getFirstNonNullVector;
  84773. private _getLastNonNullVector;
  84774. private _normalVector;
  84775. /**
  84776. * Updates the point at data for an interpolated point along this curve
  84777. * @param position the position of the point along this curve, from 0.0 to 1.0
  84778. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  84779. * @returns the (updated) point at data
  84780. */
  84781. private _updatePointAtData;
  84782. /**
  84783. * Updates the point at data from the specified parameters
  84784. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  84785. * @param point the interpolated point
  84786. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  84787. */
  84788. private _setPointAtData;
  84789. /**
  84790. * Updates the point at interpolation matrix for the tangents, normals and binormals
  84791. */
  84792. private _updateInterpolationMatrix;
  84793. }
  84794. /**
  84795. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84796. * A Curve3 is designed from a series of successive Vector3.
  84797. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  84798. */
  84799. export class Curve3 {
  84800. private _points;
  84801. private _length;
  84802. /**
  84803. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  84804. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  84805. * @param v1 (Vector3) the control point
  84806. * @param v2 (Vector3) the end point of the Quadratic Bezier
  84807. * @param nbPoints (integer) the wanted number of points in the curve
  84808. * @returns the created Curve3
  84809. */
  84810. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84811. /**
  84812. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  84813. * @param v0 (Vector3) the origin point of the Cubic Bezier
  84814. * @param v1 (Vector3) the first control point
  84815. * @param v2 (Vector3) the second control point
  84816. * @param v3 (Vector3) the end point of the Cubic Bezier
  84817. * @param nbPoints (integer) the wanted number of points in the curve
  84818. * @returns the created Curve3
  84819. */
  84820. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84821. /**
  84822. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  84823. * @param p1 (Vector3) the origin point of the Hermite Spline
  84824. * @param t1 (Vector3) the tangent vector at the origin point
  84825. * @param p2 (Vector3) the end point of the Hermite Spline
  84826. * @param t2 (Vector3) the tangent vector at the end point
  84827. * @param nbPoints (integer) the wanted number of points in the curve
  84828. * @returns the created Curve3
  84829. */
  84830. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84831. /**
  84832. * Returns a Curve3 object along a CatmullRom Spline curve :
  84833. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  84834. * @param nbPoints (integer) the wanted number of points between each curve control points
  84835. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  84836. * @returns the created Curve3
  84837. */
  84838. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  84839. /**
  84840. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84841. * A Curve3 is designed from a series of successive Vector3.
  84842. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  84843. * @param points points which make up the curve
  84844. */
  84845. constructor(points: Vector3[]);
  84846. /**
  84847. * @returns the Curve3 stored array of successive Vector3
  84848. */
  84849. getPoints(): Vector3[];
  84850. /**
  84851. * @returns the computed length (float) of the curve.
  84852. */
  84853. length(): number;
  84854. /**
  84855. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  84856. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  84857. * curveA and curveB keep unchanged.
  84858. * @param curve the curve to continue from this curve
  84859. * @returns the newly constructed curve
  84860. */
  84861. continue(curve: DeepImmutable<Curve3>): Curve3;
  84862. private _computeLength;
  84863. }
  84864. }
  84865. declare module BABYLON {
  84866. /**
  84867. * This represents the main contract an easing function should follow.
  84868. * Easing functions are used throughout the animation system.
  84869. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84870. */
  84871. export interface IEasingFunction {
  84872. /**
  84873. * Given an input gradient between 0 and 1, this returns the corrseponding value
  84874. * of the easing function.
  84875. * The link below provides some of the most common examples of easing functions.
  84876. * @see https://easings.net/
  84877. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84878. * @returns the corresponding value on the curve defined by the easing function
  84879. */
  84880. ease(gradient: number): number;
  84881. }
  84882. /**
  84883. * Base class used for every default easing function.
  84884. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84885. */
  84886. export class EasingFunction implements IEasingFunction {
  84887. /**
  84888. * Interpolation follows the mathematical formula associated with the easing function.
  84889. */
  84890. static readonly EASINGMODE_EASEIN: number;
  84891. /**
  84892. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  84893. */
  84894. static readonly EASINGMODE_EASEOUT: number;
  84895. /**
  84896. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  84897. */
  84898. static readonly EASINGMODE_EASEINOUT: number;
  84899. private _easingMode;
  84900. /**
  84901. * Sets the easing mode of the current function.
  84902. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  84903. */
  84904. setEasingMode(easingMode: number): void;
  84905. /**
  84906. * Gets the current easing mode.
  84907. * @returns the easing mode
  84908. */
  84909. getEasingMode(): number;
  84910. /**
  84911. * @hidden
  84912. */
  84913. easeInCore(gradient: number): number;
  84914. /**
  84915. * Given an input gradient between 0 and 1, this returns the corresponding value
  84916. * of the easing function.
  84917. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84918. * @returns the corresponding value on the curve defined by the easing function
  84919. */
  84920. ease(gradient: number): number;
  84921. }
  84922. /**
  84923. * Easing function with a circle shape (see link below).
  84924. * @see https://easings.net/#easeInCirc
  84925. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84926. */
  84927. export class CircleEase extends EasingFunction implements IEasingFunction {
  84928. /** @hidden */
  84929. easeInCore(gradient: number): number;
  84930. }
  84931. /**
  84932. * Easing function with a ease back shape (see link below).
  84933. * @see https://easings.net/#easeInBack
  84934. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84935. */
  84936. export class BackEase extends EasingFunction implements IEasingFunction {
  84937. /** Defines the amplitude of the function */
  84938. amplitude: number;
  84939. /**
  84940. * Instantiates a back ease easing
  84941. * @see https://easings.net/#easeInBack
  84942. * @param amplitude Defines the amplitude of the function
  84943. */
  84944. constructor(
  84945. /** Defines the amplitude of the function */
  84946. amplitude?: number);
  84947. /** @hidden */
  84948. easeInCore(gradient: number): number;
  84949. }
  84950. /**
  84951. * Easing function with a bouncing shape (see link below).
  84952. * @see https://easings.net/#easeInBounce
  84953. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84954. */
  84955. export class BounceEase extends EasingFunction implements IEasingFunction {
  84956. /** Defines the number of bounces */
  84957. bounces: number;
  84958. /** Defines the amplitude of the bounce */
  84959. bounciness: number;
  84960. /**
  84961. * Instantiates a bounce easing
  84962. * @see https://easings.net/#easeInBounce
  84963. * @param bounces Defines the number of bounces
  84964. * @param bounciness Defines the amplitude of the bounce
  84965. */
  84966. constructor(
  84967. /** Defines the number of bounces */
  84968. bounces?: number,
  84969. /** Defines the amplitude of the bounce */
  84970. bounciness?: number);
  84971. /** @hidden */
  84972. easeInCore(gradient: number): number;
  84973. }
  84974. /**
  84975. * Easing function with a power of 3 shape (see link below).
  84976. * @see https://easings.net/#easeInCubic
  84977. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84978. */
  84979. export class CubicEase extends EasingFunction implements IEasingFunction {
  84980. /** @hidden */
  84981. easeInCore(gradient: number): number;
  84982. }
  84983. /**
  84984. * Easing function with an elastic shape (see link below).
  84985. * @see https://easings.net/#easeInElastic
  84986. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84987. */
  84988. export class ElasticEase extends EasingFunction implements IEasingFunction {
  84989. /** Defines the number of oscillations*/
  84990. oscillations: number;
  84991. /** Defines the amplitude of the oscillations*/
  84992. springiness: number;
  84993. /**
  84994. * Instantiates an elastic easing function
  84995. * @see https://easings.net/#easeInElastic
  84996. * @param oscillations Defines the number of oscillations
  84997. * @param springiness Defines the amplitude of the oscillations
  84998. */
  84999. constructor(
  85000. /** Defines the number of oscillations*/
  85001. oscillations?: number,
  85002. /** Defines the amplitude of the oscillations*/
  85003. springiness?: number);
  85004. /** @hidden */
  85005. easeInCore(gradient: number): number;
  85006. }
  85007. /**
  85008. * Easing function with an exponential shape (see link below).
  85009. * @see https://easings.net/#easeInExpo
  85010. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85011. */
  85012. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  85013. /** Defines the exponent of the function */
  85014. exponent: number;
  85015. /**
  85016. * Instantiates an exponential easing function
  85017. * @see https://easings.net/#easeInExpo
  85018. * @param exponent Defines the exponent of the function
  85019. */
  85020. constructor(
  85021. /** Defines the exponent of the function */
  85022. exponent?: number);
  85023. /** @hidden */
  85024. easeInCore(gradient: number): number;
  85025. }
  85026. /**
  85027. * Easing function with a power shape (see link below).
  85028. * @see https://easings.net/#easeInQuad
  85029. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85030. */
  85031. export class PowerEase extends EasingFunction implements IEasingFunction {
  85032. /** Defines the power of the function */
  85033. power: number;
  85034. /**
  85035. * Instantiates an power base easing function
  85036. * @see https://easings.net/#easeInQuad
  85037. * @param power Defines the power of the function
  85038. */
  85039. constructor(
  85040. /** Defines the power of the function */
  85041. power?: number);
  85042. /** @hidden */
  85043. easeInCore(gradient: number): number;
  85044. }
  85045. /**
  85046. * Easing function with a power of 2 shape (see link below).
  85047. * @see https://easings.net/#easeInQuad
  85048. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85049. */
  85050. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  85051. /** @hidden */
  85052. easeInCore(gradient: number): number;
  85053. }
  85054. /**
  85055. * Easing function with a power of 4 shape (see link below).
  85056. * @see https://easings.net/#easeInQuart
  85057. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85058. */
  85059. export class QuarticEase extends EasingFunction implements IEasingFunction {
  85060. /** @hidden */
  85061. easeInCore(gradient: number): number;
  85062. }
  85063. /**
  85064. * Easing function with a power of 5 shape (see link below).
  85065. * @see https://easings.net/#easeInQuint
  85066. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85067. */
  85068. export class QuinticEase extends EasingFunction implements IEasingFunction {
  85069. /** @hidden */
  85070. easeInCore(gradient: number): number;
  85071. }
  85072. /**
  85073. * Easing function with a sin shape (see link below).
  85074. * @see https://easings.net/#easeInSine
  85075. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85076. */
  85077. export class SineEase extends EasingFunction implements IEasingFunction {
  85078. /** @hidden */
  85079. easeInCore(gradient: number): number;
  85080. }
  85081. /**
  85082. * Easing function with a bezier shape (see link below).
  85083. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85084. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85085. */
  85086. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  85087. /** Defines the x component of the start tangent in the bezier curve */
  85088. x1: number;
  85089. /** Defines the y component of the start tangent in the bezier curve */
  85090. y1: number;
  85091. /** Defines the x component of the end tangent in the bezier curve */
  85092. x2: number;
  85093. /** Defines the y component of the end tangent in the bezier curve */
  85094. y2: number;
  85095. /**
  85096. * Instantiates a bezier function
  85097. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85098. * @param x1 Defines the x component of the start tangent in the bezier curve
  85099. * @param y1 Defines the y component of the start tangent in the bezier curve
  85100. * @param x2 Defines the x component of the end tangent in the bezier curve
  85101. * @param y2 Defines the y component of the end tangent in the bezier curve
  85102. */
  85103. constructor(
  85104. /** Defines the x component of the start tangent in the bezier curve */
  85105. x1?: number,
  85106. /** Defines the y component of the start tangent in the bezier curve */
  85107. y1?: number,
  85108. /** Defines the x component of the end tangent in the bezier curve */
  85109. x2?: number,
  85110. /** Defines the y component of the end tangent in the bezier curve */
  85111. y2?: number);
  85112. /** @hidden */
  85113. easeInCore(gradient: number): number;
  85114. }
  85115. }
  85116. declare module BABYLON {
  85117. /**
  85118. * Class used to hold a RBG color
  85119. */
  85120. export class Color3 {
  85121. /**
  85122. * Defines the red component (between 0 and 1, default is 0)
  85123. */
  85124. r: number;
  85125. /**
  85126. * Defines the green component (between 0 and 1, default is 0)
  85127. */
  85128. g: number;
  85129. /**
  85130. * Defines the blue component (between 0 and 1, default is 0)
  85131. */
  85132. b: number;
  85133. /**
  85134. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  85135. * @param r defines the red component (between 0 and 1, default is 0)
  85136. * @param g defines the green component (between 0 and 1, default is 0)
  85137. * @param b defines the blue component (between 0 and 1, default is 0)
  85138. */
  85139. constructor(
  85140. /**
  85141. * Defines the red component (between 0 and 1, default is 0)
  85142. */
  85143. r?: number,
  85144. /**
  85145. * Defines the green component (between 0 and 1, default is 0)
  85146. */
  85147. g?: number,
  85148. /**
  85149. * Defines the blue component (between 0 and 1, default is 0)
  85150. */
  85151. b?: number);
  85152. /**
  85153. * Creates a string with the Color3 current values
  85154. * @returns the string representation of the Color3 object
  85155. */
  85156. toString(): string;
  85157. /**
  85158. * Returns the string "Color3"
  85159. * @returns "Color3"
  85160. */
  85161. getClassName(): string;
  85162. /**
  85163. * Compute the Color3 hash code
  85164. * @returns an unique number that can be used to hash Color3 objects
  85165. */
  85166. getHashCode(): number;
  85167. /**
  85168. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  85169. * @param array defines the array where to store the r,g,b components
  85170. * @param index defines an optional index in the target array to define where to start storing values
  85171. * @returns the current Color3 object
  85172. */
  85173. toArray(array: FloatArray, index?: number): Color3;
  85174. /**
  85175. * Update the current color with values stored in an array from the starting index of the given array
  85176. * @param array defines the source array
  85177. * @param offset defines an offset in the source array
  85178. * @returns the current Color3 object
  85179. */
  85180. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85181. /**
  85182. * Returns a new Color4 object from the current Color3 and the given alpha
  85183. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  85184. * @returns a new Color4 object
  85185. */
  85186. toColor4(alpha?: number): Color4;
  85187. /**
  85188. * Returns a new array populated with 3 numeric elements : red, green and blue values
  85189. * @returns the new array
  85190. */
  85191. asArray(): number[];
  85192. /**
  85193. * Returns the luminance value
  85194. * @returns a float value
  85195. */
  85196. toLuminance(): number;
  85197. /**
  85198. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  85199. * @param otherColor defines the second operand
  85200. * @returns the new Color3 object
  85201. */
  85202. multiply(otherColor: DeepImmutable<Color3>): Color3;
  85203. /**
  85204. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  85205. * @param otherColor defines the second operand
  85206. * @param result defines the Color3 object where to store the result
  85207. * @returns the current Color3
  85208. */
  85209. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85210. /**
  85211. * Determines equality between Color3 objects
  85212. * @param otherColor defines the second operand
  85213. * @returns true if the rgb values are equal to the given ones
  85214. */
  85215. equals(otherColor: DeepImmutable<Color3>): boolean;
  85216. /**
  85217. * Determines equality between the current Color3 object and a set of r,b,g values
  85218. * @param r defines the red component to check
  85219. * @param g defines the green component to check
  85220. * @param b defines the blue component to check
  85221. * @returns true if the rgb values are equal to the given ones
  85222. */
  85223. equalsFloats(r: number, g: number, b: number): boolean;
  85224. /**
  85225. * Multiplies in place each rgb value by scale
  85226. * @param scale defines the scaling factor
  85227. * @returns the updated Color3
  85228. */
  85229. scale(scale: number): Color3;
  85230. /**
  85231. * Multiplies the rgb values by scale and stores the result into "result"
  85232. * @param scale defines the scaling factor
  85233. * @param result defines the Color3 object where to store the result
  85234. * @returns the unmodified current Color3
  85235. */
  85236. scaleToRef(scale: number, result: Color3): Color3;
  85237. /**
  85238. * Scale the current Color3 values by a factor and add the result to a given Color3
  85239. * @param scale defines the scale factor
  85240. * @param result defines color to store the result into
  85241. * @returns the unmodified current Color3
  85242. */
  85243. scaleAndAddToRef(scale: number, result: Color3): Color3;
  85244. /**
  85245. * Clamps the rgb values by the min and max values and stores the result into "result"
  85246. * @param min defines minimum clamping value (default is 0)
  85247. * @param max defines maximum clamping value (default is 1)
  85248. * @param result defines color to store the result into
  85249. * @returns the original Color3
  85250. */
  85251. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  85252. /**
  85253. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  85254. * @param otherColor defines the second operand
  85255. * @returns the new Color3
  85256. */
  85257. add(otherColor: DeepImmutable<Color3>): Color3;
  85258. /**
  85259. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85260. * @param otherColor defines the second operand
  85261. * @param result defines Color3 object to store the result into
  85262. * @returns the unmodified current Color3
  85263. */
  85264. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85265. /**
  85266. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85267. * @param otherColor defines the second operand
  85268. * @returns the new Color3
  85269. */
  85270. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85271. /**
  85272. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85273. * @param otherColor defines the second operand
  85274. * @param result defines Color3 object to store the result into
  85275. * @returns the unmodified current Color3
  85276. */
  85277. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85278. /**
  85279. * Copy the current object
  85280. * @returns a new Color3 copied the current one
  85281. */
  85282. clone(): Color3;
  85283. /**
  85284. * Copies the rgb values from the source in the current Color3
  85285. * @param source defines the source Color3 object
  85286. * @returns the updated Color3 object
  85287. */
  85288. copyFrom(source: DeepImmutable<Color3>): Color3;
  85289. /**
  85290. * Updates the Color3 rgb values from the given floats
  85291. * @param r defines the red component to read from
  85292. * @param g defines the green component to read from
  85293. * @param b defines the blue component to read from
  85294. * @returns the current Color3 object
  85295. */
  85296. copyFromFloats(r: number, g: number, b: number): Color3;
  85297. /**
  85298. * Updates the Color3 rgb values from the given floats
  85299. * @param r defines the red component to read from
  85300. * @param g defines the green component to read from
  85301. * @param b defines the blue component to read from
  85302. * @returns the current Color3 object
  85303. */
  85304. set(r: number, g: number, b: number): Color3;
  85305. /**
  85306. * Compute the Color3 hexadecimal code as a string
  85307. * @returns a string containing the hexadecimal representation of the Color3 object
  85308. */
  85309. toHexString(): string;
  85310. /**
  85311. * Computes a new Color3 converted from the current one to linear space
  85312. * @returns a new Color3 object
  85313. */
  85314. toLinearSpace(): Color3;
  85315. /**
  85316. * Converts current color in rgb space to HSV values
  85317. * @returns a new color3 representing the HSV values
  85318. */
  85319. toHSV(): Color3;
  85320. /**
  85321. * Converts current color in rgb space to HSV values
  85322. * @param result defines the Color3 where to store the HSV values
  85323. */
  85324. toHSVToRef(result: Color3): void;
  85325. /**
  85326. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85327. * @param convertedColor defines the Color3 object where to store the linear space version
  85328. * @returns the unmodified Color3
  85329. */
  85330. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85331. /**
  85332. * Computes a new Color3 converted from the current one to gamma space
  85333. * @returns a new Color3 object
  85334. */
  85335. toGammaSpace(): Color3;
  85336. /**
  85337. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  85338. * @param convertedColor defines the Color3 object where to store the gamma space version
  85339. * @returns the unmodified Color3
  85340. */
  85341. toGammaSpaceToRef(convertedColor: Color3): Color3;
  85342. private static _BlackReadOnly;
  85343. /**
  85344. * Convert Hue, saturation and value to a Color3 (RGB)
  85345. * @param hue defines the hue
  85346. * @param saturation defines the saturation
  85347. * @param value defines the value
  85348. * @param result defines the Color3 where to store the RGB values
  85349. */
  85350. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  85351. /**
  85352. * Creates a new Color3 from the string containing valid hexadecimal values
  85353. * @param hex defines a string containing valid hexadecimal values
  85354. * @returns a new Color3 object
  85355. */
  85356. static FromHexString(hex: string): Color3;
  85357. /**
  85358. * Creates a new Color3 from the starting index of the given array
  85359. * @param array defines the source array
  85360. * @param offset defines an offset in the source array
  85361. * @returns a new Color3 object
  85362. */
  85363. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85364. /**
  85365. * Creates a new Color3 from the starting index element of the given array
  85366. * @param array defines the source array to read from
  85367. * @param offset defines the offset in the source array
  85368. * @param result defines the target Color3 object
  85369. */
  85370. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  85371. /**
  85372. * Creates a new Color3 from integer values (< 256)
  85373. * @param r defines the red component to read from (value between 0 and 255)
  85374. * @param g defines the green component to read from (value between 0 and 255)
  85375. * @param b defines the blue component to read from (value between 0 and 255)
  85376. * @returns a new Color3 object
  85377. */
  85378. static FromInts(r: number, g: number, b: number): Color3;
  85379. /**
  85380. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85381. * @param start defines the start Color3 value
  85382. * @param end defines the end Color3 value
  85383. * @param amount defines the gradient value between start and end
  85384. * @returns a new Color3 object
  85385. */
  85386. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  85387. /**
  85388. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85389. * @param left defines the start value
  85390. * @param right defines the end value
  85391. * @param amount defines the gradient factor
  85392. * @param result defines the Color3 object where to store the result
  85393. */
  85394. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  85395. /**
  85396. * Returns a Color3 value containing a red color
  85397. * @returns a new Color3 object
  85398. */
  85399. static Red(): Color3;
  85400. /**
  85401. * Returns a Color3 value containing a green color
  85402. * @returns a new Color3 object
  85403. */
  85404. static Green(): Color3;
  85405. /**
  85406. * Returns a Color3 value containing a blue color
  85407. * @returns a new Color3 object
  85408. */
  85409. static Blue(): Color3;
  85410. /**
  85411. * Returns a Color3 value containing a black color
  85412. * @returns a new Color3 object
  85413. */
  85414. static Black(): Color3;
  85415. /**
  85416. * Gets a Color3 value containing a black color that must not be updated
  85417. */
  85418. static get BlackReadOnly(): DeepImmutable<Color3>;
  85419. /**
  85420. * Returns a Color3 value containing a white color
  85421. * @returns a new Color3 object
  85422. */
  85423. static White(): Color3;
  85424. /**
  85425. * Returns a Color3 value containing a purple color
  85426. * @returns a new Color3 object
  85427. */
  85428. static Purple(): Color3;
  85429. /**
  85430. * Returns a Color3 value containing a magenta color
  85431. * @returns a new Color3 object
  85432. */
  85433. static Magenta(): Color3;
  85434. /**
  85435. * Returns a Color3 value containing a yellow color
  85436. * @returns a new Color3 object
  85437. */
  85438. static Yellow(): Color3;
  85439. /**
  85440. * Returns a Color3 value containing a gray color
  85441. * @returns a new Color3 object
  85442. */
  85443. static Gray(): Color3;
  85444. /**
  85445. * Returns a Color3 value containing a teal color
  85446. * @returns a new Color3 object
  85447. */
  85448. static Teal(): Color3;
  85449. /**
  85450. * Returns a Color3 value containing a random color
  85451. * @returns a new Color3 object
  85452. */
  85453. static Random(): Color3;
  85454. }
  85455. /**
  85456. * Class used to hold a RBGA color
  85457. */
  85458. export class Color4 {
  85459. /**
  85460. * Defines the red component (between 0 and 1, default is 0)
  85461. */
  85462. r: number;
  85463. /**
  85464. * Defines the green component (between 0 and 1, default is 0)
  85465. */
  85466. g: number;
  85467. /**
  85468. * Defines the blue component (between 0 and 1, default is 0)
  85469. */
  85470. b: number;
  85471. /**
  85472. * Defines the alpha component (between 0 and 1, default is 1)
  85473. */
  85474. a: number;
  85475. /**
  85476. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  85477. * @param r defines the red component (between 0 and 1, default is 0)
  85478. * @param g defines the green component (between 0 and 1, default is 0)
  85479. * @param b defines the blue component (between 0 and 1, default is 0)
  85480. * @param a defines the alpha component (between 0 and 1, default is 1)
  85481. */
  85482. constructor(
  85483. /**
  85484. * Defines the red component (between 0 and 1, default is 0)
  85485. */
  85486. r?: number,
  85487. /**
  85488. * Defines the green component (between 0 and 1, default is 0)
  85489. */
  85490. g?: number,
  85491. /**
  85492. * Defines the blue component (between 0 and 1, default is 0)
  85493. */
  85494. b?: number,
  85495. /**
  85496. * Defines the alpha component (between 0 and 1, default is 1)
  85497. */
  85498. a?: number);
  85499. /**
  85500. * Adds in place the given Color4 values to the current Color4 object
  85501. * @param right defines the second operand
  85502. * @returns the current updated Color4 object
  85503. */
  85504. addInPlace(right: DeepImmutable<Color4>): Color4;
  85505. /**
  85506. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  85507. * @returns the new array
  85508. */
  85509. asArray(): number[];
  85510. /**
  85511. * Stores from the starting index in the given array the Color4 successive values
  85512. * @param array defines the array where to store the r,g,b components
  85513. * @param index defines an optional index in the target array to define where to start storing values
  85514. * @returns the current Color4 object
  85515. */
  85516. toArray(array: number[], index?: number): Color4;
  85517. /**
  85518. * Update the current color with values stored in an array from the starting index of the given array
  85519. * @param array defines the source array
  85520. * @param offset defines an offset in the source array
  85521. * @returns the current Color4 object
  85522. */
  85523. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85524. /**
  85525. * Determines equality between Color4 objects
  85526. * @param otherColor defines the second operand
  85527. * @returns true if the rgba values are equal to the given ones
  85528. */
  85529. equals(otherColor: DeepImmutable<Color4>): boolean;
  85530. /**
  85531. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  85532. * @param right defines the second operand
  85533. * @returns a new Color4 object
  85534. */
  85535. add(right: DeepImmutable<Color4>): Color4;
  85536. /**
  85537. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  85538. * @param right defines the second operand
  85539. * @returns a new Color4 object
  85540. */
  85541. subtract(right: DeepImmutable<Color4>): Color4;
  85542. /**
  85543. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  85544. * @param right defines the second operand
  85545. * @param result defines the Color4 object where to store the result
  85546. * @returns the current Color4 object
  85547. */
  85548. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  85549. /**
  85550. * Creates a new Color4 with the current Color4 values multiplied by scale
  85551. * @param scale defines the scaling factor to apply
  85552. * @returns a new Color4 object
  85553. */
  85554. scale(scale: number): Color4;
  85555. /**
  85556. * Multiplies the current Color4 values by scale and stores the result in "result"
  85557. * @param scale defines the scaling factor to apply
  85558. * @param result defines the Color4 object where to store the result
  85559. * @returns the current unmodified Color4
  85560. */
  85561. scaleToRef(scale: number, result: Color4): Color4;
  85562. /**
  85563. * Scale the current Color4 values by a factor and add the result to a given Color4
  85564. * @param scale defines the scale factor
  85565. * @param result defines the Color4 object where to store the result
  85566. * @returns the unmodified current Color4
  85567. */
  85568. scaleAndAddToRef(scale: number, result: Color4): Color4;
  85569. /**
  85570. * Clamps the rgb values by the min and max values and stores the result into "result"
  85571. * @param min defines minimum clamping value (default is 0)
  85572. * @param max defines maximum clamping value (default is 1)
  85573. * @param result defines color to store the result into.
  85574. * @returns the cuurent Color4
  85575. */
  85576. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  85577. /**
  85578. * Multipy an Color4 value by another and return a new Color4 object
  85579. * @param color defines the Color4 value to multiply by
  85580. * @returns a new Color4 object
  85581. */
  85582. multiply(color: Color4): Color4;
  85583. /**
  85584. * Multipy a Color4 value by another and push the result in a reference value
  85585. * @param color defines the Color4 value to multiply by
  85586. * @param result defines the Color4 to fill the result in
  85587. * @returns the result Color4
  85588. */
  85589. multiplyToRef(color: Color4, result: Color4): Color4;
  85590. /**
  85591. * Creates a string with the Color4 current values
  85592. * @returns the string representation of the Color4 object
  85593. */
  85594. toString(): string;
  85595. /**
  85596. * Returns the string "Color4"
  85597. * @returns "Color4"
  85598. */
  85599. getClassName(): string;
  85600. /**
  85601. * Compute the Color4 hash code
  85602. * @returns an unique number that can be used to hash Color4 objects
  85603. */
  85604. getHashCode(): number;
  85605. /**
  85606. * Creates a new Color4 copied from the current one
  85607. * @returns a new Color4 object
  85608. */
  85609. clone(): Color4;
  85610. /**
  85611. * Copies the given Color4 values into the current one
  85612. * @param source defines the source Color4 object
  85613. * @returns the current updated Color4 object
  85614. */
  85615. copyFrom(source: Color4): Color4;
  85616. /**
  85617. * Copies the given float values into the current one
  85618. * @param r defines the red component to read from
  85619. * @param g defines the green component to read from
  85620. * @param b defines the blue component to read from
  85621. * @param a defines the alpha component to read from
  85622. * @returns the current updated Color4 object
  85623. */
  85624. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  85625. /**
  85626. * Copies the given float values into the current one
  85627. * @param r defines the red component to read from
  85628. * @param g defines the green component to read from
  85629. * @param b defines the blue component to read from
  85630. * @param a defines the alpha component to read from
  85631. * @returns the current updated Color4 object
  85632. */
  85633. set(r: number, g: number, b: number, a: number): Color4;
  85634. /**
  85635. * Compute the Color4 hexadecimal code as a string
  85636. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  85637. * @returns a string containing the hexadecimal representation of the Color4 object
  85638. */
  85639. toHexString(returnAsColor3?: boolean): string;
  85640. /**
  85641. * Computes a new Color4 converted from the current one to linear space
  85642. * @returns a new Color4 object
  85643. */
  85644. toLinearSpace(): Color4;
  85645. /**
  85646. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  85647. * @param convertedColor defines the Color4 object where to store the linear space version
  85648. * @returns the unmodified Color4
  85649. */
  85650. toLinearSpaceToRef(convertedColor: Color4): Color4;
  85651. /**
  85652. * Computes a new Color4 converted from the current one to gamma space
  85653. * @returns a new Color4 object
  85654. */
  85655. toGammaSpace(): Color4;
  85656. /**
  85657. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  85658. * @param convertedColor defines the Color4 object where to store the gamma space version
  85659. * @returns the unmodified Color4
  85660. */
  85661. toGammaSpaceToRef(convertedColor: Color4): Color4;
  85662. /**
  85663. * Creates a new Color4 from the string containing valid hexadecimal values
  85664. * @param hex defines a string containing valid hexadecimal values
  85665. * @returns a new Color4 object
  85666. */
  85667. static FromHexString(hex: string): Color4;
  85668. /**
  85669. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85670. * @param left defines the start value
  85671. * @param right defines the end value
  85672. * @param amount defines the gradient factor
  85673. * @returns a new Color4 object
  85674. */
  85675. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  85676. /**
  85677. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85678. * @param left defines the start value
  85679. * @param right defines the end value
  85680. * @param amount defines the gradient factor
  85681. * @param result defines the Color4 object where to store data
  85682. */
  85683. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  85684. /**
  85685. * Creates a new Color4 from a Color3 and an alpha value
  85686. * @param color3 defines the source Color3 to read from
  85687. * @param alpha defines the alpha component (1.0 by default)
  85688. * @returns a new Color4 object
  85689. */
  85690. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  85691. /**
  85692. * Creates a new Color4 from the starting index element of the given array
  85693. * @param array defines the source array to read from
  85694. * @param offset defines the offset in the source array
  85695. * @returns a new Color4 object
  85696. */
  85697. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85698. /**
  85699. * Creates a new Color4 from the starting index element of the given array
  85700. * @param array defines the source array to read from
  85701. * @param offset defines the offset in the source array
  85702. * @param result defines the target Color4 object
  85703. */
  85704. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  85705. /**
  85706. * Creates a new Color3 from integer values (< 256)
  85707. * @param r defines the red component to read from (value between 0 and 255)
  85708. * @param g defines the green component to read from (value between 0 and 255)
  85709. * @param b defines the blue component to read from (value between 0 and 255)
  85710. * @param a defines the alpha component to read from (value between 0 and 255)
  85711. * @returns a new Color3 object
  85712. */
  85713. static FromInts(r: number, g: number, b: number, a: number): Color4;
  85714. /**
  85715. * Check the content of a given array and convert it to an array containing RGBA data
  85716. * If the original array was already containing count * 4 values then it is returned directly
  85717. * @param colors defines the array to check
  85718. * @param count defines the number of RGBA data to expect
  85719. * @returns an array containing count * 4 values (RGBA)
  85720. */
  85721. static CheckColors4(colors: number[], count: number): number[];
  85722. }
  85723. /**
  85724. * @hidden
  85725. */
  85726. export class TmpColors {
  85727. static Color3: Color3[];
  85728. static Color4: Color4[];
  85729. }
  85730. }
  85731. declare module BABYLON {
  85732. /**
  85733. * Defines an interface which represents an animation key frame
  85734. */
  85735. export interface IAnimationKey {
  85736. /**
  85737. * Frame of the key frame
  85738. */
  85739. frame: number;
  85740. /**
  85741. * Value at the specifies key frame
  85742. */
  85743. value: any;
  85744. /**
  85745. * The input tangent for the cubic hermite spline
  85746. */
  85747. inTangent?: any;
  85748. /**
  85749. * The output tangent for the cubic hermite spline
  85750. */
  85751. outTangent?: any;
  85752. /**
  85753. * The animation interpolation type
  85754. */
  85755. interpolation?: AnimationKeyInterpolation;
  85756. }
  85757. /**
  85758. * Enum for the animation key frame interpolation type
  85759. */
  85760. export enum AnimationKeyInterpolation {
  85761. /**
  85762. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  85763. */
  85764. STEP = 1
  85765. }
  85766. }
  85767. declare module BABYLON {
  85768. /**
  85769. * Represents the range of an animation
  85770. */
  85771. export class AnimationRange {
  85772. /**The name of the animation range**/
  85773. name: string;
  85774. /**The starting frame of the animation */
  85775. from: number;
  85776. /**The ending frame of the animation*/
  85777. to: number;
  85778. /**
  85779. * Initializes the range of an animation
  85780. * @param name The name of the animation range
  85781. * @param from The starting frame of the animation
  85782. * @param to The ending frame of the animation
  85783. */
  85784. constructor(
  85785. /**The name of the animation range**/
  85786. name: string,
  85787. /**The starting frame of the animation */
  85788. from: number,
  85789. /**The ending frame of the animation*/
  85790. to: number);
  85791. /**
  85792. * Makes a copy of the animation range
  85793. * @returns A copy of the animation range
  85794. */
  85795. clone(): AnimationRange;
  85796. }
  85797. }
  85798. declare module BABYLON {
  85799. /**
  85800. * Composed of a frame, and an action function
  85801. */
  85802. export class AnimationEvent {
  85803. /** The frame for which the event is triggered **/
  85804. frame: number;
  85805. /** The event to perform when triggered **/
  85806. action: (currentFrame: number) => void;
  85807. /** Specifies if the event should be triggered only once**/
  85808. onlyOnce?: boolean | undefined;
  85809. /**
  85810. * Specifies if the animation event is done
  85811. */
  85812. isDone: boolean;
  85813. /**
  85814. * Initializes the animation event
  85815. * @param frame The frame for which the event is triggered
  85816. * @param action The event to perform when triggered
  85817. * @param onlyOnce Specifies if the event should be triggered only once
  85818. */
  85819. constructor(
  85820. /** The frame for which the event is triggered **/
  85821. frame: number,
  85822. /** The event to perform when triggered **/
  85823. action: (currentFrame: number) => void,
  85824. /** Specifies if the event should be triggered only once**/
  85825. onlyOnce?: boolean | undefined);
  85826. /** @hidden */
  85827. _clone(): AnimationEvent;
  85828. }
  85829. }
  85830. declare module BABYLON {
  85831. /**
  85832. * Interface used to define a behavior
  85833. */
  85834. export interface Behavior<T> {
  85835. /** gets or sets behavior's name */
  85836. name: string;
  85837. /**
  85838. * Function called when the behavior needs to be initialized (after attaching it to a target)
  85839. */
  85840. init(): void;
  85841. /**
  85842. * Called when the behavior is attached to a target
  85843. * @param target defines the target where the behavior is attached to
  85844. */
  85845. attach(target: T): void;
  85846. /**
  85847. * Called when the behavior is detached from its target
  85848. */
  85849. detach(): void;
  85850. }
  85851. /**
  85852. * Interface implemented by classes supporting behaviors
  85853. */
  85854. export interface IBehaviorAware<T> {
  85855. /**
  85856. * Attach a behavior
  85857. * @param behavior defines the behavior to attach
  85858. * @returns the current host
  85859. */
  85860. addBehavior(behavior: Behavior<T>): T;
  85861. /**
  85862. * Remove a behavior from the current object
  85863. * @param behavior defines the behavior to detach
  85864. * @returns the current host
  85865. */
  85866. removeBehavior(behavior: Behavior<T>): T;
  85867. /**
  85868. * Gets a behavior using its name to search
  85869. * @param name defines the name to search
  85870. * @returns the behavior or null if not found
  85871. */
  85872. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  85873. }
  85874. }
  85875. declare module BABYLON {
  85876. /**
  85877. * Defines an array and its length.
  85878. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  85879. */
  85880. export interface ISmartArrayLike<T> {
  85881. /**
  85882. * The data of the array.
  85883. */
  85884. data: Array<T>;
  85885. /**
  85886. * The active length of the array.
  85887. */
  85888. length: number;
  85889. }
  85890. /**
  85891. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85892. */
  85893. export class SmartArray<T> implements ISmartArrayLike<T> {
  85894. /**
  85895. * The full set of data from the array.
  85896. */
  85897. data: Array<T>;
  85898. /**
  85899. * The active length of the array.
  85900. */
  85901. length: number;
  85902. protected _id: number;
  85903. /**
  85904. * Instantiates a Smart Array.
  85905. * @param capacity defines the default capacity of the array.
  85906. */
  85907. constructor(capacity: number);
  85908. /**
  85909. * Pushes a value at the end of the active data.
  85910. * @param value defines the object to push in the array.
  85911. */
  85912. push(value: T): void;
  85913. /**
  85914. * Iterates over the active data and apply the lambda to them.
  85915. * @param func defines the action to apply on each value.
  85916. */
  85917. forEach(func: (content: T) => void): void;
  85918. /**
  85919. * Sorts the full sets of data.
  85920. * @param compareFn defines the comparison function to apply.
  85921. */
  85922. sort(compareFn: (a: T, b: T) => number): void;
  85923. /**
  85924. * Resets the active data to an empty array.
  85925. */
  85926. reset(): void;
  85927. /**
  85928. * Releases all the data from the array as well as the array.
  85929. */
  85930. dispose(): void;
  85931. /**
  85932. * Concats the active data with a given array.
  85933. * @param array defines the data to concatenate with.
  85934. */
  85935. concat(array: any): void;
  85936. /**
  85937. * Returns the position of a value in the active data.
  85938. * @param value defines the value to find the index for
  85939. * @returns the index if found in the active data otherwise -1
  85940. */
  85941. indexOf(value: T): number;
  85942. /**
  85943. * Returns whether an element is part of the active data.
  85944. * @param value defines the value to look for
  85945. * @returns true if found in the active data otherwise false
  85946. */
  85947. contains(value: T): boolean;
  85948. private static _GlobalId;
  85949. }
  85950. /**
  85951. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85952. * The data in this array can only be present once
  85953. */
  85954. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  85955. private _duplicateId;
  85956. /**
  85957. * Pushes a value at the end of the active data.
  85958. * THIS DOES NOT PREVENT DUPPLICATE DATA
  85959. * @param value defines the object to push in the array.
  85960. */
  85961. push(value: T): void;
  85962. /**
  85963. * Pushes a value at the end of the active data.
  85964. * If the data is already present, it won t be added again
  85965. * @param value defines the object to push in the array.
  85966. * @returns true if added false if it was already present
  85967. */
  85968. pushNoDuplicate(value: T): boolean;
  85969. /**
  85970. * Resets the active data to an empty array.
  85971. */
  85972. reset(): void;
  85973. /**
  85974. * Concats the active data with a given array.
  85975. * This ensures no dupplicate will be present in the result.
  85976. * @param array defines the data to concatenate with.
  85977. */
  85978. concatWithNoDuplicate(array: any): void;
  85979. }
  85980. }
  85981. declare module BABYLON {
  85982. /**
  85983. * @ignore
  85984. * This is a list of all the different input types that are available in the application.
  85985. * Fo instance: ArcRotateCameraGamepadInput...
  85986. */
  85987. export var CameraInputTypes: {};
  85988. /**
  85989. * This is the contract to implement in order to create a new input class.
  85990. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  85991. */
  85992. export interface ICameraInput<TCamera extends Camera> {
  85993. /**
  85994. * Defines the camera the input is attached to.
  85995. */
  85996. camera: Nullable<TCamera>;
  85997. /**
  85998. * Gets the class name of the current intput.
  85999. * @returns the class name
  86000. */
  86001. getClassName(): string;
  86002. /**
  86003. * Get the friendly name associated with the input class.
  86004. * @returns the input friendly name
  86005. */
  86006. getSimpleName(): string;
  86007. /**
  86008. * Attach the input controls to a specific dom element to get the input from.
  86009. * @param element Defines the element the controls should be listened from
  86010. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86011. */
  86012. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  86013. /**
  86014. * Detach the current controls from the specified dom element.
  86015. * @param element Defines the element to stop listening the inputs from
  86016. */
  86017. detachControl(element: Nullable<HTMLElement>): void;
  86018. /**
  86019. * Update the current camera state depending on the inputs that have been used this frame.
  86020. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86021. */
  86022. checkInputs?: () => void;
  86023. }
  86024. /**
  86025. * Represents a map of input types to input instance or input index to input instance.
  86026. */
  86027. export interface CameraInputsMap<TCamera extends Camera> {
  86028. /**
  86029. * Accessor to the input by input type.
  86030. */
  86031. [name: string]: ICameraInput<TCamera>;
  86032. /**
  86033. * Accessor to the input by input index.
  86034. */
  86035. [idx: number]: ICameraInput<TCamera>;
  86036. }
  86037. /**
  86038. * This represents the input manager used within a camera.
  86039. * It helps dealing with all the different kind of input attached to a camera.
  86040. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86041. */
  86042. export class CameraInputsManager<TCamera extends Camera> {
  86043. /**
  86044. * Defines the list of inputs attahed to the camera.
  86045. */
  86046. attached: CameraInputsMap<TCamera>;
  86047. /**
  86048. * Defines the dom element the camera is collecting inputs from.
  86049. * This is null if the controls have not been attached.
  86050. */
  86051. attachedElement: Nullable<HTMLElement>;
  86052. /**
  86053. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86054. */
  86055. noPreventDefault: boolean;
  86056. /**
  86057. * Defined the camera the input manager belongs to.
  86058. */
  86059. camera: TCamera;
  86060. /**
  86061. * Update the current camera state depending on the inputs that have been used this frame.
  86062. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86063. */
  86064. checkInputs: () => void;
  86065. /**
  86066. * Instantiate a new Camera Input Manager.
  86067. * @param camera Defines the camera the input manager blongs to
  86068. */
  86069. constructor(camera: TCamera);
  86070. /**
  86071. * Add an input method to a camera
  86072. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86073. * @param input camera input method
  86074. */
  86075. add(input: ICameraInput<TCamera>): void;
  86076. /**
  86077. * Remove a specific input method from a camera
  86078. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  86079. * @param inputToRemove camera input method
  86080. */
  86081. remove(inputToRemove: ICameraInput<TCamera>): void;
  86082. /**
  86083. * Remove a specific input type from a camera
  86084. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  86085. * @param inputType the type of the input to remove
  86086. */
  86087. removeByType(inputType: string): void;
  86088. private _addCheckInputs;
  86089. /**
  86090. * Attach the input controls to the currently attached dom element to listen the events from.
  86091. * @param input Defines the input to attach
  86092. */
  86093. attachInput(input: ICameraInput<TCamera>): void;
  86094. /**
  86095. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  86096. * @param element Defines the dom element to collect the events from
  86097. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86098. */
  86099. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  86100. /**
  86101. * Detach the current manager inputs controls from a specific dom element.
  86102. * @param element Defines the dom element to collect the events from
  86103. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  86104. */
  86105. detachElement(element: HTMLElement, disconnect?: boolean): void;
  86106. /**
  86107. * Rebuild the dynamic inputCheck function from the current list of
  86108. * defined inputs in the manager.
  86109. */
  86110. rebuildInputCheck(): void;
  86111. /**
  86112. * Remove all attached input methods from a camera
  86113. */
  86114. clear(): void;
  86115. /**
  86116. * Serialize the current input manager attached to a camera.
  86117. * This ensures than once parsed,
  86118. * the input associated to the camera will be identical to the current ones
  86119. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  86120. */
  86121. serialize(serializedCamera: any): void;
  86122. /**
  86123. * Parses an input manager serialized JSON to restore the previous list of inputs
  86124. * and states associated to a camera.
  86125. * @param parsedCamera Defines the JSON to parse
  86126. */
  86127. parse(parsedCamera: any): void;
  86128. }
  86129. }
  86130. declare module BABYLON {
  86131. /**
  86132. * Class used to store data that will be store in GPU memory
  86133. */
  86134. export class Buffer {
  86135. private _engine;
  86136. private _buffer;
  86137. /** @hidden */
  86138. _data: Nullable<DataArray>;
  86139. private _updatable;
  86140. private _instanced;
  86141. private _divisor;
  86142. /**
  86143. * Gets the byte stride.
  86144. */
  86145. readonly byteStride: number;
  86146. /**
  86147. * Constructor
  86148. * @param engine the engine
  86149. * @param data the data to use for this buffer
  86150. * @param updatable whether the data is updatable
  86151. * @param stride the stride (optional)
  86152. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86153. * @param instanced whether the buffer is instanced (optional)
  86154. * @param useBytes set to true if the stride in in bytes (optional)
  86155. * @param divisor sets an optional divisor for instances (1 by default)
  86156. */
  86157. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  86158. /**
  86159. * Create a new VertexBuffer based on the current buffer
  86160. * @param kind defines the vertex buffer kind (position, normal, etc.)
  86161. * @param offset defines offset in the buffer (0 by default)
  86162. * @param size defines the size in floats of attributes (position is 3 for instance)
  86163. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  86164. * @param instanced defines if the vertex buffer contains indexed data
  86165. * @param useBytes defines if the offset and stride are in bytes *
  86166. * @param divisor sets an optional divisor for instances (1 by default)
  86167. * @returns the new vertex buffer
  86168. */
  86169. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  86170. /**
  86171. * Gets a boolean indicating if the Buffer is updatable?
  86172. * @returns true if the buffer is updatable
  86173. */
  86174. isUpdatable(): boolean;
  86175. /**
  86176. * Gets current buffer's data
  86177. * @returns a DataArray or null
  86178. */
  86179. getData(): Nullable<DataArray>;
  86180. /**
  86181. * Gets underlying native buffer
  86182. * @returns underlying native buffer
  86183. */
  86184. getBuffer(): Nullable<DataBuffer>;
  86185. /**
  86186. * Gets the stride in float32 units (i.e. byte stride / 4).
  86187. * May not be an integer if the byte stride is not divisible by 4.
  86188. * @returns the stride in float32 units
  86189. * @deprecated Please use byteStride instead.
  86190. */
  86191. getStrideSize(): number;
  86192. /**
  86193. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86194. * @param data defines the data to store
  86195. */
  86196. create(data?: Nullable<DataArray>): void;
  86197. /** @hidden */
  86198. _rebuild(): void;
  86199. /**
  86200. * Update current buffer data
  86201. * @param data defines the data to store
  86202. */
  86203. update(data: DataArray): void;
  86204. /**
  86205. * Updates the data directly.
  86206. * @param data the new data
  86207. * @param offset the new offset
  86208. * @param vertexCount the vertex count (optional)
  86209. * @param useBytes set to true if the offset is in bytes
  86210. */
  86211. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  86212. /**
  86213. * Release all resources
  86214. */
  86215. dispose(): void;
  86216. }
  86217. /**
  86218. * Specialized buffer used to store vertex data
  86219. */
  86220. export class VertexBuffer {
  86221. /** @hidden */
  86222. _buffer: Buffer;
  86223. private _kind;
  86224. private _size;
  86225. private _ownsBuffer;
  86226. private _instanced;
  86227. private _instanceDivisor;
  86228. /**
  86229. * The byte type.
  86230. */
  86231. static readonly BYTE: number;
  86232. /**
  86233. * The unsigned byte type.
  86234. */
  86235. static readonly UNSIGNED_BYTE: number;
  86236. /**
  86237. * The short type.
  86238. */
  86239. static readonly SHORT: number;
  86240. /**
  86241. * The unsigned short type.
  86242. */
  86243. static readonly UNSIGNED_SHORT: number;
  86244. /**
  86245. * The integer type.
  86246. */
  86247. static readonly INT: number;
  86248. /**
  86249. * The unsigned integer type.
  86250. */
  86251. static readonly UNSIGNED_INT: number;
  86252. /**
  86253. * The float type.
  86254. */
  86255. static readonly FLOAT: number;
  86256. /**
  86257. * Gets or sets the instance divisor when in instanced mode
  86258. */
  86259. get instanceDivisor(): number;
  86260. set instanceDivisor(value: number);
  86261. /**
  86262. * Gets the byte stride.
  86263. */
  86264. readonly byteStride: number;
  86265. /**
  86266. * Gets the byte offset.
  86267. */
  86268. readonly byteOffset: number;
  86269. /**
  86270. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86271. */
  86272. readonly normalized: boolean;
  86273. /**
  86274. * Gets the data type of each component in the array.
  86275. */
  86276. readonly type: number;
  86277. /**
  86278. * Constructor
  86279. * @param engine the engine
  86280. * @param data the data to use for this vertex buffer
  86281. * @param kind the vertex buffer kind
  86282. * @param updatable whether the data is updatable
  86283. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86284. * @param stride the stride (optional)
  86285. * @param instanced whether the buffer is instanced (optional)
  86286. * @param offset the offset of the data (optional)
  86287. * @param size the number of components (optional)
  86288. * @param type the type of the component (optional)
  86289. * @param normalized whether the data contains normalized data (optional)
  86290. * @param useBytes set to true if stride and offset are in bytes (optional)
  86291. * @param divisor defines the instance divisor to use (1 by default)
  86292. */
  86293. 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);
  86294. /** @hidden */
  86295. _rebuild(): void;
  86296. /**
  86297. * Returns the kind of the VertexBuffer (string)
  86298. * @returns a string
  86299. */
  86300. getKind(): string;
  86301. /**
  86302. * Gets a boolean indicating if the VertexBuffer is updatable?
  86303. * @returns true if the buffer is updatable
  86304. */
  86305. isUpdatable(): boolean;
  86306. /**
  86307. * Gets current buffer's data
  86308. * @returns a DataArray or null
  86309. */
  86310. getData(): Nullable<DataArray>;
  86311. /**
  86312. * Gets underlying native buffer
  86313. * @returns underlying native buffer
  86314. */
  86315. getBuffer(): Nullable<DataBuffer>;
  86316. /**
  86317. * Gets the stride in float32 units (i.e. byte stride / 4).
  86318. * May not be an integer if the byte stride is not divisible by 4.
  86319. * @returns the stride in float32 units
  86320. * @deprecated Please use byteStride instead.
  86321. */
  86322. getStrideSize(): number;
  86323. /**
  86324. * Returns the offset as a multiple of the type byte length.
  86325. * @returns the offset in bytes
  86326. * @deprecated Please use byteOffset instead.
  86327. */
  86328. getOffset(): number;
  86329. /**
  86330. * Returns the number of components per vertex attribute (integer)
  86331. * @returns the size in float
  86332. */
  86333. getSize(): number;
  86334. /**
  86335. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  86336. * @returns true if this buffer is instanced
  86337. */
  86338. getIsInstanced(): boolean;
  86339. /**
  86340. * Returns the instancing divisor, zero for non-instanced (integer).
  86341. * @returns a number
  86342. */
  86343. getInstanceDivisor(): number;
  86344. /**
  86345. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86346. * @param data defines the data to store
  86347. */
  86348. create(data?: DataArray): void;
  86349. /**
  86350. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  86351. * This function will create a new buffer if the current one is not updatable
  86352. * @param data defines the data to store
  86353. */
  86354. update(data: DataArray): void;
  86355. /**
  86356. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  86357. * Returns the directly updated WebGLBuffer.
  86358. * @param data the new data
  86359. * @param offset the new offset
  86360. * @param useBytes set to true if the offset is in bytes
  86361. */
  86362. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  86363. /**
  86364. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  86365. */
  86366. dispose(): void;
  86367. /**
  86368. * Enumerates each value of this vertex buffer as numbers.
  86369. * @param count the number of values to enumerate
  86370. * @param callback the callback function called for each value
  86371. */
  86372. forEach(count: number, callback: (value: number, index: number) => void): void;
  86373. /**
  86374. * Positions
  86375. */
  86376. static readonly PositionKind: string;
  86377. /**
  86378. * Normals
  86379. */
  86380. static readonly NormalKind: string;
  86381. /**
  86382. * Tangents
  86383. */
  86384. static readonly TangentKind: string;
  86385. /**
  86386. * Texture coordinates
  86387. */
  86388. static readonly UVKind: string;
  86389. /**
  86390. * Texture coordinates 2
  86391. */
  86392. static readonly UV2Kind: string;
  86393. /**
  86394. * Texture coordinates 3
  86395. */
  86396. static readonly UV3Kind: string;
  86397. /**
  86398. * Texture coordinates 4
  86399. */
  86400. static readonly UV4Kind: string;
  86401. /**
  86402. * Texture coordinates 5
  86403. */
  86404. static readonly UV5Kind: string;
  86405. /**
  86406. * Texture coordinates 6
  86407. */
  86408. static readonly UV6Kind: string;
  86409. /**
  86410. * Colors
  86411. */
  86412. static readonly ColorKind: string;
  86413. /**
  86414. * Matrix indices (for bones)
  86415. */
  86416. static readonly MatricesIndicesKind: string;
  86417. /**
  86418. * Matrix weights (for bones)
  86419. */
  86420. static readonly MatricesWeightsKind: string;
  86421. /**
  86422. * Additional matrix indices (for bones)
  86423. */
  86424. static readonly MatricesIndicesExtraKind: string;
  86425. /**
  86426. * Additional matrix weights (for bones)
  86427. */
  86428. static readonly MatricesWeightsExtraKind: string;
  86429. /**
  86430. * Deduces the stride given a kind.
  86431. * @param kind The kind string to deduce
  86432. * @returns The deduced stride
  86433. */
  86434. static DeduceStride(kind: string): number;
  86435. /**
  86436. * Gets the byte length of the given type.
  86437. * @param type the type
  86438. * @returns the number of bytes
  86439. */
  86440. static GetTypeByteLength(type: number): number;
  86441. /**
  86442. * Enumerates each value of the given parameters as numbers.
  86443. * @param data the data to enumerate
  86444. * @param byteOffset the byte offset of the data
  86445. * @param byteStride the byte stride of the data
  86446. * @param componentCount the number of components per element
  86447. * @param componentType the type of the component
  86448. * @param count the number of values to enumerate
  86449. * @param normalized whether the data is normalized
  86450. * @param callback the callback function called for each value
  86451. */
  86452. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  86453. private static _GetFloatValue;
  86454. }
  86455. }
  86456. declare module BABYLON {
  86457. /**
  86458. * @hidden
  86459. */
  86460. export class IntersectionInfo {
  86461. bu: Nullable<number>;
  86462. bv: Nullable<number>;
  86463. distance: number;
  86464. faceId: number;
  86465. subMeshId: number;
  86466. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  86467. }
  86468. }
  86469. declare module BABYLON {
  86470. /**
  86471. * Class used to store bounding sphere information
  86472. */
  86473. export class BoundingSphere {
  86474. /**
  86475. * Gets the center of the bounding sphere in local space
  86476. */
  86477. readonly center: Vector3;
  86478. /**
  86479. * Radius of the bounding sphere in local space
  86480. */
  86481. radius: number;
  86482. /**
  86483. * Gets the center of the bounding sphere in world space
  86484. */
  86485. readonly centerWorld: Vector3;
  86486. /**
  86487. * Radius of the bounding sphere in world space
  86488. */
  86489. radiusWorld: number;
  86490. /**
  86491. * Gets the minimum vector in local space
  86492. */
  86493. readonly minimum: Vector3;
  86494. /**
  86495. * Gets the maximum vector in local space
  86496. */
  86497. readonly maximum: Vector3;
  86498. private _worldMatrix;
  86499. private static readonly TmpVector3;
  86500. /**
  86501. * Creates a new bounding sphere
  86502. * @param min defines the minimum vector (in local space)
  86503. * @param max defines the maximum vector (in local space)
  86504. * @param worldMatrix defines the new world matrix
  86505. */
  86506. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86507. /**
  86508. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  86509. * @param min defines the new minimum vector (in local space)
  86510. * @param max defines the new maximum vector (in local space)
  86511. * @param worldMatrix defines the new world matrix
  86512. */
  86513. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86514. /**
  86515. * Scale the current bounding sphere by applying a scale factor
  86516. * @param factor defines the scale factor to apply
  86517. * @returns the current bounding box
  86518. */
  86519. scale(factor: number): BoundingSphere;
  86520. /**
  86521. * Gets the world matrix of the bounding box
  86522. * @returns a matrix
  86523. */
  86524. getWorldMatrix(): DeepImmutable<Matrix>;
  86525. /** @hidden */
  86526. _update(worldMatrix: DeepImmutable<Matrix>): void;
  86527. /**
  86528. * Tests if the bounding sphere is intersecting the frustum planes
  86529. * @param frustumPlanes defines the frustum planes to test
  86530. * @returns true if there is an intersection
  86531. */
  86532. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86533. /**
  86534. * Tests if the bounding sphere center is in between the frustum planes.
  86535. * Used for optimistic fast inclusion.
  86536. * @param frustumPlanes defines the frustum planes to test
  86537. * @returns true if the sphere center is in between the frustum planes
  86538. */
  86539. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86540. /**
  86541. * Tests if a point is inside the bounding sphere
  86542. * @param point defines the point to test
  86543. * @returns true if the point is inside the bounding sphere
  86544. */
  86545. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86546. /**
  86547. * Checks if two sphere intersct
  86548. * @param sphere0 sphere 0
  86549. * @param sphere1 sphere 1
  86550. * @returns true if the speres intersect
  86551. */
  86552. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  86553. }
  86554. }
  86555. declare module BABYLON {
  86556. /**
  86557. * Class used to store bounding box information
  86558. */
  86559. export class BoundingBox implements ICullable {
  86560. /**
  86561. * Gets the 8 vectors representing the bounding box in local space
  86562. */
  86563. readonly vectors: Vector3[];
  86564. /**
  86565. * Gets the center of the bounding box in local space
  86566. */
  86567. readonly center: Vector3;
  86568. /**
  86569. * Gets the center of the bounding box in world space
  86570. */
  86571. readonly centerWorld: Vector3;
  86572. /**
  86573. * Gets the extend size in local space
  86574. */
  86575. readonly extendSize: Vector3;
  86576. /**
  86577. * Gets the extend size in world space
  86578. */
  86579. readonly extendSizeWorld: Vector3;
  86580. /**
  86581. * Gets the OBB (object bounding box) directions
  86582. */
  86583. readonly directions: Vector3[];
  86584. /**
  86585. * Gets the 8 vectors representing the bounding box in world space
  86586. */
  86587. readonly vectorsWorld: Vector3[];
  86588. /**
  86589. * Gets the minimum vector in world space
  86590. */
  86591. readonly minimumWorld: Vector3;
  86592. /**
  86593. * Gets the maximum vector in world space
  86594. */
  86595. readonly maximumWorld: Vector3;
  86596. /**
  86597. * Gets the minimum vector in local space
  86598. */
  86599. readonly minimum: Vector3;
  86600. /**
  86601. * Gets the maximum vector in local space
  86602. */
  86603. readonly maximum: Vector3;
  86604. private _worldMatrix;
  86605. private static readonly TmpVector3;
  86606. /**
  86607. * @hidden
  86608. */
  86609. _tag: number;
  86610. /**
  86611. * Creates a new bounding box
  86612. * @param min defines the minimum vector (in local space)
  86613. * @param max defines the maximum vector (in local space)
  86614. * @param worldMatrix defines the new world matrix
  86615. */
  86616. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86617. /**
  86618. * Recreates the entire bounding box from scratch as if we call the constructor in place
  86619. * @param min defines the new minimum vector (in local space)
  86620. * @param max defines the new maximum vector (in local space)
  86621. * @param worldMatrix defines the new world matrix
  86622. */
  86623. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86624. /**
  86625. * Scale the current bounding box by applying a scale factor
  86626. * @param factor defines the scale factor to apply
  86627. * @returns the current bounding box
  86628. */
  86629. scale(factor: number): BoundingBox;
  86630. /**
  86631. * Gets the world matrix of the bounding box
  86632. * @returns a matrix
  86633. */
  86634. getWorldMatrix(): DeepImmutable<Matrix>;
  86635. /** @hidden */
  86636. _update(world: DeepImmutable<Matrix>): void;
  86637. /**
  86638. * Tests if the bounding box is intersecting the frustum planes
  86639. * @param frustumPlanes defines the frustum planes to test
  86640. * @returns true if there is an intersection
  86641. */
  86642. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86643. /**
  86644. * Tests if the bounding box is entirely inside the frustum planes
  86645. * @param frustumPlanes defines the frustum planes to test
  86646. * @returns true if there is an inclusion
  86647. */
  86648. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86649. /**
  86650. * Tests if a point is inside the bounding box
  86651. * @param point defines the point to test
  86652. * @returns true if the point is inside the bounding box
  86653. */
  86654. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86655. /**
  86656. * Tests if the bounding box intersects with a bounding sphere
  86657. * @param sphere defines the sphere to test
  86658. * @returns true if there is an intersection
  86659. */
  86660. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  86661. /**
  86662. * Tests if the bounding box intersects with a box defined by a min and max vectors
  86663. * @param min defines the min vector to use
  86664. * @param max defines the max vector to use
  86665. * @returns true if there is an intersection
  86666. */
  86667. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  86668. /**
  86669. * Tests if two bounding boxes are intersections
  86670. * @param box0 defines the first box to test
  86671. * @param box1 defines the second box to test
  86672. * @returns true if there is an intersection
  86673. */
  86674. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  86675. /**
  86676. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  86677. * @param minPoint defines the minimum vector of the bounding box
  86678. * @param maxPoint defines the maximum vector of the bounding box
  86679. * @param sphereCenter defines the sphere center
  86680. * @param sphereRadius defines the sphere radius
  86681. * @returns true if there is an intersection
  86682. */
  86683. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  86684. /**
  86685. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  86686. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86687. * @param frustumPlanes defines the frustum planes to test
  86688. * @return true if there is an inclusion
  86689. */
  86690. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86691. /**
  86692. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  86693. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86694. * @param frustumPlanes defines the frustum planes to test
  86695. * @return true if there is an intersection
  86696. */
  86697. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86698. }
  86699. }
  86700. declare module BABYLON {
  86701. /** @hidden */
  86702. export class Collider {
  86703. /** Define if a collision was found */
  86704. collisionFound: boolean;
  86705. /**
  86706. * Define last intersection point in local space
  86707. */
  86708. intersectionPoint: Vector3;
  86709. /**
  86710. * Define last collided mesh
  86711. */
  86712. collidedMesh: Nullable<AbstractMesh>;
  86713. private _collisionPoint;
  86714. private _planeIntersectionPoint;
  86715. private _tempVector;
  86716. private _tempVector2;
  86717. private _tempVector3;
  86718. private _tempVector4;
  86719. private _edge;
  86720. private _baseToVertex;
  86721. private _destinationPoint;
  86722. private _slidePlaneNormal;
  86723. private _displacementVector;
  86724. /** @hidden */
  86725. _radius: Vector3;
  86726. /** @hidden */
  86727. _retry: number;
  86728. private _velocity;
  86729. private _basePoint;
  86730. private _epsilon;
  86731. /** @hidden */
  86732. _velocityWorldLength: number;
  86733. /** @hidden */
  86734. _basePointWorld: Vector3;
  86735. private _velocityWorld;
  86736. private _normalizedVelocity;
  86737. /** @hidden */
  86738. _initialVelocity: Vector3;
  86739. /** @hidden */
  86740. _initialPosition: Vector3;
  86741. private _nearestDistance;
  86742. private _collisionMask;
  86743. get collisionMask(): number;
  86744. set collisionMask(mask: number);
  86745. /**
  86746. * Gets the plane normal used to compute the sliding response (in local space)
  86747. */
  86748. get slidePlaneNormal(): Vector3;
  86749. /** @hidden */
  86750. _initialize(source: Vector3, dir: Vector3, e: number): void;
  86751. /** @hidden */
  86752. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  86753. /** @hidden */
  86754. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  86755. /** @hidden */
  86756. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86757. /** @hidden */
  86758. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86759. /** @hidden */
  86760. _getResponse(pos: Vector3, vel: Vector3): void;
  86761. }
  86762. }
  86763. declare module BABYLON {
  86764. /**
  86765. * Interface for cullable objects
  86766. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  86767. */
  86768. export interface ICullable {
  86769. /**
  86770. * Checks if the object or part of the object is in the frustum
  86771. * @param frustumPlanes Camera near/planes
  86772. * @returns true if the object is in frustum otherwise false
  86773. */
  86774. isInFrustum(frustumPlanes: Plane[]): boolean;
  86775. /**
  86776. * Checks if a cullable object (mesh...) is in the camera frustum
  86777. * Unlike isInFrustum this cheks the full bounding box
  86778. * @param frustumPlanes Camera near/planes
  86779. * @returns true if the object is in frustum otherwise false
  86780. */
  86781. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86782. }
  86783. /**
  86784. * Info for a bounding data of a mesh
  86785. */
  86786. export class BoundingInfo implements ICullable {
  86787. /**
  86788. * Bounding box for the mesh
  86789. */
  86790. readonly boundingBox: BoundingBox;
  86791. /**
  86792. * Bounding sphere for the mesh
  86793. */
  86794. readonly boundingSphere: BoundingSphere;
  86795. private _isLocked;
  86796. private static readonly TmpVector3;
  86797. /**
  86798. * Constructs bounding info
  86799. * @param minimum min vector of the bounding box/sphere
  86800. * @param maximum max vector of the bounding box/sphere
  86801. * @param worldMatrix defines the new world matrix
  86802. */
  86803. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86804. /**
  86805. * Recreates the entire bounding info from scratch as if we call the constructor in place
  86806. * @param min defines the new minimum vector (in local space)
  86807. * @param max defines the new maximum vector (in local space)
  86808. * @param worldMatrix defines the new world matrix
  86809. */
  86810. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86811. /**
  86812. * min vector of the bounding box/sphere
  86813. */
  86814. get minimum(): Vector3;
  86815. /**
  86816. * max vector of the bounding box/sphere
  86817. */
  86818. get maximum(): Vector3;
  86819. /**
  86820. * If the info is locked and won't be updated to avoid perf overhead
  86821. */
  86822. get isLocked(): boolean;
  86823. set isLocked(value: boolean);
  86824. /**
  86825. * Updates the bounding sphere and box
  86826. * @param world world matrix to be used to update
  86827. */
  86828. update(world: DeepImmutable<Matrix>): void;
  86829. /**
  86830. * Recreate the bounding info to be centered around a specific point given a specific extend.
  86831. * @param center New center of the bounding info
  86832. * @param extend New extend of the bounding info
  86833. * @returns the current bounding info
  86834. */
  86835. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  86836. /**
  86837. * Scale the current bounding info by applying a scale factor
  86838. * @param factor defines the scale factor to apply
  86839. * @returns the current bounding info
  86840. */
  86841. scale(factor: number): BoundingInfo;
  86842. /**
  86843. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  86844. * @param frustumPlanes defines the frustum to test
  86845. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  86846. * @returns true if the bounding info is in the frustum planes
  86847. */
  86848. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  86849. /**
  86850. * Gets the world distance between the min and max points of the bounding box
  86851. */
  86852. get diagonalLength(): number;
  86853. /**
  86854. * Checks if a cullable object (mesh...) is in the camera frustum
  86855. * Unlike isInFrustum this cheks the full bounding box
  86856. * @param frustumPlanes Camera near/planes
  86857. * @returns true if the object is in frustum otherwise false
  86858. */
  86859. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86860. /** @hidden */
  86861. _checkCollision(collider: Collider): boolean;
  86862. /**
  86863. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  86864. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86865. * @param point the point to check intersection with
  86866. * @returns if the point intersects
  86867. */
  86868. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86869. /**
  86870. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  86871. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86872. * @param boundingInfo the bounding info to check intersection with
  86873. * @param precise if the intersection should be done using OBB
  86874. * @returns if the bounding info intersects
  86875. */
  86876. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  86877. }
  86878. }
  86879. declare module BABYLON {
  86880. /**
  86881. * Extracts minimum and maximum values from a list of indexed positions
  86882. * @param positions defines the positions to use
  86883. * @param indices defines the indices to the positions
  86884. * @param indexStart defines the start index
  86885. * @param indexCount defines the end index
  86886. * @param bias defines bias value to add to the result
  86887. * @return minimum and maximum values
  86888. */
  86889. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  86890. minimum: Vector3;
  86891. maximum: Vector3;
  86892. };
  86893. /**
  86894. * Extracts minimum and maximum values from a list of positions
  86895. * @param positions defines the positions to use
  86896. * @param start defines the start index in the positions array
  86897. * @param count defines the number of positions to handle
  86898. * @param bias defines bias value to add to the result
  86899. * @param stride defines the stride size to use (distance between two positions in the positions array)
  86900. * @return minimum and maximum values
  86901. */
  86902. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  86903. minimum: Vector3;
  86904. maximum: Vector3;
  86905. };
  86906. }
  86907. declare module BABYLON {
  86908. /** @hidden */
  86909. export class WebGLDataBuffer extends DataBuffer {
  86910. private _buffer;
  86911. constructor(resource: WebGLBuffer);
  86912. get underlyingResource(): any;
  86913. }
  86914. }
  86915. declare module BABYLON {
  86916. /** @hidden */
  86917. export class WebGLPipelineContext implements IPipelineContext {
  86918. engine: ThinEngine;
  86919. program: Nullable<WebGLProgram>;
  86920. context?: WebGLRenderingContext;
  86921. vertexShader?: WebGLShader;
  86922. fragmentShader?: WebGLShader;
  86923. isParallelCompiled: boolean;
  86924. onCompiled?: () => void;
  86925. transformFeedback?: WebGLTransformFeedback | null;
  86926. vertexCompilationError: Nullable<string>;
  86927. fragmentCompilationError: Nullable<string>;
  86928. programLinkError: Nullable<string>;
  86929. programValidationError: Nullable<string>;
  86930. get isAsync(): boolean;
  86931. get isReady(): boolean;
  86932. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  86933. _getVertexShaderCode(): string | null;
  86934. _getFragmentShaderCode(): string | null;
  86935. }
  86936. }
  86937. declare module BABYLON {
  86938. interface ThinEngine {
  86939. /**
  86940. * Create an uniform buffer
  86941. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86942. * @param elements defines the content of the uniform buffer
  86943. * @returns the webGL uniform buffer
  86944. */
  86945. createUniformBuffer(elements: FloatArray): DataBuffer;
  86946. /**
  86947. * Create a dynamic uniform buffer
  86948. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86949. * @param elements defines the content of the uniform buffer
  86950. * @returns the webGL uniform buffer
  86951. */
  86952. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  86953. /**
  86954. * Update an existing uniform buffer
  86955. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86956. * @param uniformBuffer defines the target uniform buffer
  86957. * @param elements defines the content to update
  86958. * @param offset defines the offset in the uniform buffer where update should start
  86959. * @param count defines the size of the data to update
  86960. */
  86961. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  86962. /**
  86963. * Bind an uniform buffer to the current webGL context
  86964. * @param buffer defines the buffer to bind
  86965. */
  86966. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  86967. /**
  86968. * Bind a buffer to the current webGL context at a given location
  86969. * @param buffer defines the buffer to bind
  86970. * @param location defines the index where to bind the buffer
  86971. */
  86972. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  86973. /**
  86974. * Bind a specific block at a given index in a specific shader program
  86975. * @param pipelineContext defines the pipeline context to use
  86976. * @param blockName defines the block name
  86977. * @param index defines the index where to bind the block
  86978. */
  86979. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  86980. }
  86981. }
  86982. declare module BABYLON {
  86983. /**
  86984. * Uniform buffer objects.
  86985. *
  86986. * Handles blocks of uniform on the GPU.
  86987. *
  86988. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  86989. *
  86990. * For more information, please refer to :
  86991. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  86992. */
  86993. export class UniformBuffer {
  86994. private _engine;
  86995. private _buffer;
  86996. private _data;
  86997. private _bufferData;
  86998. private _dynamic?;
  86999. private _uniformLocations;
  87000. private _uniformSizes;
  87001. private _uniformLocationPointer;
  87002. private _needSync;
  87003. private _noUBO;
  87004. private _currentEffect;
  87005. /** @hidden */
  87006. _alreadyBound: boolean;
  87007. private static _MAX_UNIFORM_SIZE;
  87008. private static _tempBuffer;
  87009. /**
  87010. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  87011. * This is dynamic to allow compat with webgl 1 and 2.
  87012. * You will need to pass the name of the uniform as well as the value.
  87013. */
  87014. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  87015. /**
  87016. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  87017. * This is dynamic to allow compat with webgl 1 and 2.
  87018. * You will need to pass the name of the uniform as well as the value.
  87019. */
  87020. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  87021. /**
  87022. * Lambda to Update a single float in a uniform buffer.
  87023. * This is dynamic to allow compat with webgl 1 and 2.
  87024. * You will need to pass the name of the uniform as well as the value.
  87025. */
  87026. updateFloat: (name: string, x: number) => void;
  87027. /**
  87028. * Lambda to Update a vec2 of float in a uniform buffer.
  87029. * This is dynamic to allow compat with webgl 1 and 2.
  87030. * You will need to pass the name of the uniform as well as the value.
  87031. */
  87032. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  87033. /**
  87034. * Lambda to Update a vec3 of float in a uniform buffer.
  87035. * This is dynamic to allow compat with webgl 1 and 2.
  87036. * You will need to pass the name of the uniform as well as the value.
  87037. */
  87038. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  87039. /**
  87040. * Lambda to Update a vec4 of float in a uniform buffer.
  87041. * This is dynamic to allow compat with webgl 1 and 2.
  87042. * You will need to pass the name of the uniform as well as the value.
  87043. */
  87044. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  87045. /**
  87046. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  87047. * This is dynamic to allow compat with webgl 1 and 2.
  87048. * You will need to pass the name of the uniform as well as the value.
  87049. */
  87050. updateMatrix: (name: string, mat: Matrix) => void;
  87051. /**
  87052. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  87053. * This is dynamic to allow compat with webgl 1 and 2.
  87054. * You will need to pass the name of the uniform as well as the value.
  87055. */
  87056. updateVector3: (name: string, vector: Vector3) => void;
  87057. /**
  87058. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  87059. * This is dynamic to allow compat with webgl 1 and 2.
  87060. * You will need to pass the name of the uniform as well as the value.
  87061. */
  87062. updateVector4: (name: string, vector: Vector4) => void;
  87063. /**
  87064. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  87065. * This is dynamic to allow compat with webgl 1 and 2.
  87066. * You will need to pass the name of the uniform as well as the value.
  87067. */
  87068. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  87069. /**
  87070. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  87071. * This is dynamic to allow compat with webgl 1 and 2.
  87072. * You will need to pass the name of the uniform as well as the value.
  87073. */
  87074. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  87075. /**
  87076. * Instantiates a new Uniform buffer objects.
  87077. *
  87078. * Handles blocks of uniform on the GPU.
  87079. *
  87080. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87081. *
  87082. * For more information, please refer to :
  87083. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87084. * @param engine Define the engine the buffer is associated with
  87085. * @param data Define the data contained in the buffer
  87086. * @param dynamic Define if the buffer is updatable
  87087. */
  87088. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  87089. /**
  87090. * Indicates if the buffer is using the WebGL2 UBO implementation,
  87091. * or just falling back on setUniformXXX calls.
  87092. */
  87093. get useUbo(): boolean;
  87094. /**
  87095. * Indicates if the WebGL underlying uniform buffer is in sync
  87096. * with the javascript cache data.
  87097. */
  87098. get isSync(): boolean;
  87099. /**
  87100. * Indicates if the WebGL underlying uniform buffer is dynamic.
  87101. * Also, a dynamic UniformBuffer will disable cache verification and always
  87102. * update the underlying WebGL uniform buffer to the GPU.
  87103. * @returns if Dynamic, otherwise false
  87104. */
  87105. isDynamic(): boolean;
  87106. /**
  87107. * The data cache on JS side.
  87108. * @returns the underlying data as a float array
  87109. */
  87110. getData(): Float32Array;
  87111. /**
  87112. * The underlying WebGL Uniform buffer.
  87113. * @returns the webgl buffer
  87114. */
  87115. getBuffer(): Nullable<DataBuffer>;
  87116. /**
  87117. * std140 layout specifies how to align data within an UBO structure.
  87118. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  87119. * for specs.
  87120. */
  87121. private _fillAlignment;
  87122. /**
  87123. * Adds an uniform in the buffer.
  87124. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  87125. * for the layout to be correct !
  87126. * @param name Name of the uniform, as used in the uniform block in the shader.
  87127. * @param size Data size, or data directly.
  87128. */
  87129. addUniform(name: string, size: number | number[]): void;
  87130. /**
  87131. * Adds a Matrix 4x4 to the uniform buffer.
  87132. * @param name Name of the uniform, as used in the uniform block in the shader.
  87133. * @param mat A 4x4 matrix.
  87134. */
  87135. addMatrix(name: string, mat: Matrix): void;
  87136. /**
  87137. * Adds a vec2 to the uniform buffer.
  87138. * @param name Name of the uniform, as used in the uniform block in the shader.
  87139. * @param x Define the x component value of the vec2
  87140. * @param y Define the y component value of the vec2
  87141. */
  87142. addFloat2(name: string, x: number, y: number): void;
  87143. /**
  87144. * Adds a vec3 to the uniform buffer.
  87145. * @param name Name of the uniform, as used in the uniform block in the shader.
  87146. * @param x Define the x component value of the vec3
  87147. * @param y Define the y component value of the vec3
  87148. * @param z Define the z component value of the vec3
  87149. */
  87150. addFloat3(name: string, x: number, y: number, z: number): void;
  87151. /**
  87152. * Adds a vec3 to the uniform buffer.
  87153. * @param name Name of the uniform, as used in the uniform block in the shader.
  87154. * @param color Define the vec3 from a Color
  87155. */
  87156. addColor3(name: string, color: Color3): void;
  87157. /**
  87158. * Adds a vec4 to the uniform buffer.
  87159. * @param name Name of the uniform, as used in the uniform block in the shader.
  87160. * @param color Define the rgb components from a Color
  87161. * @param alpha Define the a component of the vec4
  87162. */
  87163. addColor4(name: string, color: Color3, alpha: number): void;
  87164. /**
  87165. * Adds a vec3 to the uniform buffer.
  87166. * @param name Name of the uniform, as used in the uniform block in the shader.
  87167. * @param vector Define the vec3 components from a Vector
  87168. */
  87169. addVector3(name: string, vector: Vector3): void;
  87170. /**
  87171. * Adds a Matrix 3x3 to the uniform buffer.
  87172. * @param name Name of the uniform, as used in the uniform block in the shader.
  87173. */
  87174. addMatrix3x3(name: string): void;
  87175. /**
  87176. * Adds a Matrix 2x2 to the uniform buffer.
  87177. * @param name Name of the uniform, as used in the uniform block in the shader.
  87178. */
  87179. addMatrix2x2(name: string): void;
  87180. /**
  87181. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  87182. */
  87183. create(): void;
  87184. /** @hidden */
  87185. _rebuild(): void;
  87186. /**
  87187. * Updates the WebGL Uniform Buffer on the GPU.
  87188. * If the `dynamic` flag is set to true, no cache comparison is done.
  87189. * Otherwise, the buffer will be updated only if the cache differs.
  87190. */
  87191. update(): void;
  87192. /**
  87193. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  87194. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87195. * @param data Define the flattened data
  87196. * @param size Define the size of the data.
  87197. */
  87198. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  87199. private _valueCache;
  87200. private _cacheMatrix;
  87201. private _updateMatrix3x3ForUniform;
  87202. private _updateMatrix3x3ForEffect;
  87203. private _updateMatrix2x2ForEffect;
  87204. private _updateMatrix2x2ForUniform;
  87205. private _updateFloatForEffect;
  87206. private _updateFloatForUniform;
  87207. private _updateFloat2ForEffect;
  87208. private _updateFloat2ForUniform;
  87209. private _updateFloat3ForEffect;
  87210. private _updateFloat3ForUniform;
  87211. private _updateFloat4ForEffect;
  87212. private _updateFloat4ForUniform;
  87213. private _updateMatrixForEffect;
  87214. private _updateMatrixForUniform;
  87215. private _updateVector3ForEffect;
  87216. private _updateVector3ForUniform;
  87217. private _updateVector4ForEffect;
  87218. private _updateVector4ForUniform;
  87219. private _updateColor3ForEffect;
  87220. private _updateColor3ForUniform;
  87221. private _updateColor4ForEffect;
  87222. private _updateColor4ForUniform;
  87223. /**
  87224. * Sets a sampler uniform on the effect.
  87225. * @param name Define the name of the sampler.
  87226. * @param texture Define the texture to set in the sampler
  87227. */
  87228. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  87229. /**
  87230. * Directly updates the value of the uniform in the cache AND on the GPU.
  87231. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87232. * @param data Define the flattened data
  87233. */
  87234. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  87235. /**
  87236. * Binds this uniform buffer to an effect.
  87237. * @param effect Define the effect to bind the buffer to
  87238. * @param name Name of the uniform block in the shader.
  87239. */
  87240. bindToEffect(effect: Effect, name: string): void;
  87241. /**
  87242. * Disposes the uniform buffer.
  87243. */
  87244. dispose(): void;
  87245. }
  87246. }
  87247. declare module BABYLON {
  87248. /**
  87249. * Enum that determines the text-wrapping mode to use.
  87250. */
  87251. export enum InspectableType {
  87252. /**
  87253. * Checkbox for booleans
  87254. */
  87255. Checkbox = 0,
  87256. /**
  87257. * Sliders for numbers
  87258. */
  87259. Slider = 1,
  87260. /**
  87261. * Vector3
  87262. */
  87263. Vector3 = 2,
  87264. /**
  87265. * Quaternions
  87266. */
  87267. Quaternion = 3,
  87268. /**
  87269. * Color3
  87270. */
  87271. Color3 = 4,
  87272. /**
  87273. * String
  87274. */
  87275. String = 5
  87276. }
  87277. /**
  87278. * Interface used to define custom inspectable properties.
  87279. * This interface is used by the inspector to display custom property grids
  87280. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87281. */
  87282. export interface IInspectable {
  87283. /**
  87284. * Gets the label to display
  87285. */
  87286. label: string;
  87287. /**
  87288. * Gets the name of the property to edit
  87289. */
  87290. propertyName: string;
  87291. /**
  87292. * Gets the type of the editor to use
  87293. */
  87294. type: InspectableType;
  87295. /**
  87296. * Gets the minimum value of the property when using in "slider" mode
  87297. */
  87298. min?: number;
  87299. /**
  87300. * Gets the maximum value of the property when using in "slider" mode
  87301. */
  87302. max?: number;
  87303. /**
  87304. * Gets the setp to use when using in "slider" mode
  87305. */
  87306. step?: number;
  87307. }
  87308. }
  87309. declare module BABYLON {
  87310. /**
  87311. * Class used to provide helper for timing
  87312. */
  87313. export class TimingTools {
  87314. /**
  87315. * Polyfill for setImmediate
  87316. * @param action defines the action to execute after the current execution block
  87317. */
  87318. static SetImmediate(action: () => void): void;
  87319. }
  87320. }
  87321. declare module BABYLON {
  87322. /**
  87323. * Class used to enable instatition of objects by class name
  87324. */
  87325. export class InstantiationTools {
  87326. /**
  87327. * Use this object to register external classes like custom textures or material
  87328. * to allow the laoders to instantiate them
  87329. */
  87330. static RegisteredExternalClasses: {
  87331. [key: string]: Object;
  87332. };
  87333. /**
  87334. * Tries to instantiate a new object from a given class name
  87335. * @param className defines the class name to instantiate
  87336. * @returns the new object or null if the system was not able to do the instantiation
  87337. */
  87338. static Instantiate(className: string): any;
  87339. }
  87340. }
  87341. declare module BABYLON {
  87342. /**
  87343. * Define options used to create a depth texture
  87344. */
  87345. export class DepthTextureCreationOptions {
  87346. /** Specifies whether or not a stencil should be allocated in the texture */
  87347. generateStencil?: boolean;
  87348. /** Specifies whether or not bilinear filtering is enable on the texture */
  87349. bilinearFiltering?: boolean;
  87350. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  87351. comparisonFunction?: number;
  87352. /** Specifies if the created texture is a cube texture */
  87353. isCube?: boolean;
  87354. }
  87355. }
  87356. declare module BABYLON {
  87357. interface ThinEngine {
  87358. /**
  87359. * Creates a depth stencil cube texture.
  87360. * This is only available in WebGL 2.
  87361. * @param size The size of face edge in the cube texture.
  87362. * @param options The options defining the cube texture.
  87363. * @returns The cube texture
  87364. */
  87365. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  87366. /**
  87367. * Creates a cube texture
  87368. * @param rootUrl defines the url where the files to load is located
  87369. * @param scene defines the current scene
  87370. * @param files defines the list of files to load (1 per face)
  87371. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87372. * @param onLoad defines an optional callback raised when the texture is loaded
  87373. * @param onError defines an optional callback raised if there is an issue to load the texture
  87374. * @param format defines the format of the data
  87375. * @param forcedExtension defines the extension to use to pick the right loader
  87376. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87377. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87378. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87379. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  87380. * @returns the cube texture as an InternalTexture
  87381. */
  87382. 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;
  87383. /**
  87384. * Creates a cube texture
  87385. * @param rootUrl defines the url where the files to load is located
  87386. * @param scene defines the current scene
  87387. * @param files defines the list of files to load (1 per face)
  87388. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87389. * @param onLoad defines an optional callback raised when the texture is loaded
  87390. * @param onError defines an optional callback raised if there is an issue to load the texture
  87391. * @param format defines the format of the data
  87392. * @param forcedExtension defines the extension to use to pick the right loader
  87393. * @returns the cube texture as an InternalTexture
  87394. */
  87395. 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;
  87396. /**
  87397. * Creates a cube texture
  87398. * @param rootUrl defines the url where the files to load is located
  87399. * @param scene defines the current scene
  87400. * @param files defines the list of files to load (1 per face)
  87401. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87402. * @param onLoad defines an optional callback raised when the texture is loaded
  87403. * @param onError defines an optional callback raised if there is an issue to load the texture
  87404. * @param format defines the format of the data
  87405. * @param forcedExtension defines the extension to use to pick the right loader
  87406. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87407. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87408. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87409. * @returns the cube texture as an InternalTexture
  87410. */
  87411. 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;
  87412. /** @hidden */
  87413. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  87414. /** @hidden */
  87415. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  87416. /** @hidden */
  87417. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87418. /** @hidden */
  87419. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87420. /**
  87421. * @hidden
  87422. */
  87423. _setCubeMapTextureParams(loadMipmap: boolean): void;
  87424. }
  87425. }
  87426. declare module BABYLON {
  87427. /**
  87428. * Class for creating a cube texture
  87429. */
  87430. export class CubeTexture extends BaseTexture {
  87431. private _delayedOnLoad;
  87432. /**
  87433. * Observable triggered once the texture has been loaded.
  87434. */
  87435. onLoadObservable: Observable<CubeTexture>;
  87436. /**
  87437. * The url of the texture
  87438. */
  87439. url: string;
  87440. /**
  87441. * Gets or sets the center of the bounding box associated with the cube texture.
  87442. * It must define where the camera used to render the texture was set
  87443. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87444. */
  87445. boundingBoxPosition: Vector3;
  87446. private _boundingBoxSize;
  87447. /**
  87448. * Gets or sets the size of the bounding box associated with the cube texture
  87449. * When defined, the cubemap will switch to local mode
  87450. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87451. * @example https://www.babylonjs-playground.com/#RNASML
  87452. */
  87453. set boundingBoxSize(value: Vector3);
  87454. /**
  87455. * Returns the bounding box size
  87456. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87457. */
  87458. get boundingBoxSize(): Vector3;
  87459. protected _rotationY: number;
  87460. /**
  87461. * Sets texture matrix rotation angle around Y axis in radians.
  87462. */
  87463. set rotationY(value: number);
  87464. /**
  87465. * Gets texture matrix rotation angle around Y axis radians.
  87466. */
  87467. get rotationY(): number;
  87468. /**
  87469. * Are mip maps generated for this texture or not.
  87470. */
  87471. get noMipmap(): boolean;
  87472. private _noMipmap;
  87473. private _files;
  87474. protected _forcedExtension: Nullable<string>;
  87475. private _extensions;
  87476. private _textureMatrix;
  87477. private _format;
  87478. private _createPolynomials;
  87479. /**
  87480. * Creates a cube texture from an array of image urls
  87481. * @param files defines an array of image urls
  87482. * @param scene defines the hosting scene
  87483. * @param noMipmap specifies if mip maps are not used
  87484. * @returns a cube texture
  87485. */
  87486. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  87487. /**
  87488. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  87489. * @param url defines the url of the prefiltered texture
  87490. * @param scene defines the scene the texture is attached to
  87491. * @param forcedExtension defines the extension of the file if different from the url
  87492. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87493. * @return the prefiltered texture
  87494. */
  87495. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  87496. /**
  87497. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  87498. * as prefiltered data.
  87499. * @param rootUrl defines the url of the texture or the root name of the six images
  87500. * @param null defines the scene or engine the texture is attached to
  87501. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  87502. * @param noMipmap defines if mipmaps should be created or not
  87503. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  87504. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  87505. * @param onError defines a callback triggered in case of error during load
  87506. * @param format defines the internal format to use for the texture once loaded
  87507. * @param prefiltered defines whether or not the texture is created from prefiltered data
  87508. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  87509. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87510. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87511. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87512. * @return the cube texture
  87513. */
  87514. 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);
  87515. /**
  87516. * Get the current class name of the texture useful for serialization or dynamic coding.
  87517. * @returns "CubeTexture"
  87518. */
  87519. getClassName(): string;
  87520. /**
  87521. * Update the url (and optional buffer) of this texture if url was null during construction.
  87522. * @param url the url of the texture
  87523. * @param forcedExtension defines the extension to use
  87524. * @param onLoad callback called when the texture is loaded (defaults to null)
  87525. * @param prefiltered Defines whether the updated texture is prefiltered or not
  87526. */
  87527. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  87528. /**
  87529. * Delays loading of the cube texture
  87530. * @param forcedExtension defines the extension to use
  87531. */
  87532. delayLoad(forcedExtension?: string): void;
  87533. /**
  87534. * Returns the reflection texture matrix
  87535. * @returns the reflection texture matrix
  87536. */
  87537. getReflectionTextureMatrix(): Matrix;
  87538. /**
  87539. * Sets the reflection texture matrix
  87540. * @param value Reflection texture matrix
  87541. */
  87542. setReflectionTextureMatrix(value: Matrix): void;
  87543. /**
  87544. * Parses text to create a cube texture
  87545. * @param parsedTexture define the serialized text to read from
  87546. * @param scene defines the hosting scene
  87547. * @param rootUrl defines the root url of the cube texture
  87548. * @returns a cube texture
  87549. */
  87550. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  87551. /**
  87552. * Makes a clone, or deep copy, of the cube texture
  87553. * @returns a new cube texture
  87554. */
  87555. clone(): CubeTexture;
  87556. }
  87557. }
  87558. declare module BABYLON {
  87559. /**
  87560. * Manages the defines for the Material
  87561. */
  87562. export class MaterialDefines {
  87563. /** @hidden */
  87564. protected _keys: string[];
  87565. private _isDirty;
  87566. /** @hidden */
  87567. _renderId: number;
  87568. /** @hidden */
  87569. _areLightsDirty: boolean;
  87570. /** @hidden */
  87571. _areLightsDisposed: boolean;
  87572. /** @hidden */
  87573. _areAttributesDirty: boolean;
  87574. /** @hidden */
  87575. _areTexturesDirty: boolean;
  87576. /** @hidden */
  87577. _areFresnelDirty: boolean;
  87578. /** @hidden */
  87579. _areMiscDirty: boolean;
  87580. /** @hidden */
  87581. _areImageProcessingDirty: boolean;
  87582. /** @hidden */
  87583. _normals: boolean;
  87584. /** @hidden */
  87585. _uvs: boolean;
  87586. /** @hidden */
  87587. _needNormals: boolean;
  87588. /** @hidden */
  87589. _needUVs: boolean;
  87590. [id: string]: any;
  87591. /**
  87592. * Specifies if the material needs to be re-calculated
  87593. */
  87594. get isDirty(): boolean;
  87595. /**
  87596. * Marks the material to indicate that it has been re-calculated
  87597. */
  87598. markAsProcessed(): void;
  87599. /**
  87600. * Marks the material to indicate that it needs to be re-calculated
  87601. */
  87602. markAsUnprocessed(): void;
  87603. /**
  87604. * Marks the material to indicate all of its defines need to be re-calculated
  87605. */
  87606. markAllAsDirty(): void;
  87607. /**
  87608. * Marks the material to indicate that image processing needs to be re-calculated
  87609. */
  87610. markAsImageProcessingDirty(): void;
  87611. /**
  87612. * Marks the material to indicate the lights need to be re-calculated
  87613. * @param disposed Defines whether the light is dirty due to dispose or not
  87614. */
  87615. markAsLightDirty(disposed?: boolean): void;
  87616. /**
  87617. * Marks the attribute state as changed
  87618. */
  87619. markAsAttributesDirty(): void;
  87620. /**
  87621. * Marks the texture state as changed
  87622. */
  87623. markAsTexturesDirty(): void;
  87624. /**
  87625. * Marks the fresnel state as changed
  87626. */
  87627. markAsFresnelDirty(): void;
  87628. /**
  87629. * Marks the misc state as changed
  87630. */
  87631. markAsMiscDirty(): void;
  87632. /**
  87633. * Rebuilds the material defines
  87634. */
  87635. rebuild(): void;
  87636. /**
  87637. * Specifies if two material defines are equal
  87638. * @param other - A material define instance to compare to
  87639. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  87640. */
  87641. isEqual(other: MaterialDefines): boolean;
  87642. /**
  87643. * Clones this instance's defines to another instance
  87644. * @param other - material defines to clone values to
  87645. */
  87646. cloneTo(other: MaterialDefines): void;
  87647. /**
  87648. * Resets the material define values
  87649. */
  87650. reset(): void;
  87651. /**
  87652. * Converts the material define values to a string
  87653. * @returns - String of material define information
  87654. */
  87655. toString(): string;
  87656. }
  87657. }
  87658. declare module BABYLON {
  87659. /**
  87660. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  87661. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  87662. * 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;
  87663. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  87664. */
  87665. export class ColorCurves {
  87666. private _dirty;
  87667. private _tempColor;
  87668. private _globalCurve;
  87669. private _highlightsCurve;
  87670. private _midtonesCurve;
  87671. private _shadowsCurve;
  87672. private _positiveCurve;
  87673. private _negativeCurve;
  87674. private _globalHue;
  87675. private _globalDensity;
  87676. private _globalSaturation;
  87677. private _globalExposure;
  87678. /**
  87679. * Gets the global Hue value.
  87680. * 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).
  87681. */
  87682. get globalHue(): number;
  87683. /**
  87684. * Sets the global Hue value.
  87685. * 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).
  87686. */
  87687. set globalHue(value: number);
  87688. /**
  87689. * Gets the global Density value.
  87690. * 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.
  87691. * Values less than zero provide a filter of opposite hue.
  87692. */
  87693. get globalDensity(): number;
  87694. /**
  87695. * Sets the global Density value.
  87696. * 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.
  87697. * Values less than zero provide a filter of opposite hue.
  87698. */
  87699. set globalDensity(value: number);
  87700. /**
  87701. * Gets the global Saturation value.
  87702. * 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.
  87703. */
  87704. get globalSaturation(): number;
  87705. /**
  87706. * Sets the global Saturation value.
  87707. * 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.
  87708. */
  87709. set globalSaturation(value: number);
  87710. /**
  87711. * Gets the global Exposure value.
  87712. * 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.
  87713. */
  87714. get globalExposure(): number;
  87715. /**
  87716. * Sets the global Exposure value.
  87717. * 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.
  87718. */
  87719. set globalExposure(value: number);
  87720. private _highlightsHue;
  87721. private _highlightsDensity;
  87722. private _highlightsSaturation;
  87723. private _highlightsExposure;
  87724. /**
  87725. * Gets the highlights Hue value.
  87726. * 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).
  87727. */
  87728. get highlightsHue(): number;
  87729. /**
  87730. * Sets the highlights Hue value.
  87731. * 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).
  87732. */
  87733. set highlightsHue(value: number);
  87734. /**
  87735. * Gets the highlights Density value.
  87736. * 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.
  87737. * Values less than zero provide a filter of opposite hue.
  87738. */
  87739. get highlightsDensity(): number;
  87740. /**
  87741. * Sets the highlights Density value.
  87742. * 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.
  87743. * Values less than zero provide a filter of opposite hue.
  87744. */
  87745. set highlightsDensity(value: number);
  87746. /**
  87747. * Gets the highlights Saturation value.
  87748. * 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.
  87749. */
  87750. get highlightsSaturation(): number;
  87751. /**
  87752. * Sets the highlights Saturation value.
  87753. * 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.
  87754. */
  87755. set highlightsSaturation(value: number);
  87756. /**
  87757. * Gets the highlights Exposure value.
  87758. * 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.
  87759. */
  87760. get highlightsExposure(): number;
  87761. /**
  87762. * Sets the highlights Exposure value.
  87763. * 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.
  87764. */
  87765. set highlightsExposure(value: number);
  87766. private _midtonesHue;
  87767. private _midtonesDensity;
  87768. private _midtonesSaturation;
  87769. private _midtonesExposure;
  87770. /**
  87771. * Gets the midtones Hue value.
  87772. * 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).
  87773. */
  87774. get midtonesHue(): number;
  87775. /**
  87776. * Sets the midtones Hue value.
  87777. * 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).
  87778. */
  87779. set midtonesHue(value: number);
  87780. /**
  87781. * Gets the midtones Density value.
  87782. * 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.
  87783. * Values less than zero provide a filter of opposite hue.
  87784. */
  87785. get midtonesDensity(): number;
  87786. /**
  87787. * Sets the midtones Density value.
  87788. * 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.
  87789. * Values less than zero provide a filter of opposite hue.
  87790. */
  87791. set midtonesDensity(value: number);
  87792. /**
  87793. * Gets the midtones Saturation value.
  87794. * 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.
  87795. */
  87796. get midtonesSaturation(): number;
  87797. /**
  87798. * Sets the midtones Saturation value.
  87799. * 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.
  87800. */
  87801. set midtonesSaturation(value: number);
  87802. /**
  87803. * Gets the midtones Exposure value.
  87804. * 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.
  87805. */
  87806. get midtonesExposure(): number;
  87807. /**
  87808. * Sets the midtones Exposure value.
  87809. * 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.
  87810. */
  87811. set midtonesExposure(value: number);
  87812. private _shadowsHue;
  87813. private _shadowsDensity;
  87814. private _shadowsSaturation;
  87815. private _shadowsExposure;
  87816. /**
  87817. * Gets the shadows Hue value.
  87818. * 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).
  87819. */
  87820. get shadowsHue(): number;
  87821. /**
  87822. * Sets the shadows Hue value.
  87823. * 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).
  87824. */
  87825. set shadowsHue(value: number);
  87826. /**
  87827. * Gets the shadows Density value.
  87828. * 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.
  87829. * Values less than zero provide a filter of opposite hue.
  87830. */
  87831. get shadowsDensity(): number;
  87832. /**
  87833. * Sets the shadows Density value.
  87834. * 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.
  87835. * Values less than zero provide a filter of opposite hue.
  87836. */
  87837. set shadowsDensity(value: number);
  87838. /**
  87839. * Gets the shadows Saturation value.
  87840. * 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.
  87841. */
  87842. get shadowsSaturation(): number;
  87843. /**
  87844. * Sets the shadows Saturation value.
  87845. * 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.
  87846. */
  87847. set shadowsSaturation(value: number);
  87848. /**
  87849. * Gets the shadows Exposure value.
  87850. * 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.
  87851. */
  87852. get shadowsExposure(): number;
  87853. /**
  87854. * Sets the shadows Exposure value.
  87855. * 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.
  87856. */
  87857. set shadowsExposure(value: number);
  87858. /**
  87859. * Returns the class name
  87860. * @returns The class name
  87861. */
  87862. getClassName(): string;
  87863. /**
  87864. * Binds the color curves to the shader.
  87865. * @param colorCurves The color curve to bind
  87866. * @param effect The effect to bind to
  87867. * @param positiveUniform The positive uniform shader parameter
  87868. * @param neutralUniform The neutral uniform shader parameter
  87869. * @param negativeUniform The negative uniform shader parameter
  87870. */
  87871. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  87872. /**
  87873. * Prepare the list of uniforms associated with the ColorCurves effects.
  87874. * @param uniformsList The list of uniforms used in the effect
  87875. */
  87876. static PrepareUniforms(uniformsList: string[]): void;
  87877. /**
  87878. * Returns color grading data based on a hue, density, saturation and exposure value.
  87879. * @param filterHue The hue of the color filter.
  87880. * @param filterDensity The density of the color filter.
  87881. * @param saturation The saturation.
  87882. * @param exposure The exposure.
  87883. * @param result The result data container.
  87884. */
  87885. private getColorGradingDataToRef;
  87886. /**
  87887. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  87888. * @param value The input slider value in range [-100,100].
  87889. * @returns Adjusted value.
  87890. */
  87891. private static applyColorGradingSliderNonlinear;
  87892. /**
  87893. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  87894. * @param hue The hue (H) input.
  87895. * @param saturation The saturation (S) input.
  87896. * @param brightness The brightness (B) input.
  87897. * @result An RGBA color represented as Vector4.
  87898. */
  87899. private static fromHSBToRef;
  87900. /**
  87901. * Returns a value clamped between min and max
  87902. * @param value The value to clamp
  87903. * @param min The minimum of value
  87904. * @param max The maximum of value
  87905. * @returns The clamped value.
  87906. */
  87907. private static clamp;
  87908. /**
  87909. * Clones the current color curve instance.
  87910. * @return The cloned curves
  87911. */
  87912. clone(): ColorCurves;
  87913. /**
  87914. * Serializes the current color curve instance to a json representation.
  87915. * @return a JSON representation
  87916. */
  87917. serialize(): any;
  87918. /**
  87919. * Parses the color curve from a json representation.
  87920. * @param source the JSON source to parse
  87921. * @return The parsed curves
  87922. */
  87923. static Parse(source: any): ColorCurves;
  87924. }
  87925. }
  87926. declare module BABYLON {
  87927. /**
  87928. * Interface to follow in your material defines to integrate easily the
  87929. * Image proccessing functions.
  87930. * @hidden
  87931. */
  87932. export interface IImageProcessingConfigurationDefines {
  87933. IMAGEPROCESSING: boolean;
  87934. VIGNETTE: boolean;
  87935. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87936. VIGNETTEBLENDMODEOPAQUE: boolean;
  87937. TONEMAPPING: boolean;
  87938. TONEMAPPING_ACES: boolean;
  87939. CONTRAST: boolean;
  87940. EXPOSURE: boolean;
  87941. COLORCURVES: boolean;
  87942. COLORGRADING: boolean;
  87943. COLORGRADING3D: boolean;
  87944. SAMPLER3DGREENDEPTH: boolean;
  87945. SAMPLER3DBGRMAP: boolean;
  87946. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87947. }
  87948. /**
  87949. * @hidden
  87950. */
  87951. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  87952. IMAGEPROCESSING: boolean;
  87953. VIGNETTE: boolean;
  87954. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87955. VIGNETTEBLENDMODEOPAQUE: boolean;
  87956. TONEMAPPING: boolean;
  87957. TONEMAPPING_ACES: boolean;
  87958. CONTRAST: boolean;
  87959. COLORCURVES: boolean;
  87960. COLORGRADING: boolean;
  87961. COLORGRADING3D: boolean;
  87962. SAMPLER3DGREENDEPTH: boolean;
  87963. SAMPLER3DBGRMAP: boolean;
  87964. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87965. EXPOSURE: boolean;
  87966. constructor();
  87967. }
  87968. /**
  87969. * This groups together the common properties used for image processing either in direct forward pass
  87970. * or through post processing effect depending on the use of the image processing pipeline in your scene
  87971. * or not.
  87972. */
  87973. export class ImageProcessingConfiguration {
  87974. /**
  87975. * Default tone mapping applied in BabylonJS.
  87976. */
  87977. static readonly TONEMAPPING_STANDARD: number;
  87978. /**
  87979. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  87980. * to other engines rendering to increase portability.
  87981. */
  87982. static readonly TONEMAPPING_ACES: number;
  87983. /**
  87984. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  87985. */
  87986. colorCurves: Nullable<ColorCurves>;
  87987. private _colorCurvesEnabled;
  87988. /**
  87989. * Gets wether the color curves effect is enabled.
  87990. */
  87991. get colorCurvesEnabled(): boolean;
  87992. /**
  87993. * Sets wether the color curves effect is enabled.
  87994. */
  87995. set colorCurvesEnabled(value: boolean);
  87996. private _colorGradingTexture;
  87997. /**
  87998. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87999. */
  88000. get colorGradingTexture(): Nullable<BaseTexture>;
  88001. /**
  88002. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88003. */
  88004. set colorGradingTexture(value: Nullable<BaseTexture>);
  88005. private _colorGradingEnabled;
  88006. /**
  88007. * Gets wether the color grading effect is enabled.
  88008. */
  88009. get colorGradingEnabled(): boolean;
  88010. /**
  88011. * Sets wether the color grading effect is enabled.
  88012. */
  88013. set colorGradingEnabled(value: boolean);
  88014. private _colorGradingWithGreenDepth;
  88015. /**
  88016. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  88017. */
  88018. get colorGradingWithGreenDepth(): boolean;
  88019. /**
  88020. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  88021. */
  88022. set colorGradingWithGreenDepth(value: boolean);
  88023. private _colorGradingBGR;
  88024. /**
  88025. * Gets wether the color grading texture contains BGR values.
  88026. */
  88027. get colorGradingBGR(): boolean;
  88028. /**
  88029. * Sets wether the color grading texture contains BGR values.
  88030. */
  88031. set colorGradingBGR(value: boolean);
  88032. /** @hidden */
  88033. _exposure: number;
  88034. /**
  88035. * Gets the Exposure used in the effect.
  88036. */
  88037. get exposure(): number;
  88038. /**
  88039. * Sets the Exposure used in the effect.
  88040. */
  88041. set exposure(value: number);
  88042. private _toneMappingEnabled;
  88043. /**
  88044. * Gets wether the tone mapping effect is enabled.
  88045. */
  88046. get toneMappingEnabled(): boolean;
  88047. /**
  88048. * Sets wether the tone mapping effect is enabled.
  88049. */
  88050. set toneMappingEnabled(value: boolean);
  88051. private _toneMappingType;
  88052. /**
  88053. * Gets the type of tone mapping effect.
  88054. */
  88055. get toneMappingType(): number;
  88056. /**
  88057. * Sets the type of tone mapping effect used in BabylonJS.
  88058. */
  88059. set toneMappingType(value: number);
  88060. protected _contrast: number;
  88061. /**
  88062. * Gets the contrast used in the effect.
  88063. */
  88064. get contrast(): number;
  88065. /**
  88066. * Sets the contrast used in the effect.
  88067. */
  88068. set contrast(value: number);
  88069. /**
  88070. * Vignette stretch size.
  88071. */
  88072. vignetteStretch: number;
  88073. /**
  88074. * Vignette centre X Offset.
  88075. */
  88076. vignetteCentreX: number;
  88077. /**
  88078. * Vignette centre Y Offset.
  88079. */
  88080. vignetteCentreY: number;
  88081. /**
  88082. * Vignette weight or intensity of the vignette effect.
  88083. */
  88084. vignetteWeight: number;
  88085. /**
  88086. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  88087. * if vignetteEnabled is set to true.
  88088. */
  88089. vignetteColor: Color4;
  88090. /**
  88091. * Camera field of view used by the Vignette effect.
  88092. */
  88093. vignetteCameraFov: number;
  88094. private _vignetteBlendMode;
  88095. /**
  88096. * Gets the vignette blend mode allowing different kind of effect.
  88097. */
  88098. get vignetteBlendMode(): number;
  88099. /**
  88100. * Sets the vignette blend mode allowing different kind of effect.
  88101. */
  88102. set vignetteBlendMode(value: number);
  88103. private _vignetteEnabled;
  88104. /**
  88105. * Gets wether the vignette effect is enabled.
  88106. */
  88107. get vignetteEnabled(): boolean;
  88108. /**
  88109. * Sets wether the vignette effect is enabled.
  88110. */
  88111. set vignetteEnabled(value: boolean);
  88112. private _applyByPostProcess;
  88113. /**
  88114. * Gets wether the image processing is applied through a post process or not.
  88115. */
  88116. get applyByPostProcess(): boolean;
  88117. /**
  88118. * Sets wether the image processing is applied through a post process or not.
  88119. */
  88120. set applyByPostProcess(value: boolean);
  88121. private _isEnabled;
  88122. /**
  88123. * Gets wether the image processing is enabled or not.
  88124. */
  88125. get isEnabled(): boolean;
  88126. /**
  88127. * Sets wether the image processing is enabled or not.
  88128. */
  88129. set isEnabled(value: boolean);
  88130. /**
  88131. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  88132. */
  88133. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  88134. /**
  88135. * Method called each time the image processing information changes requires to recompile the effect.
  88136. */
  88137. protected _updateParameters(): void;
  88138. /**
  88139. * Gets the current class name.
  88140. * @return "ImageProcessingConfiguration"
  88141. */
  88142. getClassName(): string;
  88143. /**
  88144. * Prepare the list of uniforms associated with the Image Processing effects.
  88145. * @param uniforms The list of uniforms used in the effect
  88146. * @param defines the list of defines currently in use
  88147. */
  88148. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  88149. /**
  88150. * Prepare the list of samplers associated with the Image Processing effects.
  88151. * @param samplersList The list of uniforms used in the effect
  88152. * @param defines the list of defines currently in use
  88153. */
  88154. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  88155. /**
  88156. * Prepare the list of defines associated to the shader.
  88157. * @param defines the list of defines to complete
  88158. * @param forPostProcess Define if we are currently in post process mode or not
  88159. */
  88160. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  88161. /**
  88162. * Returns true if all the image processing information are ready.
  88163. * @returns True if ready, otherwise, false
  88164. */
  88165. isReady(): boolean;
  88166. /**
  88167. * Binds the image processing to the shader.
  88168. * @param effect The effect to bind to
  88169. * @param overrideAspectRatio Override the aspect ratio of the effect
  88170. */
  88171. bind(effect: Effect, overrideAspectRatio?: number): void;
  88172. /**
  88173. * Clones the current image processing instance.
  88174. * @return The cloned image processing
  88175. */
  88176. clone(): ImageProcessingConfiguration;
  88177. /**
  88178. * Serializes the current image processing instance to a json representation.
  88179. * @return a JSON representation
  88180. */
  88181. serialize(): any;
  88182. /**
  88183. * Parses the image processing from a json representation.
  88184. * @param source the JSON source to parse
  88185. * @return The parsed image processing
  88186. */
  88187. static Parse(source: any): ImageProcessingConfiguration;
  88188. private static _VIGNETTEMODE_MULTIPLY;
  88189. private static _VIGNETTEMODE_OPAQUE;
  88190. /**
  88191. * Used to apply the vignette as a mix with the pixel color.
  88192. */
  88193. static get VIGNETTEMODE_MULTIPLY(): number;
  88194. /**
  88195. * Used to apply the vignette as a replacement of the pixel color.
  88196. */
  88197. static get VIGNETTEMODE_OPAQUE(): number;
  88198. }
  88199. }
  88200. declare module BABYLON {
  88201. /** @hidden */
  88202. export var postprocessVertexShader: {
  88203. name: string;
  88204. shader: string;
  88205. };
  88206. }
  88207. declare module BABYLON {
  88208. interface ThinEngine {
  88209. /**
  88210. * Creates a new render target texture
  88211. * @param size defines the size of the texture
  88212. * @param options defines the options used to create the texture
  88213. * @returns a new render target texture stored in an InternalTexture
  88214. */
  88215. createRenderTargetTexture(size: number | {
  88216. width: number;
  88217. height: number;
  88218. layers?: number;
  88219. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  88220. /**
  88221. * Creates a depth stencil texture.
  88222. * This is only available in WebGL 2 or with the depth texture extension available.
  88223. * @param size The size of face edge in the texture.
  88224. * @param options The options defining the texture.
  88225. * @returns The texture
  88226. */
  88227. createDepthStencilTexture(size: number | {
  88228. width: number;
  88229. height: number;
  88230. layers?: number;
  88231. }, options: DepthTextureCreationOptions): InternalTexture;
  88232. /** @hidden */
  88233. _createDepthStencilTexture(size: number | {
  88234. width: number;
  88235. height: number;
  88236. layers?: number;
  88237. }, options: DepthTextureCreationOptions): InternalTexture;
  88238. }
  88239. }
  88240. declare module BABYLON {
  88241. /**
  88242. * Defines the kind of connection point for node based material
  88243. */
  88244. export enum NodeMaterialBlockConnectionPointTypes {
  88245. /** Float */
  88246. Float = 1,
  88247. /** Int */
  88248. Int = 2,
  88249. /** Vector2 */
  88250. Vector2 = 4,
  88251. /** Vector3 */
  88252. Vector3 = 8,
  88253. /** Vector4 */
  88254. Vector4 = 16,
  88255. /** Color3 */
  88256. Color3 = 32,
  88257. /** Color4 */
  88258. Color4 = 64,
  88259. /** Matrix */
  88260. Matrix = 128,
  88261. /** Custom object */
  88262. Object = 256,
  88263. /** Detect type based on connection */
  88264. AutoDetect = 1024,
  88265. /** Output type that will be defined by input type */
  88266. BasedOnInput = 2048
  88267. }
  88268. }
  88269. declare module BABYLON {
  88270. /**
  88271. * Enum used to define the target of a block
  88272. */
  88273. export enum NodeMaterialBlockTargets {
  88274. /** Vertex shader */
  88275. Vertex = 1,
  88276. /** Fragment shader */
  88277. Fragment = 2,
  88278. /** Neutral */
  88279. Neutral = 4,
  88280. /** Vertex and Fragment */
  88281. VertexAndFragment = 3
  88282. }
  88283. }
  88284. declare module BABYLON {
  88285. /**
  88286. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88287. */
  88288. export enum NodeMaterialBlockConnectionPointMode {
  88289. /** Value is an uniform */
  88290. Uniform = 0,
  88291. /** Value is a mesh attribute */
  88292. Attribute = 1,
  88293. /** Value is a varying between vertex and fragment shaders */
  88294. Varying = 2,
  88295. /** Mode is undefined */
  88296. Undefined = 3
  88297. }
  88298. }
  88299. declare module BABYLON {
  88300. /**
  88301. * Enum used to define system values e.g. values automatically provided by the system
  88302. */
  88303. export enum NodeMaterialSystemValues {
  88304. /** World */
  88305. World = 1,
  88306. /** View */
  88307. View = 2,
  88308. /** Projection */
  88309. Projection = 3,
  88310. /** ViewProjection */
  88311. ViewProjection = 4,
  88312. /** WorldView */
  88313. WorldView = 5,
  88314. /** WorldViewProjection */
  88315. WorldViewProjection = 6,
  88316. /** CameraPosition */
  88317. CameraPosition = 7,
  88318. /** Fog Color */
  88319. FogColor = 8,
  88320. /** Delta time */
  88321. DeltaTime = 9
  88322. }
  88323. }
  88324. declare module BABYLON {
  88325. /** Defines supported spaces */
  88326. export enum Space {
  88327. /** Local (object) space */
  88328. LOCAL = 0,
  88329. /** World space */
  88330. WORLD = 1,
  88331. /** Bone space */
  88332. BONE = 2
  88333. }
  88334. /** Defines the 3 main axes */
  88335. export class Axis {
  88336. /** X axis */
  88337. static X: Vector3;
  88338. /** Y axis */
  88339. static Y: Vector3;
  88340. /** Z axis */
  88341. static Z: Vector3;
  88342. }
  88343. }
  88344. declare module BABYLON {
  88345. /**
  88346. * Represents a camera frustum
  88347. */
  88348. export class Frustum {
  88349. /**
  88350. * Gets the planes representing the frustum
  88351. * @param transform matrix to be applied to the returned planes
  88352. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  88353. */
  88354. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  88355. /**
  88356. * Gets the near frustum plane transformed by the transform matrix
  88357. * @param transform transformation matrix to be applied to the resulting frustum plane
  88358. * @param frustumPlane the resuling frustum plane
  88359. */
  88360. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88361. /**
  88362. * Gets the far frustum plane transformed by the transform matrix
  88363. * @param transform transformation matrix to be applied to the resulting frustum plane
  88364. * @param frustumPlane the resuling frustum plane
  88365. */
  88366. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88367. /**
  88368. * Gets the left frustum plane transformed by the transform matrix
  88369. * @param transform transformation matrix to be applied to the resulting frustum plane
  88370. * @param frustumPlane the resuling frustum plane
  88371. */
  88372. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88373. /**
  88374. * Gets the right frustum plane transformed by the transform matrix
  88375. * @param transform transformation matrix to be applied to the resulting frustum plane
  88376. * @param frustumPlane the resuling frustum plane
  88377. */
  88378. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88379. /**
  88380. * Gets the top frustum plane transformed by the transform matrix
  88381. * @param transform transformation matrix to be applied to the resulting frustum plane
  88382. * @param frustumPlane the resuling frustum plane
  88383. */
  88384. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88385. /**
  88386. * Gets the bottom frustum plane transformed by the transform matrix
  88387. * @param transform transformation matrix to be applied to the resulting frustum plane
  88388. * @param frustumPlane the resuling frustum plane
  88389. */
  88390. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88391. /**
  88392. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  88393. * @param transform transformation matrix to be applied to the resulting frustum planes
  88394. * @param frustumPlanes the resuling frustum planes
  88395. */
  88396. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  88397. }
  88398. }
  88399. declare module BABYLON {
  88400. /**
  88401. * Interface for the size containing width and height
  88402. */
  88403. export interface ISize {
  88404. /**
  88405. * Width
  88406. */
  88407. width: number;
  88408. /**
  88409. * Heighht
  88410. */
  88411. height: number;
  88412. }
  88413. /**
  88414. * Size containing widht and height
  88415. */
  88416. export class Size implements ISize {
  88417. /**
  88418. * Width
  88419. */
  88420. width: number;
  88421. /**
  88422. * Height
  88423. */
  88424. height: number;
  88425. /**
  88426. * Creates a Size object from the given width and height (floats).
  88427. * @param width width of the new size
  88428. * @param height height of the new size
  88429. */
  88430. constructor(width: number, height: number);
  88431. /**
  88432. * Returns a string with the Size width and height
  88433. * @returns a string with the Size width and height
  88434. */
  88435. toString(): string;
  88436. /**
  88437. * "Size"
  88438. * @returns the string "Size"
  88439. */
  88440. getClassName(): string;
  88441. /**
  88442. * Returns the Size hash code.
  88443. * @returns a hash code for a unique width and height
  88444. */
  88445. getHashCode(): number;
  88446. /**
  88447. * Updates the current size from the given one.
  88448. * @param src the given size
  88449. */
  88450. copyFrom(src: Size): void;
  88451. /**
  88452. * Updates in place the current Size from the given floats.
  88453. * @param width width of the new size
  88454. * @param height height of the new size
  88455. * @returns the updated Size.
  88456. */
  88457. copyFromFloats(width: number, height: number): Size;
  88458. /**
  88459. * Updates in place the current Size from the given floats.
  88460. * @param width width to set
  88461. * @param height height to set
  88462. * @returns the updated Size.
  88463. */
  88464. set(width: number, height: number): Size;
  88465. /**
  88466. * Multiplies the width and height by numbers
  88467. * @param w factor to multiple the width by
  88468. * @param h factor to multiple the height by
  88469. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  88470. */
  88471. multiplyByFloats(w: number, h: number): Size;
  88472. /**
  88473. * Clones the size
  88474. * @returns a new Size copied from the given one.
  88475. */
  88476. clone(): Size;
  88477. /**
  88478. * True if the current Size and the given one width and height are strictly equal.
  88479. * @param other the other size to compare against
  88480. * @returns True if the current Size and the given one width and height are strictly equal.
  88481. */
  88482. equals(other: Size): boolean;
  88483. /**
  88484. * The surface of the Size : width * height (float).
  88485. */
  88486. get surface(): number;
  88487. /**
  88488. * Create a new size of zero
  88489. * @returns a new Size set to (0.0, 0.0)
  88490. */
  88491. static Zero(): Size;
  88492. /**
  88493. * Sums the width and height of two sizes
  88494. * @param otherSize size to add to this size
  88495. * @returns a new Size set as the addition result of the current Size and the given one.
  88496. */
  88497. add(otherSize: Size): Size;
  88498. /**
  88499. * Subtracts the width and height of two
  88500. * @param otherSize size to subtract to this size
  88501. * @returns a new Size set as the subtraction result of the given one from the current Size.
  88502. */
  88503. subtract(otherSize: Size): Size;
  88504. /**
  88505. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  88506. * @param start starting size to lerp between
  88507. * @param end end size to lerp between
  88508. * @param amount amount to lerp between the start and end values
  88509. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  88510. */
  88511. static Lerp(start: Size, end: Size, amount: number): Size;
  88512. }
  88513. }
  88514. declare module BABYLON {
  88515. /**
  88516. * Contains position and normal vectors for a vertex
  88517. */
  88518. export class PositionNormalVertex {
  88519. /** the position of the vertex (defaut: 0,0,0) */
  88520. position: Vector3;
  88521. /** the normal of the vertex (defaut: 0,1,0) */
  88522. normal: Vector3;
  88523. /**
  88524. * Creates a PositionNormalVertex
  88525. * @param position the position of the vertex (defaut: 0,0,0)
  88526. * @param normal the normal of the vertex (defaut: 0,1,0)
  88527. */
  88528. constructor(
  88529. /** the position of the vertex (defaut: 0,0,0) */
  88530. position?: Vector3,
  88531. /** the normal of the vertex (defaut: 0,1,0) */
  88532. normal?: Vector3);
  88533. /**
  88534. * Clones the PositionNormalVertex
  88535. * @returns the cloned PositionNormalVertex
  88536. */
  88537. clone(): PositionNormalVertex;
  88538. }
  88539. /**
  88540. * Contains position, normal and uv vectors for a vertex
  88541. */
  88542. export class PositionNormalTextureVertex {
  88543. /** the position of the vertex (defaut: 0,0,0) */
  88544. position: Vector3;
  88545. /** the normal of the vertex (defaut: 0,1,0) */
  88546. normal: Vector3;
  88547. /** the uv of the vertex (default: 0,0) */
  88548. uv: Vector2;
  88549. /**
  88550. * Creates a PositionNormalTextureVertex
  88551. * @param position the position of the vertex (defaut: 0,0,0)
  88552. * @param normal the normal of the vertex (defaut: 0,1,0)
  88553. * @param uv the uv of the vertex (default: 0,0)
  88554. */
  88555. constructor(
  88556. /** the position of the vertex (defaut: 0,0,0) */
  88557. position?: Vector3,
  88558. /** the normal of the vertex (defaut: 0,1,0) */
  88559. normal?: Vector3,
  88560. /** the uv of the vertex (default: 0,0) */
  88561. uv?: Vector2);
  88562. /**
  88563. * Clones the PositionNormalTextureVertex
  88564. * @returns the cloned PositionNormalTextureVertex
  88565. */
  88566. clone(): PositionNormalTextureVertex;
  88567. }
  88568. }
  88569. declare module BABYLON {
  88570. /**
  88571. * Enum defining the type of animations supported by InputBlock
  88572. */
  88573. export enum AnimatedInputBlockTypes {
  88574. /** No animation */
  88575. None = 0,
  88576. /** Time based animation. Will only work for floats */
  88577. Time = 1
  88578. }
  88579. }
  88580. declare module BABYLON {
  88581. /**
  88582. * Interface describing all the common properties and methods a shadow light needs to implement.
  88583. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  88584. * as well as binding the different shadow properties to the effects.
  88585. */
  88586. export interface IShadowLight extends Light {
  88587. /**
  88588. * The light id in the scene (used in scene.findLighById for instance)
  88589. */
  88590. id: string;
  88591. /**
  88592. * The position the shdow will be casted from.
  88593. */
  88594. position: Vector3;
  88595. /**
  88596. * In 2d mode (needCube being false), the direction used to cast the shadow.
  88597. */
  88598. direction: Vector3;
  88599. /**
  88600. * The transformed position. Position of the light in world space taking parenting in account.
  88601. */
  88602. transformedPosition: Vector3;
  88603. /**
  88604. * The transformed direction. Direction of the light in world space taking parenting in account.
  88605. */
  88606. transformedDirection: Vector3;
  88607. /**
  88608. * The friendly name of the light in the scene.
  88609. */
  88610. name: string;
  88611. /**
  88612. * Defines the shadow projection clipping minimum z value.
  88613. */
  88614. shadowMinZ: number;
  88615. /**
  88616. * Defines the shadow projection clipping maximum z value.
  88617. */
  88618. shadowMaxZ: number;
  88619. /**
  88620. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88621. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88622. */
  88623. computeTransformedInformation(): boolean;
  88624. /**
  88625. * Gets the scene the light belongs to.
  88626. * @returns The scene
  88627. */
  88628. getScene(): Scene;
  88629. /**
  88630. * Callback defining a custom Projection Matrix Builder.
  88631. * This can be used to override the default projection matrix computation.
  88632. */
  88633. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88634. /**
  88635. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88636. * @param matrix The materix to updated with the projection information
  88637. * @param viewMatrix The transform matrix of the light
  88638. * @param renderList The list of mesh to render in the map
  88639. * @returns The current light
  88640. */
  88641. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88642. /**
  88643. * Gets the current depth scale used in ESM.
  88644. * @returns The scale
  88645. */
  88646. getDepthScale(): number;
  88647. /**
  88648. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88649. * @returns true if a cube texture needs to be use
  88650. */
  88651. needCube(): boolean;
  88652. /**
  88653. * Detects if the projection matrix requires to be recomputed this frame.
  88654. * @returns true if it requires to be recomputed otherwise, false.
  88655. */
  88656. needProjectionMatrixCompute(): boolean;
  88657. /**
  88658. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88659. */
  88660. forceProjectionMatrixCompute(): void;
  88661. /**
  88662. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88663. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88664. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88665. */
  88666. getShadowDirection(faceIndex?: number): Vector3;
  88667. /**
  88668. * Gets the minZ used for shadow according to both the scene and the light.
  88669. * @param activeCamera The camera we are returning the min for
  88670. * @returns the depth min z
  88671. */
  88672. getDepthMinZ(activeCamera: Camera): number;
  88673. /**
  88674. * Gets the maxZ used for shadow according to both the scene and the light.
  88675. * @param activeCamera The camera we are returning the max for
  88676. * @returns the depth max z
  88677. */
  88678. getDepthMaxZ(activeCamera: Camera): number;
  88679. }
  88680. /**
  88681. * Base implementation IShadowLight
  88682. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  88683. */
  88684. export abstract class ShadowLight extends Light implements IShadowLight {
  88685. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  88686. protected _position: Vector3;
  88687. protected _setPosition(value: Vector3): void;
  88688. /**
  88689. * Sets the position the shadow will be casted from. Also use as the light position for both
  88690. * point and spot lights.
  88691. */
  88692. get position(): Vector3;
  88693. /**
  88694. * Sets the position the shadow will be casted from. Also use as the light position for both
  88695. * point and spot lights.
  88696. */
  88697. set position(value: Vector3);
  88698. protected _direction: Vector3;
  88699. protected _setDirection(value: Vector3): void;
  88700. /**
  88701. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  88702. * Also use as the light direction on spot and directional lights.
  88703. */
  88704. get direction(): Vector3;
  88705. /**
  88706. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  88707. * Also use as the light direction on spot and directional lights.
  88708. */
  88709. set direction(value: Vector3);
  88710. protected _shadowMinZ: number;
  88711. /**
  88712. * Gets the shadow projection clipping minimum z value.
  88713. */
  88714. get shadowMinZ(): number;
  88715. /**
  88716. * Sets the shadow projection clipping minimum z value.
  88717. */
  88718. set shadowMinZ(value: number);
  88719. protected _shadowMaxZ: number;
  88720. /**
  88721. * Sets the shadow projection clipping maximum z value.
  88722. */
  88723. get shadowMaxZ(): number;
  88724. /**
  88725. * Gets the shadow projection clipping maximum z value.
  88726. */
  88727. set shadowMaxZ(value: number);
  88728. /**
  88729. * Callback defining a custom Projection Matrix Builder.
  88730. * This can be used to override the default projection matrix computation.
  88731. */
  88732. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88733. /**
  88734. * The transformed position. Position of the light in world space taking parenting in account.
  88735. */
  88736. transformedPosition: Vector3;
  88737. /**
  88738. * The transformed direction. Direction of the light in world space taking parenting in account.
  88739. */
  88740. transformedDirection: Vector3;
  88741. private _needProjectionMatrixCompute;
  88742. /**
  88743. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88744. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88745. */
  88746. computeTransformedInformation(): boolean;
  88747. /**
  88748. * Return the depth scale used for the shadow map.
  88749. * @returns the depth scale.
  88750. */
  88751. getDepthScale(): number;
  88752. /**
  88753. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88754. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88755. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88756. */
  88757. getShadowDirection(faceIndex?: number): Vector3;
  88758. /**
  88759. * Returns the ShadowLight absolute position in the World.
  88760. * @returns the position vector in world space
  88761. */
  88762. getAbsolutePosition(): Vector3;
  88763. /**
  88764. * Sets the ShadowLight direction toward the passed target.
  88765. * @param target The point to target in local space
  88766. * @returns the updated ShadowLight direction
  88767. */
  88768. setDirectionToTarget(target: Vector3): Vector3;
  88769. /**
  88770. * Returns the light rotation in euler definition.
  88771. * @returns the x y z rotation in local space.
  88772. */
  88773. getRotation(): Vector3;
  88774. /**
  88775. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88776. * @returns true if a cube texture needs to be use
  88777. */
  88778. needCube(): boolean;
  88779. /**
  88780. * Detects if the projection matrix requires to be recomputed this frame.
  88781. * @returns true if it requires to be recomputed otherwise, false.
  88782. */
  88783. needProjectionMatrixCompute(): boolean;
  88784. /**
  88785. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88786. */
  88787. forceProjectionMatrixCompute(): void;
  88788. /** @hidden */
  88789. _initCache(): void;
  88790. /** @hidden */
  88791. _isSynchronized(): boolean;
  88792. /**
  88793. * Computes the world matrix of the node
  88794. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  88795. * @returns the world matrix
  88796. */
  88797. computeWorldMatrix(force?: boolean): Matrix;
  88798. /**
  88799. * Gets the minZ used for shadow according to both the scene and the light.
  88800. * @param activeCamera The camera we are returning the min for
  88801. * @returns the depth min z
  88802. */
  88803. getDepthMinZ(activeCamera: Camera): number;
  88804. /**
  88805. * Gets the maxZ used for shadow according to both the scene and the light.
  88806. * @param activeCamera The camera we are returning the max for
  88807. * @returns the depth max z
  88808. */
  88809. getDepthMaxZ(activeCamera: Camera): number;
  88810. /**
  88811. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88812. * @param matrix The materix to updated with the projection information
  88813. * @param viewMatrix The transform matrix of the light
  88814. * @param renderList The list of mesh to render in the map
  88815. * @returns The current light
  88816. */
  88817. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88818. }
  88819. }
  88820. declare module BABYLON {
  88821. /** @hidden */
  88822. export var packingFunctions: {
  88823. name: string;
  88824. shader: string;
  88825. };
  88826. }
  88827. declare module BABYLON {
  88828. /** @hidden */
  88829. export var bayerDitherFunctions: {
  88830. name: string;
  88831. shader: string;
  88832. };
  88833. }
  88834. declare module BABYLON {
  88835. /** @hidden */
  88836. export var shadowMapFragmentDeclaration: {
  88837. name: string;
  88838. shader: string;
  88839. };
  88840. }
  88841. declare module BABYLON {
  88842. /** @hidden */
  88843. export var clipPlaneFragmentDeclaration: {
  88844. name: string;
  88845. shader: string;
  88846. };
  88847. }
  88848. declare module BABYLON {
  88849. /** @hidden */
  88850. export var clipPlaneFragment: {
  88851. name: string;
  88852. shader: string;
  88853. };
  88854. }
  88855. declare module BABYLON {
  88856. /** @hidden */
  88857. export var shadowMapFragment: {
  88858. name: string;
  88859. shader: string;
  88860. };
  88861. }
  88862. declare module BABYLON {
  88863. /** @hidden */
  88864. export var shadowMapPixelShader: {
  88865. name: string;
  88866. shader: string;
  88867. };
  88868. }
  88869. declare module BABYLON {
  88870. /** @hidden */
  88871. export var bonesDeclaration: {
  88872. name: string;
  88873. shader: string;
  88874. };
  88875. }
  88876. declare module BABYLON {
  88877. /** @hidden */
  88878. export var morphTargetsVertexGlobalDeclaration: {
  88879. name: string;
  88880. shader: string;
  88881. };
  88882. }
  88883. declare module BABYLON {
  88884. /** @hidden */
  88885. export var morphTargetsVertexDeclaration: {
  88886. name: string;
  88887. shader: string;
  88888. };
  88889. }
  88890. declare module BABYLON {
  88891. /** @hidden */
  88892. export var instancesDeclaration: {
  88893. name: string;
  88894. shader: string;
  88895. };
  88896. }
  88897. declare module BABYLON {
  88898. /** @hidden */
  88899. export var helperFunctions: {
  88900. name: string;
  88901. shader: string;
  88902. };
  88903. }
  88904. declare module BABYLON {
  88905. /** @hidden */
  88906. export var shadowMapVertexDeclaration: {
  88907. name: string;
  88908. shader: string;
  88909. };
  88910. }
  88911. declare module BABYLON {
  88912. /** @hidden */
  88913. export var clipPlaneVertexDeclaration: {
  88914. name: string;
  88915. shader: string;
  88916. };
  88917. }
  88918. declare module BABYLON {
  88919. /** @hidden */
  88920. export var morphTargetsVertex: {
  88921. name: string;
  88922. shader: string;
  88923. };
  88924. }
  88925. declare module BABYLON {
  88926. /** @hidden */
  88927. export var instancesVertex: {
  88928. name: string;
  88929. shader: string;
  88930. };
  88931. }
  88932. declare module BABYLON {
  88933. /** @hidden */
  88934. export var bonesVertex: {
  88935. name: string;
  88936. shader: string;
  88937. };
  88938. }
  88939. declare module BABYLON {
  88940. /** @hidden */
  88941. export var shadowMapVertexNormalBias: {
  88942. name: string;
  88943. shader: string;
  88944. };
  88945. }
  88946. declare module BABYLON {
  88947. /** @hidden */
  88948. export var shadowMapVertexMetric: {
  88949. name: string;
  88950. shader: string;
  88951. };
  88952. }
  88953. declare module BABYLON {
  88954. /** @hidden */
  88955. export var clipPlaneVertex: {
  88956. name: string;
  88957. shader: string;
  88958. };
  88959. }
  88960. declare module BABYLON {
  88961. /** @hidden */
  88962. export var shadowMapVertexShader: {
  88963. name: string;
  88964. shader: string;
  88965. };
  88966. }
  88967. declare module BABYLON {
  88968. /** @hidden */
  88969. export var depthBoxBlurPixelShader: {
  88970. name: string;
  88971. shader: string;
  88972. };
  88973. }
  88974. declare module BABYLON {
  88975. /** @hidden */
  88976. export var shadowMapFragmentSoftTransparentShadow: {
  88977. name: string;
  88978. shader: string;
  88979. };
  88980. }
  88981. declare module BABYLON {
  88982. /**
  88983. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  88984. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  88985. */
  88986. export class EffectFallbacks implements IEffectFallbacks {
  88987. private _defines;
  88988. private _currentRank;
  88989. private _maxRank;
  88990. private _mesh;
  88991. /**
  88992. * Removes the fallback from the bound mesh.
  88993. */
  88994. unBindMesh(): void;
  88995. /**
  88996. * Adds a fallback on the specified property.
  88997. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88998. * @param define The name of the define in the shader
  88999. */
  89000. addFallback(rank: number, define: string): void;
  89001. /**
  89002. * Sets the mesh to use CPU skinning when needing to fallback.
  89003. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89004. * @param mesh The mesh to use the fallbacks.
  89005. */
  89006. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  89007. /**
  89008. * Checks to see if more fallbacks are still availible.
  89009. */
  89010. get hasMoreFallbacks(): boolean;
  89011. /**
  89012. * Removes the defines that should be removed when falling back.
  89013. * @param currentDefines defines the current define statements for the shader.
  89014. * @param effect defines the current effect we try to compile
  89015. * @returns The resulting defines with defines of the current rank removed.
  89016. */
  89017. reduce(currentDefines: string, effect: Effect): string;
  89018. }
  89019. }
  89020. declare module BABYLON {
  89021. /**
  89022. * Interface used to define Action
  89023. */
  89024. export interface IAction {
  89025. /**
  89026. * Trigger for the action
  89027. */
  89028. trigger: number;
  89029. /** Options of the trigger */
  89030. triggerOptions: any;
  89031. /**
  89032. * Gets the trigger parameters
  89033. * @returns the trigger parameters
  89034. */
  89035. getTriggerParameter(): any;
  89036. /**
  89037. * Internal only - executes current action event
  89038. * @hidden
  89039. */
  89040. _executeCurrent(evt?: ActionEvent): void;
  89041. /**
  89042. * Serialize placeholder for child classes
  89043. * @param parent of child
  89044. * @returns the serialized object
  89045. */
  89046. serialize(parent: any): any;
  89047. /**
  89048. * Internal only
  89049. * @hidden
  89050. */
  89051. _prepare(): void;
  89052. /**
  89053. * Internal only - manager for action
  89054. * @hidden
  89055. */
  89056. _actionManager: Nullable<AbstractActionManager>;
  89057. /**
  89058. * Adds action to chain of actions, may be a DoNothingAction
  89059. * @param action defines the next action to execute
  89060. * @returns The action passed in
  89061. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89062. */
  89063. then(action: IAction): IAction;
  89064. }
  89065. /**
  89066. * The action to be carried out following a trigger
  89067. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  89068. */
  89069. export class Action implements IAction {
  89070. /** the trigger, with or without parameters, for the action */
  89071. triggerOptions: any;
  89072. /**
  89073. * Trigger for the action
  89074. */
  89075. trigger: number;
  89076. /**
  89077. * Internal only - manager for action
  89078. * @hidden
  89079. */
  89080. _actionManager: ActionManager;
  89081. private _nextActiveAction;
  89082. private _child;
  89083. private _condition?;
  89084. private _triggerParameter;
  89085. /**
  89086. * An event triggered prior to action being executed.
  89087. */
  89088. onBeforeExecuteObservable: Observable<Action>;
  89089. /**
  89090. * Creates a new Action
  89091. * @param triggerOptions the trigger, with or without parameters, for the action
  89092. * @param condition an optional determinant of action
  89093. */
  89094. constructor(
  89095. /** the trigger, with or without parameters, for the action */
  89096. triggerOptions: any, condition?: Condition);
  89097. /**
  89098. * Internal only
  89099. * @hidden
  89100. */
  89101. _prepare(): void;
  89102. /**
  89103. * Gets the trigger parameters
  89104. * @returns the trigger parameters
  89105. */
  89106. getTriggerParameter(): any;
  89107. /**
  89108. * Internal only - executes current action event
  89109. * @hidden
  89110. */
  89111. _executeCurrent(evt?: ActionEvent): void;
  89112. /**
  89113. * Execute placeholder for child classes
  89114. * @param evt optional action event
  89115. */
  89116. execute(evt?: ActionEvent): void;
  89117. /**
  89118. * Skips to next active action
  89119. */
  89120. skipToNextActiveAction(): void;
  89121. /**
  89122. * Adds action to chain of actions, may be a DoNothingAction
  89123. * @param action defines the next action to execute
  89124. * @returns The action passed in
  89125. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89126. */
  89127. then(action: Action): Action;
  89128. /**
  89129. * Internal only
  89130. * @hidden
  89131. */
  89132. _getProperty(propertyPath: string): string;
  89133. /**
  89134. * Internal only
  89135. * @hidden
  89136. */
  89137. _getEffectiveTarget(target: any, propertyPath: string): any;
  89138. /**
  89139. * Serialize placeholder for child classes
  89140. * @param parent of child
  89141. * @returns the serialized object
  89142. */
  89143. serialize(parent: any): any;
  89144. /**
  89145. * Internal only called by serialize
  89146. * @hidden
  89147. */
  89148. protected _serialize(serializedAction: any, parent?: any): any;
  89149. /**
  89150. * Internal only
  89151. * @hidden
  89152. */
  89153. static _SerializeValueAsString: (value: any) => string;
  89154. /**
  89155. * Internal only
  89156. * @hidden
  89157. */
  89158. static _GetTargetProperty: (target: Scene | Node) => {
  89159. name: string;
  89160. targetType: string;
  89161. value: string;
  89162. };
  89163. }
  89164. }
  89165. declare module BABYLON {
  89166. /**
  89167. * A Condition applied to an Action
  89168. */
  89169. export class Condition {
  89170. /**
  89171. * Internal only - manager for action
  89172. * @hidden
  89173. */
  89174. _actionManager: ActionManager;
  89175. /**
  89176. * Internal only
  89177. * @hidden
  89178. */
  89179. _evaluationId: number;
  89180. /**
  89181. * Internal only
  89182. * @hidden
  89183. */
  89184. _currentResult: boolean;
  89185. /**
  89186. * Creates a new Condition
  89187. * @param actionManager the manager of the action the condition is applied to
  89188. */
  89189. constructor(actionManager: ActionManager);
  89190. /**
  89191. * Check if the current condition is valid
  89192. * @returns a boolean
  89193. */
  89194. isValid(): boolean;
  89195. /**
  89196. * Internal only
  89197. * @hidden
  89198. */
  89199. _getProperty(propertyPath: string): string;
  89200. /**
  89201. * Internal only
  89202. * @hidden
  89203. */
  89204. _getEffectiveTarget(target: any, propertyPath: string): any;
  89205. /**
  89206. * Serialize placeholder for child classes
  89207. * @returns the serialized object
  89208. */
  89209. serialize(): any;
  89210. /**
  89211. * Internal only
  89212. * @hidden
  89213. */
  89214. protected _serialize(serializedCondition: any): any;
  89215. }
  89216. /**
  89217. * Defines specific conditional operators as extensions of Condition
  89218. */
  89219. export class ValueCondition extends Condition {
  89220. /** path to specify the property of the target the conditional operator uses */
  89221. propertyPath: string;
  89222. /** the value compared by the conditional operator against the current value of the property */
  89223. value: any;
  89224. /** the conditional operator, default ValueCondition.IsEqual */
  89225. operator: number;
  89226. /**
  89227. * Internal only
  89228. * @hidden
  89229. */
  89230. private static _IsEqual;
  89231. /**
  89232. * Internal only
  89233. * @hidden
  89234. */
  89235. private static _IsDifferent;
  89236. /**
  89237. * Internal only
  89238. * @hidden
  89239. */
  89240. private static _IsGreater;
  89241. /**
  89242. * Internal only
  89243. * @hidden
  89244. */
  89245. private static _IsLesser;
  89246. /**
  89247. * returns the number for IsEqual
  89248. */
  89249. static get IsEqual(): number;
  89250. /**
  89251. * Returns the number for IsDifferent
  89252. */
  89253. static get IsDifferent(): number;
  89254. /**
  89255. * Returns the number for IsGreater
  89256. */
  89257. static get IsGreater(): number;
  89258. /**
  89259. * Returns the number for IsLesser
  89260. */
  89261. static get IsLesser(): number;
  89262. /**
  89263. * Internal only The action manager for the condition
  89264. * @hidden
  89265. */
  89266. _actionManager: ActionManager;
  89267. /**
  89268. * Internal only
  89269. * @hidden
  89270. */
  89271. private _target;
  89272. /**
  89273. * Internal only
  89274. * @hidden
  89275. */
  89276. private _effectiveTarget;
  89277. /**
  89278. * Internal only
  89279. * @hidden
  89280. */
  89281. private _property;
  89282. /**
  89283. * Creates a new ValueCondition
  89284. * @param actionManager manager for the action the condition applies to
  89285. * @param target for the action
  89286. * @param propertyPath path to specify the property of the target the conditional operator uses
  89287. * @param value the value compared by the conditional operator against the current value of the property
  89288. * @param operator the conditional operator, default ValueCondition.IsEqual
  89289. */
  89290. constructor(actionManager: ActionManager, target: any,
  89291. /** path to specify the property of the target the conditional operator uses */
  89292. propertyPath: string,
  89293. /** the value compared by the conditional operator against the current value of the property */
  89294. value: any,
  89295. /** the conditional operator, default ValueCondition.IsEqual */
  89296. operator?: number);
  89297. /**
  89298. * Compares the given value with the property value for the specified conditional operator
  89299. * @returns the result of the comparison
  89300. */
  89301. isValid(): boolean;
  89302. /**
  89303. * Serialize the ValueCondition into a JSON compatible object
  89304. * @returns serialization object
  89305. */
  89306. serialize(): any;
  89307. /**
  89308. * Gets the name of the conditional operator for the ValueCondition
  89309. * @param operator the conditional operator
  89310. * @returns the name
  89311. */
  89312. static GetOperatorName(operator: number): string;
  89313. }
  89314. /**
  89315. * Defines a predicate condition as an extension of Condition
  89316. */
  89317. export class PredicateCondition extends Condition {
  89318. /** defines the predicate function used to validate the condition */
  89319. predicate: () => boolean;
  89320. /**
  89321. * Internal only - manager for action
  89322. * @hidden
  89323. */
  89324. _actionManager: ActionManager;
  89325. /**
  89326. * Creates a new PredicateCondition
  89327. * @param actionManager manager for the action the condition applies to
  89328. * @param predicate defines the predicate function used to validate the condition
  89329. */
  89330. constructor(actionManager: ActionManager,
  89331. /** defines the predicate function used to validate the condition */
  89332. predicate: () => boolean);
  89333. /**
  89334. * @returns the validity of the predicate condition
  89335. */
  89336. isValid(): boolean;
  89337. }
  89338. /**
  89339. * Defines a state condition as an extension of Condition
  89340. */
  89341. export class StateCondition extends Condition {
  89342. /** Value to compare with target state */
  89343. value: string;
  89344. /**
  89345. * Internal only - manager for action
  89346. * @hidden
  89347. */
  89348. _actionManager: ActionManager;
  89349. /**
  89350. * Internal only
  89351. * @hidden
  89352. */
  89353. private _target;
  89354. /**
  89355. * Creates a new StateCondition
  89356. * @param actionManager manager for the action the condition applies to
  89357. * @param target of the condition
  89358. * @param value to compare with target state
  89359. */
  89360. constructor(actionManager: ActionManager, target: any,
  89361. /** Value to compare with target state */
  89362. value: string);
  89363. /**
  89364. * Gets a boolean indicating if the current condition is met
  89365. * @returns the validity of the state
  89366. */
  89367. isValid(): boolean;
  89368. /**
  89369. * Serialize the StateCondition into a JSON compatible object
  89370. * @returns serialization object
  89371. */
  89372. serialize(): any;
  89373. }
  89374. }
  89375. declare module BABYLON {
  89376. /**
  89377. * This defines an action responsible to toggle a boolean once triggered.
  89378. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89379. */
  89380. export class SwitchBooleanAction extends Action {
  89381. /**
  89382. * The path to the boolean property in the target object
  89383. */
  89384. propertyPath: string;
  89385. private _target;
  89386. private _effectiveTarget;
  89387. private _property;
  89388. /**
  89389. * Instantiate the action
  89390. * @param triggerOptions defines the trigger options
  89391. * @param target defines the object containing the boolean
  89392. * @param propertyPath defines the path to the boolean property in the target object
  89393. * @param condition defines the trigger related conditions
  89394. */
  89395. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  89396. /** @hidden */
  89397. _prepare(): void;
  89398. /**
  89399. * Execute the action toggle the boolean value.
  89400. */
  89401. execute(): void;
  89402. /**
  89403. * Serializes the actions and its related information.
  89404. * @param parent defines the object to serialize in
  89405. * @returns the serialized object
  89406. */
  89407. serialize(parent: any): any;
  89408. }
  89409. /**
  89410. * This defines an action responsible to set a the state field of the target
  89411. * to a desired value once triggered.
  89412. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89413. */
  89414. export class SetStateAction extends Action {
  89415. /**
  89416. * The value to store in the state field.
  89417. */
  89418. value: string;
  89419. private _target;
  89420. /**
  89421. * Instantiate the action
  89422. * @param triggerOptions defines the trigger options
  89423. * @param target defines the object containing the state property
  89424. * @param value defines the value to store in the state field
  89425. * @param condition defines the trigger related conditions
  89426. */
  89427. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  89428. /**
  89429. * Execute the action and store the value on the target state property.
  89430. */
  89431. execute(): void;
  89432. /**
  89433. * Serializes the actions and its related information.
  89434. * @param parent defines the object to serialize in
  89435. * @returns the serialized object
  89436. */
  89437. serialize(parent: any): any;
  89438. }
  89439. /**
  89440. * This defines an action responsible to set a property of the target
  89441. * to a desired value once triggered.
  89442. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89443. */
  89444. export class SetValueAction extends Action {
  89445. /**
  89446. * The path of the property to set in the target.
  89447. */
  89448. propertyPath: string;
  89449. /**
  89450. * The value to set in the property
  89451. */
  89452. value: any;
  89453. private _target;
  89454. private _effectiveTarget;
  89455. private _property;
  89456. /**
  89457. * Instantiate the action
  89458. * @param triggerOptions defines the trigger options
  89459. * @param target defines the object containing the property
  89460. * @param propertyPath defines the path of the property to set in the target
  89461. * @param value defines the value to set in the property
  89462. * @param condition defines the trigger related conditions
  89463. */
  89464. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89465. /** @hidden */
  89466. _prepare(): void;
  89467. /**
  89468. * Execute the action and set the targetted property to the desired value.
  89469. */
  89470. execute(): void;
  89471. /**
  89472. * Serializes the actions and its related information.
  89473. * @param parent defines the object to serialize in
  89474. * @returns the serialized object
  89475. */
  89476. serialize(parent: any): any;
  89477. }
  89478. /**
  89479. * This defines an action responsible to increment the target value
  89480. * to a desired value once triggered.
  89481. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89482. */
  89483. export class IncrementValueAction extends Action {
  89484. /**
  89485. * The path of the property to increment in the target.
  89486. */
  89487. propertyPath: string;
  89488. /**
  89489. * The value we should increment the property by.
  89490. */
  89491. value: any;
  89492. private _target;
  89493. private _effectiveTarget;
  89494. private _property;
  89495. /**
  89496. * Instantiate the action
  89497. * @param triggerOptions defines the trigger options
  89498. * @param target defines the object containing the property
  89499. * @param propertyPath defines the path of the property to increment in the target
  89500. * @param value defines the value value we should increment the property by
  89501. * @param condition defines the trigger related conditions
  89502. */
  89503. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89504. /** @hidden */
  89505. _prepare(): void;
  89506. /**
  89507. * Execute the action and increment the target of the value amount.
  89508. */
  89509. execute(): void;
  89510. /**
  89511. * Serializes the actions and its related information.
  89512. * @param parent defines the object to serialize in
  89513. * @returns the serialized object
  89514. */
  89515. serialize(parent: any): any;
  89516. }
  89517. /**
  89518. * This defines an action responsible to start an animation once triggered.
  89519. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89520. */
  89521. export class PlayAnimationAction extends Action {
  89522. /**
  89523. * Where the animation should start (animation frame)
  89524. */
  89525. from: number;
  89526. /**
  89527. * Where the animation should stop (animation frame)
  89528. */
  89529. to: number;
  89530. /**
  89531. * Define if the animation should loop or stop after the first play.
  89532. */
  89533. loop?: boolean;
  89534. private _target;
  89535. /**
  89536. * Instantiate the action
  89537. * @param triggerOptions defines the trigger options
  89538. * @param target defines the target animation or animation name
  89539. * @param from defines from where the animation should start (animation frame)
  89540. * @param end defines where the animation should stop (animation frame)
  89541. * @param loop defines if the animation should loop or stop after the first play
  89542. * @param condition defines the trigger related conditions
  89543. */
  89544. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  89545. /** @hidden */
  89546. _prepare(): void;
  89547. /**
  89548. * Execute the action and play the animation.
  89549. */
  89550. execute(): void;
  89551. /**
  89552. * Serializes the actions and its related information.
  89553. * @param parent defines the object to serialize in
  89554. * @returns the serialized object
  89555. */
  89556. serialize(parent: any): any;
  89557. }
  89558. /**
  89559. * This defines an action responsible to stop an animation once triggered.
  89560. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89561. */
  89562. export class StopAnimationAction extends Action {
  89563. private _target;
  89564. /**
  89565. * Instantiate the action
  89566. * @param triggerOptions defines the trigger options
  89567. * @param target defines the target animation or animation name
  89568. * @param condition defines the trigger related conditions
  89569. */
  89570. constructor(triggerOptions: any, target: any, condition?: Condition);
  89571. /** @hidden */
  89572. _prepare(): void;
  89573. /**
  89574. * Execute the action and stop the animation.
  89575. */
  89576. execute(): void;
  89577. /**
  89578. * Serializes the actions and its related information.
  89579. * @param parent defines the object to serialize in
  89580. * @returns the serialized object
  89581. */
  89582. serialize(parent: any): any;
  89583. }
  89584. /**
  89585. * This defines an action responsible that does nothing once triggered.
  89586. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89587. */
  89588. export class DoNothingAction extends Action {
  89589. /**
  89590. * Instantiate the action
  89591. * @param triggerOptions defines the trigger options
  89592. * @param condition defines the trigger related conditions
  89593. */
  89594. constructor(triggerOptions?: any, condition?: Condition);
  89595. /**
  89596. * Execute the action and do nothing.
  89597. */
  89598. execute(): void;
  89599. /**
  89600. * Serializes the actions and its related information.
  89601. * @param parent defines the object to serialize in
  89602. * @returns the serialized object
  89603. */
  89604. serialize(parent: any): any;
  89605. }
  89606. /**
  89607. * This defines an action responsible to trigger several actions once triggered.
  89608. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89609. */
  89610. export class CombineAction extends Action {
  89611. /**
  89612. * The list of aggregated animations to run.
  89613. */
  89614. children: Action[];
  89615. /**
  89616. * Instantiate the action
  89617. * @param triggerOptions defines the trigger options
  89618. * @param children defines the list of aggregated animations to run
  89619. * @param condition defines the trigger related conditions
  89620. */
  89621. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  89622. /** @hidden */
  89623. _prepare(): void;
  89624. /**
  89625. * Execute the action and executes all the aggregated actions.
  89626. */
  89627. execute(evt: ActionEvent): void;
  89628. /**
  89629. * Serializes the actions and its related information.
  89630. * @param parent defines the object to serialize in
  89631. * @returns the serialized object
  89632. */
  89633. serialize(parent: any): any;
  89634. }
  89635. /**
  89636. * This defines an action responsible to run code (external event) once triggered.
  89637. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89638. */
  89639. export class ExecuteCodeAction extends Action {
  89640. /**
  89641. * The callback function to run.
  89642. */
  89643. func: (evt: ActionEvent) => void;
  89644. /**
  89645. * Instantiate the action
  89646. * @param triggerOptions defines the trigger options
  89647. * @param func defines the callback function to run
  89648. * @param condition defines the trigger related conditions
  89649. */
  89650. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  89651. /**
  89652. * Execute the action and run the attached code.
  89653. */
  89654. execute(evt: ActionEvent): void;
  89655. }
  89656. /**
  89657. * This defines an action responsible to set the parent property of the target once triggered.
  89658. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89659. */
  89660. export class SetParentAction extends Action {
  89661. private _parent;
  89662. private _target;
  89663. /**
  89664. * Instantiate the action
  89665. * @param triggerOptions defines the trigger options
  89666. * @param target defines the target containing the parent property
  89667. * @param parent defines from where the animation should start (animation frame)
  89668. * @param condition defines the trigger related conditions
  89669. */
  89670. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  89671. /** @hidden */
  89672. _prepare(): void;
  89673. /**
  89674. * Execute the action and set the parent property.
  89675. */
  89676. execute(): void;
  89677. /**
  89678. * Serializes the actions and its related information.
  89679. * @param parent defines the object to serialize in
  89680. * @returns the serialized object
  89681. */
  89682. serialize(parent: any): any;
  89683. }
  89684. }
  89685. declare module BABYLON {
  89686. /**
  89687. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  89688. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  89689. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89690. */
  89691. export class ActionManager extends AbstractActionManager {
  89692. /**
  89693. * Nothing
  89694. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89695. */
  89696. static readonly NothingTrigger: number;
  89697. /**
  89698. * On pick
  89699. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89700. */
  89701. static readonly OnPickTrigger: number;
  89702. /**
  89703. * On left pick
  89704. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89705. */
  89706. static readonly OnLeftPickTrigger: number;
  89707. /**
  89708. * On right pick
  89709. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89710. */
  89711. static readonly OnRightPickTrigger: number;
  89712. /**
  89713. * On center pick
  89714. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89715. */
  89716. static readonly OnCenterPickTrigger: number;
  89717. /**
  89718. * On pick down
  89719. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89720. */
  89721. static readonly OnPickDownTrigger: number;
  89722. /**
  89723. * On double pick
  89724. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89725. */
  89726. static readonly OnDoublePickTrigger: number;
  89727. /**
  89728. * On pick up
  89729. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89730. */
  89731. static readonly OnPickUpTrigger: number;
  89732. /**
  89733. * On pick out.
  89734. * This trigger will only be raised if you also declared a OnPickDown
  89735. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89736. */
  89737. static readonly OnPickOutTrigger: number;
  89738. /**
  89739. * On long press
  89740. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89741. */
  89742. static readonly OnLongPressTrigger: number;
  89743. /**
  89744. * On pointer over
  89745. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89746. */
  89747. static readonly OnPointerOverTrigger: number;
  89748. /**
  89749. * On pointer out
  89750. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89751. */
  89752. static readonly OnPointerOutTrigger: number;
  89753. /**
  89754. * On every frame
  89755. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89756. */
  89757. static readonly OnEveryFrameTrigger: number;
  89758. /**
  89759. * On intersection enter
  89760. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89761. */
  89762. static readonly OnIntersectionEnterTrigger: number;
  89763. /**
  89764. * On intersection exit
  89765. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89766. */
  89767. static readonly OnIntersectionExitTrigger: number;
  89768. /**
  89769. * On key down
  89770. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89771. */
  89772. static readonly OnKeyDownTrigger: number;
  89773. /**
  89774. * On key up
  89775. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89776. */
  89777. static readonly OnKeyUpTrigger: number;
  89778. private _scene;
  89779. /**
  89780. * Creates a new action manager
  89781. * @param scene defines the hosting scene
  89782. */
  89783. constructor(scene: Scene);
  89784. /**
  89785. * Releases all associated resources
  89786. */
  89787. dispose(): void;
  89788. /**
  89789. * Gets hosting scene
  89790. * @returns the hosting scene
  89791. */
  89792. getScene(): Scene;
  89793. /**
  89794. * Does this action manager handles actions of any of the given triggers
  89795. * @param triggers defines the triggers to be tested
  89796. * @return a boolean indicating whether one (or more) of the triggers is handled
  89797. */
  89798. hasSpecificTriggers(triggers: number[]): boolean;
  89799. /**
  89800. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  89801. * speed.
  89802. * @param triggerA defines the trigger to be tested
  89803. * @param triggerB defines the trigger to be tested
  89804. * @return a boolean indicating whether one (or more) of the triggers is handled
  89805. */
  89806. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  89807. /**
  89808. * Does this action manager handles actions of a given trigger
  89809. * @param trigger defines the trigger to be tested
  89810. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  89811. * @return whether the trigger is handled
  89812. */
  89813. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  89814. /**
  89815. * Does this action manager has pointer triggers
  89816. */
  89817. get hasPointerTriggers(): boolean;
  89818. /**
  89819. * Does this action manager has pick triggers
  89820. */
  89821. get hasPickTriggers(): boolean;
  89822. /**
  89823. * Registers an action to this action manager
  89824. * @param action defines the action to be registered
  89825. * @return the action amended (prepared) after registration
  89826. */
  89827. registerAction(action: IAction): Nullable<IAction>;
  89828. /**
  89829. * Unregisters an action to this action manager
  89830. * @param action defines the action to be unregistered
  89831. * @return a boolean indicating whether the action has been unregistered
  89832. */
  89833. unregisterAction(action: IAction): Boolean;
  89834. /**
  89835. * Process a specific trigger
  89836. * @param trigger defines the trigger to process
  89837. * @param evt defines the event details to be processed
  89838. */
  89839. processTrigger(trigger: number, evt?: IActionEvent): void;
  89840. /** @hidden */
  89841. _getEffectiveTarget(target: any, propertyPath: string): any;
  89842. /** @hidden */
  89843. _getProperty(propertyPath: string): string;
  89844. /**
  89845. * Serialize this manager to a JSON object
  89846. * @param name defines the property name to store this manager
  89847. * @returns a JSON representation of this manager
  89848. */
  89849. serialize(name: string): any;
  89850. /**
  89851. * Creates a new ActionManager from a JSON data
  89852. * @param parsedActions defines the JSON data to read from
  89853. * @param object defines the hosting mesh
  89854. * @param scene defines the hosting scene
  89855. */
  89856. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  89857. /**
  89858. * Get a trigger name by index
  89859. * @param trigger defines the trigger index
  89860. * @returns a trigger name
  89861. */
  89862. static GetTriggerName(trigger: number): string;
  89863. }
  89864. }
  89865. declare module BABYLON {
  89866. /**
  89867. * Class used to represent a sprite
  89868. * @see https://doc.babylonjs.com/babylon101/sprites
  89869. */
  89870. export class Sprite implements IAnimatable {
  89871. /** defines the name */
  89872. name: string;
  89873. /** Gets or sets the current world position */
  89874. position: Vector3;
  89875. /** Gets or sets the main color */
  89876. color: Color4;
  89877. /** Gets or sets the width */
  89878. width: number;
  89879. /** Gets or sets the height */
  89880. height: number;
  89881. /** Gets or sets rotation angle */
  89882. angle: number;
  89883. /** Gets or sets the cell index in the sprite sheet */
  89884. cellIndex: number;
  89885. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  89886. cellRef: string;
  89887. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  89888. invertU: boolean;
  89889. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  89890. invertV: boolean;
  89891. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  89892. disposeWhenFinishedAnimating: boolean;
  89893. /** Gets the list of attached animations */
  89894. animations: Nullable<Array<Animation>>;
  89895. /** Gets or sets a boolean indicating if the sprite can be picked */
  89896. isPickable: boolean;
  89897. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  89898. useAlphaForPicking: boolean;
  89899. /** @hidden */
  89900. _xOffset: number;
  89901. /** @hidden */
  89902. _yOffset: number;
  89903. /** @hidden */
  89904. _xSize: number;
  89905. /** @hidden */
  89906. _ySize: number;
  89907. /**
  89908. * Gets or sets the associated action manager
  89909. */
  89910. actionManager: Nullable<ActionManager>;
  89911. /**
  89912. * An event triggered when the control has been disposed
  89913. */
  89914. onDisposeObservable: Observable<Sprite>;
  89915. private _animationStarted;
  89916. private _loopAnimation;
  89917. private _fromIndex;
  89918. private _toIndex;
  89919. private _delay;
  89920. private _direction;
  89921. private _manager;
  89922. private _time;
  89923. private _onAnimationEnd;
  89924. /**
  89925. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  89926. */
  89927. isVisible: boolean;
  89928. /**
  89929. * Gets or sets the sprite size
  89930. */
  89931. get size(): number;
  89932. set size(value: number);
  89933. /**
  89934. * Returns a boolean indicating if the animation is started
  89935. */
  89936. get animationStarted(): boolean;
  89937. /**
  89938. * Gets or sets the unique id of the sprite
  89939. */
  89940. uniqueId: number;
  89941. /**
  89942. * Gets the manager of this sprite
  89943. */
  89944. get manager(): ISpriteManager;
  89945. /**
  89946. * Creates a new Sprite
  89947. * @param name defines the name
  89948. * @param manager defines the manager
  89949. */
  89950. constructor(
  89951. /** defines the name */
  89952. name: string, manager: ISpriteManager);
  89953. /**
  89954. * Returns the string "Sprite"
  89955. * @returns "Sprite"
  89956. */
  89957. getClassName(): string;
  89958. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  89959. get fromIndex(): number;
  89960. set fromIndex(value: number);
  89961. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  89962. get toIndex(): number;
  89963. set toIndex(value: number);
  89964. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  89965. get loopAnimation(): boolean;
  89966. set loopAnimation(value: boolean);
  89967. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  89968. get delay(): number;
  89969. set delay(value: number);
  89970. /**
  89971. * Starts an animation
  89972. * @param from defines the initial key
  89973. * @param to defines the end key
  89974. * @param loop defines if the animation must loop
  89975. * @param delay defines the start delay (in ms)
  89976. * @param onAnimationEnd defines a callback to call when animation ends
  89977. */
  89978. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  89979. /** Stops current animation (if any) */
  89980. stopAnimation(): void;
  89981. /** @hidden */
  89982. _animate(deltaTime: number): void;
  89983. /** Release associated resources */
  89984. dispose(): void;
  89985. /**
  89986. * Serializes the sprite to a JSON object
  89987. * @returns the JSON object
  89988. */
  89989. serialize(): any;
  89990. /**
  89991. * Parses a JSON object to create a new sprite
  89992. * @param parsedSprite The JSON object to parse
  89993. * @param manager defines the hosting manager
  89994. * @returns the new sprite
  89995. */
  89996. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  89997. }
  89998. }
  89999. declare module BABYLON {
  90000. /**
  90001. * Information about the result of picking within a scene
  90002. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  90003. */
  90004. export class PickingInfo {
  90005. /** @hidden */
  90006. _pickingUnavailable: boolean;
  90007. /**
  90008. * If the pick collided with an object
  90009. */
  90010. hit: boolean;
  90011. /**
  90012. * Distance away where the pick collided
  90013. */
  90014. distance: number;
  90015. /**
  90016. * The location of pick collision
  90017. */
  90018. pickedPoint: Nullable<Vector3>;
  90019. /**
  90020. * The mesh corresponding the the pick collision
  90021. */
  90022. pickedMesh: Nullable<AbstractMesh>;
  90023. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  90024. bu: number;
  90025. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  90026. bv: number;
  90027. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90028. faceId: number;
  90029. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90030. subMeshFaceId: number;
  90031. /** Id of the the submesh that was picked */
  90032. subMeshId: number;
  90033. /** If a sprite was picked, this will be the sprite the pick collided with */
  90034. pickedSprite: Nullable<Sprite>;
  90035. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  90036. thinInstanceIndex: number;
  90037. /**
  90038. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  90039. */
  90040. originMesh: Nullable<AbstractMesh>;
  90041. /**
  90042. * The ray that was used to perform the picking.
  90043. */
  90044. ray: Nullable<Ray>;
  90045. /**
  90046. * Gets the normal correspodning to the face the pick collided with
  90047. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  90048. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  90049. * @returns The normal correspodning to the face the pick collided with
  90050. */
  90051. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  90052. /**
  90053. * Gets the texture coordinates of where the pick occured
  90054. * @returns the vector containing the coordnates of the texture
  90055. */
  90056. getTextureCoordinates(): Nullable<Vector2>;
  90057. }
  90058. }
  90059. declare module BABYLON {
  90060. /**
  90061. * Class representing a ray with position and direction
  90062. */
  90063. export class Ray {
  90064. /** origin point */
  90065. origin: Vector3;
  90066. /** direction */
  90067. direction: Vector3;
  90068. /** length of the ray */
  90069. length: number;
  90070. private static readonly _TmpVector3;
  90071. private _tmpRay;
  90072. /**
  90073. * Creates a new ray
  90074. * @param origin origin point
  90075. * @param direction direction
  90076. * @param length length of the ray
  90077. */
  90078. constructor(
  90079. /** origin point */
  90080. origin: Vector3,
  90081. /** direction */
  90082. direction: Vector3,
  90083. /** length of the ray */
  90084. length?: number);
  90085. /**
  90086. * Checks if the ray intersects a box
  90087. * This does not account for the ray lenght by design to improve perfs.
  90088. * @param minimum bound of the box
  90089. * @param maximum bound of the box
  90090. * @param intersectionTreshold extra extend to be added to the box in all direction
  90091. * @returns if the box was hit
  90092. */
  90093. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  90094. /**
  90095. * Checks if the ray intersects a box
  90096. * This does not account for the ray lenght by design to improve perfs.
  90097. * @param box the bounding box to check
  90098. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  90099. * @returns if the box was hit
  90100. */
  90101. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  90102. /**
  90103. * If the ray hits a sphere
  90104. * @param sphere the bounding sphere to check
  90105. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  90106. * @returns true if it hits the sphere
  90107. */
  90108. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  90109. /**
  90110. * If the ray hits a triange
  90111. * @param vertex0 triangle vertex
  90112. * @param vertex1 triangle vertex
  90113. * @param vertex2 triangle vertex
  90114. * @returns intersection information if hit
  90115. */
  90116. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  90117. /**
  90118. * Checks if ray intersects a plane
  90119. * @param plane the plane to check
  90120. * @returns the distance away it was hit
  90121. */
  90122. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  90123. /**
  90124. * Calculate the intercept of a ray on a given axis
  90125. * @param axis to check 'x' | 'y' | 'z'
  90126. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  90127. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  90128. */
  90129. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  90130. /**
  90131. * Checks if ray intersects a mesh
  90132. * @param mesh the mesh to check
  90133. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90134. * @returns picking info of the intersecton
  90135. */
  90136. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  90137. /**
  90138. * Checks if ray intersects a mesh
  90139. * @param meshes the meshes to check
  90140. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90141. * @param results array to store result in
  90142. * @returns Array of picking infos
  90143. */
  90144. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  90145. private _comparePickingInfo;
  90146. private static smallnum;
  90147. private static rayl;
  90148. /**
  90149. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  90150. * @param sega the first point of the segment to test the intersection against
  90151. * @param segb the second point of the segment to test the intersection against
  90152. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  90153. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  90154. */
  90155. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  90156. /**
  90157. * Update the ray from viewport position
  90158. * @param x position
  90159. * @param y y position
  90160. * @param viewportWidth viewport width
  90161. * @param viewportHeight viewport height
  90162. * @param world world matrix
  90163. * @param view view matrix
  90164. * @param projection projection matrix
  90165. * @returns this ray updated
  90166. */
  90167. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90168. /**
  90169. * Creates a ray with origin and direction of 0,0,0
  90170. * @returns the new ray
  90171. */
  90172. static Zero(): Ray;
  90173. /**
  90174. * Creates a new ray from screen space and viewport
  90175. * @param x position
  90176. * @param y y position
  90177. * @param viewportWidth viewport width
  90178. * @param viewportHeight viewport height
  90179. * @param world world matrix
  90180. * @param view view matrix
  90181. * @param projection projection matrix
  90182. * @returns new ray
  90183. */
  90184. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90185. /**
  90186. * 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
  90187. * transformed to the given world matrix.
  90188. * @param origin The origin point
  90189. * @param end The end point
  90190. * @param world a matrix to transform the ray to. Default is the identity matrix.
  90191. * @returns the new ray
  90192. */
  90193. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  90194. /**
  90195. * Transforms a ray by a matrix
  90196. * @param ray ray to transform
  90197. * @param matrix matrix to apply
  90198. * @returns the resulting new ray
  90199. */
  90200. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  90201. /**
  90202. * Transforms a ray by a matrix
  90203. * @param ray ray to transform
  90204. * @param matrix matrix to apply
  90205. * @param result ray to store result in
  90206. */
  90207. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  90208. /**
  90209. * Unproject a ray from screen space to object space
  90210. * @param sourceX defines the screen space x coordinate to use
  90211. * @param sourceY defines the screen space y coordinate to use
  90212. * @param viewportWidth defines the current width of the viewport
  90213. * @param viewportHeight defines the current height of the viewport
  90214. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  90215. * @param view defines the view matrix to use
  90216. * @param projection defines the projection matrix to use
  90217. */
  90218. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  90219. }
  90220. /**
  90221. * Type used to define predicate used to select faces when a mesh intersection is detected
  90222. */
  90223. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  90224. interface Scene {
  90225. /** @hidden */
  90226. _tempPickingRay: Nullable<Ray>;
  90227. /** @hidden */
  90228. _cachedRayForTransform: Ray;
  90229. /** @hidden */
  90230. _pickWithRayInverseMatrix: Matrix;
  90231. /** @hidden */
  90232. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90233. /** @hidden */
  90234. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  90235. /** @hidden */
  90236. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90237. }
  90238. }
  90239. declare module BABYLON {
  90240. /**
  90241. * Groups all the scene component constants in one place to ease maintenance.
  90242. * @hidden
  90243. */
  90244. export class SceneComponentConstants {
  90245. static readonly NAME_EFFECTLAYER: string;
  90246. static readonly NAME_LAYER: string;
  90247. static readonly NAME_LENSFLARESYSTEM: string;
  90248. static readonly NAME_BOUNDINGBOXRENDERER: string;
  90249. static readonly NAME_PARTICLESYSTEM: string;
  90250. static readonly NAME_GAMEPAD: string;
  90251. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  90252. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  90253. static readonly NAME_PREPASSRENDERER: string;
  90254. static readonly NAME_DEPTHRENDERER: string;
  90255. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  90256. static readonly NAME_SPRITE: string;
  90257. static readonly NAME_OUTLINERENDERER: string;
  90258. static readonly NAME_PROCEDURALTEXTURE: string;
  90259. static readonly NAME_SHADOWGENERATOR: string;
  90260. static readonly NAME_OCTREE: string;
  90261. static readonly NAME_PHYSICSENGINE: string;
  90262. static readonly NAME_AUDIO: string;
  90263. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90264. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90265. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90266. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90267. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90268. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90269. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90270. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90271. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90272. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90273. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90274. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90275. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90276. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90277. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90278. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90279. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90280. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90281. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90282. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90283. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90284. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90285. static readonly STEP_AFTERRENDER_AUDIO: number;
  90286. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90287. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90288. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90289. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90290. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90291. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90292. static readonly STEP_POINTERMOVE_SPRITE: number;
  90293. static readonly STEP_POINTERDOWN_SPRITE: number;
  90294. static readonly STEP_POINTERUP_SPRITE: number;
  90295. }
  90296. /**
  90297. * This represents a scene component.
  90298. *
  90299. * This is used to decouple the dependency the scene is having on the different workloads like
  90300. * layers, post processes...
  90301. */
  90302. export interface ISceneComponent {
  90303. /**
  90304. * The name of the component. Each component must have a unique name.
  90305. */
  90306. name: string;
  90307. /**
  90308. * The scene the component belongs to.
  90309. */
  90310. scene: Scene;
  90311. /**
  90312. * Register the component to one instance of a scene.
  90313. */
  90314. register(): void;
  90315. /**
  90316. * Rebuilds the elements related to this component in case of
  90317. * context lost for instance.
  90318. */
  90319. rebuild(): void;
  90320. /**
  90321. * Disposes the component and the associated ressources.
  90322. */
  90323. dispose(): void;
  90324. }
  90325. /**
  90326. * This represents a SERIALIZABLE scene component.
  90327. *
  90328. * This extends Scene Component to add Serialization methods on top.
  90329. */
  90330. export interface ISceneSerializableComponent extends ISceneComponent {
  90331. /**
  90332. * Adds all the elements from the container to the scene
  90333. * @param container the container holding the elements
  90334. */
  90335. addFromContainer(container: AbstractScene): void;
  90336. /**
  90337. * Removes all the elements in the container from the scene
  90338. * @param container contains the elements to remove
  90339. * @param dispose if the removed element should be disposed (default: false)
  90340. */
  90341. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  90342. /**
  90343. * Serializes the component data to the specified json object
  90344. * @param serializationObject The object to serialize to
  90345. */
  90346. serialize(serializationObject: any): void;
  90347. }
  90348. /**
  90349. * Strong typing of a Mesh related stage step action
  90350. */
  90351. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  90352. /**
  90353. * Strong typing of a Evaluate Sub Mesh related stage step action
  90354. */
  90355. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  90356. /**
  90357. * Strong typing of a Active Mesh related stage step action
  90358. */
  90359. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  90360. /**
  90361. * Strong typing of a Camera related stage step action
  90362. */
  90363. export type CameraStageAction = (camera: Camera) => void;
  90364. /**
  90365. * Strong typing of a Camera Frame buffer related stage step action
  90366. */
  90367. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  90368. /**
  90369. * Strong typing of a Render Target related stage step action
  90370. */
  90371. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  90372. /**
  90373. * Strong typing of a RenderingGroup related stage step action
  90374. */
  90375. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  90376. /**
  90377. * Strong typing of a Mesh Render related stage step action
  90378. */
  90379. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  90380. /**
  90381. * Strong typing of a simple stage step action
  90382. */
  90383. export type SimpleStageAction = () => void;
  90384. /**
  90385. * Strong typing of a render target action.
  90386. */
  90387. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  90388. /**
  90389. * Strong typing of a pointer move action.
  90390. */
  90391. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  90392. /**
  90393. * Strong typing of a pointer up/down action.
  90394. */
  90395. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  90396. /**
  90397. * Representation of a stage in the scene (Basically a list of ordered steps)
  90398. * @hidden
  90399. */
  90400. export class Stage<T extends Function> extends Array<{
  90401. index: number;
  90402. component: ISceneComponent;
  90403. action: T;
  90404. }> {
  90405. /**
  90406. * Hide ctor from the rest of the world.
  90407. * @param items The items to add.
  90408. */
  90409. private constructor();
  90410. /**
  90411. * Creates a new Stage.
  90412. * @returns A new instance of a Stage
  90413. */
  90414. static Create<T extends Function>(): Stage<T>;
  90415. /**
  90416. * Registers a step in an ordered way in the targeted stage.
  90417. * @param index Defines the position to register the step in
  90418. * @param component Defines the component attached to the step
  90419. * @param action Defines the action to launch during the step
  90420. */
  90421. registerStep(index: number, component: ISceneComponent, action: T): void;
  90422. /**
  90423. * Clears all the steps from the stage.
  90424. */
  90425. clear(): void;
  90426. }
  90427. }
  90428. declare module BABYLON {
  90429. interface Scene {
  90430. /** @hidden */
  90431. _pointerOverSprite: Nullable<Sprite>;
  90432. /** @hidden */
  90433. _pickedDownSprite: Nullable<Sprite>;
  90434. /** @hidden */
  90435. _tempSpritePickingRay: Nullable<Ray>;
  90436. /**
  90437. * All of the sprite managers added to this scene
  90438. * @see https://doc.babylonjs.com/babylon101/sprites
  90439. */
  90440. spriteManagers: Array<ISpriteManager>;
  90441. /**
  90442. * An event triggered when sprites rendering is about to start
  90443. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90444. */
  90445. onBeforeSpritesRenderingObservable: Observable<Scene>;
  90446. /**
  90447. * An event triggered when sprites rendering is done
  90448. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90449. */
  90450. onAfterSpritesRenderingObservable: Observable<Scene>;
  90451. /** @hidden */
  90452. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90453. /** Launch a ray to try to pick a sprite in the scene
  90454. * @param x position on screen
  90455. * @param y position on screen
  90456. * @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
  90457. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90458. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90459. * @returns a PickingInfo
  90460. */
  90461. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90462. /** Use the given ray to pick a sprite in the scene
  90463. * @param ray The ray (in world space) to use to pick meshes
  90464. * @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
  90465. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90466. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90467. * @returns a PickingInfo
  90468. */
  90469. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90470. /** @hidden */
  90471. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90472. /** Launch a ray to try to pick sprites in the scene
  90473. * @param x position on screen
  90474. * @param y position on screen
  90475. * @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
  90476. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90477. * @returns a PickingInfo array
  90478. */
  90479. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90480. /** Use the given ray to pick sprites in the scene
  90481. * @param ray The ray (in world space) to use to pick meshes
  90482. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  90483. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90484. * @returns a PickingInfo array
  90485. */
  90486. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90487. /**
  90488. * Force the sprite under the pointer
  90489. * @param sprite defines the sprite to use
  90490. */
  90491. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  90492. /**
  90493. * Gets the sprite under the pointer
  90494. * @returns a Sprite or null if no sprite is under the pointer
  90495. */
  90496. getPointerOverSprite(): Nullable<Sprite>;
  90497. }
  90498. /**
  90499. * Defines the sprite scene component responsible to manage sprites
  90500. * in a given scene.
  90501. */
  90502. export class SpriteSceneComponent implements ISceneComponent {
  90503. /**
  90504. * The component name helpfull to identify the component in the list of scene components.
  90505. */
  90506. readonly name: string;
  90507. /**
  90508. * The scene the component belongs to.
  90509. */
  90510. scene: Scene;
  90511. /** @hidden */
  90512. private _spritePredicate;
  90513. /**
  90514. * Creates a new instance of the component for the given scene
  90515. * @param scene Defines the scene to register the component in
  90516. */
  90517. constructor(scene: Scene);
  90518. /**
  90519. * Registers the component in a given scene
  90520. */
  90521. register(): void;
  90522. /**
  90523. * Rebuilds the elements related to this component in case of
  90524. * context lost for instance.
  90525. */
  90526. rebuild(): void;
  90527. /**
  90528. * Disposes the component and the associated ressources.
  90529. */
  90530. dispose(): void;
  90531. private _pickSpriteButKeepRay;
  90532. private _pointerMove;
  90533. private _pointerDown;
  90534. private _pointerUp;
  90535. }
  90536. }
  90537. declare module BABYLON {
  90538. /** @hidden */
  90539. export var fogFragmentDeclaration: {
  90540. name: string;
  90541. shader: string;
  90542. };
  90543. }
  90544. declare module BABYLON {
  90545. /** @hidden */
  90546. export var fogFragment: {
  90547. name: string;
  90548. shader: string;
  90549. };
  90550. }
  90551. declare module BABYLON {
  90552. /** @hidden */
  90553. export var spritesPixelShader: {
  90554. name: string;
  90555. shader: string;
  90556. };
  90557. }
  90558. declare module BABYLON {
  90559. /** @hidden */
  90560. export var fogVertexDeclaration: {
  90561. name: string;
  90562. shader: string;
  90563. };
  90564. }
  90565. declare module BABYLON {
  90566. /** @hidden */
  90567. export var spritesVertexShader: {
  90568. name: string;
  90569. shader: string;
  90570. };
  90571. }
  90572. declare module BABYLON {
  90573. /**
  90574. * Defines the minimum interface to fullfil in order to be a sprite manager.
  90575. */
  90576. export interface ISpriteManager extends IDisposable {
  90577. /**
  90578. * Gets manager's name
  90579. */
  90580. name: string;
  90581. /**
  90582. * Restricts the camera to viewing objects with the same layerMask.
  90583. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  90584. */
  90585. layerMask: number;
  90586. /**
  90587. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  90588. */
  90589. isPickable: boolean;
  90590. /**
  90591. * Gets the hosting scene
  90592. */
  90593. scene: Scene;
  90594. /**
  90595. * Specifies the rendering group id for this mesh (0 by default)
  90596. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  90597. */
  90598. renderingGroupId: number;
  90599. /**
  90600. * Defines the list of sprites managed by the manager.
  90601. */
  90602. sprites: Array<Sprite>;
  90603. /**
  90604. * Gets or sets the spritesheet texture
  90605. */
  90606. texture: Texture;
  90607. /** Defines the default width of a cell in the spritesheet */
  90608. cellWidth: number;
  90609. /** Defines the default height of a cell in the spritesheet */
  90610. cellHeight: number;
  90611. /**
  90612. * Tests the intersection of a sprite with a specific ray.
  90613. * @param ray The ray we are sending to test the collision
  90614. * @param camera The camera space we are sending rays in
  90615. * @param predicate A predicate allowing excluding sprites from the list of object to test
  90616. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90617. * @returns picking info or null.
  90618. */
  90619. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90620. /**
  90621. * Intersects the sprites with a ray
  90622. * @param ray defines the ray to intersect with
  90623. * @param camera defines the current active camera
  90624. * @param predicate defines a predicate used to select candidate sprites
  90625. * @returns null if no hit or a PickingInfo array
  90626. */
  90627. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90628. /**
  90629. * Renders the list of sprites on screen.
  90630. */
  90631. render(): void;
  90632. }
  90633. /**
  90634. * Class used to manage multiple sprites on the same spritesheet
  90635. * @see https://doc.babylonjs.com/babylon101/sprites
  90636. */
  90637. export class SpriteManager implements ISpriteManager {
  90638. /** defines the manager's name */
  90639. name: string;
  90640. /** Define the Url to load snippets */
  90641. static SnippetUrl: string;
  90642. /** Snippet ID if the manager was created from the snippet server */
  90643. snippetId: string;
  90644. /** Gets the list of sprites */
  90645. sprites: Sprite[];
  90646. /** Gets or sets the rendering group id (0 by default) */
  90647. renderingGroupId: number;
  90648. /** Gets or sets camera layer mask */
  90649. layerMask: number;
  90650. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  90651. fogEnabled: boolean;
  90652. /** Gets or sets a boolean indicating if the sprites are pickable */
  90653. isPickable: boolean;
  90654. /** Defines the default width of a cell in the spritesheet */
  90655. cellWidth: number;
  90656. /** Defines the default height of a cell in the spritesheet */
  90657. cellHeight: number;
  90658. /** Associative array from JSON sprite data file */
  90659. private _cellData;
  90660. /** Array of sprite names from JSON sprite data file */
  90661. private _spriteMap;
  90662. /** True when packed cell data from JSON file is ready*/
  90663. private _packedAndReady;
  90664. private _textureContent;
  90665. private _useInstancing;
  90666. /**
  90667. * An event triggered when the manager is disposed.
  90668. */
  90669. onDisposeObservable: Observable<SpriteManager>;
  90670. private _onDisposeObserver;
  90671. /**
  90672. * Callback called when the manager is disposed
  90673. */
  90674. set onDispose(callback: () => void);
  90675. private _capacity;
  90676. private _fromPacked;
  90677. private _spriteTexture;
  90678. private _epsilon;
  90679. private _scene;
  90680. private _vertexData;
  90681. private _buffer;
  90682. private _vertexBuffers;
  90683. private _spriteBuffer;
  90684. private _indexBuffer;
  90685. private _effectBase;
  90686. private _effectFog;
  90687. private _vertexBufferSize;
  90688. /**
  90689. * Gets or sets the unique id of the sprite
  90690. */
  90691. uniqueId: number;
  90692. /**
  90693. * Gets the array of sprites
  90694. */
  90695. get children(): Sprite[];
  90696. /**
  90697. * Gets the hosting scene
  90698. */
  90699. get scene(): Scene;
  90700. /**
  90701. * Gets the capacity of the manager
  90702. */
  90703. get capacity(): number;
  90704. /**
  90705. * Gets or sets the spritesheet texture
  90706. */
  90707. get texture(): Texture;
  90708. set texture(value: Texture);
  90709. private _blendMode;
  90710. /**
  90711. * Blend mode use to render the particle, it can be any of
  90712. * the static Constants.ALPHA_x properties provided in this class.
  90713. * Default value is Constants.ALPHA_COMBINE
  90714. */
  90715. get blendMode(): number;
  90716. set blendMode(blendMode: number);
  90717. /** Disables writing to the depth buffer when rendering the sprites.
  90718. * It can be handy to disable depth writing when using textures without alpha channel
  90719. * and setting some specific blend modes.
  90720. */
  90721. disableDepthWrite: boolean;
  90722. /**
  90723. * Creates a new sprite manager
  90724. * @param name defines the manager's name
  90725. * @param imgUrl defines the sprite sheet url
  90726. * @param capacity defines the maximum allowed number of sprites
  90727. * @param cellSize defines the size of a sprite cell
  90728. * @param scene defines the hosting scene
  90729. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  90730. * @param samplingMode defines the smapling mode to use with spritesheet
  90731. * @param fromPacked set to false; do not alter
  90732. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  90733. */
  90734. constructor(
  90735. /** defines the manager's name */
  90736. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  90737. /**
  90738. * Returns the string "SpriteManager"
  90739. * @returns "SpriteManager"
  90740. */
  90741. getClassName(): string;
  90742. private _makePacked;
  90743. private _appendSpriteVertex;
  90744. private _checkTextureAlpha;
  90745. /**
  90746. * Intersects the sprites with a ray
  90747. * @param ray defines the ray to intersect with
  90748. * @param camera defines the current active camera
  90749. * @param predicate defines a predicate used to select candidate sprites
  90750. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  90751. * @returns null if no hit or a PickingInfo
  90752. */
  90753. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90754. /**
  90755. * Intersects the sprites with a ray
  90756. * @param ray defines the ray to intersect with
  90757. * @param camera defines the current active camera
  90758. * @param predicate defines a predicate used to select candidate sprites
  90759. * @returns null if no hit or a PickingInfo array
  90760. */
  90761. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90762. /**
  90763. * Render all child sprites
  90764. */
  90765. render(): void;
  90766. /**
  90767. * Release associated resources
  90768. */
  90769. dispose(): void;
  90770. /**
  90771. * Serializes the sprite manager to a JSON object
  90772. * @param serializeTexture defines if the texture must be serialized as well
  90773. * @returns the JSON object
  90774. */
  90775. serialize(serializeTexture?: boolean): any;
  90776. /**
  90777. * Parses a JSON object to create a new sprite manager.
  90778. * @param parsedManager The JSON object to parse
  90779. * @param scene The scene to create the sprite managerin
  90780. * @param rootUrl The root url to use to load external dependencies like texture
  90781. * @returns the new sprite manager
  90782. */
  90783. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  90784. /**
  90785. * Creates a sprite manager from a snippet saved in a remote file
  90786. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  90787. * @param url defines the url to load from
  90788. * @param scene defines the hosting scene
  90789. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90790. * @returns a promise that will resolve to the new sprite manager
  90791. */
  90792. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90793. /**
  90794. * Creates a sprite manager from a snippet saved by the sprite editor
  90795. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  90796. * @param scene defines the hosting scene
  90797. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90798. * @returns a promise that will resolve to the new sprite manager
  90799. */
  90800. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90801. }
  90802. }
  90803. declare module BABYLON {
  90804. /** Interface used by value gradients (color, factor, ...) */
  90805. export interface IValueGradient {
  90806. /**
  90807. * Gets or sets the gradient value (between 0 and 1)
  90808. */
  90809. gradient: number;
  90810. }
  90811. /** Class used to store color4 gradient */
  90812. export class ColorGradient implements IValueGradient {
  90813. /**
  90814. * Gets or sets the gradient value (between 0 and 1)
  90815. */
  90816. gradient: number;
  90817. /**
  90818. * Gets or sets first associated color
  90819. */
  90820. color1: Color4;
  90821. /**
  90822. * Gets or sets second associated color
  90823. */
  90824. color2?: Color4 | undefined;
  90825. /**
  90826. * Creates a new color4 gradient
  90827. * @param gradient gets or sets the gradient value (between 0 and 1)
  90828. * @param color1 gets or sets first associated color
  90829. * @param color2 gets or sets first second color
  90830. */
  90831. constructor(
  90832. /**
  90833. * Gets or sets the gradient value (between 0 and 1)
  90834. */
  90835. gradient: number,
  90836. /**
  90837. * Gets or sets first associated color
  90838. */
  90839. color1: Color4,
  90840. /**
  90841. * Gets or sets second associated color
  90842. */
  90843. color2?: Color4 | undefined);
  90844. /**
  90845. * Will get a color picked randomly between color1 and color2.
  90846. * If color2 is undefined then color1 will be used
  90847. * @param result defines the target Color4 to store the result in
  90848. */
  90849. getColorToRef(result: Color4): void;
  90850. }
  90851. /** Class used to store color 3 gradient */
  90852. export class Color3Gradient implements IValueGradient {
  90853. /**
  90854. * Gets or sets the gradient value (between 0 and 1)
  90855. */
  90856. gradient: number;
  90857. /**
  90858. * Gets or sets the associated color
  90859. */
  90860. color: Color3;
  90861. /**
  90862. * Creates a new color3 gradient
  90863. * @param gradient gets or sets the gradient value (between 0 and 1)
  90864. * @param color gets or sets associated color
  90865. */
  90866. constructor(
  90867. /**
  90868. * Gets or sets the gradient value (between 0 and 1)
  90869. */
  90870. gradient: number,
  90871. /**
  90872. * Gets or sets the associated color
  90873. */
  90874. color: Color3);
  90875. }
  90876. /** Class used to store factor gradient */
  90877. export class FactorGradient implements IValueGradient {
  90878. /**
  90879. * Gets or sets the gradient value (between 0 and 1)
  90880. */
  90881. gradient: number;
  90882. /**
  90883. * Gets or sets first associated factor
  90884. */
  90885. factor1: number;
  90886. /**
  90887. * Gets or sets second associated factor
  90888. */
  90889. factor2?: number | undefined;
  90890. /**
  90891. * Creates a new factor gradient
  90892. * @param gradient gets or sets the gradient value (between 0 and 1)
  90893. * @param factor1 gets or sets first associated factor
  90894. * @param factor2 gets or sets second associated factor
  90895. */
  90896. constructor(
  90897. /**
  90898. * Gets or sets the gradient value (between 0 and 1)
  90899. */
  90900. gradient: number,
  90901. /**
  90902. * Gets or sets first associated factor
  90903. */
  90904. factor1: number,
  90905. /**
  90906. * Gets or sets second associated factor
  90907. */
  90908. factor2?: number | undefined);
  90909. /**
  90910. * Will get a number picked randomly between factor1 and factor2.
  90911. * If factor2 is undefined then factor1 will be used
  90912. * @returns the picked number
  90913. */
  90914. getFactor(): number;
  90915. }
  90916. /**
  90917. * Helper used to simplify some generic gradient tasks
  90918. */
  90919. export class GradientHelper {
  90920. /**
  90921. * Gets the current gradient from an array of IValueGradient
  90922. * @param ratio defines the current ratio to get
  90923. * @param gradients defines the array of IValueGradient
  90924. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  90925. */
  90926. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  90927. }
  90928. }
  90929. declare module BABYLON {
  90930. interface ThinEngine {
  90931. /**
  90932. * Creates a raw texture
  90933. * @param data defines the data to store in the texture
  90934. * @param width defines the width of the texture
  90935. * @param height defines the height of the texture
  90936. * @param format defines the format of the data
  90937. * @param generateMipMaps defines if the engine should generate the mip levels
  90938. * @param invertY defines if data must be stored with Y axis inverted
  90939. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  90940. * @param compression defines the compression used (null by default)
  90941. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90942. * @returns the raw texture inside an InternalTexture
  90943. */
  90944. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  90945. /**
  90946. * Update a raw texture
  90947. * @param texture defines the texture to update
  90948. * @param data defines the data to store in the texture
  90949. * @param format defines the format of the data
  90950. * @param invertY defines if data must be stored with Y axis inverted
  90951. */
  90952. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90953. /**
  90954. * Update a raw texture
  90955. * @param texture defines the texture to update
  90956. * @param data defines the data to store in the texture
  90957. * @param format defines the format of the data
  90958. * @param invertY defines if data must be stored with Y axis inverted
  90959. * @param compression defines the compression used (null by default)
  90960. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90961. */
  90962. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  90963. /**
  90964. * Creates a new raw cube texture
  90965. * @param data defines the array of data to use to create each face
  90966. * @param size defines the size of the textures
  90967. * @param format defines the format of the data
  90968. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90969. * @param generateMipMaps defines if the engine should generate the mip levels
  90970. * @param invertY defines if data must be stored with Y axis inverted
  90971. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90972. * @param compression defines the compression used (null by default)
  90973. * @returns the cube texture as an InternalTexture
  90974. */
  90975. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  90976. /**
  90977. * Update a raw cube texture
  90978. * @param texture defines the texture to udpdate
  90979. * @param data defines the data to store
  90980. * @param format defines the data format
  90981. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90982. * @param invertY defines if data must be stored with Y axis inverted
  90983. */
  90984. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  90985. /**
  90986. * Update a raw cube texture
  90987. * @param texture defines the texture to udpdate
  90988. * @param data defines the data to store
  90989. * @param format defines the data format
  90990. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90991. * @param invertY defines if data must be stored with Y axis inverted
  90992. * @param compression defines the compression used (null by default)
  90993. */
  90994. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  90995. /**
  90996. * Update a raw cube texture
  90997. * @param texture defines the texture to udpdate
  90998. * @param data defines the data to store
  90999. * @param format defines the data format
  91000. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91001. * @param invertY defines if data must be stored with Y axis inverted
  91002. * @param compression defines the compression used (null by default)
  91003. * @param level defines which level of the texture to update
  91004. */
  91005. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  91006. /**
  91007. * Creates a new raw cube texture from a specified url
  91008. * @param url defines the url where the data is located
  91009. * @param scene defines the current scene
  91010. * @param size defines the size of the textures
  91011. * @param format defines the format of the data
  91012. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91013. * @param noMipmap defines if the engine should avoid generating the mip levels
  91014. * @param callback defines a callback used to extract texture data from loaded data
  91015. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91016. * @param onLoad defines a callback called when texture is loaded
  91017. * @param onError defines a callback called if there is an error
  91018. * @returns the cube texture as an InternalTexture
  91019. */
  91020. 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;
  91021. /**
  91022. * Creates a new raw cube texture from a specified url
  91023. * @param url defines the url where the data is located
  91024. * @param scene defines the current scene
  91025. * @param size defines the size of the textures
  91026. * @param format defines the format of the data
  91027. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91028. * @param noMipmap defines if the engine should avoid generating the mip levels
  91029. * @param callback defines a callback used to extract texture data from loaded data
  91030. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91031. * @param onLoad defines a callback called when texture is loaded
  91032. * @param onError defines a callback called if there is an error
  91033. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91034. * @param invertY defines if data must be stored with Y axis inverted
  91035. * @returns the cube texture as an InternalTexture
  91036. */
  91037. 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;
  91038. /**
  91039. * Creates a new raw 3D texture
  91040. * @param data defines the data used to create the texture
  91041. * @param width defines the width of the texture
  91042. * @param height defines the height of the texture
  91043. * @param depth defines the depth of the texture
  91044. * @param format defines the format of the texture
  91045. * @param generateMipMaps defines if the engine must generate mip levels
  91046. * @param invertY defines if data must be stored with Y axis inverted
  91047. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91048. * @param compression defines the compressed used (can be null)
  91049. * @param textureType defines the compressed used (can be null)
  91050. * @returns a new raw 3D texture (stored in an InternalTexture)
  91051. */
  91052. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91053. /**
  91054. * Update a raw 3D texture
  91055. * @param texture defines the texture to update
  91056. * @param data defines the data to store
  91057. * @param format defines the data format
  91058. * @param invertY defines if data must be stored with Y axis inverted
  91059. */
  91060. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91061. /**
  91062. * Update a raw 3D texture
  91063. * @param texture defines the texture to update
  91064. * @param data defines the data to store
  91065. * @param format defines the data format
  91066. * @param invertY defines if data must be stored with Y axis inverted
  91067. * @param compression defines the used compression (can be null)
  91068. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91069. */
  91070. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91071. /**
  91072. * Creates a new raw 2D array texture
  91073. * @param data defines the data used to create the texture
  91074. * @param width defines the width of the texture
  91075. * @param height defines the height of the texture
  91076. * @param depth defines the number of layers of the texture
  91077. * @param format defines the format of the texture
  91078. * @param generateMipMaps defines if the engine must generate mip levels
  91079. * @param invertY defines if data must be stored with Y axis inverted
  91080. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91081. * @param compression defines the compressed used (can be null)
  91082. * @param textureType defines the compressed used (can be null)
  91083. * @returns a new raw 2D array texture (stored in an InternalTexture)
  91084. */
  91085. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91086. /**
  91087. * Update a raw 2D array texture
  91088. * @param texture defines the texture to update
  91089. * @param data defines the data to store
  91090. * @param format defines the data format
  91091. * @param invertY defines if data must be stored with Y axis inverted
  91092. */
  91093. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91094. /**
  91095. * Update a raw 2D array texture
  91096. * @param texture defines the texture to update
  91097. * @param data defines the data to store
  91098. * @param format defines the data format
  91099. * @param invertY defines if data must be stored with Y axis inverted
  91100. * @param compression defines the used compression (can be null)
  91101. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91102. */
  91103. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91104. }
  91105. }
  91106. declare module BABYLON {
  91107. /**
  91108. * Raw texture can help creating a texture directly from an array of data.
  91109. * This can be super useful if you either get the data from an uncompressed source or
  91110. * if you wish to create your texture pixel by pixel.
  91111. */
  91112. export class RawTexture extends Texture {
  91113. /**
  91114. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91115. */
  91116. format: number;
  91117. /**
  91118. * Instantiates a new RawTexture.
  91119. * Raw texture can help creating a texture directly from an array of data.
  91120. * This can be super useful if you either get the data from an uncompressed source or
  91121. * if you wish to create your texture pixel by pixel.
  91122. * @param data define the array of data to use to create the texture
  91123. * @param width define the width of the texture
  91124. * @param height define the height of the texture
  91125. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91126. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91127. * @param generateMipMaps define whether mip maps should be generated or not
  91128. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91129. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91130. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91131. */
  91132. constructor(data: ArrayBufferView, width: number, height: number,
  91133. /**
  91134. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91135. */
  91136. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  91137. /**
  91138. * Updates the texture underlying data.
  91139. * @param data Define the new data of the texture
  91140. */
  91141. update(data: ArrayBufferView): void;
  91142. /**
  91143. * Creates a luminance texture from some data.
  91144. * @param data Define the texture data
  91145. * @param width Define the width of the texture
  91146. * @param height Define the height of the texture
  91147. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91148. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91149. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91150. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91151. * @returns the luminance texture
  91152. */
  91153. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91154. /**
  91155. * Creates a luminance alpha texture from some data.
  91156. * @param data Define the texture data
  91157. * @param width Define the width of the texture
  91158. * @param height Define the height of the texture
  91159. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91160. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91161. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91162. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91163. * @returns the luminance alpha texture
  91164. */
  91165. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91166. /**
  91167. * Creates an alpha texture from some data.
  91168. * @param data Define the texture data
  91169. * @param width Define the width of the texture
  91170. * @param height Define the height of the texture
  91171. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91172. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91173. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91174. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91175. * @returns the alpha texture
  91176. */
  91177. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91178. /**
  91179. * Creates a RGB texture from some data.
  91180. * @param data Define the texture data
  91181. * @param width Define the width of the texture
  91182. * @param height Define the height of the texture
  91183. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91184. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91185. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91186. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91187. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91188. * @returns the RGB alpha texture
  91189. */
  91190. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91191. /**
  91192. * Creates a RGBA texture from some data.
  91193. * @param data Define the texture data
  91194. * @param width Define the width of the texture
  91195. * @param height Define the height of the texture
  91196. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91197. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91198. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91199. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91200. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91201. * @returns the RGBA texture
  91202. */
  91203. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91204. /**
  91205. * Creates a R texture from some data.
  91206. * @param data Define the texture data
  91207. * @param width Define the width of the texture
  91208. * @param height Define the height of the texture
  91209. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91210. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91211. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91212. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91213. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91214. * @returns the R texture
  91215. */
  91216. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91217. }
  91218. }
  91219. declare module BABYLON {
  91220. interface ThinEngine {
  91221. /**
  91222. * Update a dynamic index buffer
  91223. * @param indexBuffer defines the target index buffer
  91224. * @param indices defines the data to update
  91225. * @param offset defines the offset in the target index buffer where update should start
  91226. */
  91227. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  91228. /**
  91229. * Updates a dynamic vertex buffer.
  91230. * @param vertexBuffer the vertex buffer to update
  91231. * @param data the data used to update the vertex buffer
  91232. * @param byteOffset the byte offset of the data
  91233. * @param byteLength the byte length of the data
  91234. */
  91235. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  91236. }
  91237. }
  91238. declare module BABYLON {
  91239. interface AbstractScene {
  91240. /**
  91241. * The list of procedural textures added to the scene
  91242. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91243. */
  91244. proceduralTextures: Array<ProceduralTexture>;
  91245. }
  91246. /**
  91247. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  91248. * in a given scene.
  91249. */
  91250. export class ProceduralTextureSceneComponent implements ISceneComponent {
  91251. /**
  91252. * The component name helpfull to identify the component in the list of scene components.
  91253. */
  91254. readonly name: string;
  91255. /**
  91256. * The scene the component belongs to.
  91257. */
  91258. scene: Scene;
  91259. /**
  91260. * Creates a new instance of the component for the given scene
  91261. * @param scene Defines the scene to register the component in
  91262. */
  91263. constructor(scene: Scene);
  91264. /**
  91265. * Registers the component in a given scene
  91266. */
  91267. register(): void;
  91268. /**
  91269. * Rebuilds the elements related to this component in case of
  91270. * context lost for instance.
  91271. */
  91272. rebuild(): void;
  91273. /**
  91274. * Disposes the component and the associated ressources.
  91275. */
  91276. dispose(): void;
  91277. private _beforeClear;
  91278. }
  91279. }
  91280. declare module BABYLON {
  91281. interface ThinEngine {
  91282. /**
  91283. * Creates a new render target cube texture
  91284. * @param size defines the size of the texture
  91285. * @param options defines the options used to create the texture
  91286. * @returns a new render target cube texture stored in an InternalTexture
  91287. */
  91288. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91289. }
  91290. }
  91291. declare module BABYLON {
  91292. /** @hidden */
  91293. export var proceduralVertexShader: {
  91294. name: string;
  91295. shader: string;
  91296. };
  91297. }
  91298. declare module BABYLON {
  91299. /**
  91300. * 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.
  91301. * This is the base class of any Procedural texture and contains most of the shareable code.
  91302. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91303. */
  91304. export class ProceduralTexture extends Texture {
  91305. /**
  91306. * Define if the texture is enabled or not (disabled texture will not render)
  91307. */
  91308. isEnabled: boolean;
  91309. /**
  91310. * Define if the texture must be cleared before rendering (default is true)
  91311. */
  91312. autoClear: boolean;
  91313. /**
  91314. * Callback called when the texture is generated
  91315. */
  91316. onGenerated: () => void;
  91317. /**
  91318. * Event raised when the texture is generated
  91319. */
  91320. onGeneratedObservable: Observable<ProceduralTexture>;
  91321. /** @hidden */
  91322. _generateMipMaps: boolean;
  91323. /** @hidden **/
  91324. _effect: Effect;
  91325. /** @hidden */
  91326. _textures: {
  91327. [key: string]: Texture;
  91328. };
  91329. /** @hidden */
  91330. protected _fallbackTexture: Nullable<Texture>;
  91331. private _size;
  91332. private _currentRefreshId;
  91333. private _frameId;
  91334. private _refreshRate;
  91335. private _vertexBuffers;
  91336. private _indexBuffer;
  91337. private _uniforms;
  91338. private _samplers;
  91339. private _fragment;
  91340. private _floats;
  91341. private _ints;
  91342. private _floatsArrays;
  91343. private _colors3;
  91344. private _colors4;
  91345. private _vectors2;
  91346. private _vectors3;
  91347. private _matrices;
  91348. private _fallbackTextureUsed;
  91349. private _fullEngine;
  91350. private _cachedDefines;
  91351. private _contentUpdateId;
  91352. private _contentData;
  91353. /**
  91354. * Instantiates a new procedural texture.
  91355. * 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.
  91356. * This is the base class of any Procedural texture and contains most of the shareable code.
  91357. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91358. * @param name Define the name of the texture
  91359. * @param size Define the size of the texture to create
  91360. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  91361. * @param scene Define the scene the texture belongs to
  91362. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  91363. * @param generateMipMaps Define if the texture should creates mip maps or not
  91364. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  91365. */
  91366. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  91367. /**
  91368. * The effect that is created when initializing the post process.
  91369. * @returns The created effect corresponding the the postprocess.
  91370. */
  91371. getEffect(): Effect;
  91372. /**
  91373. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  91374. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  91375. */
  91376. getContent(): Nullable<ArrayBufferView>;
  91377. private _createIndexBuffer;
  91378. /** @hidden */
  91379. _rebuild(): void;
  91380. /**
  91381. * Resets the texture in order to recreate its associated resources.
  91382. * This can be called in case of context loss
  91383. */
  91384. reset(): void;
  91385. protected _getDefines(): string;
  91386. /**
  91387. * Is the texture ready to be used ? (rendered at least once)
  91388. * @returns true if ready, otherwise, false.
  91389. */
  91390. isReady(): boolean;
  91391. /**
  91392. * Resets the refresh counter of the texture and start bak from scratch.
  91393. * Could be useful to regenerate the texture if it is setup to render only once.
  91394. */
  91395. resetRefreshCounter(): void;
  91396. /**
  91397. * Set the fragment shader to use in order to render the texture.
  91398. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  91399. */
  91400. setFragment(fragment: any): void;
  91401. /**
  91402. * Define the refresh rate of the texture or the rendering frequency.
  91403. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  91404. */
  91405. get refreshRate(): number;
  91406. set refreshRate(value: number);
  91407. /** @hidden */
  91408. _shouldRender(): boolean;
  91409. /**
  91410. * Get the size the texture is rendering at.
  91411. * @returns the size (texture is always squared)
  91412. */
  91413. getRenderSize(): number;
  91414. /**
  91415. * Resize the texture to new value.
  91416. * @param size Define the new size the texture should have
  91417. * @param generateMipMaps Define whether the new texture should create mip maps
  91418. */
  91419. resize(size: number, generateMipMaps: boolean): void;
  91420. private _checkUniform;
  91421. /**
  91422. * Set a texture in the shader program used to render.
  91423. * @param name Define the name of the uniform samplers as defined in the shader
  91424. * @param texture Define the texture to bind to this sampler
  91425. * @return the texture itself allowing "fluent" like uniform updates
  91426. */
  91427. setTexture(name: string, texture: Texture): ProceduralTexture;
  91428. /**
  91429. * Set a float in the shader.
  91430. * @param name Define the name of the uniform as defined in the shader
  91431. * @param value Define the value to give to the uniform
  91432. * @return the texture itself allowing "fluent" like uniform updates
  91433. */
  91434. setFloat(name: string, value: number): ProceduralTexture;
  91435. /**
  91436. * Set a int in the shader.
  91437. * @param name Define the name of the uniform as defined in the shader
  91438. * @param value Define the value to give to the uniform
  91439. * @return the texture itself allowing "fluent" like uniform updates
  91440. */
  91441. setInt(name: string, value: number): ProceduralTexture;
  91442. /**
  91443. * Set an array of floats in the shader.
  91444. * @param name Define the name of the uniform as defined in the shader
  91445. * @param value Define the value to give to the uniform
  91446. * @return the texture itself allowing "fluent" like uniform updates
  91447. */
  91448. setFloats(name: string, value: number[]): ProceduralTexture;
  91449. /**
  91450. * Set a vec3 in the shader from a Color3.
  91451. * @param name Define the name of the uniform as defined in the shader
  91452. * @param value Define the value to give to the uniform
  91453. * @return the texture itself allowing "fluent" like uniform updates
  91454. */
  91455. setColor3(name: string, value: Color3): ProceduralTexture;
  91456. /**
  91457. * Set a vec4 in the shader from a Color4.
  91458. * @param name Define the name of the uniform as defined in the shader
  91459. * @param value Define the value to give to the uniform
  91460. * @return the texture itself allowing "fluent" like uniform updates
  91461. */
  91462. setColor4(name: string, value: Color4): ProceduralTexture;
  91463. /**
  91464. * Set a vec2 in the shader from a Vector2.
  91465. * @param name Define the name of the uniform as defined in the shader
  91466. * @param value Define the value to give to the uniform
  91467. * @return the texture itself allowing "fluent" like uniform updates
  91468. */
  91469. setVector2(name: string, value: Vector2): ProceduralTexture;
  91470. /**
  91471. * Set a vec3 in the shader from a Vector3.
  91472. * @param name Define the name of the uniform as defined in the shader
  91473. * @param value Define the value to give to the uniform
  91474. * @return the texture itself allowing "fluent" like uniform updates
  91475. */
  91476. setVector3(name: string, value: Vector3): ProceduralTexture;
  91477. /**
  91478. * Set a mat4 in the shader from a MAtrix.
  91479. * @param name Define the name of the uniform as defined in the shader
  91480. * @param value Define the value to give to the uniform
  91481. * @return the texture itself allowing "fluent" like uniform updates
  91482. */
  91483. setMatrix(name: string, value: Matrix): ProceduralTexture;
  91484. /**
  91485. * Render the texture to its associated render target.
  91486. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  91487. */
  91488. render(useCameraPostProcess?: boolean): void;
  91489. /**
  91490. * Clone the texture.
  91491. * @returns the cloned texture
  91492. */
  91493. clone(): ProceduralTexture;
  91494. /**
  91495. * Dispose the texture and release its asoociated resources.
  91496. */
  91497. dispose(): void;
  91498. }
  91499. }
  91500. declare module BABYLON {
  91501. /**
  91502. * This represents the base class for particle system in Babylon.
  91503. * 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.
  91504. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91505. * @example https://doc.babylonjs.com/babylon101/particles
  91506. */
  91507. export class BaseParticleSystem {
  91508. /**
  91509. * Source color is added to the destination color without alpha affecting the result
  91510. */
  91511. static BLENDMODE_ONEONE: number;
  91512. /**
  91513. * Blend current color and particle color using particle’s alpha
  91514. */
  91515. static BLENDMODE_STANDARD: number;
  91516. /**
  91517. * Add current color and particle color multiplied by particle’s alpha
  91518. */
  91519. static BLENDMODE_ADD: number;
  91520. /**
  91521. * Multiply current color with particle color
  91522. */
  91523. static BLENDMODE_MULTIPLY: number;
  91524. /**
  91525. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  91526. */
  91527. static BLENDMODE_MULTIPLYADD: number;
  91528. /**
  91529. * List of animations used by the particle system.
  91530. */
  91531. animations: Animation[];
  91532. /**
  91533. * Gets or sets the unique id of the particle system
  91534. */
  91535. uniqueId: number;
  91536. /**
  91537. * The id of the Particle system.
  91538. */
  91539. id: string;
  91540. /**
  91541. * The friendly name of the Particle system.
  91542. */
  91543. name: string;
  91544. /**
  91545. * Snippet ID if the particle system was created from the snippet server
  91546. */
  91547. snippetId: string;
  91548. /**
  91549. * The rendering group used by the Particle system to chose when to render.
  91550. */
  91551. renderingGroupId: number;
  91552. /**
  91553. * The emitter represents the Mesh or position we are attaching the particle system to.
  91554. */
  91555. emitter: Nullable<AbstractMesh | Vector3>;
  91556. /**
  91557. * The maximum number of particles to emit per frame
  91558. */
  91559. emitRate: number;
  91560. /**
  91561. * If you want to launch only a few particles at once, that can be done, as well.
  91562. */
  91563. manualEmitCount: number;
  91564. /**
  91565. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91566. */
  91567. updateSpeed: number;
  91568. /**
  91569. * The amount of time the particle system is running (depends of the overall update speed).
  91570. */
  91571. targetStopDuration: number;
  91572. /**
  91573. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91574. */
  91575. disposeOnStop: boolean;
  91576. /**
  91577. * Minimum power of emitting particles.
  91578. */
  91579. minEmitPower: number;
  91580. /**
  91581. * Maximum power of emitting particles.
  91582. */
  91583. maxEmitPower: number;
  91584. /**
  91585. * Minimum life time of emitting particles.
  91586. */
  91587. minLifeTime: number;
  91588. /**
  91589. * Maximum life time of emitting particles.
  91590. */
  91591. maxLifeTime: number;
  91592. /**
  91593. * Minimum Size of emitting particles.
  91594. */
  91595. minSize: number;
  91596. /**
  91597. * Maximum Size of emitting particles.
  91598. */
  91599. maxSize: number;
  91600. /**
  91601. * Minimum scale of emitting particles on X axis.
  91602. */
  91603. minScaleX: number;
  91604. /**
  91605. * Maximum scale of emitting particles on X axis.
  91606. */
  91607. maxScaleX: number;
  91608. /**
  91609. * Minimum scale of emitting particles on Y axis.
  91610. */
  91611. minScaleY: number;
  91612. /**
  91613. * Maximum scale of emitting particles on Y axis.
  91614. */
  91615. maxScaleY: number;
  91616. /**
  91617. * Gets or sets the minimal initial rotation in radians.
  91618. */
  91619. minInitialRotation: number;
  91620. /**
  91621. * Gets or sets the maximal initial rotation in radians.
  91622. */
  91623. maxInitialRotation: number;
  91624. /**
  91625. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91626. */
  91627. minAngularSpeed: number;
  91628. /**
  91629. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91630. */
  91631. maxAngularSpeed: number;
  91632. /**
  91633. * The texture used to render each particle. (this can be a spritesheet)
  91634. */
  91635. particleTexture: Nullable<BaseTexture>;
  91636. /**
  91637. * The layer mask we are rendering the particles through.
  91638. */
  91639. layerMask: number;
  91640. /**
  91641. * This can help using your own shader to render the particle system.
  91642. * The according effect will be created
  91643. */
  91644. customShader: any;
  91645. /**
  91646. * By default particle system starts as soon as they are created. This prevents the
  91647. * automatic start to happen and let you decide when to start emitting particles.
  91648. */
  91649. preventAutoStart: boolean;
  91650. private _noiseTexture;
  91651. /**
  91652. * Gets or sets a texture used to add random noise to particle positions
  91653. */
  91654. get noiseTexture(): Nullable<ProceduralTexture>;
  91655. set noiseTexture(value: Nullable<ProceduralTexture>);
  91656. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91657. noiseStrength: Vector3;
  91658. /**
  91659. * Callback triggered when the particle animation is ending.
  91660. */
  91661. onAnimationEnd: Nullable<() => void>;
  91662. /**
  91663. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  91664. */
  91665. blendMode: number;
  91666. /**
  91667. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  91668. * to override the particles.
  91669. */
  91670. forceDepthWrite: boolean;
  91671. /** 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 */
  91672. preWarmCycles: number;
  91673. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  91674. preWarmStepOffset: number;
  91675. /**
  91676. * 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)
  91677. */
  91678. spriteCellChangeSpeed: number;
  91679. /**
  91680. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91681. */
  91682. startSpriteCellID: number;
  91683. /**
  91684. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91685. */
  91686. endSpriteCellID: number;
  91687. /**
  91688. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91689. */
  91690. spriteCellWidth: number;
  91691. /**
  91692. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91693. */
  91694. spriteCellHeight: number;
  91695. /**
  91696. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91697. */
  91698. spriteRandomStartCell: boolean;
  91699. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91700. translationPivot: Vector2;
  91701. /** @hidden */
  91702. protected _isAnimationSheetEnabled: boolean;
  91703. /**
  91704. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91705. */
  91706. beginAnimationOnStart: boolean;
  91707. /**
  91708. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91709. */
  91710. beginAnimationFrom: number;
  91711. /**
  91712. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91713. */
  91714. beginAnimationTo: number;
  91715. /**
  91716. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91717. */
  91718. beginAnimationLoop: boolean;
  91719. /**
  91720. * Gets or sets a world offset applied to all particles
  91721. */
  91722. worldOffset: Vector3;
  91723. /**
  91724. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  91725. */
  91726. get isAnimationSheetEnabled(): boolean;
  91727. set isAnimationSheetEnabled(value: boolean);
  91728. /**
  91729. * Get hosting scene
  91730. * @returns the scene
  91731. */
  91732. getScene(): Nullable<Scene>;
  91733. /**
  91734. * You can use gravity if you want to give an orientation to your particles.
  91735. */
  91736. gravity: Vector3;
  91737. protected _colorGradients: Nullable<Array<ColorGradient>>;
  91738. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  91739. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  91740. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  91741. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  91742. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  91743. protected _dragGradients: Nullable<Array<FactorGradient>>;
  91744. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  91745. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  91746. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  91747. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  91748. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  91749. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  91750. /**
  91751. * Defines the delay in milliseconds before starting the system (0 by default)
  91752. */
  91753. startDelay: number;
  91754. /**
  91755. * Gets the current list of drag gradients.
  91756. * You must use addDragGradient and removeDragGradient to udpate this list
  91757. * @returns the list of drag gradients
  91758. */
  91759. getDragGradients(): Nullable<Array<FactorGradient>>;
  91760. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91761. limitVelocityDamping: number;
  91762. /**
  91763. * Gets the current list of limit velocity gradients.
  91764. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  91765. * @returns the list of limit velocity gradients
  91766. */
  91767. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  91768. /**
  91769. * Gets the current list of color gradients.
  91770. * You must use addColorGradient and removeColorGradient to udpate this list
  91771. * @returns the list of color gradients
  91772. */
  91773. getColorGradients(): Nullable<Array<ColorGradient>>;
  91774. /**
  91775. * Gets the current list of size gradients.
  91776. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91777. * @returns the list of size gradients
  91778. */
  91779. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91780. /**
  91781. * Gets the current list of color remap gradients.
  91782. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  91783. * @returns the list of color remap gradients
  91784. */
  91785. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  91786. /**
  91787. * Gets the current list of alpha remap gradients.
  91788. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  91789. * @returns the list of alpha remap gradients
  91790. */
  91791. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  91792. /**
  91793. * Gets the current list of life time gradients.
  91794. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  91795. * @returns the list of life time gradients
  91796. */
  91797. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  91798. /**
  91799. * Gets the current list of angular speed gradients.
  91800. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91801. * @returns the list of angular speed gradients
  91802. */
  91803. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91804. /**
  91805. * Gets the current list of velocity gradients.
  91806. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91807. * @returns the list of velocity gradients
  91808. */
  91809. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91810. /**
  91811. * Gets the current list of start size gradients.
  91812. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  91813. * @returns the list of start size gradients
  91814. */
  91815. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  91816. /**
  91817. * Gets the current list of emit rate gradients.
  91818. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  91819. * @returns the list of emit rate gradients
  91820. */
  91821. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  91822. /**
  91823. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91824. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91825. */
  91826. get direction1(): Vector3;
  91827. set direction1(value: Vector3);
  91828. /**
  91829. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91830. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91831. */
  91832. get direction2(): Vector3;
  91833. set direction2(value: Vector3);
  91834. /**
  91835. * 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.
  91836. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91837. */
  91838. get minEmitBox(): Vector3;
  91839. set minEmitBox(value: Vector3);
  91840. /**
  91841. * 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.
  91842. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91843. */
  91844. get maxEmitBox(): Vector3;
  91845. set maxEmitBox(value: Vector3);
  91846. /**
  91847. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91848. */
  91849. color1: Color4;
  91850. /**
  91851. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91852. */
  91853. color2: Color4;
  91854. /**
  91855. * Color the particle will have at the end of its lifetime
  91856. */
  91857. colorDead: Color4;
  91858. /**
  91859. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  91860. */
  91861. textureMask: Color4;
  91862. /**
  91863. * The particle emitter type defines the emitter used by the particle system.
  91864. * It can be for example box, sphere, or cone...
  91865. */
  91866. particleEmitterType: IParticleEmitterType;
  91867. /** @hidden */
  91868. _isSubEmitter: boolean;
  91869. /**
  91870. * Gets or sets the billboard mode to use when isBillboardBased = true.
  91871. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  91872. */
  91873. billboardMode: number;
  91874. protected _isBillboardBased: boolean;
  91875. /**
  91876. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  91877. */
  91878. get isBillboardBased(): boolean;
  91879. set isBillboardBased(value: boolean);
  91880. /**
  91881. * The scene the particle system belongs to.
  91882. */
  91883. protected _scene: Nullable<Scene>;
  91884. /**
  91885. * The engine the particle system belongs to.
  91886. */
  91887. protected _engine: ThinEngine;
  91888. /**
  91889. * Local cache of defines for image processing.
  91890. */
  91891. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  91892. /**
  91893. * Default configuration related to image processing available in the standard Material.
  91894. */
  91895. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  91896. /**
  91897. * Gets the image processing configuration used either in this material.
  91898. */
  91899. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  91900. /**
  91901. * Sets the Default image processing configuration used either in the this material.
  91902. *
  91903. * If sets to null, the scene one is in use.
  91904. */
  91905. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  91906. /**
  91907. * Attaches a new image processing configuration to the Standard Material.
  91908. * @param configuration
  91909. */
  91910. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  91911. /** @hidden */
  91912. protected _reset(): void;
  91913. /** @hidden */
  91914. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  91915. /**
  91916. * Instantiates a particle system.
  91917. * 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.
  91918. * @param name The name of the particle system
  91919. */
  91920. constructor(name: string);
  91921. /**
  91922. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  91923. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91924. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91925. * @returns the emitter
  91926. */
  91927. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  91928. /**
  91929. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  91930. * @param radius The radius of the hemisphere to emit from
  91931. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91932. * @returns the emitter
  91933. */
  91934. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  91935. /**
  91936. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  91937. * @param radius The radius of the sphere to emit from
  91938. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91939. * @returns the emitter
  91940. */
  91941. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  91942. /**
  91943. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  91944. * @param radius The radius of the sphere to emit from
  91945. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  91946. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  91947. * @returns the emitter
  91948. */
  91949. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  91950. /**
  91951. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  91952. * @param radius The radius of the emission cylinder
  91953. * @param height The height of the emission cylinder
  91954. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  91955. * @param directionRandomizer How much to randomize the particle direction [0-1]
  91956. * @returns the emitter
  91957. */
  91958. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  91959. /**
  91960. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  91961. * @param radius The radius of the cylinder to emit from
  91962. * @param height The height of the emission cylinder
  91963. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91964. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  91965. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  91966. * @returns the emitter
  91967. */
  91968. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  91969. /**
  91970. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  91971. * @param radius The radius of the cone to emit from
  91972. * @param angle The base angle of the cone
  91973. * @returns the emitter
  91974. */
  91975. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  91976. /**
  91977. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  91978. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91979. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91980. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91981. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91982. * @returns the emitter
  91983. */
  91984. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  91985. }
  91986. }
  91987. declare module BABYLON {
  91988. /**
  91989. * Type of sub emitter
  91990. */
  91991. export enum SubEmitterType {
  91992. /**
  91993. * Attached to the particle over it's lifetime
  91994. */
  91995. ATTACHED = 0,
  91996. /**
  91997. * Created when the particle dies
  91998. */
  91999. END = 1
  92000. }
  92001. /**
  92002. * Sub emitter class used to emit particles from an existing particle
  92003. */
  92004. export class SubEmitter {
  92005. /**
  92006. * the particle system to be used by the sub emitter
  92007. */
  92008. particleSystem: ParticleSystem;
  92009. /**
  92010. * Type of the submitter (Default: END)
  92011. */
  92012. type: SubEmitterType;
  92013. /**
  92014. * 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)
  92015. * Note: This only is supported when using an emitter of type Mesh
  92016. */
  92017. inheritDirection: boolean;
  92018. /**
  92019. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  92020. */
  92021. inheritedVelocityAmount: number;
  92022. /**
  92023. * Creates a sub emitter
  92024. * @param particleSystem the particle system to be used by the sub emitter
  92025. */
  92026. constructor(
  92027. /**
  92028. * the particle system to be used by the sub emitter
  92029. */
  92030. particleSystem: ParticleSystem);
  92031. /**
  92032. * Clones the sub emitter
  92033. * @returns the cloned sub emitter
  92034. */
  92035. clone(): SubEmitter;
  92036. /**
  92037. * Serialize current object to a JSON object
  92038. * @returns the serialized object
  92039. */
  92040. serialize(): any;
  92041. /** @hidden */
  92042. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  92043. /**
  92044. * Creates a new SubEmitter from a serialized JSON version
  92045. * @param serializationObject defines the JSON object to read from
  92046. * @param sceneOrEngine defines the hosting scene or the hosting engine
  92047. * @param rootUrl defines the rootUrl for data loading
  92048. * @returns a new SubEmitter
  92049. */
  92050. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  92051. /** Release associated resources */
  92052. dispose(): void;
  92053. }
  92054. }
  92055. declare module BABYLON {
  92056. /** @hidden */
  92057. export var imageProcessingDeclaration: {
  92058. name: string;
  92059. shader: string;
  92060. };
  92061. }
  92062. declare module BABYLON {
  92063. /** @hidden */
  92064. export var imageProcessingFunctions: {
  92065. name: string;
  92066. shader: string;
  92067. };
  92068. }
  92069. declare module BABYLON {
  92070. /** @hidden */
  92071. export var particlesPixelShader: {
  92072. name: string;
  92073. shader: string;
  92074. };
  92075. }
  92076. declare module BABYLON {
  92077. /** @hidden */
  92078. export var particlesVertexShader: {
  92079. name: string;
  92080. shader: string;
  92081. };
  92082. }
  92083. declare module BABYLON {
  92084. /**
  92085. * Interface used to define entities containing multiple clip planes
  92086. */
  92087. export interface IClipPlanesHolder {
  92088. /**
  92089. * Gets or sets the active clipplane 1
  92090. */
  92091. clipPlane: Nullable<Plane>;
  92092. /**
  92093. * Gets or sets the active clipplane 2
  92094. */
  92095. clipPlane2: Nullable<Plane>;
  92096. /**
  92097. * Gets or sets the active clipplane 3
  92098. */
  92099. clipPlane3: Nullable<Plane>;
  92100. /**
  92101. * Gets or sets the active clipplane 4
  92102. */
  92103. clipPlane4: Nullable<Plane>;
  92104. /**
  92105. * Gets or sets the active clipplane 5
  92106. */
  92107. clipPlane5: Nullable<Plane>;
  92108. /**
  92109. * Gets or sets the active clipplane 6
  92110. */
  92111. clipPlane6: Nullable<Plane>;
  92112. }
  92113. }
  92114. declare module BABYLON {
  92115. /**
  92116. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  92117. *
  92118. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  92119. *
  92120. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  92121. */
  92122. export class ThinMaterialHelper {
  92123. /**
  92124. * Binds the clip plane information from the holder to the effect.
  92125. * @param effect The effect we are binding the data to
  92126. * @param holder The entity containing the clip plane information
  92127. */
  92128. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  92129. }
  92130. }
  92131. declare module BABYLON {
  92132. interface ThinEngine {
  92133. /**
  92134. * Sets alpha constants used by some alpha blending modes
  92135. * @param r defines the red component
  92136. * @param g defines the green component
  92137. * @param b defines the blue component
  92138. * @param a defines the alpha component
  92139. */
  92140. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  92141. /**
  92142. * Sets the current alpha mode
  92143. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  92144. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  92145. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92146. */
  92147. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  92148. /**
  92149. * Gets the current alpha mode
  92150. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92151. * @returns the current alpha mode
  92152. */
  92153. getAlphaMode(): number;
  92154. /**
  92155. * Sets the current alpha equation
  92156. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  92157. */
  92158. setAlphaEquation(equation: number): void;
  92159. /**
  92160. * Gets the current alpha equation.
  92161. * @returns the current alpha equation
  92162. */
  92163. getAlphaEquation(): number;
  92164. }
  92165. }
  92166. declare module BABYLON {
  92167. /**
  92168. * This represents a particle system in Babylon.
  92169. * 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.
  92170. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92171. * @example https://doc.babylonjs.com/babylon101/particles
  92172. */
  92173. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  92174. /**
  92175. * Billboard mode will only apply to Y axis
  92176. */
  92177. static readonly BILLBOARDMODE_Y: number;
  92178. /**
  92179. * Billboard mode will apply to all axes
  92180. */
  92181. static readonly BILLBOARDMODE_ALL: number;
  92182. /**
  92183. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  92184. */
  92185. static readonly BILLBOARDMODE_STRETCHED: number;
  92186. /**
  92187. * This function can be defined to provide custom update for active particles.
  92188. * This function will be called instead of regular update (age, position, color, etc.).
  92189. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  92190. */
  92191. updateFunction: (particles: Particle[]) => void;
  92192. private _emitterWorldMatrix;
  92193. /**
  92194. * This function can be defined to specify initial direction for every new particle.
  92195. * It by default use the emitterType defined function
  92196. */
  92197. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92198. /**
  92199. * This function can be defined to specify initial position for every new particle.
  92200. * It by default use the emitterType defined function
  92201. */
  92202. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92203. /**
  92204. * @hidden
  92205. */
  92206. _inheritedVelocityOffset: Vector3;
  92207. /**
  92208. * An event triggered when the system is disposed
  92209. */
  92210. onDisposeObservable: Observable<IParticleSystem>;
  92211. private _onDisposeObserver;
  92212. /**
  92213. * Sets a callback that will be triggered when the system is disposed
  92214. */
  92215. set onDispose(callback: () => void);
  92216. private _particles;
  92217. private _epsilon;
  92218. private _capacity;
  92219. private _stockParticles;
  92220. private _newPartsExcess;
  92221. private _vertexData;
  92222. private _vertexBuffer;
  92223. private _vertexBuffers;
  92224. private _spriteBuffer;
  92225. private _indexBuffer;
  92226. private _effect;
  92227. private _customEffect;
  92228. private _cachedDefines;
  92229. private _scaledColorStep;
  92230. private _colorDiff;
  92231. private _scaledDirection;
  92232. private _scaledGravity;
  92233. private _currentRenderId;
  92234. private _alive;
  92235. private _useInstancing;
  92236. private _started;
  92237. private _stopped;
  92238. private _actualFrame;
  92239. private _scaledUpdateSpeed;
  92240. private _vertexBufferSize;
  92241. /** @hidden */
  92242. _currentEmitRateGradient: Nullable<FactorGradient>;
  92243. /** @hidden */
  92244. _currentEmitRate1: number;
  92245. /** @hidden */
  92246. _currentEmitRate2: number;
  92247. /** @hidden */
  92248. _currentStartSizeGradient: Nullable<FactorGradient>;
  92249. /** @hidden */
  92250. _currentStartSize1: number;
  92251. /** @hidden */
  92252. _currentStartSize2: number;
  92253. private readonly _rawTextureWidth;
  92254. private _rampGradientsTexture;
  92255. private _useRampGradients;
  92256. /** Gets or sets a matrix to use to compute projection */
  92257. defaultProjectionMatrix: Matrix;
  92258. /** Gets or sets a matrix to use to compute view */
  92259. defaultViewMatrix: Matrix;
  92260. /** Gets or sets a boolean indicating that ramp gradients must be used
  92261. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92262. */
  92263. get useRampGradients(): boolean;
  92264. set useRampGradients(value: boolean);
  92265. /**
  92266. * 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.
  92267. * 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: [])
  92268. */
  92269. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92270. private _subEmitters;
  92271. /**
  92272. * @hidden
  92273. * If the particle systems emitter should be disposed when the particle system is disposed
  92274. */
  92275. _disposeEmitterOnDispose: boolean;
  92276. /**
  92277. * The current active Sub-systems, this property is used by the root particle system only.
  92278. */
  92279. activeSubSystems: Array<ParticleSystem>;
  92280. /**
  92281. * Specifies if the particles are updated in emitter local space or world space
  92282. */
  92283. isLocal: boolean;
  92284. private _rootParticleSystem;
  92285. /**
  92286. * Gets the current list of active particles
  92287. */
  92288. get particles(): Particle[];
  92289. /**
  92290. * Gets the number of particles active at the same time.
  92291. * @returns The number of active particles.
  92292. */
  92293. getActiveCount(): number;
  92294. /**
  92295. * Returns the string "ParticleSystem"
  92296. * @returns a string containing the class name
  92297. */
  92298. getClassName(): string;
  92299. /**
  92300. * Gets a boolean indicating that the system is stopping
  92301. * @returns true if the system is currently stopping
  92302. */
  92303. isStopping(): boolean;
  92304. /**
  92305. * Gets the custom effect used to render the particles
  92306. * @param blendMode Blend mode for which the effect should be retrieved
  92307. * @returns The effect
  92308. */
  92309. getCustomEffect(blendMode?: number): Nullable<Effect>;
  92310. /**
  92311. * Sets the custom effect used to render the particles
  92312. * @param effect The effect to set
  92313. * @param blendMode Blend mode for which the effect should be set
  92314. */
  92315. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  92316. /** @hidden */
  92317. private _onBeforeDrawParticlesObservable;
  92318. /**
  92319. * Observable that will be called just before the particles are drawn
  92320. */
  92321. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  92322. /**
  92323. * Gets the name of the particle vertex shader
  92324. */
  92325. get vertexShaderName(): string;
  92326. /**
  92327. * Instantiates a particle system.
  92328. * 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.
  92329. * @param name The name of the particle system
  92330. * @param capacity The max number of particles alive at the same time
  92331. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  92332. * @param customEffect a custom effect used to change the way particles are rendered by default
  92333. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  92334. * @param epsilon Offset used to render the particles
  92335. */
  92336. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  92337. private _addFactorGradient;
  92338. private _removeFactorGradient;
  92339. /**
  92340. * Adds a new life time gradient
  92341. * @param gradient defines the gradient to use (between 0 and 1)
  92342. * @param factor defines the life time factor to affect to the specified gradient
  92343. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92344. * @returns the current particle system
  92345. */
  92346. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92347. /**
  92348. * Remove a specific life time gradient
  92349. * @param gradient defines the gradient to remove
  92350. * @returns the current particle system
  92351. */
  92352. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92353. /**
  92354. * Adds a new size gradient
  92355. * @param gradient defines the gradient to use (between 0 and 1)
  92356. * @param factor defines the size factor to affect to the specified gradient
  92357. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92358. * @returns the current particle system
  92359. */
  92360. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92361. /**
  92362. * Remove a specific size gradient
  92363. * @param gradient defines the gradient to remove
  92364. * @returns the current particle system
  92365. */
  92366. removeSizeGradient(gradient: number): IParticleSystem;
  92367. /**
  92368. * Adds a new color remap gradient
  92369. * @param gradient defines the gradient to use (between 0 and 1)
  92370. * @param min defines the color remap minimal range
  92371. * @param max defines the color remap maximal range
  92372. * @returns the current particle system
  92373. */
  92374. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92375. /**
  92376. * Remove a specific color remap gradient
  92377. * @param gradient defines the gradient to remove
  92378. * @returns the current particle system
  92379. */
  92380. removeColorRemapGradient(gradient: number): IParticleSystem;
  92381. /**
  92382. * Adds a new alpha remap gradient
  92383. * @param gradient defines the gradient to use (between 0 and 1)
  92384. * @param min defines the alpha remap minimal range
  92385. * @param max defines the alpha remap maximal range
  92386. * @returns the current particle system
  92387. */
  92388. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92389. /**
  92390. * Remove a specific alpha remap gradient
  92391. * @param gradient defines the gradient to remove
  92392. * @returns the current particle system
  92393. */
  92394. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  92395. /**
  92396. * Adds a new angular speed gradient
  92397. * @param gradient defines the gradient to use (between 0 and 1)
  92398. * @param factor defines the angular speed to affect to the specified gradient
  92399. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92400. * @returns the current particle system
  92401. */
  92402. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92403. /**
  92404. * Remove a specific angular speed gradient
  92405. * @param gradient defines the gradient to remove
  92406. * @returns the current particle system
  92407. */
  92408. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92409. /**
  92410. * Adds a new velocity gradient
  92411. * @param gradient defines the gradient to use (between 0 and 1)
  92412. * @param factor defines the velocity to affect to the specified gradient
  92413. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92414. * @returns the current particle system
  92415. */
  92416. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92417. /**
  92418. * Remove a specific velocity gradient
  92419. * @param gradient defines the gradient to remove
  92420. * @returns the current particle system
  92421. */
  92422. removeVelocityGradient(gradient: number): IParticleSystem;
  92423. /**
  92424. * Adds a new limit velocity gradient
  92425. * @param gradient defines the gradient to use (between 0 and 1)
  92426. * @param factor defines the limit velocity value to affect to the specified gradient
  92427. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92428. * @returns the current particle system
  92429. */
  92430. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92431. /**
  92432. * Remove a specific limit velocity gradient
  92433. * @param gradient defines the gradient to remove
  92434. * @returns the current particle system
  92435. */
  92436. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92437. /**
  92438. * Adds a new drag gradient
  92439. * @param gradient defines the gradient to use (between 0 and 1)
  92440. * @param factor defines the drag value to affect to the specified gradient
  92441. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92442. * @returns the current particle system
  92443. */
  92444. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92445. /**
  92446. * Remove a specific drag gradient
  92447. * @param gradient defines the gradient to remove
  92448. * @returns the current particle system
  92449. */
  92450. removeDragGradient(gradient: number): IParticleSystem;
  92451. /**
  92452. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92453. * @param gradient defines the gradient to use (between 0 and 1)
  92454. * @param factor defines the emit rate value to affect to the specified gradient
  92455. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92456. * @returns the current particle system
  92457. */
  92458. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92459. /**
  92460. * Remove a specific emit rate gradient
  92461. * @param gradient defines the gradient to remove
  92462. * @returns the current particle system
  92463. */
  92464. removeEmitRateGradient(gradient: number): IParticleSystem;
  92465. /**
  92466. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92467. * @param gradient defines the gradient to use (between 0 and 1)
  92468. * @param factor defines the start size value to affect to the specified gradient
  92469. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92470. * @returns the current particle system
  92471. */
  92472. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92473. /**
  92474. * Remove a specific start size gradient
  92475. * @param gradient defines the gradient to remove
  92476. * @returns the current particle system
  92477. */
  92478. removeStartSizeGradient(gradient: number): IParticleSystem;
  92479. private _createRampGradientTexture;
  92480. /**
  92481. * Gets the current list of ramp gradients.
  92482. * You must use addRampGradient and removeRampGradient to udpate this list
  92483. * @returns the list of ramp gradients
  92484. */
  92485. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92486. /** Force the system to rebuild all gradients that need to be resync */
  92487. forceRefreshGradients(): void;
  92488. private _syncRampGradientTexture;
  92489. /**
  92490. * Adds a new ramp gradient used to remap particle colors
  92491. * @param gradient defines the gradient to use (between 0 and 1)
  92492. * @param color defines the color to affect to the specified gradient
  92493. * @returns the current particle system
  92494. */
  92495. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  92496. /**
  92497. * Remove a specific ramp gradient
  92498. * @param gradient defines the gradient to remove
  92499. * @returns the current particle system
  92500. */
  92501. removeRampGradient(gradient: number): ParticleSystem;
  92502. /**
  92503. * Adds a new color gradient
  92504. * @param gradient defines the gradient to use (between 0 and 1)
  92505. * @param color1 defines the color to affect to the specified gradient
  92506. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92507. * @returns this particle system
  92508. */
  92509. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92510. /**
  92511. * Remove a specific color gradient
  92512. * @param gradient defines the gradient to remove
  92513. * @returns this particle system
  92514. */
  92515. removeColorGradient(gradient: number): IParticleSystem;
  92516. private _fetchR;
  92517. protected _reset(): void;
  92518. private _resetEffect;
  92519. private _createVertexBuffers;
  92520. private _createIndexBuffer;
  92521. /**
  92522. * Gets the maximum number of particles active at the same time.
  92523. * @returns The max number of active particles.
  92524. */
  92525. getCapacity(): number;
  92526. /**
  92527. * Gets whether there are still active particles in the system.
  92528. * @returns True if it is alive, otherwise false.
  92529. */
  92530. isAlive(): boolean;
  92531. /**
  92532. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92533. * @returns True if it has been started, otherwise false.
  92534. */
  92535. isStarted(): boolean;
  92536. private _prepareSubEmitterInternalArray;
  92537. /**
  92538. * Starts the particle system and begins to emit
  92539. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  92540. */
  92541. start(delay?: number): void;
  92542. /**
  92543. * Stops the particle system.
  92544. * @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.
  92545. */
  92546. stop(stopSubEmitters?: boolean): void;
  92547. /**
  92548. * Remove all active particles
  92549. */
  92550. reset(): void;
  92551. /**
  92552. * @hidden (for internal use only)
  92553. */
  92554. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  92555. /**
  92556. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  92557. * Its lifetime will start back at 0.
  92558. */
  92559. recycleParticle: (particle: Particle) => void;
  92560. private _stopSubEmitters;
  92561. private _createParticle;
  92562. private _removeFromRoot;
  92563. private _emitFromParticle;
  92564. private _update;
  92565. /** @hidden */
  92566. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  92567. /** @hidden */
  92568. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  92569. /**
  92570. * Fill the defines array according to the current settings of the particle system
  92571. * @param defines Array to be updated
  92572. * @param blendMode blend mode to take into account when updating the array
  92573. */
  92574. fillDefines(defines: Array<string>, blendMode: number): void;
  92575. /**
  92576. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92577. * @param uniforms Uniforms array to fill
  92578. * @param attributes Attributes array to fill
  92579. * @param samplers Samplers array to fill
  92580. */
  92581. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92582. /** @hidden */
  92583. private _getEffect;
  92584. /**
  92585. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  92586. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  92587. */
  92588. animate(preWarmOnly?: boolean): void;
  92589. private _appendParticleVertices;
  92590. /**
  92591. * Rebuilds the particle system.
  92592. */
  92593. rebuild(): void;
  92594. /**
  92595. * Is this system ready to be used/rendered
  92596. * @return true if the system is ready
  92597. */
  92598. isReady(): boolean;
  92599. private _render;
  92600. /**
  92601. * Renders the particle system in its current state.
  92602. * @returns the current number of particles
  92603. */
  92604. render(): number;
  92605. /**
  92606. * Disposes the particle system and free the associated resources
  92607. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92608. */
  92609. dispose(disposeTexture?: boolean): void;
  92610. /**
  92611. * Clones the particle system.
  92612. * @param name The name of the cloned object
  92613. * @param newEmitter The new emitter to use
  92614. * @returns the cloned particle system
  92615. */
  92616. clone(name: string, newEmitter: any): ParticleSystem;
  92617. /**
  92618. * Serializes the particle system to a JSON object
  92619. * @param serializeTexture defines if the texture must be serialized as well
  92620. * @returns the JSON object
  92621. */
  92622. serialize(serializeTexture?: boolean): any;
  92623. /** @hidden */
  92624. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  92625. /** @hidden */
  92626. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  92627. /**
  92628. * Parses a JSON object to create a particle system.
  92629. * @param parsedParticleSystem The JSON object to parse
  92630. * @param sceneOrEngine The scene or the engine to create the particle system in
  92631. * @param rootUrl The root url to use to load external dependencies like texture
  92632. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  92633. * @returns the Parsed particle system
  92634. */
  92635. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  92636. }
  92637. }
  92638. declare module BABYLON {
  92639. /**
  92640. * A particle represents one of the element emitted by a particle system.
  92641. * This is mainly define by its coordinates, direction, velocity and age.
  92642. */
  92643. export class Particle {
  92644. /**
  92645. * The particle system the particle belongs to.
  92646. */
  92647. particleSystem: ParticleSystem;
  92648. private static _Count;
  92649. /**
  92650. * Unique ID of the particle
  92651. */
  92652. id: number;
  92653. /**
  92654. * The world position of the particle in the scene.
  92655. */
  92656. position: Vector3;
  92657. /**
  92658. * The world direction of the particle in the scene.
  92659. */
  92660. direction: Vector3;
  92661. /**
  92662. * The color of the particle.
  92663. */
  92664. color: Color4;
  92665. /**
  92666. * The color change of the particle per step.
  92667. */
  92668. colorStep: Color4;
  92669. /**
  92670. * Defines how long will the life of the particle be.
  92671. */
  92672. lifeTime: number;
  92673. /**
  92674. * The current age of the particle.
  92675. */
  92676. age: number;
  92677. /**
  92678. * The current size of the particle.
  92679. */
  92680. size: number;
  92681. /**
  92682. * The current scale of the particle.
  92683. */
  92684. scale: Vector2;
  92685. /**
  92686. * The current angle of the particle.
  92687. */
  92688. angle: number;
  92689. /**
  92690. * Defines how fast is the angle changing.
  92691. */
  92692. angularSpeed: number;
  92693. /**
  92694. * Defines the cell index used by the particle to be rendered from a sprite.
  92695. */
  92696. cellIndex: number;
  92697. /**
  92698. * The information required to support color remapping
  92699. */
  92700. remapData: Vector4;
  92701. /** @hidden */
  92702. _randomCellOffset?: number;
  92703. /** @hidden */
  92704. _initialDirection: Nullable<Vector3>;
  92705. /** @hidden */
  92706. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  92707. /** @hidden */
  92708. _initialStartSpriteCellID: number;
  92709. /** @hidden */
  92710. _initialEndSpriteCellID: number;
  92711. /** @hidden */
  92712. _currentColorGradient: Nullable<ColorGradient>;
  92713. /** @hidden */
  92714. _currentColor1: Color4;
  92715. /** @hidden */
  92716. _currentColor2: Color4;
  92717. /** @hidden */
  92718. _currentSizeGradient: Nullable<FactorGradient>;
  92719. /** @hidden */
  92720. _currentSize1: number;
  92721. /** @hidden */
  92722. _currentSize2: number;
  92723. /** @hidden */
  92724. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  92725. /** @hidden */
  92726. _currentAngularSpeed1: number;
  92727. /** @hidden */
  92728. _currentAngularSpeed2: number;
  92729. /** @hidden */
  92730. _currentVelocityGradient: Nullable<FactorGradient>;
  92731. /** @hidden */
  92732. _currentVelocity1: number;
  92733. /** @hidden */
  92734. _currentVelocity2: number;
  92735. /** @hidden */
  92736. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  92737. /** @hidden */
  92738. _currentLimitVelocity1: number;
  92739. /** @hidden */
  92740. _currentLimitVelocity2: number;
  92741. /** @hidden */
  92742. _currentDragGradient: Nullable<FactorGradient>;
  92743. /** @hidden */
  92744. _currentDrag1: number;
  92745. /** @hidden */
  92746. _currentDrag2: number;
  92747. /** @hidden */
  92748. _randomNoiseCoordinates1: Vector3;
  92749. /** @hidden */
  92750. _randomNoiseCoordinates2: Vector3;
  92751. /** @hidden */
  92752. _localPosition?: Vector3;
  92753. /**
  92754. * Creates a new instance Particle
  92755. * @param particleSystem the particle system the particle belongs to
  92756. */
  92757. constructor(
  92758. /**
  92759. * The particle system the particle belongs to.
  92760. */
  92761. particleSystem: ParticleSystem);
  92762. private updateCellInfoFromSystem;
  92763. /**
  92764. * Defines how the sprite cell index is updated for the particle
  92765. */
  92766. updateCellIndex(): void;
  92767. /** @hidden */
  92768. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  92769. /** @hidden */
  92770. _inheritParticleInfoToSubEmitters(): void;
  92771. /** @hidden */
  92772. _reset(): void;
  92773. /**
  92774. * Copy the properties of particle to another one.
  92775. * @param other the particle to copy the information to.
  92776. */
  92777. copyTo(other: Particle): void;
  92778. }
  92779. }
  92780. declare module BABYLON {
  92781. /**
  92782. * Particle emitter represents a volume emitting particles.
  92783. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  92784. */
  92785. export interface IParticleEmitterType {
  92786. /**
  92787. * Called by the particle System when the direction is computed for the created particle.
  92788. * @param worldMatrix is the world matrix of the particle system
  92789. * @param directionToUpdate is the direction vector to update with the result
  92790. * @param particle is the particle we are computed the direction for
  92791. * @param isLocal defines if the direction should be set in local space
  92792. */
  92793. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92794. /**
  92795. * Called by the particle System when the position is computed for the created particle.
  92796. * @param worldMatrix is the world matrix of the particle system
  92797. * @param positionToUpdate is the position vector to update with the result
  92798. * @param particle is the particle we are computed the position for
  92799. * @param isLocal defines if the position should be set in local space
  92800. */
  92801. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92802. /**
  92803. * Clones the current emitter and returns a copy of it
  92804. * @returns the new emitter
  92805. */
  92806. clone(): IParticleEmitterType;
  92807. /**
  92808. * Called by the GPUParticleSystem to setup the update shader
  92809. * @param effect defines the update shader
  92810. */
  92811. applyToShader(effect: Effect): void;
  92812. /**
  92813. * Returns a string to use to update the GPU particles update shader
  92814. * @returns the effect defines string
  92815. */
  92816. getEffectDefines(): string;
  92817. /**
  92818. * Returns a string representing the class name
  92819. * @returns a string containing the class name
  92820. */
  92821. getClassName(): string;
  92822. /**
  92823. * Serializes the particle system to a JSON object.
  92824. * @returns the JSON object
  92825. */
  92826. serialize(): any;
  92827. /**
  92828. * Parse properties from a JSON object
  92829. * @param serializationObject defines the JSON object
  92830. * @param scene defines the hosting scene
  92831. */
  92832. parse(serializationObject: any, scene: Nullable<Scene>): void;
  92833. }
  92834. }
  92835. declare module BABYLON {
  92836. /**
  92837. * Particle emitter emitting particles from the inside of a box.
  92838. * It emits the particles randomly between 2 given directions.
  92839. */
  92840. export class BoxParticleEmitter implements IParticleEmitterType {
  92841. /**
  92842. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92843. */
  92844. direction1: Vector3;
  92845. /**
  92846. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92847. */
  92848. direction2: Vector3;
  92849. /**
  92850. * 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.
  92851. */
  92852. minEmitBox: Vector3;
  92853. /**
  92854. * 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.
  92855. */
  92856. maxEmitBox: Vector3;
  92857. /**
  92858. * Creates a new instance BoxParticleEmitter
  92859. */
  92860. constructor();
  92861. /**
  92862. * Called by the particle System when the direction is computed for the created particle.
  92863. * @param worldMatrix is the world matrix of the particle system
  92864. * @param directionToUpdate is the direction vector to update with the result
  92865. * @param particle is the particle we are computed the direction for
  92866. * @param isLocal defines if the direction should be set in local space
  92867. */
  92868. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92869. /**
  92870. * Called by the particle System when the position is computed for the created particle.
  92871. * @param worldMatrix is the world matrix of the particle system
  92872. * @param positionToUpdate is the position vector to update with the result
  92873. * @param particle is the particle we are computed the position for
  92874. * @param isLocal defines if the position should be set in local space
  92875. */
  92876. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92877. /**
  92878. * Clones the current emitter and returns a copy of it
  92879. * @returns the new emitter
  92880. */
  92881. clone(): BoxParticleEmitter;
  92882. /**
  92883. * Called by the GPUParticleSystem to setup the update shader
  92884. * @param effect defines the update shader
  92885. */
  92886. applyToShader(effect: Effect): void;
  92887. /**
  92888. * Returns a string to use to update the GPU particles update shader
  92889. * @returns a string containng the defines string
  92890. */
  92891. getEffectDefines(): string;
  92892. /**
  92893. * Returns the string "BoxParticleEmitter"
  92894. * @returns a string containing the class name
  92895. */
  92896. getClassName(): string;
  92897. /**
  92898. * Serializes the particle system to a JSON object.
  92899. * @returns the JSON object
  92900. */
  92901. serialize(): any;
  92902. /**
  92903. * Parse properties from a JSON object
  92904. * @param serializationObject defines the JSON object
  92905. */
  92906. parse(serializationObject: any): void;
  92907. }
  92908. }
  92909. declare module BABYLON {
  92910. /**
  92911. * Particle emitter emitting particles from the inside of a cone.
  92912. * It emits the particles alongside the cone volume from the base to the particle.
  92913. * The emission direction might be randomized.
  92914. */
  92915. export class ConeParticleEmitter implements IParticleEmitterType {
  92916. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92917. directionRandomizer: number;
  92918. private _radius;
  92919. private _angle;
  92920. private _height;
  92921. /**
  92922. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  92923. */
  92924. radiusRange: number;
  92925. /**
  92926. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  92927. */
  92928. heightRange: number;
  92929. /**
  92930. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  92931. */
  92932. emitFromSpawnPointOnly: boolean;
  92933. /**
  92934. * Gets or sets the radius of the emission cone
  92935. */
  92936. get radius(): number;
  92937. set radius(value: number);
  92938. /**
  92939. * Gets or sets the angle of the emission cone
  92940. */
  92941. get angle(): number;
  92942. set angle(value: number);
  92943. private _buildHeight;
  92944. /**
  92945. * Creates a new instance ConeParticleEmitter
  92946. * @param radius the radius of the emission cone (1 by default)
  92947. * @param angle the cone base angle (PI by default)
  92948. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  92949. */
  92950. constructor(radius?: number, angle?: number,
  92951. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92952. directionRandomizer?: number);
  92953. /**
  92954. * Called by the particle System when the direction is computed for the created particle.
  92955. * @param worldMatrix is the world matrix of the particle system
  92956. * @param directionToUpdate is the direction vector to update with the result
  92957. * @param particle is the particle we are computed the direction for
  92958. * @param isLocal defines if the direction should be set in local space
  92959. */
  92960. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92961. /**
  92962. * Called by the particle System when the position is computed for the created particle.
  92963. * @param worldMatrix is the world matrix of the particle system
  92964. * @param positionToUpdate is the position vector to update with the result
  92965. * @param particle is the particle we are computed the position for
  92966. * @param isLocal defines if the position should be set in local space
  92967. */
  92968. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92969. /**
  92970. * Clones the current emitter and returns a copy of it
  92971. * @returns the new emitter
  92972. */
  92973. clone(): ConeParticleEmitter;
  92974. /**
  92975. * Called by the GPUParticleSystem to setup the update shader
  92976. * @param effect defines the update shader
  92977. */
  92978. applyToShader(effect: Effect): void;
  92979. /**
  92980. * Returns a string to use to update the GPU particles update shader
  92981. * @returns a string containng the defines string
  92982. */
  92983. getEffectDefines(): string;
  92984. /**
  92985. * Returns the string "ConeParticleEmitter"
  92986. * @returns a string containing the class name
  92987. */
  92988. getClassName(): string;
  92989. /**
  92990. * Serializes the particle system to a JSON object.
  92991. * @returns the JSON object
  92992. */
  92993. serialize(): any;
  92994. /**
  92995. * Parse properties from a JSON object
  92996. * @param serializationObject defines the JSON object
  92997. */
  92998. parse(serializationObject: any): void;
  92999. }
  93000. }
  93001. declare module BABYLON {
  93002. /**
  93003. * Particle emitter emitting particles from the inside of a cylinder.
  93004. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  93005. */
  93006. export class CylinderParticleEmitter implements IParticleEmitterType {
  93007. /**
  93008. * The radius of the emission cylinder.
  93009. */
  93010. radius: number;
  93011. /**
  93012. * The height of the emission cylinder.
  93013. */
  93014. height: number;
  93015. /**
  93016. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93017. */
  93018. radiusRange: number;
  93019. /**
  93020. * How much to randomize the particle direction [0-1].
  93021. */
  93022. directionRandomizer: number;
  93023. /**
  93024. * Creates a new instance CylinderParticleEmitter
  93025. * @param radius the radius of the emission cylinder (1 by default)
  93026. * @param height the height of the emission cylinder (1 by default)
  93027. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93028. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93029. */
  93030. constructor(
  93031. /**
  93032. * The radius of the emission cylinder.
  93033. */
  93034. radius?: number,
  93035. /**
  93036. * The height of the emission cylinder.
  93037. */
  93038. height?: number,
  93039. /**
  93040. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93041. */
  93042. radiusRange?: number,
  93043. /**
  93044. * How much to randomize the particle direction [0-1].
  93045. */
  93046. directionRandomizer?: number);
  93047. /**
  93048. * Called by the particle System when the direction is computed for the created particle.
  93049. * @param worldMatrix is the world matrix of the particle system
  93050. * @param directionToUpdate is the direction vector to update with the result
  93051. * @param particle is the particle we are computed the direction for
  93052. * @param isLocal defines if the direction should be set in local space
  93053. */
  93054. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93055. /**
  93056. * Called by the particle System when the position is computed for the created particle.
  93057. * @param worldMatrix is the world matrix of the particle system
  93058. * @param positionToUpdate is the position vector to update with the result
  93059. * @param particle is the particle we are computed the position for
  93060. * @param isLocal defines if the position should be set in local space
  93061. */
  93062. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93063. /**
  93064. * Clones the current emitter and returns a copy of it
  93065. * @returns the new emitter
  93066. */
  93067. clone(): CylinderParticleEmitter;
  93068. /**
  93069. * Called by the GPUParticleSystem to setup the update shader
  93070. * @param effect defines the update shader
  93071. */
  93072. applyToShader(effect: Effect): void;
  93073. /**
  93074. * Returns a string to use to update the GPU particles update shader
  93075. * @returns a string containng the defines string
  93076. */
  93077. getEffectDefines(): string;
  93078. /**
  93079. * Returns the string "CylinderParticleEmitter"
  93080. * @returns a string containing the class name
  93081. */
  93082. getClassName(): string;
  93083. /**
  93084. * Serializes the particle system to a JSON object.
  93085. * @returns the JSON object
  93086. */
  93087. serialize(): any;
  93088. /**
  93089. * Parse properties from a JSON object
  93090. * @param serializationObject defines the JSON object
  93091. */
  93092. parse(serializationObject: any): void;
  93093. }
  93094. /**
  93095. * Particle emitter emitting particles from the inside of a cylinder.
  93096. * It emits the particles randomly between two vectors.
  93097. */
  93098. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  93099. /**
  93100. * The min limit of the emission direction.
  93101. */
  93102. direction1: Vector3;
  93103. /**
  93104. * The max limit of the emission direction.
  93105. */
  93106. direction2: Vector3;
  93107. /**
  93108. * Creates a new instance CylinderDirectedParticleEmitter
  93109. * @param radius the radius of the emission cylinder (1 by default)
  93110. * @param height the height of the emission cylinder (1 by default)
  93111. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93112. * @param direction1 the min limit of the emission direction (up vector by default)
  93113. * @param direction2 the max limit of the emission direction (up vector by default)
  93114. */
  93115. constructor(radius?: number, height?: number, radiusRange?: number,
  93116. /**
  93117. * The min limit of the emission direction.
  93118. */
  93119. direction1?: Vector3,
  93120. /**
  93121. * The max limit of the emission direction.
  93122. */
  93123. direction2?: Vector3);
  93124. /**
  93125. * Called by the particle System when the direction is computed for the created particle.
  93126. * @param worldMatrix is the world matrix of the particle system
  93127. * @param directionToUpdate is the direction vector to update with the result
  93128. * @param particle is the particle we are computed the direction for
  93129. */
  93130. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93131. /**
  93132. * Clones the current emitter and returns a copy of it
  93133. * @returns the new emitter
  93134. */
  93135. clone(): CylinderDirectedParticleEmitter;
  93136. /**
  93137. * Called by the GPUParticleSystem to setup the update shader
  93138. * @param effect defines the update shader
  93139. */
  93140. applyToShader(effect: Effect): void;
  93141. /**
  93142. * Returns a string to use to update the GPU particles update shader
  93143. * @returns a string containng the defines string
  93144. */
  93145. getEffectDefines(): string;
  93146. /**
  93147. * Returns the string "CylinderDirectedParticleEmitter"
  93148. * @returns a string containing the class name
  93149. */
  93150. getClassName(): string;
  93151. /**
  93152. * Serializes the particle system to a JSON object.
  93153. * @returns the JSON object
  93154. */
  93155. serialize(): any;
  93156. /**
  93157. * Parse properties from a JSON object
  93158. * @param serializationObject defines the JSON object
  93159. */
  93160. parse(serializationObject: any): void;
  93161. }
  93162. }
  93163. declare module BABYLON {
  93164. /**
  93165. * Particle emitter emitting particles from the inside of a hemisphere.
  93166. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  93167. */
  93168. export class HemisphericParticleEmitter implements IParticleEmitterType {
  93169. /**
  93170. * The radius of the emission hemisphere.
  93171. */
  93172. radius: number;
  93173. /**
  93174. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93175. */
  93176. radiusRange: number;
  93177. /**
  93178. * How much to randomize the particle direction [0-1].
  93179. */
  93180. directionRandomizer: number;
  93181. /**
  93182. * Creates a new instance HemisphericParticleEmitter
  93183. * @param radius the radius of the emission hemisphere (1 by default)
  93184. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93185. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93186. */
  93187. constructor(
  93188. /**
  93189. * The radius of the emission hemisphere.
  93190. */
  93191. radius?: number,
  93192. /**
  93193. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93194. */
  93195. radiusRange?: number,
  93196. /**
  93197. * How much to randomize the particle direction [0-1].
  93198. */
  93199. directionRandomizer?: number);
  93200. /**
  93201. * Called by the particle System when the direction is computed for the created particle.
  93202. * @param worldMatrix is the world matrix of the particle system
  93203. * @param directionToUpdate is the direction vector to update with the result
  93204. * @param particle is the particle we are computed the direction for
  93205. * @param isLocal defines if the direction should be set in local space
  93206. */
  93207. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93208. /**
  93209. * Called by the particle System when the position is computed for the created particle.
  93210. * @param worldMatrix is the world matrix of the particle system
  93211. * @param positionToUpdate is the position vector to update with the result
  93212. * @param particle is the particle we are computed the position for
  93213. * @param isLocal defines if the position should be set in local space
  93214. */
  93215. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93216. /**
  93217. * Clones the current emitter and returns a copy of it
  93218. * @returns the new emitter
  93219. */
  93220. clone(): HemisphericParticleEmitter;
  93221. /**
  93222. * Called by the GPUParticleSystem to setup the update shader
  93223. * @param effect defines the update shader
  93224. */
  93225. applyToShader(effect: Effect): void;
  93226. /**
  93227. * Returns a string to use to update the GPU particles update shader
  93228. * @returns a string containng the defines string
  93229. */
  93230. getEffectDefines(): string;
  93231. /**
  93232. * Returns the string "HemisphericParticleEmitter"
  93233. * @returns a string containing the class name
  93234. */
  93235. getClassName(): string;
  93236. /**
  93237. * Serializes the particle system to a JSON object.
  93238. * @returns the JSON object
  93239. */
  93240. serialize(): any;
  93241. /**
  93242. * Parse properties from a JSON object
  93243. * @param serializationObject defines the JSON object
  93244. */
  93245. parse(serializationObject: any): void;
  93246. }
  93247. }
  93248. declare module BABYLON {
  93249. /**
  93250. * Particle emitter emitting particles from a point.
  93251. * It emits the particles randomly between 2 given directions.
  93252. */
  93253. export class PointParticleEmitter implements IParticleEmitterType {
  93254. /**
  93255. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93256. */
  93257. direction1: Vector3;
  93258. /**
  93259. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93260. */
  93261. direction2: Vector3;
  93262. /**
  93263. * Creates a new instance PointParticleEmitter
  93264. */
  93265. constructor();
  93266. /**
  93267. * Called by the particle System when the direction is computed for the created particle.
  93268. * @param worldMatrix is the world matrix of the particle system
  93269. * @param directionToUpdate is the direction vector to update with the result
  93270. * @param particle is the particle we are computed the direction for
  93271. * @param isLocal defines if the direction should be set in local space
  93272. */
  93273. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93274. /**
  93275. * Called by the particle System when the position is computed for the created particle.
  93276. * @param worldMatrix is the world matrix of the particle system
  93277. * @param positionToUpdate is the position vector to update with the result
  93278. * @param particle is the particle we are computed the position for
  93279. * @param isLocal defines if the position should be set in local space
  93280. */
  93281. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93282. /**
  93283. * Clones the current emitter and returns a copy of it
  93284. * @returns the new emitter
  93285. */
  93286. clone(): PointParticleEmitter;
  93287. /**
  93288. * Called by the GPUParticleSystem to setup the update shader
  93289. * @param effect defines the update shader
  93290. */
  93291. applyToShader(effect: Effect): void;
  93292. /**
  93293. * Returns a string to use to update the GPU particles update shader
  93294. * @returns a string containng the defines string
  93295. */
  93296. getEffectDefines(): string;
  93297. /**
  93298. * Returns the string "PointParticleEmitter"
  93299. * @returns a string containing the class name
  93300. */
  93301. getClassName(): string;
  93302. /**
  93303. * Serializes the particle system to a JSON object.
  93304. * @returns the JSON object
  93305. */
  93306. serialize(): any;
  93307. /**
  93308. * Parse properties from a JSON object
  93309. * @param serializationObject defines the JSON object
  93310. */
  93311. parse(serializationObject: any): void;
  93312. }
  93313. }
  93314. declare module BABYLON {
  93315. /**
  93316. * Particle emitter emitting particles from the inside of a sphere.
  93317. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  93318. */
  93319. export class SphereParticleEmitter implements IParticleEmitterType {
  93320. /**
  93321. * The radius of the emission sphere.
  93322. */
  93323. radius: number;
  93324. /**
  93325. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93326. */
  93327. radiusRange: number;
  93328. /**
  93329. * How much to randomize the particle direction [0-1].
  93330. */
  93331. directionRandomizer: number;
  93332. /**
  93333. * Creates a new instance SphereParticleEmitter
  93334. * @param radius the radius of the emission sphere (1 by default)
  93335. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93336. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93337. */
  93338. constructor(
  93339. /**
  93340. * The radius of the emission sphere.
  93341. */
  93342. radius?: number,
  93343. /**
  93344. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93345. */
  93346. radiusRange?: number,
  93347. /**
  93348. * How much to randomize the particle direction [0-1].
  93349. */
  93350. directionRandomizer?: number);
  93351. /**
  93352. * Called by the particle System when the direction is computed for the created particle.
  93353. * @param worldMatrix is the world matrix of the particle system
  93354. * @param directionToUpdate is the direction vector to update with the result
  93355. * @param particle is the particle we are computed the direction for
  93356. * @param isLocal defines if the direction should be set in local space
  93357. */
  93358. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93359. /**
  93360. * Called by the particle System when the position is computed for the created particle.
  93361. * @param worldMatrix is the world matrix of the particle system
  93362. * @param positionToUpdate is the position vector to update with the result
  93363. * @param particle is the particle we are computed the position for
  93364. * @param isLocal defines if the position should be set in local space
  93365. */
  93366. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93367. /**
  93368. * Clones the current emitter and returns a copy of it
  93369. * @returns the new emitter
  93370. */
  93371. clone(): SphereParticleEmitter;
  93372. /**
  93373. * Called by the GPUParticleSystem to setup the update shader
  93374. * @param effect defines the update shader
  93375. */
  93376. applyToShader(effect: Effect): void;
  93377. /**
  93378. * Returns a string to use to update the GPU particles update shader
  93379. * @returns a string containng the defines string
  93380. */
  93381. getEffectDefines(): string;
  93382. /**
  93383. * Returns the string "SphereParticleEmitter"
  93384. * @returns a string containing the class name
  93385. */
  93386. getClassName(): string;
  93387. /**
  93388. * Serializes the particle system to a JSON object.
  93389. * @returns the JSON object
  93390. */
  93391. serialize(): any;
  93392. /**
  93393. * Parse properties from a JSON object
  93394. * @param serializationObject defines the JSON object
  93395. */
  93396. parse(serializationObject: any): void;
  93397. }
  93398. /**
  93399. * Particle emitter emitting particles from the inside of a sphere.
  93400. * It emits the particles randomly between two vectors.
  93401. */
  93402. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  93403. /**
  93404. * The min limit of the emission direction.
  93405. */
  93406. direction1: Vector3;
  93407. /**
  93408. * The max limit of the emission direction.
  93409. */
  93410. direction2: Vector3;
  93411. /**
  93412. * Creates a new instance SphereDirectedParticleEmitter
  93413. * @param radius the radius of the emission sphere (1 by default)
  93414. * @param direction1 the min limit of the emission direction (up vector by default)
  93415. * @param direction2 the max limit of the emission direction (up vector by default)
  93416. */
  93417. constructor(radius?: number,
  93418. /**
  93419. * The min limit of the emission direction.
  93420. */
  93421. direction1?: Vector3,
  93422. /**
  93423. * The max limit of the emission direction.
  93424. */
  93425. direction2?: Vector3);
  93426. /**
  93427. * Called by the particle System when the direction is computed for the created particle.
  93428. * @param worldMatrix is the world matrix of the particle system
  93429. * @param directionToUpdate is the direction vector to update with the result
  93430. * @param particle is the particle we are computed the direction for
  93431. */
  93432. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93433. /**
  93434. * Clones the current emitter and returns a copy of it
  93435. * @returns the new emitter
  93436. */
  93437. clone(): SphereDirectedParticleEmitter;
  93438. /**
  93439. * Called by the GPUParticleSystem to setup the update shader
  93440. * @param effect defines the update shader
  93441. */
  93442. applyToShader(effect: Effect): void;
  93443. /**
  93444. * Returns a string to use to update the GPU particles update shader
  93445. * @returns a string containng the defines string
  93446. */
  93447. getEffectDefines(): string;
  93448. /**
  93449. * Returns the string "SphereDirectedParticleEmitter"
  93450. * @returns a string containing the class name
  93451. */
  93452. getClassName(): string;
  93453. /**
  93454. * Serializes the particle system to a JSON object.
  93455. * @returns the JSON object
  93456. */
  93457. serialize(): any;
  93458. /**
  93459. * Parse properties from a JSON object
  93460. * @param serializationObject defines the JSON object
  93461. */
  93462. parse(serializationObject: any): void;
  93463. }
  93464. }
  93465. declare module BABYLON {
  93466. /**
  93467. * Particle emitter emitting particles from a custom list of positions.
  93468. */
  93469. export class CustomParticleEmitter implements IParticleEmitterType {
  93470. /**
  93471. * Gets or sets the position generator that will create the inital position of each particle.
  93472. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93473. */
  93474. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  93475. /**
  93476. * Gets or sets the destination generator that will create the final destination of each particle.
  93477. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93478. */
  93479. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  93480. /**
  93481. * Creates a new instance CustomParticleEmitter
  93482. */
  93483. constructor();
  93484. /**
  93485. * Called by the particle System when the direction is computed for the created particle.
  93486. * @param worldMatrix is the world matrix of the particle system
  93487. * @param directionToUpdate is the direction vector to update with the result
  93488. * @param particle is the particle we are computed the direction for
  93489. * @param isLocal defines if the direction should be set in local space
  93490. */
  93491. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93492. /**
  93493. * Called by the particle System when the position is computed for the created particle.
  93494. * @param worldMatrix is the world matrix of the particle system
  93495. * @param positionToUpdate is the position vector to update with the result
  93496. * @param particle is the particle we are computed the position for
  93497. * @param isLocal defines if the position should be set in local space
  93498. */
  93499. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93500. /**
  93501. * Clones the current emitter and returns a copy of it
  93502. * @returns the new emitter
  93503. */
  93504. clone(): CustomParticleEmitter;
  93505. /**
  93506. * Called by the GPUParticleSystem to setup the update shader
  93507. * @param effect defines the update shader
  93508. */
  93509. applyToShader(effect: Effect): void;
  93510. /**
  93511. * Returns a string to use to update the GPU particles update shader
  93512. * @returns a string containng the defines string
  93513. */
  93514. getEffectDefines(): string;
  93515. /**
  93516. * Returns the string "PointParticleEmitter"
  93517. * @returns a string containing the class name
  93518. */
  93519. getClassName(): string;
  93520. /**
  93521. * Serializes the particle system to a JSON object.
  93522. * @returns the JSON object
  93523. */
  93524. serialize(): any;
  93525. /**
  93526. * Parse properties from a JSON object
  93527. * @param serializationObject defines the JSON object
  93528. */
  93529. parse(serializationObject: any): 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 MeshParticleEmitter implements IParticleEmitterType {
  93538. private _indices;
  93539. private _positions;
  93540. private _normals;
  93541. private _storedNormal;
  93542. private _mesh;
  93543. /**
  93544. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93545. */
  93546. direction1: Vector3;
  93547. /**
  93548. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93549. */
  93550. direction2: Vector3;
  93551. /**
  93552. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  93553. */
  93554. useMeshNormalsForDirection: boolean;
  93555. /** Defines the mesh to use as source */
  93556. get mesh(): Nullable<AbstractMesh>;
  93557. set mesh(value: Nullable<AbstractMesh>);
  93558. /**
  93559. * Creates a new instance MeshParticleEmitter
  93560. * @param mesh defines the mesh to use as source
  93561. */
  93562. constructor(mesh?: Nullable<AbstractMesh>);
  93563. /**
  93564. * Called by the particle System when the direction is computed for the created particle.
  93565. * @param worldMatrix is the world matrix of the particle system
  93566. * @param directionToUpdate is the direction vector to update with the result
  93567. * @param particle is the particle we are computed the direction for
  93568. * @param isLocal defines if the direction should be set in local space
  93569. */
  93570. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93571. /**
  93572. * Called by the particle System when the position is computed for the created particle.
  93573. * @param worldMatrix is the world matrix of the particle system
  93574. * @param positionToUpdate is the position vector to update with the result
  93575. * @param particle is the particle we are computed the position for
  93576. * @param isLocal defines if the position should be set in local space
  93577. */
  93578. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93579. /**
  93580. * Clones the current emitter and returns a copy of it
  93581. * @returns the new emitter
  93582. */
  93583. clone(): MeshParticleEmitter;
  93584. /**
  93585. * Called by the GPUParticleSystem to setup the update shader
  93586. * @param effect defines the update shader
  93587. */
  93588. applyToShader(effect: Effect): void;
  93589. /**
  93590. * Returns a string to use to update the GPU particles update shader
  93591. * @returns a string containng the defines string
  93592. */
  93593. getEffectDefines(): string;
  93594. /**
  93595. * Returns the string "BoxParticleEmitter"
  93596. * @returns a string containing the class name
  93597. */
  93598. getClassName(): string;
  93599. /**
  93600. * Serializes the particle system to a JSON object.
  93601. * @returns the JSON object
  93602. */
  93603. serialize(): any;
  93604. /**
  93605. * Parse properties from a JSON object
  93606. * @param serializationObject defines the JSON object
  93607. * @param scene defines the hosting scene
  93608. */
  93609. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93610. }
  93611. }
  93612. declare module BABYLON {
  93613. /**
  93614. * Interface representing a particle system in Babylon.js.
  93615. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  93616. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  93617. */
  93618. export interface IParticleSystem {
  93619. /**
  93620. * List of animations used by the particle system.
  93621. */
  93622. animations: Animation[];
  93623. /**
  93624. * The id of the Particle system.
  93625. */
  93626. id: string;
  93627. /**
  93628. * The name of the Particle system.
  93629. */
  93630. name: string;
  93631. /**
  93632. * The emitter represents the Mesh or position we are attaching the particle system to.
  93633. */
  93634. emitter: Nullable<AbstractMesh | Vector3>;
  93635. /**
  93636. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93637. */
  93638. isBillboardBased: boolean;
  93639. /**
  93640. * The rendering group used by the Particle system to chose when to render.
  93641. */
  93642. renderingGroupId: number;
  93643. /**
  93644. * The layer mask we are rendering the particles through.
  93645. */
  93646. layerMask: number;
  93647. /**
  93648. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  93649. */
  93650. updateSpeed: number;
  93651. /**
  93652. * The amount of time the particle system is running (depends of the overall update speed).
  93653. */
  93654. targetStopDuration: number;
  93655. /**
  93656. * The texture used to render each particle. (this can be a spritesheet)
  93657. */
  93658. particleTexture: Nullable<BaseTexture>;
  93659. /**
  93660. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  93661. */
  93662. blendMode: number;
  93663. /**
  93664. * Minimum life time of emitting particles.
  93665. */
  93666. minLifeTime: number;
  93667. /**
  93668. * Maximum life time of emitting particles.
  93669. */
  93670. maxLifeTime: number;
  93671. /**
  93672. * Minimum Size of emitting particles.
  93673. */
  93674. minSize: number;
  93675. /**
  93676. * Maximum Size of emitting particles.
  93677. */
  93678. maxSize: number;
  93679. /**
  93680. * Minimum scale of emitting particles on X axis.
  93681. */
  93682. minScaleX: number;
  93683. /**
  93684. * Maximum scale of emitting particles on X axis.
  93685. */
  93686. maxScaleX: number;
  93687. /**
  93688. * Minimum scale of emitting particles on Y axis.
  93689. */
  93690. minScaleY: number;
  93691. /**
  93692. * Maximum scale of emitting particles on Y axis.
  93693. */
  93694. maxScaleY: number;
  93695. /**
  93696. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93697. */
  93698. color1: Color4;
  93699. /**
  93700. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93701. */
  93702. color2: Color4;
  93703. /**
  93704. * Color the particle will have at the end of its lifetime.
  93705. */
  93706. colorDead: Color4;
  93707. /**
  93708. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  93709. */
  93710. emitRate: number;
  93711. /**
  93712. * You can use gravity if you want to give an orientation to your particles.
  93713. */
  93714. gravity: Vector3;
  93715. /**
  93716. * Minimum power of emitting particles.
  93717. */
  93718. minEmitPower: number;
  93719. /**
  93720. * Maximum power of emitting particles.
  93721. */
  93722. maxEmitPower: number;
  93723. /**
  93724. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  93725. */
  93726. minAngularSpeed: number;
  93727. /**
  93728. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  93729. */
  93730. maxAngularSpeed: number;
  93731. /**
  93732. * Gets or sets the minimal initial rotation in radians.
  93733. */
  93734. minInitialRotation: number;
  93735. /**
  93736. * Gets or sets the maximal initial rotation in radians.
  93737. */
  93738. maxInitialRotation: number;
  93739. /**
  93740. * The particle emitter type defines the emitter used by the particle system.
  93741. * It can be for example box, sphere, or cone...
  93742. */
  93743. particleEmitterType: Nullable<IParticleEmitterType>;
  93744. /**
  93745. * Defines the delay in milliseconds before starting the system (0 by default)
  93746. */
  93747. startDelay: number;
  93748. /**
  93749. * 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
  93750. */
  93751. preWarmCycles: number;
  93752. /**
  93753. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  93754. */
  93755. preWarmStepOffset: number;
  93756. /**
  93757. * 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)
  93758. */
  93759. spriteCellChangeSpeed: number;
  93760. /**
  93761. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  93762. */
  93763. startSpriteCellID: number;
  93764. /**
  93765. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  93766. */
  93767. endSpriteCellID: number;
  93768. /**
  93769. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  93770. */
  93771. spriteCellWidth: number;
  93772. /**
  93773. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  93774. */
  93775. spriteCellHeight: number;
  93776. /**
  93777. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  93778. */
  93779. spriteRandomStartCell: boolean;
  93780. /**
  93781. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  93782. */
  93783. isAnimationSheetEnabled: boolean;
  93784. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  93785. translationPivot: Vector2;
  93786. /**
  93787. * Gets or sets a texture used to add random noise to particle positions
  93788. */
  93789. noiseTexture: Nullable<BaseTexture>;
  93790. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  93791. noiseStrength: Vector3;
  93792. /**
  93793. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93794. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93795. */
  93796. billboardMode: number;
  93797. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  93798. limitVelocityDamping: number;
  93799. /**
  93800. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  93801. */
  93802. beginAnimationOnStart: boolean;
  93803. /**
  93804. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  93805. */
  93806. beginAnimationFrom: number;
  93807. /**
  93808. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  93809. */
  93810. beginAnimationTo: number;
  93811. /**
  93812. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  93813. */
  93814. beginAnimationLoop: boolean;
  93815. /**
  93816. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  93817. */
  93818. disposeOnStop: boolean;
  93819. /**
  93820. * Specifies if the particles are updated in emitter local space or world space
  93821. */
  93822. isLocal: boolean;
  93823. /** Snippet ID if the particle system was created from the snippet server */
  93824. snippetId: string;
  93825. /** Gets or sets a matrix to use to compute projection */
  93826. defaultProjectionMatrix: Matrix;
  93827. /**
  93828. * Gets the maximum number of particles active at the same time.
  93829. * @returns The max number of active particles.
  93830. */
  93831. getCapacity(): number;
  93832. /**
  93833. * Gets the number of particles active at the same time.
  93834. * @returns The number of active particles.
  93835. */
  93836. getActiveCount(): number;
  93837. /**
  93838. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93839. * @returns True if it has been started, otherwise false.
  93840. */
  93841. isStarted(): boolean;
  93842. /**
  93843. * Animates the particle system for this frame.
  93844. */
  93845. animate(): void;
  93846. /**
  93847. * Renders the particle system in its current state.
  93848. * @returns the current number of particles
  93849. */
  93850. render(): number;
  93851. /**
  93852. * Dispose the particle system and frees its associated resources.
  93853. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93854. */
  93855. dispose(disposeTexture?: boolean): void;
  93856. /**
  93857. * An event triggered when the system is disposed
  93858. */
  93859. onDisposeObservable: Observable<IParticleSystem>;
  93860. /**
  93861. * Clones the particle system.
  93862. * @param name The name of the cloned object
  93863. * @param newEmitter The new emitter to use
  93864. * @returns the cloned particle system
  93865. */
  93866. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  93867. /**
  93868. * Serializes the particle system to a JSON object
  93869. * @param serializeTexture defines if the texture must be serialized as well
  93870. * @returns the JSON object
  93871. */
  93872. serialize(serializeTexture: boolean): any;
  93873. /**
  93874. * Rebuild the particle system
  93875. */
  93876. rebuild(): void;
  93877. /** Force the system to rebuild all gradients that need to be resync */
  93878. forceRefreshGradients(): void;
  93879. /**
  93880. * Starts the particle system and begins to emit
  93881. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  93882. */
  93883. start(delay?: number): void;
  93884. /**
  93885. * Stops the particle system.
  93886. */
  93887. stop(): void;
  93888. /**
  93889. * Remove all active particles
  93890. */
  93891. reset(): void;
  93892. /**
  93893. * Gets a boolean indicating that the system is stopping
  93894. * @returns true if the system is currently stopping
  93895. */
  93896. isStopping(): boolean;
  93897. /**
  93898. * Is this system ready to be used/rendered
  93899. * @return true if the system is ready
  93900. */
  93901. isReady(): boolean;
  93902. /**
  93903. * Returns the string "ParticleSystem"
  93904. * @returns a string containing the class name
  93905. */
  93906. getClassName(): string;
  93907. /**
  93908. * Gets the custom effect used to render the particles
  93909. * @param blendMode Blend mode for which the effect should be retrieved
  93910. * @returns The effect
  93911. */
  93912. getCustomEffect(blendMode: number): Nullable<Effect>;
  93913. /**
  93914. * Sets the custom effect used to render the particles
  93915. * @param effect The effect to set
  93916. * @param blendMode Blend mode for which the effect should be set
  93917. */
  93918. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  93919. /**
  93920. * Fill the defines array according to the current settings of the particle system
  93921. * @param defines Array to be updated
  93922. * @param blendMode blend mode to take into account when updating the array
  93923. */
  93924. fillDefines(defines: Array<string>, blendMode: number): void;
  93925. /**
  93926. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93927. * @param uniforms Uniforms array to fill
  93928. * @param attributes Attributes array to fill
  93929. * @param samplers Samplers array to fill
  93930. */
  93931. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93932. /**
  93933. * Observable that will be called just before the particles are drawn
  93934. */
  93935. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  93936. /**
  93937. * Gets the name of the particle vertex shader
  93938. */
  93939. vertexShaderName: string;
  93940. /**
  93941. * Adds a new color gradient
  93942. * @param gradient defines the gradient to use (between 0 and 1)
  93943. * @param color1 defines the color to affect to the specified gradient
  93944. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93945. * @returns the current particle system
  93946. */
  93947. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93948. /**
  93949. * Remove a specific color gradient
  93950. * @param gradient defines the gradient to remove
  93951. * @returns the current particle system
  93952. */
  93953. removeColorGradient(gradient: number): IParticleSystem;
  93954. /**
  93955. * Adds a new size gradient
  93956. * @param gradient defines the gradient to use (between 0 and 1)
  93957. * @param factor defines the size factor to affect to the specified gradient
  93958. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93959. * @returns the current particle system
  93960. */
  93961. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93962. /**
  93963. * Remove a specific size gradient
  93964. * @param gradient defines the gradient to remove
  93965. * @returns the current particle system
  93966. */
  93967. removeSizeGradient(gradient: number): IParticleSystem;
  93968. /**
  93969. * Gets the current list of color gradients.
  93970. * You must use addColorGradient and removeColorGradient to udpate this list
  93971. * @returns the list of color gradients
  93972. */
  93973. getColorGradients(): Nullable<Array<ColorGradient>>;
  93974. /**
  93975. * Gets the current list of size gradients.
  93976. * You must use addSizeGradient and removeSizeGradient to udpate this list
  93977. * @returns the list of size gradients
  93978. */
  93979. getSizeGradients(): Nullable<Array<FactorGradient>>;
  93980. /**
  93981. * Gets the current list of angular speed gradients.
  93982. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  93983. * @returns the list of angular speed gradients
  93984. */
  93985. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  93986. /**
  93987. * Adds a new angular speed gradient
  93988. * @param gradient defines the gradient to use (between 0 and 1)
  93989. * @param factor defines the angular speed to affect to the specified gradient
  93990. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93991. * @returns the current particle system
  93992. */
  93993. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93994. /**
  93995. * Remove a specific angular speed gradient
  93996. * @param gradient defines the gradient to remove
  93997. * @returns the current particle system
  93998. */
  93999. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  94000. /**
  94001. * Gets the current list of velocity gradients.
  94002. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  94003. * @returns the list of velocity gradients
  94004. */
  94005. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  94006. /**
  94007. * Adds a new velocity gradient
  94008. * @param gradient defines the gradient to use (between 0 and 1)
  94009. * @param factor defines the velocity to affect to the specified gradient
  94010. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94011. * @returns the current particle system
  94012. */
  94013. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94014. /**
  94015. * Remove a specific velocity gradient
  94016. * @param gradient defines the gradient to remove
  94017. * @returns the current particle system
  94018. */
  94019. removeVelocityGradient(gradient: number): IParticleSystem;
  94020. /**
  94021. * Gets the current list of limit velocity gradients.
  94022. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  94023. * @returns the list of limit velocity gradients
  94024. */
  94025. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  94026. /**
  94027. * Adds a new limit velocity gradient
  94028. * @param gradient defines the gradient to use (between 0 and 1)
  94029. * @param factor defines the limit velocity to affect to the specified gradient
  94030. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94031. * @returns the current particle system
  94032. */
  94033. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94034. /**
  94035. * Remove a specific limit velocity gradient
  94036. * @param gradient defines the gradient to remove
  94037. * @returns the current particle system
  94038. */
  94039. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  94040. /**
  94041. * Adds a new drag gradient
  94042. * @param gradient defines the gradient to use (between 0 and 1)
  94043. * @param factor defines the drag to affect to the specified gradient
  94044. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94045. * @returns the current particle system
  94046. */
  94047. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94048. /**
  94049. * Remove a specific drag gradient
  94050. * @param gradient defines the gradient to remove
  94051. * @returns the current particle system
  94052. */
  94053. removeDragGradient(gradient: number): IParticleSystem;
  94054. /**
  94055. * Gets the current list of drag gradients.
  94056. * You must use addDragGradient and removeDragGradient to udpate this list
  94057. * @returns the list of drag gradients
  94058. */
  94059. getDragGradients(): Nullable<Array<FactorGradient>>;
  94060. /**
  94061. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  94062. * @param gradient defines the gradient to use (between 0 and 1)
  94063. * @param factor defines the emit rate to affect to the specified gradient
  94064. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94065. * @returns the current particle system
  94066. */
  94067. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94068. /**
  94069. * Remove a specific emit rate gradient
  94070. * @param gradient defines the gradient to remove
  94071. * @returns the current particle system
  94072. */
  94073. removeEmitRateGradient(gradient: number): IParticleSystem;
  94074. /**
  94075. * Gets the current list of emit rate gradients.
  94076. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  94077. * @returns the list of emit rate gradients
  94078. */
  94079. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  94080. /**
  94081. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  94082. * @param gradient defines the gradient to use (between 0 and 1)
  94083. * @param factor defines the start size to affect to the specified gradient
  94084. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94085. * @returns the current particle system
  94086. */
  94087. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94088. /**
  94089. * Remove a specific start size gradient
  94090. * @param gradient defines the gradient to remove
  94091. * @returns the current particle system
  94092. */
  94093. removeStartSizeGradient(gradient: number): IParticleSystem;
  94094. /**
  94095. * Gets the current list of start size gradients.
  94096. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  94097. * @returns the list of start size gradients
  94098. */
  94099. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  94100. /**
  94101. * Adds a new life time gradient
  94102. * @param gradient defines the gradient to use (between 0 and 1)
  94103. * @param factor defines the life time factor to affect to the specified gradient
  94104. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94105. * @returns the current particle system
  94106. */
  94107. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94108. /**
  94109. * Remove a specific life time gradient
  94110. * @param gradient defines the gradient to remove
  94111. * @returns the current particle system
  94112. */
  94113. removeLifeTimeGradient(gradient: number): IParticleSystem;
  94114. /**
  94115. * Gets the current list of life time gradients.
  94116. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  94117. * @returns the list of life time gradients
  94118. */
  94119. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  94120. /**
  94121. * Gets the current list of color gradients.
  94122. * You must use addColorGradient and removeColorGradient to udpate this list
  94123. * @returns the list of color gradients
  94124. */
  94125. getColorGradients(): Nullable<Array<ColorGradient>>;
  94126. /**
  94127. * Adds a new ramp gradient used to remap particle colors
  94128. * @param gradient defines the gradient to use (between 0 and 1)
  94129. * @param color defines the color to affect to the specified gradient
  94130. * @returns the current particle system
  94131. */
  94132. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  94133. /**
  94134. * Gets the current list of ramp gradients.
  94135. * You must use addRampGradient and removeRampGradient to udpate this list
  94136. * @returns the list of ramp gradients
  94137. */
  94138. getRampGradients(): Nullable<Array<Color3Gradient>>;
  94139. /** Gets or sets a boolean indicating that ramp gradients must be used
  94140. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  94141. */
  94142. useRampGradients: boolean;
  94143. /**
  94144. * Adds a new color remap gradient
  94145. * @param gradient defines the gradient to use (between 0 and 1)
  94146. * @param min defines the color remap minimal range
  94147. * @param max defines the color remap maximal range
  94148. * @returns the current particle system
  94149. */
  94150. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94151. /**
  94152. * Gets the current list of color remap gradients.
  94153. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  94154. * @returns the list of color remap gradients
  94155. */
  94156. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  94157. /**
  94158. * Adds a new alpha remap gradient
  94159. * @param gradient defines the gradient to use (between 0 and 1)
  94160. * @param min defines the alpha remap minimal range
  94161. * @param max defines the alpha remap maximal range
  94162. * @returns the current particle system
  94163. */
  94164. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94165. /**
  94166. * Gets the current list of alpha remap gradients.
  94167. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  94168. * @returns the list of alpha remap gradients
  94169. */
  94170. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  94171. /**
  94172. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  94173. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94174. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94175. * @returns the emitter
  94176. */
  94177. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  94178. /**
  94179. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  94180. * @param radius The radius of the hemisphere to emit from
  94181. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94182. * @returns the emitter
  94183. */
  94184. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  94185. /**
  94186. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  94187. * @param radius The radius of the sphere to emit from
  94188. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94189. * @returns the emitter
  94190. */
  94191. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  94192. /**
  94193. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  94194. * @param radius The radius of the sphere to emit from
  94195. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  94196. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  94197. * @returns the emitter
  94198. */
  94199. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94200. /**
  94201. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  94202. * @param radius The radius of the emission cylinder
  94203. * @param height The height of the emission cylinder
  94204. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  94205. * @param directionRandomizer How much to randomize the particle direction [0-1]
  94206. * @returns the emitter
  94207. */
  94208. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  94209. /**
  94210. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  94211. * @param radius The radius of the cylinder to emit from
  94212. * @param height The height of the emission cylinder
  94213. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94214. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  94215. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  94216. * @returns the emitter
  94217. */
  94218. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94219. /**
  94220. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  94221. * @param radius The radius of the cone to emit from
  94222. * @param angle The base angle of the cone
  94223. * @returns the emitter
  94224. */
  94225. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  94226. /**
  94227. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  94228. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94229. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94230. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94231. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94232. * @returns the emitter
  94233. */
  94234. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  94235. /**
  94236. * Get hosting scene
  94237. * @returns the scene
  94238. */
  94239. getScene(): Nullable<Scene>;
  94240. }
  94241. }
  94242. declare module BABYLON {
  94243. /**
  94244. * 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.
  94245. * @see https://doc.babylonjs.com/how_to/transformnode
  94246. */
  94247. export class TransformNode extends Node {
  94248. /**
  94249. * Object will not rotate to face the camera
  94250. */
  94251. static BILLBOARDMODE_NONE: number;
  94252. /**
  94253. * Object will rotate to face the camera but only on the x axis
  94254. */
  94255. static BILLBOARDMODE_X: number;
  94256. /**
  94257. * Object will rotate to face the camera but only on the y axis
  94258. */
  94259. static BILLBOARDMODE_Y: number;
  94260. /**
  94261. * Object will rotate to face the camera but only on the z axis
  94262. */
  94263. static BILLBOARDMODE_Z: number;
  94264. /**
  94265. * Object will rotate to face the camera
  94266. */
  94267. static BILLBOARDMODE_ALL: number;
  94268. /**
  94269. * Object will rotate to face the camera's position instead of orientation
  94270. */
  94271. static BILLBOARDMODE_USE_POSITION: number;
  94272. private static _TmpRotation;
  94273. private static _TmpScaling;
  94274. private static _TmpTranslation;
  94275. private _forward;
  94276. private _forwardInverted;
  94277. private _up;
  94278. private _right;
  94279. private _rightInverted;
  94280. private _position;
  94281. private _rotation;
  94282. private _rotationQuaternion;
  94283. protected _scaling: Vector3;
  94284. protected _isDirty: boolean;
  94285. private _transformToBoneReferal;
  94286. private _isAbsoluteSynced;
  94287. private _billboardMode;
  94288. /**
  94289. * Gets or sets the billboard mode. Default is 0.
  94290. *
  94291. * | Value | Type | Description |
  94292. * | --- | --- | --- |
  94293. * | 0 | BILLBOARDMODE_NONE | |
  94294. * | 1 | BILLBOARDMODE_X | |
  94295. * | 2 | BILLBOARDMODE_Y | |
  94296. * | 4 | BILLBOARDMODE_Z | |
  94297. * | 7 | BILLBOARDMODE_ALL | |
  94298. *
  94299. */
  94300. get billboardMode(): number;
  94301. set billboardMode(value: number);
  94302. private _preserveParentRotationForBillboard;
  94303. /**
  94304. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  94305. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  94306. */
  94307. get preserveParentRotationForBillboard(): boolean;
  94308. set preserveParentRotationForBillboard(value: boolean);
  94309. /**
  94310. * 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
  94311. */
  94312. scalingDeterminant: number;
  94313. private _infiniteDistance;
  94314. /**
  94315. * Gets or sets the distance of the object to max, often used by skybox
  94316. */
  94317. get infiniteDistance(): boolean;
  94318. set infiniteDistance(value: boolean);
  94319. /**
  94320. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  94321. * By default the system will update normals to compensate
  94322. */
  94323. ignoreNonUniformScaling: boolean;
  94324. /**
  94325. * 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
  94326. */
  94327. reIntegrateRotationIntoRotationQuaternion: boolean;
  94328. /** @hidden */
  94329. _poseMatrix: Nullable<Matrix>;
  94330. /** @hidden */
  94331. _localMatrix: Matrix;
  94332. private _usePivotMatrix;
  94333. private _absolutePosition;
  94334. private _absoluteScaling;
  94335. private _absoluteRotationQuaternion;
  94336. private _pivotMatrix;
  94337. private _pivotMatrixInverse;
  94338. protected _postMultiplyPivotMatrix: boolean;
  94339. protected _isWorldMatrixFrozen: boolean;
  94340. /** @hidden */
  94341. _indexInSceneTransformNodesArray: number;
  94342. /**
  94343. * An event triggered after the world matrix is updated
  94344. */
  94345. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  94346. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  94347. /**
  94348. * Gets a string identifying the name of the class
  94349. * @returns "TransformNode" string
  94350. */
  94351. getClassName(): string;
  94352. /**
  94353. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  94354. */
  94355. get position(): Vector3;
  94356. set position(newPosition: Vector3);
  94357. /**
  94358. * 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)).
  94359. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  94360. */
  94361. get rotation(): Vector3;
  94362. set rotation(newRotation: Vector3);
  94363. /**
  94364. * 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)).
  94365. */
  94366. get scaling(): Vector3;
  94367. set scaling(newScaling: Vector3);
  94368. /**
  94369. * 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).
  94370. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  94371. */
  94372. get rotationQuaternion(): Nullable<Quaternion>;
  94373. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  94374. /**
  94375. * The forward direction of that transform in world space.
  94376. */
  94377. get forward(): Vector3;
  94378. /**
  94379. * The up direction of that transform in world space.
  94380. */
  94381. get up(): Vector3;
  94382. /**
  94383. * The right direction of that transform in world space.
  94384. */
  94385. get right(): Vector3;
  94386. /**
  94387. * Copies the parameter passed Matrix into the mesh Pose matrix.
  94388. * @param matrix the matrix to copy the pose from
  94389. * @returns this TransformNode.
  94390. */
  94391. updatePoseMatrix(matrix: Matrix): TransformNode;
  94392. /**
  94393. * Returns the mesh Pose matrix.
  94394. * @returns the pose matrix
  94395. */
  94396. getPoseMatrix(): Matrix;
  94397. /** @hidden */
  94398. _isSynchronized(): boolean;
  94399. /** @hidden */
  94400. _initCache(): void;
  94401. /**
  94402. * Flag the transform node as dirty (Forcing it to update everything)
  94403. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  94404. * @returns this transform node
  94405. */
  94406. markAsDirty(property: string): TransformNode;
  94407. /**
  94408. * Returns the current mesh absolute position.
  94409. * Returns a Vector3.
  94410. */
  94411. get absolutePosition(): Vector3;
  94412. /**
  94413. * Returns the current mesh absolute scaling.
  94414. * Returns a Vector3.
  94415. */
  94416. get absoluteScaling(): Vector3;
  94417. /**
  94418. * Returns the current mesh absolute rotation.
  94419. * Returns a Quaternion.
  94420. */
  94421. get absoluteRotationQuaternion(): Quaternion;
  94422. /**
  94423. * Sets a new matrix to apply before all other transformation
  94424. * @param matrix defines the transform matrix
  94425. * @returns the current TransformNode
  94426. */
  94427. setPreTransformMatrix(matrix: Matrix): TransformNode;
  94428. /**
  94429. * Sets a new pivot matrix to the current node
  94430. * @param matrix defines the new pivot matrix to use
  94431. * @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
  94432. * @returns the current TransformNode
  94433. */
  94434. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  94435. /**
  94436. * Returns the mesh pivot matrix.
  94437. * Default : Identity.
  94438. * @returns the matrix
  94439. */
  94440. getPivotMatrix(): Matrix;
  94441. /**
  94442. * Instantiate (when possible) or clone that node with its hierarchy
  94443. * @param newParent defines the new parent to use for the instance (or clone)
  94444. * @param options defines options to configure how copy is done
  94445. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  94446. * @returns an instance (or a clone) of the current node with its hiearchy
  94447. */
  94448. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  94449. doNotInstantiate: boolean;
  94450. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  94451. /**
  94452. * Prevents the World matrix to be computed any longer
  94453. * @param newWorldMatrix defines an optional matrix to use as world matrix
  94454. * @returns the TransformNode.
  94455. */
  94456. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  94457. /**
  94458. * Allows back the World matrix computation.
  94459. * @returns the TransformNode.
  94460. */
  94461. unfreezeWorldMatrix(): this;
  94462. /**
  94463. * True if the World matrix has been frozen.
  94464. */
  94465. get isWorldMatrixFrozen(): boolean;
  94466. /**
  94467. * Retuns the mesh absolute position in the World.
  94468. * @returns a Vector3.
  94469. */
  94470. getAbsolutePosition(): Vector3;
  94471. /**
  94472. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  94473. * @param absolutePosition the absolute position to set
  94474. * @returns the TransformNode.
  94475. */
  94476. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  94477. /**
  94478. * Sets the mesh position in its local space.
  94479. * @param vector3 the position to set in localspace
  94480. * @returns the TransformNode.
  94481. */
  94482. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  94483. /**
  94484. * Returns the mesh position in the local space from the current World matrix values.
  94485. * @returns a new Vector3.
  94486. */
  94487. getPositionExpressedInLocalSpace(): Vector3;
  94488. /**
  94489. * Translates the mesh along the passed Vector3 in its local space.
  94490. * @param vector3 the distance to translate in localspace
  94491. * @returns the TransformNode.
  94492. */
  94493. locallyTranslate(vector3: Vector3): TransformNode;
  94494. private static _lookAtVectorCache;
  94495. /**
  94496. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  94497. * @param targetPoint the position (must be in same space as current mesh) to look at
  94498. * @param yawCor optional yaw (y-axis) correction in radians
  94499. * @param pitchCor optional pitch (x-axis) correction in radians
  94500. * @param rollCor optional roll (z-axis) correction in radians
  94501. * @param space the choosen space of the target
  94502. * @returns the TransformNode.
  94503. */
  94504. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  94505. /**
  94506. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94507. * This Vector3 is expressed in the World space.
  94508. * @param localAxis axis to rotate
  94509. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94510. */
  94511. getDirection(localAxis: Vector3): Vector3;
  94512. /**
  94513. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  94514. * localAxis is expressed in the mesh local space.
  94515. * result is computed in the Wordl space from the mesh World matrix.
  94516. * @param localAxis axis to rotate
  94517. * @param result the resulting transformnode
  94518. * @returns this TransformNode.
  94519. */
  94520. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  94521. /**
  94522. * Sets this transform node rotation to the given local axis.
  94523. * @param localAxis the axis in local space
  94524. * @param yawCor optional yaw (y-axis) correction in radians
  94525. * @param pitchCor optional pitch (x-axis) correction in radians
  94526. * @param rollCor optional roll (z-axis) correction in radians
  94527. * @returns this TransformNode
  94528. */
  94529. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  94530. /**
  94531. * Sets a new pivot point to the current node
  94532. * @param point defines the new pivot point to use
  94533. * @param space defines if the point is in world or local space (local by default)
  94534. * @returns the current TransformNode
  94535. */
  94536. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  94537. /**
  94538. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  94539. * @returns the pivot point
  94540. */
  94541. getPivotPoint(): Vector3;
  94542. /**
  94543. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  94544. * @param result the vector3 to store the result
  94545. * @returns this TransformNode.
  94546. */
  94547. getPivotPointToRef(result: Vector3): TransformNode;
  94548. /**
  94549. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  94550. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  94551. */
  94552. getAbsolutePivotPoint(): Vector3;
  94553. /**
  94554. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  94555. * @param result vector3 to store the result
  94556. * @returns this TransformNode.
  94557. */
  94558. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  94559. /**
  94560. * Defines the passed node as the parent of the current node.
  94561. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  94562. * @see https://doc.babylonjs.com/how_to/parenting
  94563. * @param node the node ot set as the parent
  94564. * @returns this TransformNode.
  94565. */
  94566. setParent(node: Nullable<Node>): TransformNode;
  94567. private _nonUniformScaling;
  94568. /**
  94569. * True if the scaling property of this object is non uniform eg. (1,2,1)
  94570. */
  94571. get nonUniformScaling(): boolean;
  94572. /** @hidden */
  94573. _updateNonUniformScalingState(value: boolean): boolean;
  94574. /**
  94575. * Attach the current TransformNode to another TransformNode associated with a bone
  94576. * @param bone Bone affecting the TransformNode
  94577. * @param affectedTransformNode TransformNode associated with the bone
  94578. * @returns this object
  94579. */
  94580. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  94581. /**
  94582. * Detach the transform node if its associated with a bone
  94583. * @returns this object
  94584. */
  94585. detachFromBone(): TransformNode;
  94586. private static _rotationAxisCache;
  94587. /**
  94588. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  94589. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94590. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94591. * The passed axis is also normalized.
  94592. * @param axis the axis to rotate around
  94593. * @param amount the amount to rotate in radians
  94594. * @param space Space to rotate in (Default: local)
  94595. * @returns the TransformNode.
  94596. */
  94597. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  94598. /**
  94599. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  94600. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94601. * The passed axis is also normalized. .
  94602. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  94603. * @param point the point to rotate around
  94604. * @param axis the axis to rotate around
  94605. * @param amount the amount to rotate in radians
  94606. * @returns the TransformNode
  94607. */
  94608. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  94609. /**
  94610. * Translates the mesh along the axis vector for the passed distance in the given space.
  94611. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94612. * @param axis the axis to translate in
  94613. * @param distance the distance to translate
  94614. * @param space Space to rotate in (Default: local)
  94615. * @returns the TransformNode.
  94616. */
  94617. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  94618. /**
  94619. * Adds a rotation step to the mesh current rotation.
  94620. * x, y, z are Euler angles expressed in radians.
  94621. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  94622. * This means this rotation is made in the mesh local space only.
  94623. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  94624. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  94625. * ```javascript
  94626. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  94627. * ```
  94628. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  94629. * 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.
  94630. * @param x Rotation to add
  94631. * @param y Rotation to add
  94632. * @param z Rotation to add
  94633. * @returns the TransformNode.
  94634. */
  94635. addRotation(x: number, y: number, z: number): TransformNode;
  94636. /**
  94637. * @hidden
  94638. */
  94639. protected _getEffectiveParent(): Nullable<Node>;
  94640. /**
  94641. * Computes the world matrix of the node
  94642. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94643. * @returns the world matrix
  94644. */
  94645. computeWorldMatrix(force?: boolean): Matrix;
  94646. /**
  94647. * Resets this nodeTransform's local matrix to Matrix.Identity().
  94648. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  94649. */
  94650. resetLocalMatrix(independentOfChildren?: boolean): void;
  94651. protected _afterComputeWorldMatrix(): void;
  94652. /**
  94653. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  94654. * @param func callback function to add
  94655. *
  94656. * @returns the TransformNode.
  94657. */
  94658. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94659. /**
  94660. * Removes a registered callback function.
  94661. * @param func callback function to remove
  94662. * @returns the TransformNode.
  94663. */
  94664. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94665. /**
  94666. * Gets the position of the current mesh in camera space
  94667. * @param camera defines the camera to use
  94668. * @returns a position
  94669. */
  94670. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  94671. /**
  94672. * Returns the distance from the mesh to the active camera
  94673. * @param camera defines the camera to use
  94674. * @returns the distance
  94675. */
  94676. getDistanceToCamera(camera?: Nullable<Camera>): number;
  94677. /**
  94678. * Clone the current transform node
  94679. * @param name Name of the new clone
  94680. * @param newParent New parent for the clone
  94681. * @param doNotCloneChildren Do not clone children hierarchy
  94682. * @returns the new transform node
  94683. */
  94684. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  94685. /**
  94686. * Serializes the objects information.
  94687. * @param currentSerializationObject defines the object to serialize in
  94688. * @returns the serialized object
  94689. */
  94690. serialize(currentSerializationObject?: any): any;
  94691. /**
  94692. * Returns a new TransformNode object parsed from the source provided.
  94693. * @param parsedTransformNode is the source.
  94694. * @param scene the scne the object belongs to
  94695. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  94696. * @returns a new TransformNode object parsed from the source provided.
  94697. */
  94698. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  94699. /**
  94700. * Get all child-transformNodes of this node
  94701. * @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
  94702. * @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
  94703. * @returns an array of TransformNode
  94704. */
  94705. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  94706. /**
  94707. * Releases resources associated with this transform node.
  94708. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94709. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94710. */
  94711. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94712. /**
  94713. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94714. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94715. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94716. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94717. * @returns the current mesh
  94718. */
  94719. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  94720. private _syncAbsoluteScalingAndRotation;
  94721. }
  94722. }
  94723. declare module BABYLON {
  94724. /**
  94725. * Class used to override all child animations of a given target
  94726. */
  94727. export class AnimationPropertiesOverride {
  94728. /**
  94729. * Gets or sets a value indicating if animation blending must be used
  94730. */
  94731. enableBlending: boolean;
  94732. /**
  94733. * Gets or sets the blending speed to use when enableBlending is true
  94734. */
  94735. blendingSpeed: number;
  94736. /**
  94737. * Gets or sets the default loop mode to use
  94738. */
  94739. loopMode: number;
  94740. }
  94741. }
  94742. declare module BABYLON {
  94743. /**
  94744. * Class used to store bone information
  94745. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94746. */
  94747. export class Bone extends Node {
  94748. /**
  94749. * defines the bone name
  94750. */
  94751. name: string;
  94752. private static _tmpVecs;
  94753. private static _tmpQuat;
  94754. private static _tmpMats;
  94755. /**
  94756. * Gets the list of child bones
  94757. */
  94758. children: Bone[];
  94759. /** Gets the animations associated with this bone */
  94760. animations: Animation[];
  94761. /**
  94762. * Gets or sets bone length
  94763. */
  94764. length: number;
  94765. /**
  94766. * @hidden Internal only
  94767. * Set this value to map this bone to a different index in the transform matrices
  94768. * Set this value to -1 to exclude the bone from the transform matrices
  94769. */
  94770. _index: Nullable<number>;
  94771. private _skeleton;
  94772. private _localMatrix;
  94773. private _restPose;
  94774. private _bindPose;
  94775. private _baseMatrix;
  94776. private _absoluteTransform;
  94777. private _invertedAbsoluteTransform;
  94778. private _parent;
  94779. private _scalingDeterminant;
  94780. private _worldTransform;
  94781. private _localScaling;
  94782. private _localRotation;
  94783. private _localPosition;
  94784. private _needToDecompose;
  94785. private _needToCompose;
  94786. /** @hidden */
  94787. _linkedTransformNode: Nullable<TransformNode>;
  94788. /** @hidden */
  94789. _waitingTransformNodeId: Nullable<string>;
  94790. /** @hidden */
  94791. get _matrix(): Matrix;
  94792. /** @hidden */
  94793. set _matrix(value: Matrix);
  94794. /**
  94795. * Create a new bone
  94796. * @param name defines the bone name
  94797. * @param skeleton defines the parent skeleton
  94798. * @param parentBone defines the parent (can be null if the bone is the root)
  94799. * @param localMatrix defines the local matrix
  94800. * @param restPose defines the rest pose matrix
  94801. * @param baseMatrix defines the base matrix
  94802. * @param index defines index of the bone in the hiearchy
  94803. */
  94804. constructor(
  94805. /**
  94806. * defines the bone name
  94807. */
  94808. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  94809. /**
  94810. * Gets the current object class name.
  94811. * @return the class name
  94812. */
  94813. getClassName(): string;
  94814. /**
  94815. * Gets the parent skeleton
  94816. * @returns a skeleton
  94817. */
  94818. getSkeleton(): Skeleton;
  94819. /**
  94820. * Gets parent bone
  94821. * @returns a bone or null if the bone is the root of the bone hierarchy
  94822. */
  94823. getParent(): Nullable<Bone>;
  94824. /**
  94825. * Returns an array containing the root bones
  94826. * @returns an array containing the root bones
  94827. */
  94828. getChildren(): Array<Bone>;
  94829. /**
  94830. * Gets the node index in matrix array generated for rendering
  94831. * @returns the node index
  94832. */
  94833. getIndex(): number;
  94834. /**
  94835. * Sets the parent bone
  94836. * @param parent defines the parent (can be null if the bone is the root)
  94837. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94838. */
  94839. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  94840. /**
  94841. * Gets the local matrix
  94842. * @returns a matrix
  94843. */
  94844. getLocalMatrix(): Matrix;
  94845. /**
  94846. * Gets the base matrix (initial matrix which remains unchanged)
  94847. * @returns a matrix
  94848. */
  94849. getBaseMatrix(): Matrix;
  94850. /**
  94851. * Gets the rest pose matrix
  94852. * @returns a matrix
  94853. */
  94854. getRestPose(): Matrix;
  94855. /**
  94856. * Sets the rest pose matrix
  94857. * @param matrix the local-space rest pose to set for this bone
  94858. */
  94859. setRestPose(matrix: Matrix): void;
  94860. /**
  94861. * Gets the bind pose matrix
  94862. * @returns the bind pose matrix
  94863. */
  94864. getBindPose(): Matrix;
  94865. /**
  94866. * Sets the bind pose matrix
  94867. * @param matrix the local-space bind pose to set for this bone
  94868. */
  94869. setBindPose(matrix: Matrix): void;
  94870. /**
  94871. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  94872. */
  94873. getWorldMatrix(): Matrix;
  94874. /**
  94875. * Sets the local matrix to rest pose matrix
  94876. */
  94877. returnToRest(): void;
  94878. /**
  94879. * Gets the inverse of the absolute transform matrix.
  94880. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  94881. * @returns a matrix
  94882. */
  94883. getInvertedAbsoluteTransform(): Matrix;
  94884. /**
  94885. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  94886. * @returns a matrix
  94887. */
  94888. getAbsoluteTransform(): Matrix;
  94889. /**
  94890. * Links with the given transform node.
  94891. * The local matrix of this bone is copied from the transform node every frame.
  94892. * @param transformNode defines the transform node to link to
  94893. */
  94894. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  94895. /**
  94896. * Gets the node used to drive the bone's transformation
  94897. * @returns a transform node or null
  94898. */
  94899. getTransformNode(): Nullable<TransformNode>;
  94900. /** Gets or sets current position (in local space) */
  94901. get position(): Vector3;
  94902. set position(newPosition: Vector3);
  94903. /** Gets or sets current rotation (in local space) */
  94904. get rotation(): Vector3;
  94905. set rotation(newRotation: Vector3);
  94906. /** Gets or sets current rotation quaternion (in local space) */
  94907. get rotationQuaternion(): Quaternion;
  94908. set rotationQuaternion(newRotation: Quaternion);
  94909. /** Gets or sets current scaling (in local space) */
  94910. get scaling(): Vector3;
  94911. set scaling(newScaling: Vector3);
  94912. /**
  94913. * Gets the animation properties override
  94914. */
  94915. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  94916. private _decompose;
  94917. private _compose;
  94918. /**
  94919. * Update the base and local matrices
  94920. * @param matrix defines the new base or local matrix
  94921. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94922. * @param updateLocalMatrix defines if the local matrix should be updated
  94923. */
  94924. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  94925. /** @hidden */
  94926. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  94927. /**
  94928. * Flag the bone as dirty (Forcing it to update everything)
  94929. */
  94930. markAsDirty(): void;
  94931. /** @hidden */
  94932. _markAsDirtyAndCompose(): void;
  94933. private _markAsDirtyAndDecompose;
  94934. /**
  94935. * Translate the bone in local or world space
  94936. * @param vec The amount to translate the bone
  94937. * @param space The space that the translation is in
  94938. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94939. */
  94940. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94941. /**
  94942. * Set the postion of the bone in local or world space
  94943. * @param position The position to set the bone
  94944. * @param space The space that the position is in
  94945. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94946. */
  94947. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94948. /**
  94949. * Set the absolute position of the bone (world space)
  94950. * @param position The position to set the bone
  94951. * @param mesh The mesh that this bone is attached to
  94952. */
  94953. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  94954. /**
  94955. * Scale the bone on the x, y and z axes (in local space)
  94956. * @param x The amount to scale the bone on the x axis
  94957. * @param y The amount to scale the bone on the y axis
  94958. * @param z The amount to scale the bone on the z axis
  94959. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  94960. */
  94961. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  94962. /**
  94963. * Set the bone scaling in local space
  94964. * @param scale defines the scaling vector
  94965. */
  94966. setScale(scale: Vector3): void;
  94967. /**
  94968. * Gets the current scaling in local space
  94969. * @returns the current scaling vector
  94970. */
  94971. getScale(): Vector3;
  94972. /**
  94973. * Gets the current scaling in local space and stores it in a target vector
  94974. * @param result defines the target vector
  94975. */
  94976. getScaleToRef(result: Vector3): void;
  94977. /**
  94978. * Set the yaw, pitch, and roll of the bone in local or world space
  94979. * @param yaw The rotation of the bone on the y axis
  94980. * @param pitch The rotation of the bone on the x axis
  94981. * @param roll The rotation of the bone on the z axis
  94982. * @param space The space that the axes of rotation are in
  94983. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94984. */
  94985. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  94986. /**
  94987. * Add a rotation to the bone on an axis in local or world space
  94988. * @param axis The axis to rotate the bone on
  94989. * @param amount The amount to rotate the bone
  94990. * @param space The space that the axis is in
  94991. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94992. */
  94993. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  94994. /**
  94995. * Set the rotation of the bone to a particular axis angle in local or world space
  94996. * @param axis The axis to rotate the bone on
  94997. * @param angle The angle that the bone should be rotated to
  94998. * @param space The space that the axis is in
  94999. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95000. */
  95001. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  95002. /**
  95003. * Set the euler rotation of the bone in local of world space
  95004. * @param rotation The euler rotation that the bone should be set to
  95005. * @param space The space that the rotation is in
  95006. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95007. */
  95008. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95009. /**
  95010. * Set the quaternion rotation of the bone in local of world space
  95011. * @param quat The quaternion rotation that the bone should be set to
  95012. * @param space The space that the rotation is in
  95013. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95014. */
  95015. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  95016. /**
  95017. * Set the rotation matrix of the bone in local of world space
  95018. * @param rotMat The rotation matrix that the bone should be set to
  95019. * @param space The space that the rotation is in
  95020. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95021. */
  95022. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  95023. private _rotateWithMatrix;
  95024. private _getNegativeRotationToRef;
  95025. /**
  95026. * Get the position of the bone in local or world space
  95027. * @param space The space that the returned position is in
  95028. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95029. * @returns The position of the bone
  95030. */
  95031. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95032. /**
  95033. * Copy the position of the bone to a vector3 in local or world space
  95034. * @param space The space that the returned position is in
  95035. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95036. * @param result The vector3 to copy the position to
  95037. */
  95038. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  95039. /**
  95040. * Get the absolute position of the bone (world space)
  95041. * @param mesh The mesh that this bone is attached to
  95042. * @returns The absolute position of the bone
  95043. */
  95044. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  95045. /**
  95046. * Copy the absolute position of the bone (world space) to the result param
  95047. * @param mesh The mesh that this bone is attached to
  95048. * @param result The vector3 to copy the absolute position to
  95049. */
  95050. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  95051. /**
  95052. * Compute the absolute transforms of this bone and its children
  95053. */
  95054. computeAbsoluteTransforms(): void;
  95055. /**
  95056. * Get the world direction from an axis that is in the local space of the bone
  95057. * @param localAxis The local direction that is used to compute the world direction
  95058. * @param mesh The mesh that this bone is attached to
  95059. * @returns The world direction
  95060. */
  95061. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95062. /**
  95063. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  95064. * @param localAxis The local direction that is used to compute the world direction
  95065. * @param mesh The mesh that this bone is attached to
  95066. * @param result The vector3 that the world direction will be copied to
  95067. */
  95068. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95069. /**
  95070. * Get the euler rotation of the bone in local or world space
  95071. * @param space The space that the rotation should be in
  95072. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95073. * @returns The euler rotation
  95074. */
  95075. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95076. /**
  95077. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  95078. * @param space The space that the rotation should be in
  95079. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95080. * @param result The vector3 that the rotation should be copied to
  95081. */
  95082. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95083. /**
  95084. * Get the quaternion rotation of the bone in either local or world space
  95085. * @param space The space that the rotation should be in
  95086. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95087. * @returns The quaternion rotation
  95088. */
  95089. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  95090. /**
  95091. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  95092. * @param space The space that the rotation should be in
  95093. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95094. * @param result The quaternion that the rotation should be copied to
  95095. */
  95096. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  95097. /**
  95098. * Get the rotation matrix of the bone in local or world space
  95099. * @param space The space that the rotation should be in
  95100. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95101. * @returns The rotation matrix
  95102. */
  95103. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  95104. /**
  95105. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  95106. * @param space The space that the rotation should be in
  95107. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95108. * @param result The quaternion that the rotation should be copied to
  95109. */
  95110. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  95111. /**
  95112. * Get the world position of a point that is in the local space of the bone
  95113. * @param position The local position
  95114. * @param mesh The mesh that this bone is attached to
  95115. * @returns The world position
  95116. */
  95117. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95118. /**
  95119. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  95120. * @param position The local position
  95121. * @param mesh The mesh that this bone is attached to
  95122. * @param result The vector3 that the world position should be copied to
  95123. */
  95124. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95125. /**
  95126. * Get the local position of a point that is in world space
  95127. * @param position The world position
  95128. * @param mesh The mesh that this bone is attached to
  95129. * @returns The local position
  95130. */
  95131. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95132. /**
  95133. * Get the local position of a point that is in world space and copy it to the result param
  95134. * @param position The world position
  95135. * @param mesh The mesh that this bone is attached to
  95136. * @param result The vector3 that the local position should be copied to
  95137. */
  95138. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95139. }
  95140. }
  95141. declare module BABYLON {
  95142. /**
  95143. * Defines a runtime animation
  95144. */
  95145. export class RuntimeAnimation {
  95146. private _events;
  95147. /**
  95148. * The current frame of the runtime animation
  95149. */
  95150. private _currentFrame;
  95151. /**
  95152. * The animation used by the runtime animation
  95153. */
  95154. private _animation;
  95155. /**
  95156. * The target of the runtime animation
  95157. */
  95158. private _target;
  95159. /**
  95160. * The initiating animatable
  95161. */
  95162. private _host;
  95163. /**
  95164. * The original value of the runtime animation
  95165. */
  95166. private _originalValue;
  95167. /**
  95168. * The original blend value of the runtime animation
  95169. */
  95170. private _originalBlendValue;
  95171. /**
  95172. * The offsets cache of the runtime animation
  95173. */
  95174. private _offsetsCache;
  95175. /**
  95176. * The high limits cache of the runtime animation
  95177. */
  95178. private _highLimitsCache;
  95179. /**
  95180. * Specifies if the runtime animation has been stopped
  95181. */
  95182. private _stopped;
  95183. /**
  95184. * The blending factor of the runtime animation
  95185. */
  95186. private _blendingFactor;
  95187. /**
  95188. * The BabylonJS scene
  95189. */
  95190. private _scene;
  95191. /**
  95192. * The current value of the runtime animation
  95193. */
  95194. private _currentValue;
  95195. /** @hidden */
  95196. _animationState: _IAnimationState;
  95197. /**
  95198. * The active target of the runtime animation
  95199. */
  95200. private _activeTargets;
  95201. private _currentActiveTarget;
  95202. private _directTarget;
  95203. /**
  95204. * The target path of the runtime animation
  95205. */
  95206. private _targetPath;
  95207. /**
  95208. * The weight of the runtime animation
  95209. */
  95210. private _weight;
  95211. /**
  95212. * The ratio offset of the runtime animation
  95213. */
  95214. private _ratioOffset;
  95215. /**
  95216. * The previous delay of the runtime animation
  95217. */
  95218. private _previousDelay;
  95219. /**
  95220. * The previous ratio of the runtime animation
  95221. */
  95222. private _previousRatio;
  95223. private _enableBlending;
  95224. private _keys;
  95225. private _minFrame;
  95226. private _maxFrame;
  95227. private _minValue;
  95228. private _maxValue;
  95229. private _targetIsArray;
  95230. /**
  95231. * Gets the current frame of the runtime animation
  95232. */
  95233. get currentFrame(): number;
  95234. /**
  95235. * Gets the weight of the runtime animation
  95236. */
  95237. get weight(): number;
  95238. /**
  95239. * Gets the current value of the runtime animation
  95240. */
  95241. get currentValue(): any;
  95242. /**
  95243. * Gets the target path of the runtime animation
  95244. */
  95245. get targetPath(): string;
  95246. /**
  95247. * Gets the actual target of the runtime animation
  95248. */
  95249. get target(): any;
  95250. /**
  95251. * Gets the additive state of the runtime animation
  95252. */
  95253. get isAdditive(): boolean;
  95254. /** @hidden */
  95255. _onLoop: () => void;
  95256. /**
  95257. * Create a new RuntimeAnimation object
  95258. * @param target defines the target of the animation
  95259. * @param animation defines the source animation object
  95260. * @param scene defines the hosting scene
  95261. * @param host defines the initiating Animatable
  95262. */
  95263. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95264. private _preparePath;
  95265. /**
  95266. * Gets the animation from the runtime animation
  95267. */
  95268. get animation(): Animation;
  95269. /**
  95270. * Resets the runtime animation to the beginning
  95271. * @param restoreOriginal defines whether to restore the target property to the original value
  95272. */
  95273. reset(restoreOriginal?: boolean): void;
  95274. /**
  95275. * Specifies if the runtime animation is stopped
  95276. * @returns Boolean specifying if the runtime animation is stopped
  95277. */
  95278. isStopped(): boolean;
  95279. /**
  95280. * Disposes of the runtime animation
  95281. */
  95282. dispose(): void;
  95283. /**
  95284. * Apply the interpolated value to the target
  95285. * @param currentValue defines the value computed by the animation
  95286. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  95287. */
  95288. setValue(currentValue: any, weight: number): void;
  95289. private _getOriginalValues;
  95290. private _setValue;
  95291. /**
  95292. * Gets the loop pmode of the runtime animation
  95293. * @returns Loop Mode
  95294. */
  95295. private _getCorrectLoopMode;
  95296. /**
  95297. * Move the current animation to a given frame
  95298. * @param frame defines the frame to move to
  95299. */
  95300. goToFrame(frame: number): void;
  95301. /**
  95302. * @hidden Internal use only
  95303. */
  95304. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  95305. /**
  95306. * Execute the current animation
  95307. * @param delay defines the delay to add to the current frame
  95308. * @param from defines the lower bound of the animation range
  95309. * @param to defines the upper bound of the animation range
  95310. * @param loop defines if the current animation must loop
  95311. * @param speedRatio defines the current speed ratio
  95312. * @param weight defines the weight of the animation (default is -1 so no weight)
  95313. * @param onLoop optional callback called when animation loops
  95314. * @returns a boolean indicating if the animation is running
  95315. */
  95316. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  95317. }
  95318. }
  95319. declare module BABYLON {
  95320. /**
  95321. * Class used to store an actual running animation
  95322. */
  95323. export class Animatable {
  95324. /** defines the target object */
  95325. target: any;
  95326. /** defines the starting frame number (default is 0) */
  95327. fromFrame: number;
  95328. /** defines the ending frame number (default is 100) */
  95329. toFrame: number;
  95330. /** defines if the animation must loop (default is false) */
  95331. loopAnimation: boolean;
  95332. /** defines a callback to call when animation ends if it is not looping */
  95333. onAnimationEnd?: (() => void) | null | undefined;
  95334. /** defines a callback to call when animation loops */
  95335. onAnimationLoop?: (() => void) | null | undefined;
  95336. /** defines whether the animation should be evaluated additively */
  95337. isAdditive: boolean;
  95338. private _localDelayOffset;
  95339. private _pausedDelay;
  95340. private _runtimeAnimations;
  95341. private _paused;
  95342. private _scene;
  95343. private _speedRatio;
  95344. private _weight;
  95345. private _syncRoot;
  95346. /**
  95347. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  95348. * This will only apply for non looping animation (default is true)
  95349. */
  95350. disposeOnEnd: boolean;
  95351. /**
  95352. * Gets a boolean indicating if the animation has started
  95353. */
  95354. animationStarted: boolean;
  95355. /**
  95356. * Observer raised when the animation ends
  95357. */
  95358. onAnimationEndObservable: Observable<Animatable>;
  95359. /**
  95360. * Observer raised when the animation loops
  95361. */
  95362. onAnimationLoopObservable: Observable<Animatable>;
  95363. /**
  95364. * Gets the root Animatable used to synchronize and normalize animations
  95365. */
  95366. get syncRoot(): Nullable<Animatable>;
  95367. /**
  95368. * Gets the current frame of the first RuntimeAnimation
  95369. * Used to synchronize Animatables
  95370. */
  95371. get masterFrame(): number;
  95372. /**
  95373. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  95374. */
  95375. get weight(): number;
  95376. set weight(value: number);
  95377. /**
  95378. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  95379. */
  95380. get speedRatio(): number;
  95381. set speedRatio(value: number);
  95382. /**
  95383. * Creates a new Animatable
  95384. * @param scene defines the hosting scene
  95385. * @param target defines the target object
  95386. * @param fromFrame defines the starting frame number (default is 0)
  95387. * @param toFrame defines the ending frame number (default is 100)
  95388. * @param loopAnimation defines if the animation must loop (default is false)
  95389. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  95390. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  95391. * @param animations defines a group of animation to add to the new Animatable
  95392. * @param onAnimationLoop defines a callback to call when animation loops
  95393. * @param isAdditive defines whether the animation should be evaluated additively
  95394. */
  95395. constructor(scene: Scene,
  95396. /** defines the target object */
  95397. target: any,
  95398. /** defines the starting frame number (default is 0) */
  95399. fromFrame?: number,
  95400. /** defines the ending frame number (default is 100) */
  95401. toFrame?: number,
  95402. /** defines if the animation must loop (default is false) */
  95403. loopAnimation?: boolean, speedRatio?: number,
  95404. /** defines a callback to call when animation ends if it is not looping */
  95405. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  95406. /** defines a callback to call when animation loops */
  95407. onAnimationLoop?: (() => void) | null | undefined,
  95408. /** defines whether the animation should be evaluated additively */
  95409. isAdditive?: boolean);
  95410. /**
  95411. * Synchronize and normalize current Animatable with a source Animatable
  95412. * This is useful when using animation weights and when animations are not of the same length
  95413. * @param root defines the root Animatable to synchronize with
  95414. * @returns the current Animatable
  95415. */
  95416. syncWith(root: Animatable): Animatable;
  95417. /**
  95418. * Gets the list of runtime animations
  95419. * @returns an array of RuntimeAnimation
  95420. */
  95421. getAnimations(): RuntimeAnimation[];
  95422. /**
  95423. * Adds more animations to the current animatable
  95424. * @param target defines the target of the animations
  95425. * @param animations defines the new animations to add
  95426. */
  95427. appendAnimations(target: any, animations: Animation[]): void;
  95428. /**
  95429. * Gets the source animation for a specific property
  95430. * @param property defines the propertyu to look for
  95431. * @returns null or the source animation for the given property
  95432. */
  95433. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  95434. /**
  95435. * Gets the runtime animation for a specific property
  95436. * @param property defines the propertyu to look for
  95437. * @returns null or the runtime animation for the given property
  95438. */
  95439. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  95440. /**
  95441. * Resets the animatable to its original state
  95442. */
  95443. reset(): void;
  95444. /**
  95445. * Allows the animatable to blend with current running animations
  95446. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95447. * @param blendingSpeed defines the blending speed to use
  95448. */
  95449. enableBlending(blendingSpeed: number): void;
  95450. /**
  95451. * Disable animation blending
  95452. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95453. */
  95454. disableBlending(): void;
  95455. /**
  95456. * Jump directly to a given frame
  95457. * @param frame defines the frame to jump to
  95458. */
  95459. goToFrame(frame: number): void;
  95460. /**
  95461. * Pause the animation
  95462. */
  95463. pause(): void;
  95464. /**
  95465. * Restart the animation
  95466. */
  95467. restart(): void;
  95468. private _raiseOnAnimationEnd;
  95469. /**
  95470. * Stop and delete the current animation
  95471. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  95472. * @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)
  95473. */
  95474. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  95475. /**
  95476. * Wait asynchronously for the animation to end
  95477. * @returns a promise which will be fullfilled when the animation ends
  95478. */
  95479. waitAsync(): Promise<Animatable>;
  95480. /** @hidden */
  95481. _animate(delay: number): boolean;
  95482. }
  95483. interface Scene {
  95484. /** @hidden */
  95485. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  95486. /** @hidden */
  95487. _processLateAnimationBindingsForMatrices(holder: {
  95488. totalWeight: number;
  95489. totalAdditiveWeight: number;
  95490. animations: RuntimeAnimation[];
  95491. additiveAnimations: RuntimeAnimation[];
  95492. originalValue: Matrix;
  95493. }): any;
  95494. /** @hidden */
  95495. _processLateAnimationBindingsForQuaternions(holder: {
  95496. totalWeight: number;
  95497. totalAdditiveWeight: number;
  95498. animations: RuntimeAnimation[];
  95499. additiveAnimations: RuntimeAnimation[];
  95500. originalValue: Quaternion;
  95501. }, refQuaternion: Quaternion): Quaternion;
  95502. /** @hidden */
  95503. _processLateAnimationBindings(): void;
  95504. /**
  95505. * Will start the animation sequence of a given target
  95506. * @param target defines the target
  95507. * @param from defines from which frame should animation start
  95508. * @param to defines until which frame should animation run.
  95509. * @param weight defines the weight to apply to the animation (1.0 by default)
  95510. * @param loop defines if the animation loops
  95511. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95512. * @param onAnimationEnd defines the function to be executed when the animation ends
  95513. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95514. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95515. * @param onAnimationLoop defines the callback to call when an animation loops
  95516. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95517. * @returns the animatable object created for this animation
  95518. */
  95519. 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;
  95520. /**
  95521. * Will start the animation sequence of a given target
  95522. * @param target defines the target
  95523. * @param from defines from which frame should animation start
  95524. * @param to defines until which frame should animation run.
  95525. * @param loop defines if the animation loops
  95526. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95527. * @param onAnimationEnd defines the function to be executed when the animation ends
  95528. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95529. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95530. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  95531. * @param onAnimationLoop defines the callback to call when an animation loops
  95532. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95533. * @returns the animatable object created for this animation
  95534. */
  95535. 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;
  95536. /**
  95537. * Will start the animation sequence of a given target and its hierarchy
  95538. * @param target defines the target
  95539. * @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.
  95540. * @param from defines from which frame should animation start
  95541. * @param to defines until which frame should animation run.
  95542. * @param loop defines if the animation loops
  95543. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95544. * @param onAnimationEnd defines the function to be executed when the animation ends
  95545. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95546. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95547. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95548. * @param onAnimationLoop defines the callback to call when an animation loops
  95549. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95550. * @returns the list of created animatables
  95551. */
  95552. 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[];
  95553. /**
  95554. * Begin a new animation on a given node
  95555. * @param target defines the target where the animation will take place
  95556. * @param animations defines the list of animations to start
  95557. * @param from defines the initial value
  95558. * @param to defines the final value
  95559. * @param loop defines if you want animation to loop (off by default)
  95560. * @param speedRatio defines the speed ratio to apply to all animations
  95561. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95562. * @param onAnimationLoop defines the callback to call when an animation loops
  95563. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95564. * @returns the list of created animatables
  95565. */
  95566. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95567. /**
  95568. * Begin a new animation on a given node and its hierarchy
  95569. * @param target defines the root node where the animation will take place
  95570. * @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.
  95571. * @param animations defines the list of animations to start
  95572. * @param from defines the initial value
  95573. * @param to defines the final value
  95574. * @param loop defines if you want animation to loop (off by default)
  95575. * @param speedRatio defines the speed ratio to apply to all animations
  95576. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95577. * @param onAnimationLoop defines the callback to call when an animation loops
  95578. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95579. * @returns the list of animatables created for all nodes
  95580. */
  95581. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  95582. /**
  95583. * Gets the animatable associated with a specific target
  95584. * @param target defines the target of the animatable
  95585. * @returns the required animatable if found
  95586. */
  95587. getAnimatableByTarget(target: any): Nullable<Animatable>;
  95588. /**
  95589. * Gets all animatables associated with a given target
  95590. * @param target defines the target to look animatables for
  95591. * @returns an array of Animatables
  95592. */
  95593. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  95594. /**
  95595. * Stops and removes all animations that have been applied to the scene
  95596. */
  95597. stopAllAnimations(): void;
  95598. /**
  95599. * Gets the current delta time used by animation engine
  95600. */
  95601. deltaTime: number;
  95602. }
  95603. interface Bone {
  95604. /**
  95605. * Copy an animation range from another bone
  95606. * @param source defines the source bone
  95607. * @param rangeName defines the range name to copy
  95608. * @param frameOffset defines the frame offset
  95609. * @param rescaleAsRequired defines if rescaling must be applied if required
  95610. * @param skelDimensionsRatio defines the scaling ratio
  95611. * @returns true if operation was successful
  95612. */
  95613. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  95614. }
  95615. }
  95616. declare module BABYLON {
  95617. /**
  95618. * Class used to handle skinning animations
  95619. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95620. */
  95621. export class Skeleton implements IAnimatable {
  95622. /** defines the skeleton name */
  95623. name: string;
  95624. /** defines the skeleton Id */
  95625. id: string;
  95626. /**
  95627. * Defines the list of child bones
  95628. */
  95629. bones: Bone[];
  95630. /**
  95631. * Defines an estimate of the dimension of the skeleton at rest
  95632. */
  95633. dimensionsAtRest: Vector3;
  95634. /**
  95635. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  95636. */
  95637. needInitialSkinMatrix: boolean;
  95638. /**
  95639. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  95640. */
  95641. overrideMesh: Nullable<AbstractMesh>;
  95642. /**
  95643. * Gets the list of animations attached to this skeleton
  95644. */
  95645. animations: Array<Animation>;
  95646. private _scene;
  95647. private _isDirty;
  95648. private _transformMatrices;
  95649. private _transformMatrixTexture;
  95650. private _meshesWithPoseMatrix;
  95651. private _animatables;
  95652. private _identity;
  95653. private _synchronizedWithMesh;
  95654. private _ranges;
  95655. private _lastAbsoluteTransformsUpdateId;
  95656. private _canUseTextureForBones;
  95657. private _uniqueId;
  95658. /** @hidden */
  95659. _numBonesWithLinkedTransformNode: number;
  95660. /** @hidden */
  95661. _hasWaitingData: Nullable<boolean>;
  95662. /** @hidden */
  95663. _waitingOverrideMeshId: Nullable<string>;
  95664. /**
  95665. * Specifies if the skeleton should be serialized
  95666. */
  95667. doNotSerialize: boolean;
  95668. private _useTextureToStoreBoneMatrices;
  95669. /**
  95670. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  95671. * Please note that this option is not available if the hardware does not support it
  95672. */
  95673. get useTextureToStoreBoneMatrices(): boolean;
  95674. set useTextureToStoreBoneMatrices(value: boolean);
  95675. private _animationPropertiesOverride;
  95676. /**
  95677. * Gets or sets the animation properties override
  95678. */
  95679. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95680. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  95681. /**
  95682. * List of inspectable custom properties (used by the Inspector)
  95683. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95684. */
  95685. inspectableCustomProperties: IInspectable[];
  95686. /**
  95687. * An observable triggered before computing the skeleton's matrices
  95688. */
  95689. onBeforeComputeObservable: Observable<Skeleton>;
  95690. /**
  95691. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  95692. */
  95693. get isUsingTextureForMatrices(): boolean;
  95694. /**
  95695. * Gets the unique ID of this skeleton
  95696. */
  95697. get uniqueId(): number;
  95698. /**
  95699. * Creates a new skeleton
  95700. * @param name defines the skeleton name
  95701. * @param id defines the skeleton Id
  95702. * @param scene defines the hosting scene
  95703. */
  95704. constructor(
  95705. /** defines the skeleton name */
  95706. name: string,
  95707. /** defines the skeleton Id */
  95708. id: string, scene: Scene);
  95709. /**
  95710. * Gets the current object class name.
  95711. * @return the class name
  95712. */
  95713. getClassName(): string;
  95714. /**
  95715. * Returns an array containing the root bones
  95716. * @returns an array containing the root bones
  95717. */
  95718. getChildren(): Array<Bone>;
  95719. /**
  95720. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  95721. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95722. * @returns a Float32Array containing matrices data
  95723. */
  95724. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  95725. /**
  95726. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  95727. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95728. * @returns a raw texture containing the data
  95729. */
  95730. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  95731. /**
  95732. * Gets the current hosting scene
  95733. * @returns a scene object
  95734. */
  95735. getScene(): Scene;
  95736. /**
  95737. * Gets a string representing the current skeleton data
  95738. * @param fullDetails defines a boolean indicating if we want a verbose version
  95739. * @returns a string representing the current skeleton data
  95740. */
  95741. toString(fullDetails?: boolean): string;
  95742. /**
  95743. * Get bone's index searching by name
  95744. * @param name defines bone's name to search for
  95745. * @return the indice of the bone. Returns -1 if not found
  95746. */
  95747. getBoneIndexByName(name: string): number;
  95748. /**
  95749. * Creater a new animation range
  95750. * @param name defines the name of the range
  95751. * @param from defines the start key
  95752. * @param to defines the end key
  95753. */
  95754. createAnimationRange(name: string, from: number, to: number): void;
  95755. /**
  95756. * Delete a specific animation range
  95757. * @param name defines the name of the range
  95758. * @param deleteFrames defines if frames must be removed as well
  95759. */
  95760. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95761. /**
  95762. * Gets a specific animation range
  95763. * @param name defines the name of the range to look for
  95764. * @returns the requested animation range or null if not found
  95765. */
  95766. getAnimationRange(name: string): Nullable<AnimationRange>;
  95767. /**
  95768. * Gets the list of all animation ranges defined on this skeleton
  95769. * @returns an array
  95770. */
  95771. getAnimationRanges(): Nullable<AnimationRange>[];
  95772. /**
  95773. * Copy animation range from a source skeleton.
  95774. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  95775. * @param source defines the source skeleton
  95776. * @param name defines the name of the range to copy
  95777. * @param rescaleAsRequired defines if rescaling must be applied if required
  95778. * @returns true if operation was successful
  95779. */
  95780. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  95781. /**
  95782. * Forces the skeleton to go to rest pose
  95783. */
  95784. returnToRest(): void;
  95785. private _getHighestAnimationFrame;
  95786. /**
  95787. * Begin a specific animation range
  95788. * @param name defines the name of the range to start
  95789. * @param loop defines if looping must be turned on (false by default)
  95790. * @param speedRatio defines the speed ratio to apply (1 by default)
  95791. * @param onAnimationEnd defines a callback which will be called when animation will end
  95792. * @returns a new animatable
  95793. */
  95794. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95795. /**
  95796. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  95797. * @param skeleton defines the Skeleton containing the animation range to convert
  95798. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  95799. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  95800. * @returns the original skeleton
  95801. */
  95802. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  95803. /** @hidden */
  95804. _markAsDirty(): void;
  95805. /** @hidden */
  95806. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95807. /** @hidden */
  95808. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95809. private _computeTransformMatrices;
  95810. /**
  95811. * Build all resources required to render a skeleton
  95812. */
  95813. prepare(): void;
  95814. /**
  95815. * Gets the list of animatables currently running for this skeleton
  95816. * @returns an array of animatables
  95817. */
  95818. getAnimatables(): IAnimatable[];
  95819. /**
  95820. * Clone the current skeleton
  95821. * @param name defines the name of the new skeleton
  95822. * @param id defines the id of the new skeleton
  95823. * @returns the new skeleton
  95824. */
  95825. clone(name: string, id?: string): Skeleton;
  95826. /**
  95827. * Enable animation blending for this skeleton
  95828. * @param blendingSpeed defines the blending speed to apply
  95829. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95830. */
  95831. enableBlending(blendingSpeed?: number): void;
  95832. /**
  95833. * Releases all resources associated with the current skeleton
  95834. */
  95835. dispose(): void;
  95836. /**
  95837. * Serialize the skeleton in a JSON object
  95838. * @returns a JSON object
  95839. */
  95840. serialize(): any;
  95841. /**
  95842. * Creates a new skeleton from serialized data
  95843. * @param parsedSkeleton defines the serialized data
  95844. * @param scene defines the hosting scene
  95845. * @returns a new skeleton
  95846. */
  95847. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  95848. /**
  95849. * Compute all node absolute transforms
  95850. * @param forceUpdate defines if computation must be done even if cache is up to date
  95851. */
  95852. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  95853. /**
  95854. * Gets the root pose matrix
  95855. * @returns a matrix
  95856. */
  95857. getPoseMatrix(): Nullable<Matrix>;
  95858. /**
  95859. * Sorts bones per internal index
  95860. */
  95861. sortBones(): void;
  95862. private _sortBones;
  95863. }
  95864. }
  95865. declare module BABYLON {
  95866. /**
  95867. * Creates an instance based on a source mesh.
  95868. */
  95869. export class InstancedMesh extends AbstractMesh {
  95870. private _sourceMesh;
  95871. private _currentLOD;
  95872. /** @hidden */
  95873. _indexInSourceMeshInstanceArray: number;
  95874. constructor(name: string, source: Mesh);
  95875. /**
  95876. * Returns the string "InstancedMesh".
  95877. */
  95878. getClassName(): string;
  95879. /** Gets the list of lights affecting that mesh */
  95880. get lightSources(): Light[];
  95881. _resyncLightSources(): void;
  95882. _resyncLightSource(light: Light): void;
  95883. _removeLightSource(light: Light, dispose: boolean): void;
  95884. /**
  95885. * If the source mesh receives shadows
  95886. */
  95887. get receiveShadows(): boolean;
  95888. /**
  95889. * The material of the source mesh
  95890. */
  95891. get material(): Nullable<Material>;
  95892. /**
  95893. * Visibility of the source mesh
  95894. */
  95895. get visibility(): number;
  95896. /**
  95897. * Skeleton of the source mesh
  95898. */
  95899. get skeleton(): Nullable<Skeleton>;
  95900. /**
  95901. * Rendering ground id of the source mesh
  95902. */
  95903. get renderingGroupId(): number;
  95904. set renderingGroupId(value: number);
  95905. /**
  95906. * Returns the total number of vertices (integer).
  95907. */
  95908. getTotalVertices(): number;
  95909. /**
  95910. * Returns a positive integer : the total number of indices in this mesh geometry.
  95911. * @returns the numner of indices or zero if the mesh has no geometry.
  95912. */
  95913. getTotalIndices(): number;
  95914. /**
  95915. * The source mesh of the instance
  95916. */
  95917. get sourceMesh(): Mesh;
  95918. /**
  95919. * Creates a new InstancedMesh object from the mesh model.
  95920. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  95921. * @param name defines the name of the new instance
  95922. * @returns a new InstancedMesh
  95923. */
  95924. createInstance(name: string): InstancedMesh;
  95925. /**
  95926. * Is this node ready to be used/rendered
  95927. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95928. * @return {boolean} is it ready
  95929. */
  95930. isReady(completeCheck?: boolean): boolean;
  95931. /**
  95932. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  95933. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  95934. * @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.
  95935. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  95936. */
  95937. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  95938. /**
  95939. * Sets the vertex data of the mesh geometry for the requested `kind`.
  95940. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  95941. * The `data` are either a numeric array either a Float32Array.
  95942. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  95943. * 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).
  95944. * Note that a new underlying VertexBuffer object is created each call.
  95945. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  95946. *
  95947. * Possible `kind` values :
  95948. * - VertexBuffer.PositionKind
  95949. * - VertexBuffer.UVKind
  95950. * - VertexBuffer.UV2Kind
  95951. * - VertexBuffer.UV3Kind
  95952. * - VertexBuffer.UV4Kind
  95953. * - VertexBuffer.UV5Kind
  95954. * - VertexBuffer.UV6Kind
  95955. * - VertexBuffer.ColorKind
  95956. * - VertexBuffer.MatricesIndicesKind
  95957. * - VertexBuffer.MatricesIndicesExtraKind
  95958. * - VertexBuffer.MatricesWeightsKind
  95959. * - VertexBuffer.MatricesWeightsExtraKind
  95960. *
  95961. * Returns the Mesh.
  95962. */
  95963. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  95964. /**
  95965. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  95966. * If the mesh has no geometry, it is simply returned as it is.
  95967. * The `data` are either a numeric array either a Float32Array.
  95968. * No new underlying VertexBuffer object is created.
  95969. * 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.
  95970. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  95971. *
  95972. * Possible `kind` values :
  95973. * - VertexBuffer.PositionKind
  95974. * - VertexBuffer.UVKind
  95975. * - VertexBuffer.UV2Kind
  95976. * - VertexBuffer.UV3Kind
  95977. * - VertexBuffer.UV4Kind
  95978. * - VertexBuffer.UV5Kind
  95979. * - VertexBuffer.UV6Kind
  95980. * - VertexBuffer.ColorKind
  95981. * - VertexBuffer.MatricesIndicesKind
  95982. * - VertexBuffer.MatricesIndicesExtraKind
  95983. * - VertexBuffer.MatricesWeightsKind
  95984. * - VertexBuffer.MatricesWeightsExtraKind
  95985. *
  95986. * Returns the Mesh.
  95987. */
  95988. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  95989. /**
  95990. * Sets the mesh indices.
  95991. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  95992. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  95993. * This method creates a new index buffer each call.
  95994. * Returns the Mesh.
  95995. */
  95996. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  95997. /**
  95998. * Boolean : True if the mesh owns the requested kind of data.
  95999. */
  96000. isVerticesDataPresent(kind: string): boolean;
  96001. /**
  96002. * Returns an array of indices (IndicesArray).
  96003. */
  96004. getIndices(): Nullable<IndicesArray>;
  96005. get _positions(): Nullable<Vector3[]>;
  96006. /**
  96007. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  96008. * This means the mesh underlying bounding box and sphere are recomputed.
  96009. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  96010. * @returns the current mesh
  96011. */
  96012. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  96013. /** @hidden */
  96014. _preActivate(): InstancedMesh;
  96015. /** @hidden */
  96016. _activate(renderId: number, intermediateRendering: boolean): boolean;
  96017. /** @hidden */
  96018. _postActivate(): void;
  96019. getWorldMatrix(): Matrix;
  96020. get isAnInstance(): boolean;
  96021. /**
  96022. * Returns the current associated LOD AbstractMesh.
  96023. */
  96024. getLOD(camera: Camera): AbstractMesh;
  96025. /** @hidden */
  96026. _preActivateForIntermediateRendering(renderId: number): Mesh;
  96027. /** @hidden */
  96028. _syncSubMeshes(): InstancedMesh;
  96029. /** @hidden */
  96030. _generatePointsArray(): boolean;
  96031. /** @hidden */
  96032. _updateBoundingInfo(): AbstractMesh;
  96033. /**
  96034. * Creates a new InstancedMesh from the current mesh.
  96035. * - name (string) : the cloned mesh name
  96036. * - newParent (optional Node) : the optional Node to parent the clone to.
  96037. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  96038. *
  96039. * Returns the clone.
  96040. */
  96041. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  96042. /**
  96043. * Disposes the InstancedMesh.
  96044. * Returns nothing.
  96045. */
  96046. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96047. }
  96048. interface Mesh {
  96049. /**
  96050. * Register a custom buffer that will be instanced
  96051. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96052. * @param kind defines the buffer kind
  96053. * @param stride defines the stride in floats
  96054. */
  96055. registerInstancedBuffer(kind: string, stride: number): void;
  96056. /**
  96057. * true to use the edge renderer for all instances of this mesh
  96058. */
  96059. edgesShareWithInstances: boolean;
  96060. /** @hidden */
  96061. _userInstancedBuffersStorage: {
  96062. data: {
  96063. [key: string]: Float32Array;
  96064. };
  96065. sizes: {
  96066. [key: string]: number;
  96067. };
  96068. vertexBuffers: {
  96069. [key: string]: Nullable<VertexBuffer>;
  96070. };
  96071. strides: {
  96072. [key: string]: number;
  96073. };
  96074. };
  96075. }
  96076. interface AbstractMesh {
  96077. /**
  96078. * Object used to store instanced buffers defined by user
  96079. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96080. */
  96081. instancedBuffers: {
  96082. [key: string]: any;
  96083. };
  96084. }
  96085. }
  96086. declare module BABYLON {
  96087. /**
  96088. * Defines the options associated with the creation of a shader material.
  96089. */
  96090. export interface IShaderMaterialOptions {
  96091. /**
  96092. * Does the material work in alpha blend mode
  96093. */
  96094. needAlphaBlending: boolean;
  96095. /**
  96096. * Does the material work in alpha test mode
  96097. */
  96098. needAlphaTesting: boolean;
  96099. /**
  96100. * The list of attribute names used in the shader
  96101. */
  96102. attributes: string[];
  96103. /**
  96104. * The list of unifrom names used in the shader
  96105. */
  96106. uniforms: string[];
  96107. /**
  96108. * The list of UBO names used in the shader
  96109. */
  96110. uniformBuffers: string[];
  96111. /**
  96112. * The list of sampler names used in the shader
  96113. */
  96114. samplers: string[];
  96115. /**
  96116. * The list of defines used in the shader
  96117. */
  96118. defines: string[];
  96119. }
  96120. /**
  96121. * 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.
  96122. *
  96123. * This returned material effects how the mesh will look based on the code in the shaders.
  96124. *
  96125. * @see https://doc.babylonjs.com/how_to/shader_material
  96126. */
  96127. export class ShaderMaterial extends Material {
  96128. private _shaderPath;
  96129. private _options;
  96130. private _textures;
  96131. private _textureArrays;
  96132. private _floats;
  96133. private _ints;
  96134. private _floatsArrays;
  96135. private _colors3;
  96136. private _colors3Arrays;
  96137. private _colors4;
  96138. private _colors4Arrays;
  96139. private _vectors2;
  96140. private _vectors3;
  96141. private _vectors4;
  96142. private _matrices;
  96143. private _matrixArrays;
  96144. private _matrices3x3;
  96145. private _matrices2x2;
  96146. private _vectors2Arrays;
  96147. private _vectors3Arrays;
  96148. private _vectors4Arrays;
  96149. private _cachedWorldViewMatrix;
  96150. private _cachedWorldViewProjectionMatrix;
  96151. private _renderId;
  96152. private _multiview;
  96153. private _cachedDefines;
  96154. /** Define the Url to load snippets */
  96155. static SnippetUrl: string;
  96156. /** Snippet ID if the material was created from the snippet server */
  96157. snippetId: string;
  96158. /**
  96159. * Instantiate a new shader material.
  96160. * 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.
  96161. * This returned material effects how the mesh will look based on the code in the shaders.
  96162. * @see https://doc.babylonjs.com/how_to/shader_material
  96163. * @param name Define the name of the material in the scene
  96164. * @param scene Define the scene the material belongs to
  96165. * @param shaderPath Defines the route to the shader code in one of three ways:
  96166. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  96167. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  96168. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  96169. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  96170. * @param options Define the options used to create the shader
  96171. */
  96172. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  96173. /**
  96174. * Gets the shader path used to define the shader code
  96175. * It can be modified to trigger a new compilation
  96176. */
  96177. get shaderPath(): any;
  96178. /**
  96179. * Sets the shader path used to define the shader code
  96180. * It can be modified to trigger a new compilation
  96181. */
  96182. set shaderPath(shaderPath: any);
  96183. /**
  96184. * Gets the options used to compile the shader.
  96185. * They can be modified to trigger a new compilation
  96186. */
  96187. get options(): IShaderMaterialOptions;
  96188. /**
  96189. * Gets the current class name of the material e.g. "ShaderMaterial"
  96190. * Mainly use in serialization.
  96191. * @returns the class name
  96192. */
  96193. getClassName(): string;
  96194. /**
  96195. * Specifies if the material will require alpha blending
  96196. * @returns a boolean specifying if alpha blending is needed
  96197. */
  96198. needAlphaBlending(): boolean;
  96199. /**
  96200. * Specifies if this material should be rendered in alpha test mode
  96201. * @returns a boolean specifying if an alpha test is needed.
  96202. */
  96203. needAlphaTesting(): boolean;
  96204. private _checkUniform;
  96205. /**
  96206. * Set a texture in the shader.
  96207. * @param name Define the name of the uniform samplers as defined in the shader
  96208. * @param texture Define the texture to bind to this sampler
  96209. * @return the material itself allowing "fluent" like uniform updates
  96210. */
  96211. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  96212. /**
  96213. * Set a texture array in the shader.
  96214. * @param name Define the name of the uniform sampler array as defined in the shader
  96215. * @param textures Define the list of textures to bind to this sampler
  96216. * @return the material itself allowing "fluent" like uniform updates
  96217. */
  96218. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  96219. /**
  96220. * Set a float in the shader.
  96221. * @param name Define the name of the uniform as defined in the shader
  96222. * @param value Define the value to give to the uniform
  96223. * @return the material itself allowing "fluent" like uniform updates
  96224. */
  96225. setFloat(name: string, value: number): ShaderMaterial;
  96226. /**
  96227. * Set a int in the shader.
  96228. * @param name Define the name of the uniform as defined in the shader
  96229. * @param value Define the value to give to the uniform
  96230. * @return the material itself allowing "fluent" like uniform updates
  96231. */
  96232. setInt(name: string, value: number): ShaderMaterial;
  96233. /**
  96234. * Set an array of floats in the shader.
  96235. * @param name Define the name of the uniform as defined in the shader
  96236. * @param value Define the value to give to the uniform
  96237. * @return the material itself allowing "fluent" like uniform updates
  96238. */
  96239. setFloats(name: string, value: number[]): ShaderMaterial;
  96240. /**
  96241. * Set a vec3 in the shader from a Color3.
  96242. * @param name Define the name of the uniform as defined in the shader
  96243. * @param value Define the value to give to the uniform
  96244. * @return the material itself allowing "fluent" like uniform updates
  96245. */
  96246. setColor3(name: string, value: Color3): ShaderMaterial;
  96247. /**
  96248. * Set a vec3 array in the shader from a Color3 array.
  96249. * @param name Define the name of the uniform as defined in the shader
  96250. * @param value Define the value to give to the uniform
  96251. * @return the material itself allowing "fluent" like uniform updates
  96252. */
  96253. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  96254. /**
  96255. * Set a vec4 in the shader from a Color4.
  96256. * @param name Define the name of the uniform as defined in the shader
  96257. * @param value Define the value to give to the uniform
  96258. * @return the material itself allowing "fluent" like uniform updates
  96259. */
  96260. setColor4(name: string, value: Color4): ShaderMaterial;
  96261. /**
  96262. * Set a vec4 array in the shader from a Color4 array.
  96263. * @param name Define the name of the uniform as defined in the shader
  96264. * @param value Define the value to give to the uniform
  96265. * @return the material itself allowing "fluent" like uniform updates
  96266. */
  96267. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96268. /**
  96269. * Set a vec2 in the shader from a Vector2.
  96270. * @param name Define the name of the uniform as defined in the shader
  96271. * @param value Define the value to give to the uniform
  96272. * @return the material itself allowing "fluent" like uniform updates
  96273. */
  96274. setVector2(name: string, value: Vector2): ShaderMaterial;
  96275. /**
  96276. * Set a vec3 in the shader from a Vector3.
  96277. * @param name Define the name of the uniform as defined in the shader
  96278. * @param value Define the value to give to the uniform
  96279. * @return the material itself allowing "fluent" like uniform updates
  96280. */
  96281. setVector3(name: string, value: Vector3): ShaderMaterial;
  96282. /**
  96283. * Set a vec4 in the shader from a Vector4.
  96284. * @param name Define the name of the uniform as defined in the shader
  96285. * @param value Define the value to give to the uniform
  96286. * @return the material itself allowing "fluent" like uniform updates
  96287. */
  96288. setVector4(name: string, value: Vector4): ShaderMaterial;
  96289. /**
  96290. * Set a mat4 in the shader from a Matrix.
  96291. * @param name Define the name of the uniform as defined in the shader
  96292. * @param value Define the value to give to the uniform
  96293. * @return the material itself allowing "fluent" like uniform updates
  96294. */
  96295. setMatrix(name: string, value: Matrix): ShaderMaterial;
  96296. /**
  96297. * Set a float32Array in the shader from a matrix array.
  96298. * @param name Define the name of the uniform as defined in the shader
  96299. * @param value Define the value to give to the uniform
  96300. * @return the material itself allowing "fluent" like uniform updates
  96301. */
  96302. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  96303. /**
  96304. * Set a mat3 in the shader from a Float32Array.
  96305. * @param name Define the name of the uniform as defined in the shader
  96306. * @param value Define the value to give to the uniform
  96307. * @return the material itself allowing "fluent" like uniform updates
  96308. */
  96309. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96310. /**
  96311. * Set a mat2 in the shader from a Float32Array.
  96312. * @param name Define the name of the uniform as defined in the shader
  96313. * @param value Define the value to give to the uniform
  96314. * @return the material itself allowing "fluent" like uniform updates
  96315. */
  96316. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96317. /**
  96318. * Set a vec2 array in the shader from a number array.
  96319. * @param name Define the name of the uniform as defined in the shader
  96320. * @param value Define the value to give to the uniform
  96321. * @return the material itself allowing "fluent" like uniform updates
  96322. */
  96323. setArray2(name: string, value: number[]): ShaderMaterial;
  96324. /**
  96325. * Set a vec3 array in the shader from a number array.
  96326. * @param name Define the name of the uniform as defined in the shader
  96327. * @param value Define the value to give to the uniform
  96328. * @return the material itself allowing "fluent" like uniform updates
  96329. */
  96330. setArray3(name: string, value: number[]): ShaderMaterial;
  96331. /**
  96332. * Set a vec4 array in the shader from a number array.
  96333. * @param name Define the name of the uniform as defined in the shader
  96334. * @param value Define the value to give to the uniform
  96335. * @return the material itself allowing "fluent" like uniform updates
  96336. */
  96337. setArray4(name: string, value: number[]): ShaderMaterial;
  96338. private _checkCache;
  96339. /**
  96340. * Specifies that the submesh is ready to be used
  96341. * @param mesh defines the mesh to check
  96342. * @param subMesh defines which submesh to check
  96343. * @param useInstances specifies that instances should be used
  96344. * @returns a boolean indicating that the submesh is ready or not
  96345. */
  96346. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  96347. /**
  96348. * Checks if the material is ready to render the requested mesh
  96349. * @param mesh Define the mesh to render
  96350. * @param useInstances Define whether or not the material is used with instances
  96351. * @returns true if ready, otherwise false
  96352. */
  96353. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  96354. /**
  96355. * Binds the world matrix to the material
  96356. * @param world defines the world transformation matrix
  96357. * @param effectOverride - If provided, use this effect instead of internal effect
  96358. */
  96359. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  96360. /**
  96361. * Binds the submesh to this material by preparing the effect and shader to draw
  96362. * @param world defines the world transformation matrix
  96363. * @param mesh defines the mesh containing the submesh
  96364. * @param subMesh defines the submesh to bind the material to
  96365. */
  96366. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  96367. /**
  96368. * Binds the material to the mesh
  96369. * @param world defines the world transformation matrix
  96370. * @param mesh defines the mesh to bind the material to
  96371. * @param effectOverride - If provided, use this effect instead of internal effect
  96372. */
  96373. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  96374. protected _afterBind(mesh?: Mesh): void;
  96375. /**
  96376. * Gets the active textures from the material
  96377. * @returns an array of textures
  96378. */
  96379. getActiveTextures(): BaseTexture[];
  96380. /**
  96381. * Specifies if the material uses a texture
  96382. * @param texture defines the texture to check against the material
  96383. * @returns a boolean specifying if the material uses the texture
  96384. */
  96385. hasTexture(texture: BaseTexture): boolean;
  96386. /**
  96387. * Makes a duplicate of the material, and gives it a new name
  96388. * @param name defines the new name for the duplicated material
  96389. * @returns the cloned material
  96390. */
  96391. clone(name: string): ShaderMaterial;
  96392. /**
  96393. * Disposes the material
  96394. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  96395. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  96396. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  96397. */
  96398. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  96399. /**
  96400. * Serializes this material in a JSON representation
  96401. * @returns the serialized material object
  96402. */
  96403. serialize(): any;
  96404. /**
  96405. * Creates a shader material from parsed shader material data
  96406. * @param source defines the JSON represnetation of the material
  96407. * @param scene defines the hosting scene
  96408. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96409. * @returns a new material
  96410. */
  96411. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  96412. /**
  96413. * Creates a new ShaderMaterial from a snippet saved in a remote file
  96414. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  96415. * @param url defines the url to load from
  96416. * @param scene defines the hosting scene
  96417. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96418. * @returns a promise that will resolve to the new ShaderMaterial
  96419. */
  96420. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96421. /**
  96422. * Creates a ShaderMaterial from a snippet saved by the Inspector
  96423. * @param snippetId defines the snippet to load
  96424. * @param scene defines the hosting scene
  96425. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96426. * @returns a promise that will resolve to the new ShaderMaterial
  96427. */
  96428. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96429. }
  96430. }
  96431. declare module BABYLON {
  96432. /** @hidden */
  96433. export var colorPixelShader: {
  96434. name: string;
  96435. shader: string;
  96436. };
  96437. }
  96438. declare module BABYLON {
  96439. /** @hidden */
  96440. export var colorVertexShader: {
  96441. name: string;
  96442. shader: string;
  96443. };
  96444. }
  96445. declare module BABYLON {
  96446. /**
  96447. * Line mesh
  96448. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  96449. */
  96450. export class LinesMesh extends Mesh {
  96451. /**
  96452. * If vertex color should be applied to the mesh
  96453. */
  96454. readonly useVertexColor?: boolean | undefined;
  96455. /**
  96456. * If vertex alpha should be applied to the mesh
  96457. */
  96458. readonly useVertexAlpha?: boolean | undefined;
  96459. /**
  96460. * Color of the line (Default: White)
  96461. */
  96462. color: Color3;
  96463. /**
  96464. * Alpha of the line (Default: 1)
  96465. */
  96466. alpha: number;
  96467. /**
  96468. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96469. * This margin is expressed in world space coordinates, so its value may vary.
  96470. * Default value is 0.1
  96471. */
  96472. intersectionThreshold: number;
  96473. private _colorShader;
  96474. private color4;
  96475. /**
  96476. * Creates a new LinesMesh
  96477. * @param name defines the name
  96478. * @param scene defines the hosting scene
  96479. * @param parent defines the parent mesh if any
  96480. * @param source defines the optional source LinesMesh used to clone data from
  96481. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  96482. * When false, achieved by calling a clone(), also passing False.
  96483. * This will make creation of children, recursive.
  96484. * @param useVertexColor defines if this LinesMesh supports vertex color
  96485. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  96486. */
  96487. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  96488. /**
  96489. * If vertex color should be applied to the mesh
  96490. */
  96491. useVertexColor?: boolean | undefined,
  96492. /**
  96493. * If vertex alpha should be applied to the mesh
  96494. */
  96495. useVertexAlpha?: boolean | undefined);
  96496. private _addClipPlaneDefine;
  96497. private _removeClipPlaneDefine;
  96498. isReady(): boolean;
  96499. /**
  96500. * Returns the string "LineMesh"
  96501. */
  96502. getClassName(): string;
  96503. /**
  96504. * @hidden
  96505. */
  96506. get material(): Material;
  96507. /**
  96508. * @hidden
  96509. */
  96510. set material(value: Material);
  96511. /**
  96512. * @hidden
  96513. */
  96514. get checkCollisions(): boolean;
  96515. /** @hidden */
  96516. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  96517. /** @hidden */
  96518. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  96519. /**
  96520. * Disposes of the line mesh
  96521. * @param doNotRecurse If children should be disposed
  96522. */
  96523. dispose(doNotRecurse?: boolean): void;
  96524. /**
  96525. * Returns a new LineMesh object cloned from the current one.
  96526. */
  96527. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  96528. /**
  96529. * Creates a new InstancedLinesMesh object from the mesh model.
  96530. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96531. * @param name defines the name of the new instance
  96532. * @returns a new InstancedLinesMesh
  96533. */
  96534. createInstance(name: string): InstancedLinesMesh;
  96535. }
  96536. /**
  96537. * Creates an instance based on a source LinesMesh
  96538. */
  96539. export class InstancedLinesMesh extends InstancedMesh {
  96540. /**
  96541. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96542. * This margin is expressed in world space coordinates, so its value may vary.
  96543. * Initilized with the intersectionThreshold value of the source LinesMesh
  96544. */
  96545. intersectionThreshold: number;
  96546. constructor(name: string, source: LinesMesh);
  96547. /**
  96548. * Returns the string "InstancedLinesMesh".
  96549. */
  96550. getClassName(): string;
  96551. }
  96552. }
  96553. declare module BABYLON {
  96554. /** @hidden */
  96555. export var linePixelShader: {
  96556. name: string;
  96557. shader: string;
  96558. };
  96559. }
  96560. declare module BABYLON {
  96561. /** @hidden */
  96562. export var lineVertexShader: {
  96563. name: string;
  96564. shader: string;
  96565. };
  96566. }
  96567. declare module BABYLON {
  96568. interface Scene {
  96569. /** @hidden */
  96570. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  96571. }
  96572. interface AbstractMesh {
  96573. /**
  96574. * Gets the edgesRenderer associated with the mesh
  96575. */
  96576. edgesRenderer: Nullable<EdgesRenderer>;
  96577. }
  96578. interface LinesMesh {
  96579. /**
  96580. * Enables the edge rendering mode on the mesh.
  96581. * This mode makes the mesh edges visible
  96582. * @param epsilon defines the maximal distance between two angles to detect a face
  96583. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96584. * @returns the currentAbstractMesh
  96585. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96586. */
  96587. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  96588. }
  96589. interface InstancedLinesMesh {
  96590. /**
  96591. * Enables the edge rendering mode on the mesh.
  96592. * This mode makes the mesh edges visible
  96593. * @param epsilon defines the maximal distance between two angles to detect a face
  96594. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96595. * @returns the current InstancedLinesMesh
  96596. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96597. */
  96598. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  96599. }
  96600. /**
  96601. * Defines the minimum contract an Edges renderer should follow.
  96602. */
  96603. export interface IEdgesRenderer extends IDisposable {
  96604. /**
  96605. * Gets or sets a boolean indicating if the edgesRenderer is active
  96606. */
  96607. isEnabled: boolean;
  96608. /**
  96609. * Renders the edges of the attached mesh,
  96610. */
  96611. render(): void;
  96612. /**
  96613. * Checks wether or not the edges renderer is ready to render.
  96614. * @return true if ready, otherwise false.
  96615. */
  96616. isReady(): boolean;
  96617. /**
  96618. * List of instances to render in case the source mesh has instances
  96619. */
  96620. customInstances: SmartArray<Matrix>;
  96621. }
  96622. /**
  96623. * Defines the additional options of the edges renderer
  96624. */
  96625. export interface IEdgesRendererOptions {
  96626. /**
  96627. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  96628. * If not defined, the default value is true
  96629. */
  96630. useAlternateEdgeFinder?: boolean;
  96631. /**
  96632. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  96633. * If not defined, the default value is true.
  96634. * 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)
  96635. * This option is used only if useAlternateEdgeFinder = true
  96636. */
  96637. useFastVertexMerger?: boolean;
  96638. /**
  96639. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  96640. * The default value is 1e-6
  96641. * This option is used only if useAlternateEdgeFinder = true
  96642. */
  96643. epsilonVertexMerge?: number;
  96644. /**
  96645. * 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
  96646. * 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.
  96647. * This option is used only if useAlternateEdgeFinder = true
  96648. */
  96649. applyTessellation?: boolean;
  96650. /**
  96651. * 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
  96652. * The default value is 1e-6
  96653. * This option is used only if useAlternateEdgeFinder = true
  96654. */
  96655. epsilonVertexAligned?: number;
  96656. }
  96657. /**
  96658. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  96659. */
  96660. export class EdgesRenderer implements IEdgesRenderer {
  96661. /**
  96662. * Define the size of the edges with an orthographic camera
  96663. */
  96664. edgesWidthScalerForOrthographic: number;
  96665. /**
  96666. * Define the size of the edges with a perspective camera
  96667. */
  96668. edgesWidthScalerForPerspective: number;
  96669. protected _source: AbstractMesh;
  96670. protected _linesPositions: number[];
  96671. protected _linesNormals: number[];
  96672. protected _linesIndices: number[];
  96673. protected _epsilon: number;
  96674. protected _indicesCount: number;
  96675. protected _lineShader: ShaderMaterial;
  96676. protected _ib: DataBuffer;
  96677. protected _buffers: {
  96678. [key: string]: Nullable<VertexBuffer>;
  96679. };
  96680. protected _buffersForInstances: {
  96681. [key: string]: Nullable<VertexBuffer>;
  96682. };
  96683. protected _checkVerticesInsteadOfIndices: boolean;
  96684. protected _options: Nullable<IEdgesRendererOptions>;
  96685. private _meshRebuildObserver;
  96686. private _meshDisposeObserver;
  96687. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  96688. isEnabled: boolean;
  96689. /**
  96690. * List of instances to render in case the source mesh has instances
  96691. */
  96692. customInstances: SmartArray<Matrix>;
  96693. private static GetShader;
  96694. /**
  96695. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  96696. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  96697. * @param source Mesh used to create edges
  96698. * @param epsilon sum of angles in adjacency to check for edge
  96699. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  96700. * @param generateEdgesLines - should generate Lines or only prepare resources.
  96701. * @param options The options to apply when generating the edges
  96702. */
  96703. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  96704. protected _prepareRessources(): void;
  96705. /** @hidden */
  96706. _rebuild(): void;
  96707. /**
  96708. * Releases the required resources for the edges renderer
  96709. */
  96710. dispose(): void;
  96711. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  96712. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  96713. /**
  96714. * Checks if the pair of p0 and p1 is en edge
  96715. * @param faceIndex
  96716. * @param edge
  96717. * @param faceNormals
  96718. * @param p0
  96719. * @param p1
  96720. * @private
  96721. */
  96722. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  96723. /**
  96724. * push line into the position, normal and index buffer
  96725. * @protected
  96726. */
  96727. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  96728. /**
  96729. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  96730. */
  96731. private _tessellateTriangle;
  96732. private _generateEdgesLinesAlternate;
  96733. /**
  96734. * Generates lines edges from adjacencjes
  96735. * @private
  96736. */
  96737. _generateEdgesLines(): void;
  96738. /**
  96739. * Checks wether or not the edges renderer is ready to render.
  96740. * @return true if ready, otherwise false.
  96741. */
  96742. isReady(): boolean;
  96743. /**
  96744. * Renders the edges of the attached mesh,
  96745. */
  96746. render(): void;
  96747. }
  96748. /**
  96749. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  96750. */
  96751. export class LineEdgesRenderer extends EdgesRenderer {
  96752. /**
  96753. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  96754. * @param source LineMesh used to generate edges
  96755. * @param epsilon not important (specified angle for edge detection)
  96756. * @param checkVerticesInsteadOfIndices not important for LineMesh
  96757. */
  96758. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  96759. /**
  96760. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  96761. */
  96762. _generateEdgesLines(): void;
  96763. }
  96764. }
  96765. declare module BABYLON {
  96766. /**
  96767. * This represents the object necessary to create a rendering group.
  96768. * This is exclusively used and created by the rendering manager.
  96769. * To modify the behavior, you use the available helpers in your scene or meshes.
  96770. * @hidden
  96771. */
  96772. export class RenderingGroup {
  96773. index: number;
  96774. private static _zeroVector;
  96775. private _scene;
  96776. private _opaqueSubMeshes;
  96777. private _transparentSubMeshes;
  96778. private _alphaTestSubMeshes;
  96779. private _depthOnlySubMeshes;
  96780. private _particleSystems;
  96781. private _spriteManagers;
  96782. private _opaqueSortCompareFn;
  96783. private _alphaTestSortCompareFn;
  96784. private _transparentSortCompareFn;
  96785. private _renderOpaque;
  96786. private _renderAlphaTest;
  96787. private _renderTransparent;
  96788. /** @hidden */
  96789. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  96790. onBeforeTransparentRendering: () => void;
  96791. /**
  96792. * Set the opaque sort comparison function.
  96793. * If null the sub meshes will be render in the order they were created
  96794. */
  96795. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96796. /**
  96797. * Set the alpha test sort comparison function.
  96798. * If null the sub meshes will be render in the order they were created
  96799. */
  96800. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96801. /**
  96802. * Set the transparent sort comparison function.
  96803. * If null the sub meshes will be render in the order they were created
  96804. */
  96805. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96806. /**
  96807. * Creates a new rendering group.
  96808. * @param index The rendering group index
  96809. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  96810. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  96811. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  96812. */
  96813. 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>);
  96814. /**
  96815. * Render all the sub meshes contained in the group.
  96816. * @param customRenderFunction Used to override the default render behaviour of the group.
  96817. * @returns true if rendered some submeshes.
  96818. */
  96819. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  96820. /**
  96821. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  96822. * @param subMeshes The submeshes to render
  96823. */
  96824. private renderOpaqueSorted;
  96825. /**
  96826. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  96827. * @param subMeshes The submeshes to render
  96828. */
  96829. private renderAlphaTestSorted;
  96830. /**
  96831. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  96832. * @param subMeshes The submeshes to render
  96833. */
  96834. private renderTransparentSorted;
  96835. /**
  96836. * Renders the submeshes in a specified order.
  96837. * @param subMeshes The submeshes to sort before render
  96838. * @param sortCompareFn The comparison function use to sort
  96839. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  96840. * @param transparent Specifies to activate blending if true
  96841. */
  96842. private static renderSorted;
  96843. /**
  96844. * Renders the submeshes in the order they were dispatched (no sort applied).
  96845. * @param subMeshes The submeshes to render
  96846. */
  96847. private static renderUnsorted;
  96848. /**
  96849. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96850. * are rendered back to front if in the same alpha index.
  96851. *
  96852. * @param a The first submesh
  96853. * @param b The second submesh
  96854. * @returns The result of the comparison
  96855. */
  96856. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  96857. /**
  96858. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96859. * are rendered back to front.
  96860. *
  96861. * @param a The first submesh
  96862. * @param b The second submesh
  96863. * @returns The result of the comparison
  96864. */
  96865. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  96866. /**
  96867. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96868. * are rendered front to back (prevent overdraw).
  96869. *
  96870. * @param a The first submesh
  96871. * @param b The second submesh
  96872. * @returns The result of the comparison
  96873. */
  96874. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  96875. /**
  96876. * Resets the different lists of submeshes to prepare a new frame.
  96877. */
  96878. prepare(): void;
  96879. dispose(): void;
  96880. /**
  96881. * Inserts the submesh in its correct queue depending on its material.
  96882. * @param subMesh The submesh to dispatch
  96883. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96884. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96885. */
  96886. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96887. dispatchSprites(spriteManager: ISpriteManager): void;
  96888. dispatchParticles(particleSystem: IParticleSystem): void;
  96889. private _renderParticles;
  96890. private _renderSprites;
  96891. }
  96892. }
  96893. declare module BABYLON {
  96894. /**
  96895. * Interface describing the different options available in the rendering manager
  96896. * regarding Auto Clear between groups.
  96897. */
  96898. export interface IRenderingManagerAutoClearSetup {
  96899. /**
  96900. * Defines whether or not autoclear is enable.
  96901. */
  96902. autoClear: boolean;
  96903. /**
  96904. * Defines whether or not to autoclear the depth buffer.
  96905. */
  96906. depth: boolean;
  96907. /**
  96908. * Defines whether or not to autoclear the stencil buffer.
  96909. */
  96910. stencil: boolean;
  96911. }
  96912. /**
  96913. * This class is used by the onRenderingGroupObservable
  96914. */
  96915. export class RenderingGroupInfo {
  96916. /**
  96917. * The Scene that being rendered
  96918. */
  96919. scene: Scene;
  96920. /**
  96921. * The camera currently used for the rendering pass
  96922. */
  96923. camera: Nullable<Camera>;
  96924. /**
  96925. * The ID of the renderingGroup being processed
  96926. */
  96927. renderingGroupId: number;
  96928. }
  96929. /**
  96930. * This is the manager responsible of all the rendering for meshes sprites and particles.
  96931. * It is enable to manage the different groups as well as the different necessary sort functions.
  96932. * This should not be used directly aside of the few static configurations
  96933. */
  96934. export class RenderingManager {
  96935. /**
  96936. * The max id used for rendering groups (not included)
  96937. */
  96938. static MAX_RENDERINGGROUPS: number;
  96939. /**
  96940. * The min id used for rendering groups (included)
  96941. */
  96942. static MIN_RENDERINGGROUPS: number;
  96943. /**
  96944. * Used to globally prevent autoclearing scenes.
  96945. */
  96946. static AUTOCLEAR: boolean;
  96947. /**
  96948. * @hidden
  96949. */
  96950. _useSceneAutoClearSetup: boolean;
  96951. private _scene;
  96952. private _renderingGroups;
  96953. private _depthStencilBufferAlreadyCleaned;
  96954. private _autoClearDepthStencil;
  96955. private _customOpaqueSortCompareFn;
  96956. private _customAlphaTestSortCompareFn;
  96957. private _customTransparentSortCompareFn;
  96958. private _renderingGroupInfo;
  96959. /**
  96960. * Instantiates a new rendering group for a particular scene
  96961. * @param scene Defines the scene the groups belongs to
  96962. */
  96963. constructor(scene: Scene);
  96964. private _clearDepthStencilBuffer;
  96965. /**
  96966. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  96967. * @hidden
  96968. */
  96969. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  96970. /**
  96971. * Resets the different information of the group to prepare a new frame
  96972. * @hidden
  96973. */
  96974. reset(): void;
  96975. /**
  96976. * Dispose and release the group and its associated resources.
  96977. * @hidden
  96978. */
  96979. dispose(): void;
  96980. /**
  96981. * Clear the info related to rendering groups preventing retention points during dispose.
  96982. */
  96983. freeRenderingGroups(): void;
  96984. private _prepareRenderingGroup;
  96985. /**
  96986. * Add a sprite manager to the rendering manager in order to render it this frame.
  96987. * @param spriteManager Define the sprite manager to render
  96988. */
  96989. dispatchSprites(spriteManager: ISpriteManager): void;
  96990. /**
  96991. * Add a particle system to the rendering manager in order to render it this frame.
  96992. * @param particleSystem Define the particle system to render
  96993. */
  96994. dispatchParticles(particleSystem: IParticleSystem): void;
  96995. /**
  96996. * Add a submesh to the manager in order to render it this frame
  96997. * @param subMesh The submesh to dispatch
  96998. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96999. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97000. */
  97001. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97002. /**
  97003. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  97004. * This allowed control for front to back rendering or reversly depending of the special needs.
  97005. *
  97006. * @param renderingGroupId The rendering group id corresponding to its index
  97007. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  97008. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  97009. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  97010. */
  97011. 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;
  97012. /**
  97013. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  97014. *
  97015. * @param renderingGroupId The rendering group id corresponding to its index
  97016. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  97017. * @param depth Automatically clears depth between groups if true and autoClear is true.
  97018. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  97019. */
  97020. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  97021. /**
  97022. * Gets the current auto clear configuration for one rendering group of the rendering
  97023. * manager.
  97024. * @param index the rendering group index to get the information for
  97025. * @returns The auto clear setup for the requested rendering group
  97026. */
  97027. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  97028. }
  97029. }
  97030. declare module BABYLON {
  97031. /**
  97032. * Defines the options associated with the creation of a custom shader for a shadow generator.
  97033. */
  97034. export interface ICustomShaderOptions {
  97035. /**
  97036. * Gets or sets the custom shader name to use
  97037. */
  97038. shaderName: string;
  97039. /**
  97040. * The list of attribute names used in the shader
  97041. */
  97042. attributes?: string[];
  97043. /**
  97044. * The list of unifrom names used in the shader
  97045. */
  97046. uniforms?: string[];
  97047. /**
  97048. * The list of sampler names used in the shader
  97049. */
  97050. samplers?: string[];
  97051. /**
  97052. * The list of defines used in the shader
  97053. */
  97054. defines?: string[];
  97055. }
  97056. /**
  97057. * Interface to implement to create a shadow generator compatible with BJS.
  97058. */
  97059. export interface IShadowGenerator {
  97060. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97061. id: string;
  97062. /**
  97063. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97064. * @returns The render target texture if present otherwise, null
  97065. */
  97066. getShadowMap(): Nullable<RenderTargetTexture>;
  97067. /**
  97068. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97069. * @param subMesh The submesh we want to render in the shadow map
  97070. * @param useInstances Defines wether will draw in the map using instances
  97071. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97072. * @returns true if ready otherwise, false
  97073. */
  97074. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97075. /**
  97076. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97077. * @param defines Defines of the material we want to update
  97078. * @param lightIndex Index of the light in the enabled light list of the material
  97079. */
  97080. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  97081. /**
  97082. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97083. * defined in the generator but impacting the effect).
  97084. * It implies the unifroms available on the materials are the standard BJS ones.
  97085. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97086. * @param effect The effect we are binfing the information for
  97087. */
  97088. bindShadowLight(lightIndex: string, effect: Effect): void;
  97089. /**
  97090. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97091. * (eq to shadow prjection matrix * light transform matrix)
  97092. * @returns The transform matrix used to create the shadow map
  97093. */
  97094. getTransformMatrix(): Matrix;
  97095. /**
  97096. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97097. * Cube and 2D textures for instance.
  97098. */
  97099. recreateShadowMap(): void;
  97100. /**
  97101. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97102. * @param onCompiled Callback triggered at the and of the effects compilation
  97103. * @param options Sets of optional options forcing the compilation with different modes
  97104. */
  97105. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97106. useInstances: boolean;
  97107. }>): void;
  97108. /**
  97109. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97110. * @param options Sets of optional options forcing the compilation with different modes
  97111. * @returns A promise that resolves when the compilation completes
  97112. */
  97113. forceCompilationAsync(options?: Partial<{
  97114. useInstances: boolean;
  97115. }>): Promise<void>;
  97116. /**
  97117. * Serializes the shadow generator setup to a json object.
  97118. * @returns The serialized JSON object
  97119. */
  97120. serialize(): any;
  97121. /**
  97122. * Disposes the Shadow map and related Textures and effects.
  97123. */
  97124. dispose(): void;
  97125. }
  97126. /**
  97127. * Default implementation IShadowGenerator.
  97128. * This is the main object responsible of generating shadows in the framework.
  97129. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  97130. */
  97131. export class ShadowGenerator implements IShadowGenerator {
  97132. /**
  97133. * Name of the shadow generator class
  97134. */
  97135. static CLASSNAME: string;
  97136. /**
  97137. * Shadow generator mode None: no filtering applied.
  97138. */
  97139. static readonly FILTER_NONE: number;
  97140. /**
  97141. * Shadow generator mode ESM: Exponential Shadow Mapping.
  97142. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97143. */
  97144. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  97145. /**
  97146. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  97147. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  97148. */
  97149. static readonly FILTER_POISSONSAMPLING: number;
  97150. /**
  97151. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  97152. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97153. */
  97154. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  97155. /**
  97156. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  97157. * edge artifacts on steep falloff.
  97158. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97159. */
  97160. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  97161. /**
  97162. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  97163. * edge artifacts on steep falloff.
  97164. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97165. */
  97166. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  97167. /**
  97168. * Shadow generator mode PCF: Percentage Closer Filtering
  97169. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97170. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  97171. */
  97172. static readonly FILTER_PCF: number;
  97173. /**
  97174. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  97175. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97176. * Contact Hardening
  97177. */
  97178. static readonly FILTER_PCSS: number;
  97179. /**
  97180. * Reserved for PCF and PCSS
  97181. * Highest Quality.
  97182. *
  97183. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  97184. *
  97185. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  97186. */
  97187. static readonly QUALITY_HIGH: number;
  97188. /**
  97189. * Reserved for PCF and PCSS
  97190. * Good tradeoff for quality/perf cross devices
  97191. *
  97192. * Execute PCF on a 3*3 kernel.
  97193. *
  97194. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  97195. */
  97196. static readonly QUALITY_MEDIUM: number;
  97197. /**
  97198. * Reserved for PCF and PCSS
  97199. * The lowest quality but the fastest.
  97200. *
  97201. * Execute PCF on a 1*1 kernel.
  97202. *
  97203. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  97204. */
  97205. static readonly QUALITY_LOW: number;
  97206. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97207. id: string;
  97208. /** Gets or sets the custom shader name to use */
  97209. customShaderOptions: ICustomShaderOptions;
  97210. /**
  97211. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  97212. */
  97213. onBeforeShadowMapRenderObservable: Observable<Effect>;
  97214. /**
  97215. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  97216. */
  97217. onAfterShadowMapRenderObservable: Observable<Effect>;
  97218. /**
  97219. * Observable triggered before a mesh is rendered in the shadow map.
  97220. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  97221. */
  97222. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  97223. /**
  97224. * Observable triggered after a mesh is rendered in the shadow map.
  97225. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  97226. */
  97227. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  97228. protected _bias: number;
  97229. /**
  97230. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  97231. */
  97232. get bias(): number;
  97233. /**
  97234. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  97235. */
  97236. set bias(bias: number);
  97237. protected _normalBias: number;
  97238. /**
  97239. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97240. */
  97241. get normalBias(): number;
  97242. /**
  97243. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97244. */
  97245. set normalBias(normalBias: number);
  97246. protected _blurBoxOffset: number;
  97247. /**
  97248. * Gets the blur box offset: offset applied during the blur pass.
  97249. * Only useful if useKernelBlur = false
  97250. */
  97251. get blurBoxOffset(): number;
  97252. /**
  97253. * Sets the blur box offset: offset applied during the blur pass.
  97254. * Only useful if useKernelBlur = false
  97255. */
  97256. set blurBoxOffset(value: number);
  97257. protected _blurScale: number;
  97258. /**
  97259. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  97260. * 2 means half of the size.
  97261. */
  97262. get blurScale(): number;
  97263. /**
  97264. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97265. * 2 means half of the size.
  97266. */
  97267. set blurScale(value: number);
  97268. protected _blurKernel: number;
  97269. /**
  97270. * Gets the blur kernel: kernel size of the blur pass.
  97271. * Only useful if useKernelBlur = true
  97272. */
  97273. get blurKernel(): number;
  97274. /**
  97275. * Sets the blur kernel: kernel size of the blur pass.
  97276. * Only useful if useKernelBlur = true
  97277. */
  97278. set blurKernel(value: number);
  97279. protected _useKernelBlur: boolean;
  97280. /**
  97281. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  97282. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97283. */
  97284. get useKernelBlur(): boolean;
  97285. /**
  97286. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  97287. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97288. */
  97289. set useKernelBlur(value: boolean);
  97290. protected _depthScale: number;
  97291. /**
  97292. * Gets the depth scale used in ESM mode.
  97293. */
  97294. get depthScale(): number;
  97295. /**
  97296. * Sets the depth scale used in ESM mode.
  97297. * This can override the scale stored on the light.
  97298. */
  97299. set depthScale(value: number);
  97300. protected _validateFilter(filter: number): number;
  97301. protected _filter: number;
  97302. /**
  97303. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  97304. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97305. */
  97306. get filter(): number;
  97307. /**
  97308. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  97309. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97310. */
  97311. set filter(value: number);
  97312. /**
  97313. * Gets if the current filter is set to Poisson Sampling.
  97314. */
  97315. get usePoissonSampling(): boolean;
  97316. /**
  97317. * Sets the current filter to Poisson Sampling.
  97318. */
  97319. set usePoissonSampling(value: boolean);
  97320. /**
  97321. * Gets if the current filter is set to ESM.
  97322. */
  97323. get useExponentialShadowMap(): boolean;
  97324. /**
  97325. * Sets the current filter is to ESM.
  97326. */
  97327. set useExponentialShadowMap(value: boolean);
  97328. /**
  97329. * Gets if the current filter is set to filtered ESM.
  97330. */
  97331. get useBlurExponentialShadowMap(): boolean;
  97332. /**
  97333. * Gets if the current filter is set to filtered ESM.
  97334. */
  97335. set useBlurExponentialShadowMap(value: boolean);
  97336. /**
  97337. * Gets if the current filter is set to "close ESM" (using the inverse of the
  97338. * exponential to prevent steep falloff artifacts).
  97339. */
  97340. get useCloseExponentialShadowMap(): boolean;
  97341. /**
  97342. * Sets the current filter to "close ESM" (using the inverse of the
  97343. * exponential to prevent steep falloff artifacts).
  97344. */
  97345. set useCloseExponentialShadowMap(value: boolean);
  97346. /**
  97347. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  97348. * exponential to prevent steep falloff artifacts).
  97349. */
  97350. get useBlurCloseExponentialShadowMap(): boolean;
  97351. /**
  97352. * Sets the current filter to filtered "close ESM" (using the inverse of the
  97353. * exponential to prevent steep falloff artifacts).
  97354. */
  97355. set useBlurCloseExponentialShadowMap(value: boolean);
  97356. /**
  97357. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  97358. */
  97359. get usePercentageCloserFiltering(): boolean;
  97360. /**
  97361. * Sets the current filter to "PCF" (percentage closer filtering).
  97362. */
  97363. set usePercentageCloserFiltering(value: boolean);
  97364. protected _filteringQuality: number;
  97365. /**
  97366. * Gets the PCF or PCSS Quality.
  97367. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97368. */
  97369. get filteringQuality(): number;
  97370. /**
  97371. * Sets the PCF or PCSS Quality.
  97372. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97373. */
  97374. set filteringQuality(filteringQuality: number);
  97375. /**
  97376. * Gets if the current filter is set to "PCSS" (contact hardening).
  97377. */
  97378. get useContactHardeningShadow(): boolean;
  97379. /**
  97380. * Sets the current filter to "PCSS" (contact hardening).
  97381. */
  97382. set useContactHardeningShadow(value: boolean);
  97383. protected _contactHardeningLightSizeUVRatio: number;
  97384. /**
  97385. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97386. * Using a ratio helps keeping shape stability independently of the map size.
  97387. *
  97388. * It does not account for the light projection as it was having too much
  97389. * instability during the light setup or during light position changes.
  97390. *
  97391. * Only valid if useContactHardeningShadow is true.
  97392. */
  97393. get contactHardeningLightSizeUVRatio(): number;
  97394. /**
  97395. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97396. * Using a ratio helps keeping shape stability independently of the map size.
  97397. *
  97398. * It does not account for the light projection as it was having too much
  97399. * instability during the light setup or during light position changes.
  97400. *
  97401. * Only valid if useContactHardeningShadow is true.
  97402. */
  97403. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  97404. protected _darkness: number;
  97405. /** Gets or sets the actual darkness of a shadow */
  97406. get darkness(): number;
  97407. set darkness(value: number);
  97408. /**
  97409. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  97410. * 0 means strongest and 1 would means no shadow.
  97411. * @returns the darkness.
  97412. */
  97413. getDarkness(): number;
  97414. /**
  97415. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  97416. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  97417. * @returns the shadow generator allowing fluent coding.
  97418. */
  97419. setDarkness(darkness: number): ShadowGenerator;
  97420. protected _transparencyShadow: boolean;
  97421. /** Gets or sets the ability to have transparent shadow */
  97422. get transparencyShadow(): boolean;
  97423. set transparencyShadow(value: boolean);
  97424. /**
  97425. * Sets the ability to have transparent shadow (boolean).
  97426. * @param transparent True if transparent else False
  97427. * @returns the shadow generator allowing fluent coding
  97428. */
  97429. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  97430. /**
  97431. * Enables or disables shadows with varying strength based on the transparency
  97432. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  97433. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  97434. * mesh.visibility * alphaTexture.a
  97435. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  97436. */
  97437. enableSoftTransparentShadow: boolean;
  97438. protected _shadowMap: Nullable<RenderTargetTexture>;
  97439. protected _shadowMap2: Nullable<RenderTargetTexture>;
  97440. /**
  97441. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97442. * @returns The render target texture if present otherwise, null
  97443. */
  97444. getShadowMap(): Nullable<RenderTargetTexture>;
  97445. /**
  97446. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  97447. * @returns The render target texture if the shadow map is present otherwise, null
  97448. */
  97449. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  97450. /**
  97451. * Gets the class name of that object
  97452. * @returns "ShadowGenerator"
  97453. */
  97454. getClassName(): string;
  97455. /**
  97456. * Helper function to add a mesh and its descendants to the list of shadow casters.
  97457. * @param mesh Mesh to add
  97458. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  97459. * @returns the Shadow Generator itself
  97460. */
  97461. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97462. /**
  97463. * Helper function to remove a mesh and its descendants from the list of shadow casters
  97464. * @param mesh Mesh to remove
  97465. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  97466. * @returns the Shadow Generator itself
  97467. */
  97468. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97469. /**
  97470. * Controls the extent to which the shadows fade out at the edge of the frustum
  97471. */
  97472. frustumEdgeFalloff: number;
  97473. protected _light: IShadowLight;
  97474. /**
  97475. * Returns the associated light object.
  97476. * @returns the light generating the shadow
  97477. */
  97478. getLight(): IShadowLight;
  97479. /**
  97480. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  97481. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  97482. * It might on the other hand introduce peter panning.
  97483. */
  97484. forceBackFacesOnly: boolean;
  97485. protected _scene: Scene;
  97486. protected _lightDirection: Vector3;
  97487. protected _effect: Effect;
  97488. protected _viewMatrix: Matrix;
  97489. protected _projectionMatrix: Matrix;
  97490. protected _transformMatrix: Matrix;
  97491. protected _cachedPosition: Vector3;
  97492. protected _cachedDirection: Vector3;
  97493. protected _cachedDefines: string;
  97494. protected _currentRenderID: number;
  97495. protected _boxBlurPostprocess: Nullable<PostProcess>;
  97496. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  97497. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  97498. protected _blurPostProcesses: PostProcess[];
  97499. protected _mapSize: number;
  97500. protected _currentFaceIndex: number;
  97501. protected _currentFaceIndexCache: number;
  97502. protected _textureType: number;
  97503. protected _defaultTextureMatrix: Matrix;
  97504. protected _storedUniqueId: Nullable<number>;
  97505. /** @hidden */
  97506. static _SceneComponentInitialization: (scene: Scene) => void;
  97507. /**
  97508. * Creates a ShadowGenerator object.
  97509. * A ShadowGenerator is the required tool to use the shadows.
  97510. * Each light casting shadows needs to use its own ShadowGenerator.
  97511. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  97512. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  97513. * @param light The light object generating the shadows.
  97514. * @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.
  97515. */
  97516. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  97517. protected _initializeGenerator(): void;
  97518. protected _createTargetRenderTexture(): void;
  97519. protected _initializeShadowMap(): void;
  97520. protected _initializeBlurRTTAndPostProcesses(): void;
  97521. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  97522. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  97523. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  97524. protected _applyFilterValues(): void;
  97525. /**
  97526. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97527. * @param onCompiled Callback triggered at the and of the effects compilation
  97528. * @param options Sets of optional options forcing the compilation with different modes
  97529. */
  97530. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97531. useInstances: boolean;
  97532. }>): void;
  97533. /**
  97534. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97535. * @param options Sets of optional options forcing the compilation with different modes
  97536. * @returns A promise that resolves when the compilation completes
  97537. */
  97538. forceCompilationAsync(options?: Partial<{
  97539. useInstances: boolean;
  97540. }>): Promise<void>;
  97541. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  97542. private _prepareShadowDefines;
  97543. /**
  97544. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97545. * @param subMesh The submesh we want to render in the shadow map
  97546. * @param useInstances Defines wether will draw in the map using instances
  97547. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97548. * @returns true if ready otherwise, false
  97549. */
  97550. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97551. /**
  97552. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97553. * @param defines Defines of the material we want to update
  97554. * @param lightIndex Index of the light in the enabled light list of the material
  97555. */
  97556. prepareDefines(defines: any, lightIndex: number): void;
  97557. /**
  97558. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97559. * defined in the generator but impacting the effect).
  97560. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97561. * @param effect The effect we are binfing the information for
  97562. */
  97563. bindShadowLight(lightIndex: string, effect: Effect): void;
  97564. /**
  97565. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97566. * (eq to shadow prjection matrix * light transform matrix)
  97567. * @returns The transform matrix used to create the shadow map
  97568. */
  97569. getTransformMatrix(): Matrix;
  97570. /**
  97571. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97572. * Cube and 2D textures for instance.
  97573. */
  97574. recreateShadowMap(): void;
  97575. protected _disposeBlurPostProcesses(): void;
  97576. protected _disposeRTTandPostProcesses(): void;
  97577. /**
  97578. * Disposes the ShadowGenerator.
  97579. * Returns nothing.
  97580. */
  97581. dispose(): void;
  97582. /**
  97583. * Serializes the shadow generator setup to a json object.
  97584. * @returns The serialized JSON object
  97585. */
  97586. serialize(): any;
  97587. /**
  97588. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  97589. * @param parsedShadowGenerator The JSON object to parse
  97590. * @param scene The scene to create the shadow map for
  97591. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  97592. * @returns The parsed shadow generator
  97593. */
  97594. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  97595. }
  97596. }
  97597. declare module BABYLON {
  97598. /**
  97599. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  97600. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  97601. * 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.
  97602. */
  97603. export abstract class Light extends Node {
  97604. /**
  97605. * Falloff Default: light is falling off following the material specification:
  97606. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  97607. */
  97608. static readonly FALLOFF_DEFAULT: number;
  97609. /**
  97610. * Falloff Physical: light is falling off following the inverse squared distance law.
  97611. */
  97612. static readonly FALLOFF_PHYSICAL: number;
  97613. /**
  97614. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  97615. * to enhance interoperability with other engines.
  97616. */
  97617. static readonly FALLOFF_GLTF: number;
  97618. /**
  97619. * Falloff Standard: light is falling off like in the standard material
  97620. * to enhance interoperability with other materials.
  97621. */
  97622. static readonly FALLOFF_STANDARD: number;
  97623. /**
  97624. * If every light affecting the material is in this lightmapMode,
  97625. * material.lightmapTexture adds or multiplies
  97626. * (depends on material.useLightmapAsShadowmap)
  97627. * after every other light calculations.
  97628. */
  97629. static readonly LIGHTMAP_DEFAULT: number;
  97630. /**
  97631. * material.lightmapTexture as only diffuse lighting from this light
  97632. * adds only specular lighting from this light
  97633. * adds dynamic shadows
  97634. */
  97635. static readonly LIGHTMAP_SPECULAR: number;
  97636. /**
  97637. * material.lightmapTexture as only lighting
  97638. * no light calculation from this light
  97639. * only adds dynamic shadows from this light
  97640. */
  97641. static readonly LIGHTMAP_SHADOWSONLY: number;
  97642. /**
  97643. * Each light type uses the default quantity according to its type:
  97644. * point/spot lights use luminous intensity
  97645. * directional lights use illuminance
  97646. */
  97647. static readonly INTENSITYMODE_AUTOMATIC: number;
  97648. /**
  97649. * lumen (lm)
  97650. */
  97651. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  97652. /**
  97653. * candela (lm/sr)
  97654. */
  97655. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  97656. /**
  97657. * lux (lm/m^2)
  97658. */
  97659. static readonly INTENSITYMODE_ILLUMINANCE: number;
  97660. /**
  97661. * nit (cd/m^2)
  97662. */
  97663. static readonly INTENSITYMODE_LUMINANCE: number;
  97664. /**
  97665. * Light type const id of the point light.
  97666. */
  97667. static readonly LIGHTTYPEID_POINTLIGHT: number;
  97668. /**
  97669. * Light type const id of the directional light.
  97670. */
  97671. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  97672. /**
  97673. * Light type const id of the spot light.
  97674. */
  97675. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  97676. /**
  97677. * Light type const id of the hemispheric light.
  97678. */
  97679. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  97680. /**
  97681. * Diffuse gives the basic color to an object.
  97682. */
  97683. diffuse: Color3;
  97684. /**
  97685. * Specular produces a highlight color on an object.
  97686. * Note: This is note affecting PBR materials.
  97687. */
  97688. specular: Color3;
  97689. /**
  97690. * Defines the falloff type for this light. This lets overrriding how punctual light are
  97691. * falling off base on range or angle.
  97692. * This can be set to any values in Light.FALLOFF_x.
  97693. *
  97694. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  97695. * other types of materials.
  97696. */
  97697. falloffType: number;
  97698. /**
  97699. * Strength of the light.
  97700. * Note: By default it is define in the framework own unit.
  97701. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  97702. */
  97703. intensity: number;
  97704. private _range;
  97705. protected _inverseSquaredRange: number;
  97706. /**
  97707. * Defines how far from the source the light is impacting in scene units.
  97708. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97709. */
  97710. get range(): number;
  97711. /**
  97712. * Defines how far from the source the light is impacting in scene units.
  97713. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97714. */
  97715. set range(value: number);
  97716. /**
  97717. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  97718. * of light.
  97719. */
  97720. private _photometricScale;
  97721. private _intensityMode;
  97722. /**
  97723. * Gets the photometric scale used to interpret the intensity.
  97724. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97725. */
  97726. get intensityMode(): number;
  97727. /**
  97728. * Sets the photometric scale used to interpret the intensity.
  97729. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97730. */
  97731. set intensityMode(value: number);
  97732. private _radius;
  97733. /**
  97734. * Gets the light radius used by PBR Materials to simulate soft area lights.
  97735. */
  97736. get radius(): number;
  97737. /**
  97738. * sets the light radius used by PBR Materials to simulate soft area lights.
  97739. */
  97740. set radius(value: number);
  97741. private _renderPriority;
  97742. /**
  97743. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  97744. * exceeding the number allowed of the materials.
  97745. */
  97746. renderPriority: number;
  97747. private _shadowEnabled;
  97748. /**
  97749. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97750. * the current shadow generator.
  97751. */
  97752. get shadowEnabled(): boolean;
  97753. /**
  97754. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97755. * the current shadow generator.
  97756. */
  97757. set shadowEnabled(value: boolean);
  97758. private _includedOnlyMeshes;
  97759. /**
  97760. * Gets the only meshes impacted by this light.
  97761. */
  97762. get includedOnlyMeshes(): AbstractMesh[];
  97763. /**
  97764. * Sets the only meshes impacted by this light.
  97765. */
  97766. set includedOnlyMeshes(value: AbstractMesh[]);
  97767. private _excludedMeshes;
  97768. /**
  97769. * Gets the meshes not impacted by this light.
  97770. */
  97771. get excludedMeshes(): AbstractMesh[];
  97772. /**
  97773. * Sets the meshes not impacted by this light.
  97774. */
  97775. set excludedMeshes(value: AbstractMesh[]);
  97776. private _excludeWithLayerMask;
  97777. /**
  97778. * Gets the layer id use to find what meshes are not impacted by the light.
  97779. * Inactive if 0
  97780. */
  97781. get excludeWithLayerMask(): number;
  97782. /**
  97783. * Sets the layer id use to find what meshes are not impacted by the light.
  97784. * Inactive if 0
  97785. */
  97786. set excludeWithLayerMask(value: number);
  97787. private _includeOnlyWithLayerMask;
  97788. /**
  97789. * Gets the layer id use to find what meshes are impacted by the light.
  97790. * Inactive if 0
  97791. */
  97792. get includeOnlyWithLayerMask(): number;
  97793. /**
  97794. * Sets the layer id use to find what meshes are impacted by the light.
  97795. * Inactive if 0
  97796. */
  97797. set includeOnlyWithLayerMask(value: number);
  97798. private _lightmapMode;
  97799. /**
  97800. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97801. */
  97802. get lightmapMode(): number;
  97803. /**
  97804. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97805. */
  97806. set lightmapMode(value: number);
  97807. /**
  97808. * Shadow generator associted to the light.
  97809. * @hidden Internal use only.
  97810. */
  97811. _shadowGenerator: Nullable<IShadowGenerator>;
  97812. /**
  97813. * @hidden Internal use only.
  97814. */
  97815. _excludedMeshesIds: string[];
  97816. /**
  97817. * @hidden Internal use only.
  97818. */
  97819. _includedOnlyMeshesIds: string[];
  97820. /**
  97821. * The current light unifom buffer.
  97822. * @hidden Internal use only.
  97823. */
  97824. _uniformBuffer: UniformBuffer;
  97825. /** @hidden */
  97826. _renderId: number;
  97827. /**
  97828. * Creates a Light object in the scene.
  97829. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97830. * @param name The firendly name of the light
  97831. * @param scene The scene the light belongs too
  97832. */
  97833. constructor(name: string, scene: Scene);
  97834. protected abstract _buildUniformLayout(): void;
  97835. /**
  97836. * Sets the passed Effect "effect" with the Light information.
  97837. * @param effect The effect to update
  97838. * @param lightIndex The index of the light in the effect to update
  97839. * @returns The light
  97840. */
  97841. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  97842. /**
  97843. * Sets the passed Effect "effect" with the Light textures.
  97844. * @param effect The effect to update
  97845. * @param lightIndex The index of the light in the effect to update
  97846. * @returns The light
  97847. */
  97848. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  97849. /**
  97850. * Binds the lights information from the scene to the effect for the given mesh.
  97851. * @param lightIndex Light index
  97852. * @param scene The scene where the light belongs to
  97853. * @param effect The effect we are binding the data to
  97854. * @param useSpecular Defines if specular is supported
  97855. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97856. */
  97857. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97858. /**
  97859. * Sets the passed Effect "effect" with the Light information.
  97860. * @param effect The effect to update
  97861. * @param lightDataUniformName The uniform used to store light data (position or direction)
  97862. * @returns The light
  97863. */
  97864. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  97865. /**
  97866. * Returns the string "Light".
  97867. * @returns the class name
  97868. */
  97869. getClassName(): string;
  97870. /** @hidden */
  97871. readonly _isLight: boolean;
  97872. /**
  97873. * Converts the light information to a readable string for debug purpose.
  97874. * @param fullDetails Supports for multiple levels of logging within scene loading
  97875. * @returns the human readable light info
  97876. */
  97877. toString(fullDetails?: boolean): string;
  97878. /** @hidden */
  97879. protected _syncParentEnabledState(): void;
  97880. /**
  97881. * Set the enabled state of this node.
  97882. * @param value - the new enabled state
  97883. */
  97884. setEnabled(value: boolean): void;
  97885. /**
  97886. * Returns the Light associated shadow generator if any.
  97887. * @return the associated shadow generator.
  97888. */
  97889. getShadowGenerator(): Nullable<IShadowGenerator>;
  97890. /**
  97891. * Returns a Vector3, the absolute light position in the World.
  97892. * @returns the world space position of the light
  97893. */
  97894. getAbsolutePosition(): Vector3;
  97895. /**
  97896. * Specifies if the light will affect the passed mesh.
  97897. * @param mesh The mesh to test against the light
  97898. * @return true the mesh is affected otherwise, false.
  97899. */
  97900. canAffectMesh(mesh: AbstractMesh): boolean;
  97901. /**
  97902. * Sort function to order lights for rendering.
  97903. * @param a First Light object to compare to second.
  97904. * @param b Second Light object to compare first.
  97905. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  97906. */
  97907. static CompareLightsPriority(a: Light, b: Light): number;
  97908. /**
  97909. * Releases resources associated with this node.
  97910. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  97911. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  97912. */
  97913. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  97914. /**
  97915. * Returns the light type ID (integer).
  97916. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  97917. */
  97918. getTypeID(): number;
  97919. /**
  97920. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  97921. * @returns the scaled intensity in intensity mode unit
  97922. */
  97923. getScaledIntensity(): number;
  97924. /**
  97925. * Returns a new Light object, named "name", from the current one.
  97926. * @param name The name of the cloned light
  97927. * @param newParent The parent of this light, if it has one
  97928. * @returns the new created light
  97929. */
  97930. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  97931. /**
  97932. * Serializes the current light into a Serialization object.
  97933. * @returns the serialized object.
  97934. */
  97935. serialize(): any;
  97936. /**
  97937. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  97938. * This new light is named "name" and added to the passed scene.
  97939. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  97940. * @param name The friendly name of the light
  97941. * @param scene The scene the new light will belong to
  97942. * @returns the constructor function
  97943. */
  97944. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  97945. /**
  97946. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  97947. * @param parsedLight The JSON representation of the light
  97948. * @param scene The scene to create the parsed light in
  97949. * @returns the created light after parsing
  97950. */
  97951. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  97952. private _hookArrayForExcluded;
  97953. private _hookArrayForIncludedOnly;
  97954. private _resyncMeshes;
  97955. /**
  97956. * Forces the meshes to update their light related information in their rendering used effects
  97957. * @hidden Internal Use Only
  97958. */
  97959. _markMeshesAsLightDirty(): void;
  97960. /**
  97961. * Recomputes the cached photometric scale if needed.
  97962. */
  97963. private _computePhotometricScale;
  97964. /**
  97965. * Returns the Photometric Scale according to the light type and intensity mode.
  97966. */
  97967. private _getPhotometricScale;
  97968. /**
  97969. * Reorder the light in the scene according to their defined priority.
  97970. * @hidden Internal Use Only
  97971. */
  97972. _reorderLightsInScene(): void;
  97973. /**
  97974. * Prepares the list of defines specific to the light type.
  97975. * @param defines the list of defines
  97976. * @param lightIndex defines the index of the light for the effect
  97977. */
  97978. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  97979. }
  97980. }
  97981. declare module BABYLON {
  97982. /**
  97983. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  97984. * This is the base of the follow, arc rotate cameras and Free camera
  97985. * @see https://doc.babylonjs.com/features/cameras
  97986. */
  97987. export class TargetCamera extends Camera {
  97988. private static _RigCamTransformMatrix;
  97989. private static _TargetTransformMatrix;
  97990. private static _TargetFocalPoint;
  97991. private _tmpUpVector;
  97992. private _tmpTargetVector;
  97993. /**
  97994. * Define the current direction the camera is moving to
  97995. */
  97996. cameraDirection: Vector3;
  97997. /**
  97998. * Define the current rotation the camera is rotating to
  97999. */
  98000. cameraRotation: Vector2;
  98001. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  98002. ignoreParentScaling: boolean;
  98003. /**
  98004. * When set, the up vector of the camera will be updated by the rotation of the camera
  98005. */
  98006. updateUpVectorFromRotation: boolean;
  98007. private _tmpQuaternion;
  98008. /**
  98009. * Define the current rotation of the camera
  98010. */
  98011. rotation: Vector3;
  98012. /**
  98013. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  98014. */
  98015. rotationQuaternion: Quaternion;
  98016. /**
  98017. * Define the current speed of the camera
  98018. */
  98019. speed: number;
  98020. /**
  98021. * Add constraint to the camera to prevent it to move freely in all directions and
  98022. * around all axis.
  98023. */
  98024. noRotationConstraint: boolean;
  98025. /**
  98026. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  98027. * panning
  98028. */
  98029. invertRotation: boolean;
  98030. /**
  98031. * Speed multiplier for inverse camera panning
  98032. */
  98033. inverseRotationSpeed: number;
  98034. /**
  98035. * Define the current target of the camera as an object or a position.
  98036. */
  98037. lockedTarget: any;
  98038. /** @hidden */
  98039. _currentTarget: Vector3;
  98040. /** @hidden */
  98041. _initialFocalDistance: number;
  98042. /** @hidden */
  98043. _viewMatrix: Matrix;
  98044. /** @hidden */
  98045. _camMatrix: Matrix;
  98046. /** @hidden */
  98047. _cameraTransformMatrix: Matrix;
  98048. /** @hidden */
  98049. _cameraRotationMatrix: Matrix;
  98050. /** @hidden */
  98051. _referencePoint: Vector3;
  98052. /** @hidden */
  98053. _transformedReferencePoint: Vector3;
  98054. /** @hidden */
  98055. _reset: () => void;
  98056. private _defaultUp;
  98057. /**
  98058. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  98059. * This is the base of the follow, arc rotate cameras and Free camera
  98060. * @see https://doc.babylonjs.com/features/cameras
  98061. * @param name Defines the name of the camera in the scene
  98062. * @param position Defines the start position of the camera in the scene
  98063. * @param scene Defines the scene the camera belongs to
  98064. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98065. */
  98066. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98067. /**
  98068. * Gets the position in front of the camera at a given distance.
  98069. * @param distance The distance from the camera we want the position to be
  98070. * @returns the position
  98071. */
  98072. getFrontPosition(distance: number): Vector3;
  98073. /** @hidden */
  98074. _getLockedTargetPosition(): Nullable<Vector3>;
  98075. private _storedPosition;
  98076. private _storedRotation;
  98077. private _storedRotationQuaternion;
  98078. /**
  98079. * Store current camera state of the camera (fov, position, rotation, etc..)
  98080. * @returns the camera
  98081. */
  98082. storeState(): Camera;
  98083. /**
  98084. * Restored camera state. You must call storeState() first
  98085. * @returns whether it was successful or not
  98086. * @hidden
  98087. */
  98088. _restoreStateValues(): boolean;
  98089. /** @hidden */
  98090. _initCache(): void;
  98091. /** @hidden */
  98092. _updateCache(ignoreParentClass?: boolean): void;
  98093. /** @hidden */
  98094. _isSynchronizedViewMatrix(): boolean;
  98095. /** @hidden */
  98096. _computeLocalCameraSpeed(): number;
  98097. /**
  98098. * Defines the target the camera should look at.
  98099. * @param target Defines the new target as a Vector or a mesh
  98100. */
  98101. setTarget(target: Vector3): void;
  98102. /**
  98103. * Defines the target point of the camera.
  98104. * The camera looks towards it form the radius distance.
  98105. */
  98106. get target(): Vector3;
  98107. set target(value: Vector3);
  98108. /**
  98109. * Return the current target position of the camera. This value is expressed in local space.
  98110. * @returns the target position
  98111. */
  98112. getTarget(): Vector3;
  98113. /** @hidden */
  98114. _decideIfNeedsToMove(): boolean;
  98115. /** @hidden */
  98116. _updatePosition(): void;
  98117. /** @hidden */
  98118. _checkInputs(): void;
  98119. protected _updateCameraRotationMatrix(): void;
  98120. /**
  98121. * 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)
  98122. * @returns the current camera
  98123. */
  98124. private _rotateUpVectorWithCameraRotationMatrix;
  98125. private _cachedRotationZ;
  98126. private _cachedQuaternionRotationZ;
  98127. /** @hidden */
  98128. _getViewMatrix(): Matrix;
  98129. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  98130. /**
  98131. * @hidden
  98132. */
  98133. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  98134. /**
  98135. * @hidden
  98136. */
  98137. _updateRigCameras(): void;
  98138. private _getRigCamPositionAndTarget;
  98139. /**
  98140. * Gets the current object class name.
  98141. * @return the class name
  98142. */
  98143. getClassName(): string;
  98144. }
  98145. }
  98146. declare module BABYLON {
  98147. /**
  98148. * Gather the list of keyboard event types as constants.
  98149. */
  98150. export class KeyboardEventTypes {
  98151. /**
  98152. * The keydown event is fired when a key becomes active (pressed).
  98153. */
  98154. static readonly KEYDOWN: number;
  98155. /**
  98156. * The keyup event is fired when a key has been released.
  98157. */
  98158. static readonly KEYUP: number;
  98159. }
  98160. /**
  98161. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98162. */
  98163. export class KeyboardInfo {
  98164. /**
  98165. * Defines the type of event (KeyboardEventTypes)
  98166. */
  98167. type: number;
  98168. /**
  98169. * Defines the related dom event
  98170. */
  98171. event: KeyboardEvent;
  98172. /**
  98173. * Instantiates a new keyboard info.
  98174. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98175. * @param type Defines the type of event (KeyboardEventTypes)
  98176. * @param event Defines the related dom event
  98177. */
  98178. constructor(
  98179. /**
  98180. * Defines the type of event (KeyboardEventTypes)
  98181. */
  98182. type: number,
  98183. /**
  98184. * Defines the related dom event
  98185. */
  98186. event: KeyboardEvent);
  98187. }
  98188. /**
  98189. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98190. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  98191. */
  98192. export class KeyboardInfoPre extends KeyboardInfo {
  98193. /**
  98194. * Defines the type of event (KeyboardEventTypes)
  98195. */
  98196. type: number;
  98197. /**
  98198. * Defines the related dom event
  98199. */
  98200. event: KeyboardEvent;
  98201. /**
  98202. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  98203. */
  98204. skipOnPointerObservable: boolean;
  98205. /**
  98206. * Instantiates a new keyboard pre info.
  98207. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98208. * @param type Defines the type of event (KeyboardEventTypes)
  98209. * @param event Defines the related dom event
  98210. */
  98211. constructor(
  98212. /**
  98213. * Defines the type of event (KeyboardEventTypes)
  98214. */
  98215. type: number,
  98216. /**
  98217. * Defines the related dom event
  98218. */
  98219. event: KeyboardEvent);
  98220. }
  98221. }
  98222. declare module BABYLON {
  98223. /**
  98224. * Manage the keyboard inputs to control the movement of a free camera.
  98225. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98226. */
  98227. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  98228. /**
  98229. * Defines the camera the input is attached to.
  98230. */
  98231. camera: FreeCamera;
  98232. /**
  98233. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98234. */
  98235. keysUp: number[];
  98236. /**
  98237. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98238. */
  98239. keysUpward: number[];
  98240. /**
  98241. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98242. */
  98243. keysDown: number[];
  98244. /**
  98245. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98246. */
  98247. keysDownward: number[];
  98248. /**
  98249. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98250. */
  98251. keysLeft: number[];
  98252. /**
  98253. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98254. */
  98255. keysRight: number[];
  98256. private _keys;
  98257. private _onCanvasBlurObserver;
  98258. private _onKeyboardObserver;
  98259. private _engine;
  98260. private _scene;
  98261. /**
  98262. * Attach the input controls to a specific dom element to get the input from.
  98263. * @param element Defines the element the controls should be listened from
  98264. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98265. */
  98266. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98267. /**
  98268. * Detach the current controls from the specified dom element.
  98269. * @param element Defines the element to stop listening the inputs from
  98270. */
  98271. detachControl(element: Nullable<HTMLElement>): void;
  98272. /**
  98273. * Update the current camera state depending on the inputs that have been used this frame.
  98274. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98275. */
  98276. checkInputs(): void;
  98277. /**
  98278. * Gets the class name of the current intput.
  98279. * @returns the class name
  98280. */
  98281. getClassName(): string;
  98282. /** @hidden */
  98283. _onLostFocus(): void;
  98284. /**
  98285. * Get the friendly name associated with the input class.
  98286. * @returns the input friendly name
  98287. */
  98288. getSimpleName(): string;
  98289. }
  98290. }
  98291. declare module BABYLON {
  98292. /**
  98293. * Gather the list of pointer event types as constants.
  98294. */
  98295. export class PointerEventTypes {
  98296. /**
  98297. * 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.
  98298. */
  98299. static readonly POINTERDOWN: number;
  98300. /**
  98301. * The pointerup event is fired when a pointer is no longer active.
  98302. */
  98303. static readonly POINTERUP: number;
  98304. /**
  98305. * The pointermove event is fired when a pointer changes coordinates.
  98306. */
  98307. static readonly POINTERMOVE: number;
  98308. /**
  98309. * The pointerwheel event is fired when a mouse wheel has been rotated.
  98310. */
  98311. static readonly POINTERWHEEL: number;
  98312. /**
  98313. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  98314. */
  98315. static readonly POINTERPICK: number;
  98316. /**
  98317. * The pointertap event is fired when a the object has been touched and released without drag.
  98318. */
  98319. static readonly POINTERTAP: number;
  98320. /**
  98321. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  98322. */
  98323. static readonly POINTERDOUBLETAP: number;
  98324. }
  98325. /**
  98326. * Base class of pointer info types.
  98327. */
  98328. export class PointerInfoBase {
  98329. /**
  98330. * Defines the type of event (PointerEventTypes)
  98331. */
  98332. type: number;
  98333. /**
  98334. * Defines the related dom event
  98335. */
  98336. event: PointerEvent | MouseWheelEvent;
  98337. /**
  98338. * Instantiates the base class of pointers info.
  98339. * @param type Defines the type of event (PointerEventTypes)
  98340. * @param event Defines the related dom event
  98341. */
  98342. constructor(
  98343. /**
  98344. * Defines the type of event (PointerEventTypes)
  98345. */
  98346. type: number,
  98347. /**
  98348. * Defines the related dom event
  98349. */
  98350. event: PointerEvent | MouseWheelEvent);
  98351. }
  98352. /**
  98353. * This class is used to store pointer related info for the onPrePointerObservable event.
  98354. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  98355. */
  98356. export class PointerInfoPre extends PointerInfoBase {
  98357. /**
  98358. * Ray from a pointer if availible (eg. 6dof controller)
  98359. */
  98360. ray: Nullable<Ray>;
  98361. /**
  98362. * Defines the local position of the pointer on the canvas.
  98363. */
  98364. localPosition: Vector2;
  98365. /**
  98366. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  98367. */
  98368. skipOnPointerObservable: boolean;
  98369. /**
  98370. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  98371. * @param type Defines the type of event (PointerEventTypes)
  98372. * @param event Defines the related dom event
  98373. * @param localX Defines the local x coordinates of the pointer when the event occured
  98374. * @param localY Defines the local y coordinates of the pointer when the event occured
  98375. */
  98376. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  98377. }
  98378. /**
  98379. * This type contains all the data related to a pointer event in Babylon.js.
  98380. * 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.
  98381. */
  98382. export class PointerInfo extends PointerInfoBase {
  98383. /**
  98384. * Defines the picking info associated to the info (if any)\
  98385. */
  98386. pickInfo: Nullable<PickingInfo>;
  98387. /**
  98388. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  98389. * @param type Defines the type of event (PointerEventTypes)
  98390. * @param event Defines the related dom event
  98391. * @param pickInfo Defines the picking info associated to the info (if any)\
  98392. */
  98393. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  98394. /**
  98395. * Defines the picking info associated to the info (if any)\
  98396. */
  98397. pickInfo: Nullable<PickingInfo>);
  98398. }
  98399. /**
  98400. * Data relating to a touch event on the screen.
  98401. */
  98402. export interface PointerTouch {
  98403. /**
  98404. * X coordinate of touch.
  98405. */
  98406. x: number;
  98407. /**
  98408. * Y coordinate of touch.
  98409. */
  98410. y: number;
  98411. /**
  98412. * Id of touch. Unique for each finger.
  98413. */
  98414. pointerId: number;
  98415. /**
  98416. * Event type passed from DOM.
  98417. */
  98418. type: any;
  98419. }
  98420. }
  98421. declare module BABYLON {
  98422. /**
  98423. * Manage the mouse inputs to control the movement of a free camera.
  98424. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98425. */
  98426. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  98427. /**
  98428. * Define if touch is enabled in the mouse input
  98429. */
  98430. touchEnabled: boolean;
  98431. /**
  98432. * Defines the camera the input is attached to.
  98433. */
  98434. camera: FreeCamera;
  98435. /**
  98436. * Defines the buttons associated with the input to handle camera move.
  98437. */
  98438. buttons: number[];
  98439. /**
  98440. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  98441. */
  98442. angularSensibility: number;
  98443. private _pointerInput;
  98444. private _onMouseMove;
  98445. private _observer;
  98446. private previousPosition;
  98447. /**
  98448. * Observable for when a pointer move event occurs containing the move offset
  98449. */
  98450. onPointerMovedObservable: Observable<{
  98451. offsetX: number;
  98452. offsetY: number;
  98453. }>;
  98454. /**
  98455. * @hidden
  98456. * If the camera should be rotated automatically based on pointer movement
  98457. */
  98458. _allowCameraRotation: boolean;
  98459. /**
  98460. * Manage the mouse inputs to control the movement of a free camera.
  98461. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98462. * @param touchEnabled Defines if touch is enabled or not
  98463. */
  98464. constructor(
  98465. /**
  98466. * Define if touch is enabled in the mouse input
  98467. */
  98468. touchEnabled?: boolean);
  98469. /**
  98470. * Attach the input controls to a specific dom element to get the input from.
  98471. * @param element Defines the element the controls should be listened from
  98472. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98473. */
  98474. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98475. /**
  98476. * Called on JS contextmenu event.
  98477. * Override this method to provide functionality.
  98478. */
  98479. protected onContextMenu(evt: PointerEvent): void;
  98480. /**
  98481. * Detach the current controls from the specified dom element.
  98482. * @param element Defines the element to stop listening the inputs from
  98483. */
  98484. detachControl(element: Nullable<HTMLElement>): void;
  98485. /**
  98486. * Gets the class name of the current intput.
  98487. * @returns the class name
  98488. */
  98489. getClassName(): string;
  98490. /**
  98491. * Get the friendly name associated with the input class.
  98492. * @returns the input friendly name
  98493. */
  98494. getSimpleName(): string;
  98495. }
  98496. }
  98497. declare module BABYLON {
  98498. /**
  98499. * Manage the touch inputs to control the movement of a free camera.
  98500. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98501. */
  98502. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  98503. /**
  98504. * Define if mouse events can be treated as touch events
  98505. */
  98506. allowMouse: boolean;
  98507. /**
  98508. * Defines the camera the input is attached to.
  98509. */
  98510. camera: FreeCamera;
  98511. /**
  98512. * Defines the touch sensibility for rotation.
  98513. * The higher the faster.
  98514. */
  98515. touchAngularSensibility: number;
  98516. /**
  98517. * Defines the touch sensibility for move.
  98518. * The higher the faster.
  98519. */
  98520. touchMoveSensibility: number;
  98521. private _offsetX;
  98522. private _offsetY;
  98523. private _pointerPressed;
  98524. private _pointerInput;
  98525. private _observer;
  98526. private _onLostFocus;
  98527. /**
  98528. * Manage the touch inputs to control the movement of a free camera.
  98529. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98530. * @param allowMouse Defines if mouse events can be treated as touch events
  98531. */
  98532. constructor(
  98533. /**
  98534. * Define if mouse events can be treated as touch events
  98535. */
  98536. allowMouse?: boolean);
  98537. /**
  98538. * Attach the input controls to a specific dom element to get the input from.
  98539. * @param element Defines the element the controls should be listened from
  98540. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98541. */
  98542. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98543. /**
  98544. * Detach the current controls from the specified dom element.
  98545. * @param element Defines the element to stop listening the inputs from
  98546. */
  98547. detachControl(element: Nullable<HTMLElement>): void;
  98548. /**
  98549. * Update the current camera state depending on the inputs that have been used this frame.
  98550. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98551. */
  98552. checkInputs(): void;
  98553. /**
  98554. * Gets the class name of the current intput.
  98555. * @returns the class name
  98556. */
  98557. getClassName(): string;
  98558. /**
  98559. * Get the friendly name associated with the input class.
  98560. * @returns the input friendly name
  98561. */
  98562. getSimpleName(): string;
  98563. }
  98564. }
  98565. declare module BABYLON {
  98566. /**
  98567. * Default Inputs manager for the FreeCamera.
  98568. * It groups all the default supported inputs for ease of use.
  98569. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98570. */
  98571. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  98572. /**
  98573. * @hidden
  98574. */
  98575. _mouseInput: Nullable<FreeCameraMouseInput>;
  98576. /**
  98577. * Instantiates a new FreeCameraInputsManager.
  98578. * @param camera Defines the camera the inputs belong to
  98579. */
  98580. constructor(camera: FreeCamera);
  98581. /**
  98582. * Add keyboard input support to the input manager.
  98583. * @returns the current input manager
  98584. */
  98585. addKeyboard(): FreeCameraInputsManager;
  98586. /**
  98587. * Add mouse input support to the input manager.
  98588. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  98589. * @returns the current input manager
  98590. */
  98591. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  98592. /**
  98593. * Removes the mouse input support from the manager
  98594. * @returns the current input manager
  98595. */
  98596. removeMouse(): FreeCameraInputsManager;
  98597. /**
  98598. * Add touch input support to the input manager.
  98599. * @returns the current input manager
  98600. */
  98601. addTouch(): FreeCameraInputsManager;
  98602. /**
  98603. * Remove all attached input methods from a camera
  98604. */
  98605. clear(): void;
  98606. }
  98607. }
  98608. declare module BABYLON {
  98609. /**
  98610. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98611. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  98612. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98613. */
  98614. export class FreeCamera extends TargetCamera {
  98615. /**
  98616. * Define the collision ellipsoid of the camera.
  98617. * This is helpful to simulate a camera body like the player body around the camera
  98618. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  98619. */
  98620. ellipsoid: Vector3;
  98621. /**
  98622. * Define an offset for the position of the ellipsoid around the camera.
  98623. * This can be helpful to determine the center of the body near the gravity center of the body
  98624. * instead of its head.
  98625. */
  98626. ellipsoidOffset: Vector3;
  98627. /**
  98628. * Enable or disable collisions of the camera with the rest of the scene objects.
  98629. */
  98630. checkCollisions: boolean;
  98631. /**
  98632. * Enable or disable gravity on the camera.
  98633. */
  98634. applyGravity: boolean;
  98635. /**
  98636. * Define the input manager associated to the camera.
  98637. */
  98638. inputs: FreeCameraInputsManager;
  98639. /**
  98640. * Gets the input sensibility for a mouse input. (default is 2000.0)
  98641. * Higher values reduce sensitivity.
  98642. */
  98643. get angularSensibility(): number;
  98644. /**
  98645. * Sets the input sensibility for a mouse input. (default is 2000.0)
  98646. * Higher values reduce sensitivity.
  98647. */
  98648. set angularSensibility(value: number);
  98649. /**
  98650. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98651. */
  98652. get keysUp(): number[];
  98653. set keysUp(value: number[]);
  98654. /**
  98655. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98656. */
  98657. get keysUpward(): number[];
  98658. set keysUpward(value: number[]);
  98659. /**
  98660. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98661. */
  98662. get keysDown(): number[];
  98663. set keysDown(value: number[]);
  98664. /**
  98665. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98666. */
  98667. get keysDownward(): number[];
  98668. set keysDownward(value: number[]);
  98669. /**
  98670. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98671. */
  98672. get keysLeft(): number[];
  98673. set keysLeft(value: number[]);
  98674. /**
  98675. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98676. */
  98677. get keysRight(): number[];
  98678. set keysRight(value: number[]);
  98679. /**
  98680. * Event raised when the camera collide with a mesh in the scene.
  98681. */
  98682. onCollide: (collidedMesh: AbstractMesh) => void;
  98683. private _collider;
  98684. private _needMoveForGravity;
  98685. private _oldPosition;
  98686. private _diffPosition;
  98687. private _newPosition;
  98688. /** @hidden */
  98689. _localDirection: Vector3;
  98690. /** @hidden */
  98691. _transformedDirection: Vector3;
  98692. /**
  98693. * Instantiates a Free Camera.
  98694. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98695. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  98696. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98697. * @param name Define the name of the camera in the scene
  98698. * @param position Define the start position of the camera in the scene
  98699. * @param scene Define the scene the camera belongs to
  98700. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98701. */
  98702. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98703. /**
  98704. * Attached controls to the current camera.
  98705. * @param element Defines the element the controls should be listened from
  98706. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98707. */
  98708. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98709. /**
  98710. * Detach the current controls from the camera.
  98711. * The camera will stop reacting to inputs.
  98712. * @param element Defines the element to stop listening the inputs from
  98713. */
  98714. detachControl(element: HTMLElement): void;
  98715. private _collisionMask;
  98716. /**
  98717. * Define a collision mask to limit the list of object the camera can collide with
  98718. */
  98719. get collisionMask(): number;
  98720. set collisionMask(mask: number);
  98721. /** @hidden */
  98722. _collideWithWorld(displacement: Vector3): void;
  98723. private _onCollisionPositionChange;
  98724. /** @hidden */
  98725. _checkInputs(): void;
  98726. /** @hidden */
  98727. _decideIfNeedsToMove(): boolean;
  98728. /** @hidden */
  98729. _updatePosition(): void;
  98730. /**
  98731. * Destroy the camera and release the current resources hold by it.
  98732. */
  98733. dispose(): void;
  98734. /**
  98735. * Gets the current object class name.
  98736. * @return the class name
  98737. */
  98738. getClassName(): string;
  98739. }
  98740. }
  98741. declare module BABYLON {
  98742. /**
  98743. * Represents a gamepad control stick position
  98744. */
  98745. export class StickValues {
  98746. /**
  98747. * The x component of the control stick
  98748. */
  98749. x: number;
  98750. /**
  98751. * The y component of the control stick
  98752. */
  98753. y: number;
  98754. /**
  98755. * Initializes the gamepad x and y control stick values
  98756. * @param x The x component of the gamepad control stick value
  98757. * @param y The y component of the gamepad control stick value
  98758. */
  98759. constructor(
  98760. /**
  98761. * The x component of the control stick
  98762. */
  98763. x: number,
  98764. /**
  98765. * The y component of the control stick
  98766. */
  98767. y: number);
  98768. }
  98769. /**
  98770. * An interface which manages callbacks for gamepad button changes
  98771. */
  98772. export interface GamepadButtonChanges {
  98773. /**
  98774. * Called when a gamepad has been changed
  98775. */
  98776. changed: boolean;
  98777. /**
  98778. * Called when a gamepad press event has been triggered
  98779. */
  98780. pressChanged: boolean;
  98781. /**
  98782. * Called when a touch event has been triggered
  98783. */
  98784. touchChanged: boolean;
  98785. /**
  98786. * Called when a value has changed
  98787. */
  98788. valueChanged: boolean;
  98789. }
  98790. /**
  98791. * Represents a gamepad
  98792. */
  98793. export class Gamepad {
  98794. /**
  98795. * The id of the gamepad
  98796. */
  98797. id: string;
  98798. /**
  98799. * The index of the gamepad
  98800. */
  98801. index: number;
  98802. /**
  98803. * The browser gamepad
  98804. */
  98805. browserGamepad: any;
  98806. /**
  98807. * Specifies what type of gamepad this represents
  98808. */
  98809. type: number;
  98810. private _leftStick;
  98811. private _rightStick;
  98812. /** @hidden */
  98813. _isConnected: boolean;
  98814. private _leftStickAxisX;
  98815. private _leftStickAxisY;
  98816. private _rightStickAxisX;
  98817. private _rightStickAxisY;
  98818. /**
  98819. * Triggered when the left control stick has been changed
  98820. */
  98821. private _onleftstickchanged;
  98822. /**
  98823. * Triggered when the right control stick has been changed
  98824. */
  98825. private _onrightstickchanged;
  98826. /**
  98827. * Represents a gamepad controller
  98828. */
  98829. static GAMEPAD: number;
  98830. /**
  98831. * Represents a generic controller
  98832. */
  98833. static GENERIC: number;
  98834. /**
  98835. * Represents an XBox controller
  98836. */
  98837. static XBOX: number;
  98838. /**
  98839. * Represents a pose-enabled controller
  98840. */
  98841. static POSE_ENABLED: number;
  98842. /**
  98843. * Represents an Dual Shock controller
  98844. */
  98845. static DUALSHOCK: number;
  98846. /**
  98847. * Specifies whether the left control stick should be Y-inverted
  98848. */
  98849. protected _invertLeftStickY: boolean;
  98850. /**
  98851. * Specifies if the gamepad has been connected
  98852. */
  98853. get isConnected(): boolean;
  98854. /**
  98855. * Initializes the gamepad
  98856. * @param id The id of the gamepad
  98857. * @param index The index of the gamepad
  98858. * @param browserGamepad The browser gamepad
  98859. * @param leftStickX The x component of the left joystick
  98860. * @param leftStickY The y component of the left joystick
  98861. * @param rightStickX The x component of the right joystick
  98862. * @param rightStickY The y component of the right joystick
  98863. */
  98864. constructor(
  98865. /**
  98866. * The id of the gamepad
  98867. */
  98868. id: string,
  98869. /**
  98870. * The index of the gamepad
  98871. */
  98872. index: number,
  98873. /**
  98874. * The browser gamepad
  98875. */
  98876. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  98877. /**
  98878. * Callback triggered when the left joystick has changed
  98879. * @param callback
  98880. */
  98881. onleftstickchanged(callback: (values: StickValues) => void): void;
  98882. /**
  98883. * Callback triggered when the right joystick has changed
  98884. * @param callback
  98885. */
  98886. onrightstickchanged(callback: (values: StickValues) => void): void;
  98887. /**
  98888. * Gets the left joystick
  98889. */
  98890. get leftStick(): StickValues;
  98891. /**
  98892. * Sets the left joystick values
  98893. */
  98894. set leftStick(newValues: StickValues);
  98895. /**
  98896. * Gets the right joystick
  98897. */
  98898. get rightStick(): StickValues;
  98899. /**
  98900. * Sets the right joystick value
  98901. */
  98902. set rightStick(newValues: StickValues);
  98903. /**
  98904. * Updates the gamepad joystick positions
  98905. */
  98906. update(): void;
  98907. /**
  98908. * Disposes the gamepad
  98909. */
  98910. dispose(): void;
  98911. }
  98912. /**
  98913. * Represents a generic gamepad
  98914. */
  98915. export class GenericPad extends Gamepad {
  98916. private _buttons;
  98917. private _onbuttondown;
  98918. private _onbuttonup;
  98919. /**
  98920. * Observable triggered when a button has been pressed
  98921. */
  98922. onButtonDownObservable: Observable<number>;
  98923. /**
  98924. * Observable triggered when a button has been released
  98925. */
  98926. onButtonUpObservable: Observable<number>;
  98927. /**
  98928. * Callback triggered when a button has been pressed
  98929. * @param callback Called when a button has been pressed
  98930. */
  98931. onbuttondown(callback: (buttonPressed: number) => void): void;
  98932. /**
  98933. * Callback triggered when a button has been released
  98934. * @param callback Called when a button has been released
  98935. */
  98936. onbuttonup(callback: (buttonReleased: number) => void): void;
  98937. /**
  98938. * Initializes the generic gamepad
  98939. * @param id The id of the generic gamepad
  98940. * @param index The index of the generic gamepad
  98941. * @param browserGamepad The browser gamepad
  98942. */
  98943. constructor(id: string, index: number, browserGamepad: any);
  98944. private _setButtonValue;
  98945. /**
  98946. * Updates the generic gamepad
  98947. */
  98948. update(): void;
  98949. /**
  98950. * Disposes the generic gamepad
  98951. */
  98952. dispose(): void;
  98953. }
  98954. }
  98955. declare module BABYLON {
  98956. /**
  98957. * Defines the types of pose enabled controllers that are supported
  98958. */
  98959. export enum PoseEnabledControllerType {
  98960. /**
  98961. * HTC Vive
  98962. */
  98963. VIVE = 0,
  98964. /**
  98965. * Oculus Rift
  98966. */
  98967. OCULUS = 1,
  98968. /**
  98969. * Windows mixed reality
  98970. */
  98971. WINDOWS = 2,
  98972. /**
  98973. * Samsung gear VR
  98974. */
  98975. GEAR_VR = 3,
  98976. /**
  98977. * Google Daydream
  98978. */
  98979. DAYDREAM = 4,
  98980. /**
  98981. * Generic
  98982. */
  98983. GENERIC = 5
  98984. }
  98985. /**
  98986. * Defines the MutableGamepadButton interface for the state of a gamepad button
  98987. */
  98988. export interface MutableGamepadButton {
  98989. /**
  98990. * Value of the button/trigger
  98991. */
  98992. value: number;
  98993. /**
  98994. * If the button/trigger is currently touched
  98995. */
  98996. touched: boolean;
  98997. /**
  98998. * If the button/trigger is currently pressed
  98999. */
  99000. pressed: boolean;
  99001. }
  99002. /**
  99003. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  99004. * @hidden
  99005. */
  99006. export interface ExtendedGamepadButton extends GamepadButton {
  99007. /**
  99008. * If the button/trigger is currently pressed
  99009. */
  99010. readonly pressed: boolean;
  99011. /**
  99012. * If the button/trigger is currently touched
  99013. */
  99014. readonly touched: boolean;
  99015. /**
  99016. * Value of the button/trigger
  99017. */
  99018. readonly value: number;
  99019. }
  99020. /** @hidden */
  99021. export interface _GamePadFactory {
  99022. /**
  99023. * Returns whether or not the current gamepad can be created for this type of controller.
  99024. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99025. * @returns true if it can be created, otherwise false
  99026. */
  99027. canCreate(gamepadInfo: any): boolean;
  99028. /**
  99029. * Creates a new instance of the Gamepad.
  99030. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99031. * @returns the new gamepad instance
  99032. */
  99033. create(gamepadInfo: any): Gamepad;
  99034. }
  99035. /**
  99036. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99037. */
  99038. export class PoseEnabledControllerHelper {
  99039. /** @hidden */
  99040. static _ControllerFactories: _GamePadFactory[];
  99041. /** @hidden */
  99042. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  99043. /**
  99044. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99045. * @param vrGamepad the gamepad to initialized
  99046. * @returns a vr controller of the type the gamepad identified as
  99047. */
  99048. static InitiateController(vrGamepad: any): Gamepad;
  99049. }
  99050. /**
  99051. * Defines the PoseEnabledController object that contains state of a vr capable controller
  99052. */
  99053. export class PoseEnabledController extends Gamepad implements PoseControlled {
  99054. /**
  99055. * If the controller is used in a webXR session
  99056. */
  99057. isXR: boolean;
  99058. private _deviceRoomPosition;
  99059. private _deviceRoomRotationQuaternion;
  99060. /**
  99061. * The device position in babylon space
  99062. */
  99063. devicePosition: Vector3;
  99064. /**
  99065. * The device rotation in babylon space
  99066. */
  99067. deviceRotationQuaternion: Quaternion;
  99068. /**
  99069. * The scale factor of the device in babylon space
  99070. */
  99071. deviceScaleFactor: number;
  99072. /**
  99073. * (Likely devicePosition should be used instead) The device position in its room space
  99074. */
  99075. position: Vector3;
  99076. /**
  99077. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  99078. */
  99079. rotationQuaternion: Quaternion;
  99080. /**
  99081. * The type of controller (Eg. Windows mixed reality)
  99082. */
  99083. controllerType: PoseEnabledControllerType;
  99084. protected _calculatedPosition: Vector3;
  99085. private _calculatedRotation;
  99086. /**
  99087. * The raw pose from the device
  99088. */
  99089. rawPose: DevicePose;
  99090. private _trackPosition;
  99091. private _maxRotationDistFromHeadset;
  99092. private _draggedRoomRotation;
  99093. /**
  99094. * @hidden
  99095. */
  99096. _disableTrackPosition(fixedPosition: Vector3): void;
  99097. /**
  99098. * Internal, the mesh attached to the controller
  99099. * @hidden
  99100. */
  99101. _mesh: Nullable<AbstractMesh>;
  99102. private _poseControlledCamera;
  99103. private _leftHandSystemQuaternion;
  99104. /**
  99105. * Internal, matrix used to convert room space to babylon space
  99106. * @hidden
  99107. */
  99108. _deviceToWorld: Matrix;
  99109. /**
  99110. * Node to be used when casting a ray from the controller
  99111. * @hidden
  99112. */
  99113. _pointingPoseNode: Nullable<TransformNode>;
  99114. /**
  99115. * Name of the child mesh that can be used to cast a ray from the controller
  99116. */
  99117. static readonly POINTING_POSE: string;
  99118. /**
  99119. * Creates a new PoseEnabledController from a gamepad
  99120. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  99121. */
  99122. constructor(browserGamepad: any);
  99123. private _workingMatrix;
  99124. /**
  99125. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  99126. */
  99127. update(): void;
  99128. /**
  99129. * Updates only the pose device and mesh without doing any button event checking
  99130. */
  99131. protected _updatePoseAndMesh(): void;
  99132. /**
  99133. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  99134. * @param poseData raw pose fromthe device
  99135. */
  99136. updateFromDevice(poseData: DevicePose): void;
  99137. /**
  99138. * @hidden
  99139. */
  99140. _meshAttachedObservable: Observable<AbstractMesh>;
  99141. /**
  99142. * Attaches a mesh to the controller
  99143. * @param mesh the mesh to be attached
  99144. */
  99145. attachToMesh(mesh: AbstractMesh): void;
  99146. /**
  99147. * Attaches the controllers mesh to a camera
  99148. * @param camera the camera the mesh should be attached to
  99149. */
  99150. attachToPoseControlledCamera(camera: TargetCamera): void;
  99151. /**
  99152. * Disposes of the controller
  99153. */
  99154. dispose(): void;
  99155. /**
  99156. * The mesh that is attached to the controller
  99157. */
  99158. get mesh(): Nullable<AbstractMesh>;
  99159. /**
  99160. * Gets the ray of the controller in the direction the controller is pointing
  99161. * @param length the length the resulting ray should be
  99162. * @returns a ray in the direction the controller is pointing
  99163. */
  99164. getForwardRay(length?: number): Ray;
  99165. }
  99166. }
  99167. declare module BABYLON {
  99168. /**
  99169. * Defines the WebVRController object that represents controllers tracked in 3D space
  99170. */
  99171. export abstract class WebVRController extends PoseEnabledController {
  99172. /**
  99173. * Internal, the default controller model for the controller
  99174. */
  99175. protected _defaultModel: Nullable<AbstractMesh>;
  99176. /**
  99177. * Fired when the trigger state has changed
  99178. */
  99179. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  99180. /**
  99181. * Fired when the main button state has changed
  99182. */
  99183. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99184. /**
  99185. * Fired when the secondary button state has changed
  99186. */
  99187. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99188. /**
  99189. * Fired when the pad state has changed
  99190. */
  99191. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  99192. /**
  99193. * Fired when controllers stick values have changed
  99194. */
  99195. onPadValuesChangedObservable: Observable<StickValues>;
  99196. /**
  99197. * Array of button availible on the controller
  99198. */
  99199. protected _buttons: Array<MutableGamepadButton>;
  99200. private _onButtonStateChange;
  99201. /**
  99202. * Fired when a controller button's state has changed
  99203. * @param callback the callback containing the button that was modified
  99204. */
  99205. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  99206. /**
  99207. * X and Y axis corresponding to the controllers joystick
  99208. */
  99209. pad: StickValues;
  99210. /**
  99211. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  99212. */
  99213. hand: string;
  99214. /**
  99215. * The default controller model for the controller
  99216. */
  99217. get defaultModel(): Nullable<AbstractMesh>;
  99218. /**
  99219. * Creates a new WebVRController from a gamepad
  99220. * @param vrGamepad the gamepad that the WebVRController should be created from
  99221. */
  99222. constructor(vrGamepad: any);
  99223. /**
  99224. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  99225. */
  99226. update(): void;
  99227. /**
  99228. * Function to be called when a button is modified
  99229. */
  99230. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  99231. /**
  99232. * Loads a mesh and attaches it to the controller
  99233. * @param scene the scene the mesh should be added to
  99234. * @param meshLoaded callback for when the mesh has been loaded
  99235. */
  99236. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  99237. private _setButtonValue;
  99238. private _changes;
  99239. private _checkChanges;
  99240. /**
  99241. * Disposes of th webVRCOntroller
  99242. */
  99243. dispose(): void;
  99244. }
  99245. }
  99246. declare module BABYLON {
  99247. /**
  99248. * The HemisphericLight simulates the ambient environment light,
  99249. * so the passed direction is the light reflection direction, not the incoming direction.
  99250. */
  99251. export class HemisphericLight extends Light {
  99252. /**
  99253. * The groundColor is the light in the opposite direction to the one specified during creation.
  99254. * 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.
  99255. */
  99256. groundColor: Color3;
  99257. /**
  99258. * The light reflection direction, not the incoming direction.
  99259. */
  99260. direction: Vector3;
  99261. /**
  99262. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99263. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99264. * The HemisphericLight can't cast shadows.
  99265. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99266. * @param name The friendly name of the light
  99267. * @param direction The direction of the light reflection
  99268. * @param scene The scene the light belongs to
  99269. */
  99270. constructor(name: string, direction: Vector3, scene: Scene);
  99271. protected _buildUniformLayout(): void;
  99272. /**
  99273. * Returns the string "HemisphericLight".
  99274. * @return The class name
  99275. */
  99276. getClassName(): string;
  99277. /**
  99278. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99279. * Returns the updated direction.
  99280. * @param target The target the direction should point to
  99281. * @return The computed direction
  99282. */
  99283. setDirectionToTarget(target: Vector3): Vector3;
  99284. /**
  99285. * Returns the shadow generator associated to the light.
  99286. * @returns Always null for hemispheric lights because it does not support shadows.
  99287. */
  99288. getShadowGenerator(): Nullable<IShadowGenerator>;
  99289. /**
  99290. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  99291. * @param effect The effect to update
  99292. * @param lightIndex The index of the light in the effect to update
  99293. * @returns The hemispheric light
  99294. */
  99295. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  99296. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  99297. /**
  99298. * Computes the world matrix of the node
  99299. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  99300. * @param useWasUpdatedFlag defines a reserved property
  99301. * @returns the world matrix
  99302. */
  99303. computeWorldMatrix(): Matrix;
  99304. /**
  99305. * Returns the integer 3.
  99306. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  99307. */
  99308. getTypeID(): number;
  99309. /**
  99310. * Prepares the list of defines specific to the light type.
  99311. * @param defines the list of defines
  99312. * @param lightIndex defines the index of the light for the effect
  99313. */
  99314. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  99315. }
  99316. }
  99317. declare module BABYLON {
  99318. /** @hidden */
  99319. export var vrMultiviewToSingleviewPixelShader: {
  99320. name: string;
  99321. shader: string;
  99322. };
  99323. }
  99324. declare module BABYLON {
  99325. /**
  99326. * Renders to multiple views with a single draw call
  99327. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  99328. */
  99329. export class MultiviewRenderTarget extends RenderTargetTexture {
  99330. /**
  99331. * Creates a multiview render target
  99332. * @param scene scene used with the render target
  99333. * @param size the size of the render target (used for each view)
  99334. */
  99335. constructor(scene: Scene, size?: number | {
  99336. width: number;
  99337. height: number;
  99338. } | {
  99339. ratio: number;
  99340. });
  99341. /**
  99342. * @hidden
  99343. * @param faceIndex the face index, if its a cube texture
  99344. */
  99345. _bindFrameBuffer(faceIndex?: number): void;
  99346. /**
  99347. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  99348. * @returns the view count
  99349. */
  99350. getViewCount(): number;
  99351. }
  99352. }
  99353. declare module BABYLON {
  99354. interface Engine {
  99355. /**
  99356. * Creates a new multiview render target
  99357. * @param width defines the width of the texture
  99358. * @param height defines the height of the texture
  99359. * @returns the created multiview texture
  99360. */
  99361. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  99362. /**
  99363. * Binds a multiview framebuffer to be drawn to
  99364. * @param multiviewTexture texture to bind
  99365. */
  99366. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  99367. }
  99368. interface Camera {
  99369. /**
  99370. * @hidden
  99371. * 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)
  99372. */
  99373. _useMultiviewToSingleView: boolean;
  99374. /**
  99375. * @hidden
  99376. * 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)
  99377. */
  99378. _multiviewTexture: Nullable<RenderTargetTexture>;
  99379. /**
  99380. * @hidden
  99381. * ensures the multiview texture of the camera exists and has the specified width/height
  99382. * @param width height to set on the multiview texture
  99383. * @param height width to set on the multiview texture
  99384. */
  99385. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  99386. }
  99387. interface Scene {
  99388. /** @hidden */
  99389. _transformMatrixR: Matrix;
  99390. /** @hidden */
  99391. _multiviewSceneUbo: Nullable<UniformBuffer>;
  99392. /** @hidden */
  99393. _createMultiviewUbo(): void;
  99394. /** @hidden */
  99395. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  99396. /** @hidden */
  99397. _renderMultiviewToSingleView(camera: Camera): void;
  99398. }
  99399. }
  99400. declare module BABYLON {
  99401. /**
  99402. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  99403. * This will not be used for webXR as it supports displaying texture arrays directly
  99404. */
  99405. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  99406. /**
  99407. * Gets a string identifying the name of the class
  99408. * @returns "VRMultiviewToSingleviewPostProcess" string
  99409. */
  99410. getClassName(): string;
  99411. /**
  99412. * Initializes a VRMultiviewToSingleview
  99413. * @param name name of the post process
  99414. * @param camera camera to be applied to
  99415. * @param scaleFactor scaling factor to the size of the output texture
  99416. */
  99417. constructor(name: string, camera: Camera, scaleFactor: number);
  99418. }
  99419. }
  99420. declare module BABYLON {
  99421. /**
  99422. * Interface used to define additional presentation attributes
  99423. */
  99424. export interface IVRPresentationAttributes {
  99425. /**
  99426. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  99427. */
  99428. highRefreshRate: boolean;
  99429. /**
  99430. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  99431. */
  99432. foveationLevel: number;
  99433. }
  99434. interface Engine {
  99435. /** @hidden */
  99436. _vrDisplay: any;
  99437. /** @hidden */
  99438. _vrSupported: boolean;
  99439. /** @hidden */
  99440. _oldSize: Size;
  99441. /** @hidden */
  99442. _oldHardwareScaleFactor: number;
  99443. /** @hidden */
  99444. _vrExclusivePointerMode: boolean;
  99445. /** @hidden */
  99446. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  99447. /** @hidden */
  99448. _onVRDisplayPointerRestricted: () => void;
  99449. /** @hidden */
  99450. _onVRDisplayPointerUnrestricted: () => void;
  99451. /** @hidden */
  99452. _onVrDisplayConnect: Nullable<(display: any) => void>;
  99453. /** @hidden */
  99454. _onVrDisplayDisconnect: Nullable<() => void>;
  99455. /** @hidden */
  99456. _onVrDisplayPresentChange: Nullable<() => void>;
  99457. /**
  99458. * Observable signaled when VR display mode changes
  99459. */
  99460. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  99461. /**
  99462. * Observable signaled when VR request present is complete
  99463. */
  99464. onVRRequestPresentComplete: Observable<boolean>;
  99465. /**
  99466. * Observable signaled when VR request present starts
  99467. */
  99468. onVRRequestPresentStart: Observable<Engine>;
  99469. /**
  99470. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  99471. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  99472. */
  99473. isInVRExclusivePointerMode: boolean;
  99474. /**
  99475. * Gets a boolean indicating if a webVR device was detected
  99476. * @returns true if a webVR device was detected
  99477. */
  99478. isVRDevicePresent(): boolean;
  99479. /**
  99480. * Gets the current webVR device
  99481. * @returns the current webVR device (or null)
  99482. */
  99483. getVRDevice(): any;
  99484. /**
  99485. * Initializes a webVR display and starts listening to display change events
  99486. * The onVRDisplayChangedObservable will be notified upon these changes
  99487. * @returns A promise containing a VRDisplay and if vr is supported
  99488. */
  99489. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  99490. /** @hidden */
  99491. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  99492. /**
  99493. * Gets or sets the presentation attributes used to configure VR rendering
  99494. */
  99495. vrPresentationAttributes?: IVRPresentationAttributes;
  99496. /**
  99497. * Call this function to switch to webVR mode
  99498. * Will do nothing if webVR is not supported or if there is no webVR device
  99499. * @param options the webvr options provided to the camera. mainly used for multiview
  99500. * @see https://doc.babylonjs.com/how_to/webvr_camera
  99501. */
  99502. enableVR(options: WebVROptions): void;
  99503. /** @hidden */
  99504. _onVRFullScreenTriggered(): void;
  99505. }
  99506. }
  99507. declare module BABYLON {
  99508. /**
  99509. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  99510. * IMPORTANT!! The data is right-hand data.
  99511. * @export
  99512. * @interface DevicePose
  99513. */
  99514. export interface DevicePose {
  99515. /**
  99516. * The position of the device, values in array are [x,y,z].
  99517. */
  99518. readonly position: Nullable<Float32Array>;
  99519. /**
  99520. * The linearVelocity of the device, values in array are [x,y,z].
  99521. */
  99522. readonly linearVelocity: Nullable<Float32Array>;
  99523. /**
  99524. * The linearAcceleration of the device, values in array are [x,y,z].
  99525. */
  99526. readonly linearAcceleration: Nullable<Float32Array>;
  99527. /**
  99528. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  99529. */
  99530. readonly orientation: Nullable<Float32Array>;
  99531. /**
  99532. * The angularVelocity of the device, values in array are [x,y,z].
  99533. */
  99534. readonly angularVelocity: Nullable<Float32Array>;
  99535. /**
  99536. * The angularAcceleration of the device, values in array are [x,y,z].
  99537. */
  99538. readonly angularAcceleration: Nullable<Float32Array>;
  99539. }
  99540. /**
  99541. * Interface representing a pose controlled object in Babylon.
  99542. * A pose controlled object has both regular pose values as well as pose values
  99543. * from an external device such as a VR head mounted display
  99544. */
  99545. export interface PoseControlled {
  99546. /**
  99547. * The position of the object in babylon space.
  99548. */
  99549. position: Vector3;
  99550. /**
  99551. * The rotation quaternion of the object in babylon space.
  99552. */
  99553. rotationQuaternion: Quaternion;
  99554. /**
  99555. * The position of the device in babylon space.
  99556. */
  99557. devicePosition?: Vector3;
  99558. /**
  99559. * The rotation quaternion of the device in babylon space.
  99560. */
  99561. deviceRotationQuaternion: Quaternion;
  99562. /**
  99563. * The raw pose coming from the device.
  99564. */
  99565. rawPose: Nullable<DevicePose>;
  99566. /**
  99567. * The scale of the device to be used when translating from device space to babylon space.
  99568. */
  99569. deviceScaleFactor: number;
  99570. /**
  99571. * Updates the poseControlled values based on the input device pose.
  99572. * @param poseData the pose data to update the object with
  99573. */
  99574. updateFromDevice(poseData: DevicePose): void;
  99575. }
  99576. /**
  99577. * Set of options to customize the webVRCamera
  99578. */
  99579. export interface WebVROptions {
  99580. /**
  99581. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  99582. */
  99583. trackPosition?: boolean;
  99584. /**
  99585. * Sets the scale of the vrDevice in babylon space. (default: 1)
  99586. */
  99587. positionScale?: number;
  99588. /**
  99589. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  99590. */
  99591. displayName?: string;
  99592. /**
  99593. * Should the native controller meshes be initialized. (default: true)
  99594. */
  99595. controllerMeshes?: boolean;
  99596. /**
  99597. * Creating a default HemiLight only on controllers. (default: true)
  99598. */
  99599. defaultLightingOnControllers?: boolean;
  99600. /**
  99601. * If you don't want to use the default VR button of the helper. (default: false)
  99602. */
  99603. useCustomVRButton?: boolean;
  99604. /**
  99605. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  99606. */
  99607. customVRButton?: HTMLButtonElement;
  99608. /**
  99609. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  99610. */
  99611. rayLength?: number;
  99612. /**
  99613. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  99614. */
  99615. defaultHeight?: number;
  99616. /**
  99617. * If multiview should be used if availible (default: false)
  99618. */
  99619. useMultiview?: boolean;
  99620. }
  99621. /**
  99622. * This represents a WebVR camera.
  99623. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  99624. * @example https://doc.babylonjs.com/how_to/webvr_camera
  99625. */
  99626. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  99627. private webVROptions;
  99628. /**
  99629. * @hidden
  99630. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  99631. */
  99632. _vrDevice: any;
  99633. /**
  99634. * The rawPose of the vrDevice.
  99635. */
  99636. rawPose: Nullable<DevicePose>;
  99637. private _onVREnabled;
  99638. private _specsVersion;
  99639. private _attached;
  99640. private _frameData;
  99641. protected _descendants: Array<Node>;
  99642. private _deviceRoomPosition;
  99643. /** @hidden */
  99644. _deviceRoomRotationQuaternion: Quaternion;
  99645. private _standingMatrix;
  99646. /**
  99647. * Represents device position in babylon space.
  99648. */
  99649. devicePosition: Vector3;
  99650. /**
  99651. * Represents device rotation in babylon space.
  99652. */
  99653. deviceRotationQuaternion: Quaternion;
  99654. /**
  99655. * The scale of the device to be used when translating from device space to babylon space.
  99656. */
  99657. deviceScaleFactor: number;
  99658. private _deviceToWorld;
  99659. private _worldToDevice;
  99660. /**
  99661. * References to the webVR controllers for the vrDevice.
  99662. */
  99663. controllers: Array<WebVRController>;
  99664. /**
  99665. * Emits an event when a controller is attached.
  99666. */
  99667. onControllersAttachedObservable: Observable<WebVRController[]>;
  99668. /**
  99669. * Emits an event when a controller's mesh has been loaded;
  99670. */
  99671. onControllerMeshLoadedObservable: Observable<WebVRController>;
  99672. /**
  99673. * Emits an event when the HMD's pose has been updated.
  99674. */
  99675. onPoseUpdatedFromDeviceObservable: Observable<any>;
  99676. private _poseSet;
  99677. /**
  99678. * If the rig cameras be used as parent instead of this camera.
  99679. */
  99680. rigParenting: boolean;
  99681. private _lightOnControllers;
  99682. private _defaultHeight?;
  99683. /**
  99684. * Instantiates a WebVRFreeCamera.
  99685. * @param name The name of the WebVRFreeCamera
  99686. * @param position The starting anchor position for the camera
  99687. * @param scene The scene the camera belongs to
  99688. * @param webVROptions a set of customizable options for the webVRCamera
  99689. */
  99690. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  99691. /**
  99692. * Gets the device distance from the ground in meters.
  99693. * @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.
  99694. */
  99695. deviceDistanceToRoomGround(): number;
  99696. /**
  99697. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99698. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  99699. */
  99700. useStandingMatrix(callback?: (bool: boolean) => void): void;
  99701. /**
  99702. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99703. * @returns A promise with a boolean set to if the standing matrix is supported.
  99704. */
  99705. useStandingMatrixAsync(): Promise<boolean>;
  99706. /**
  99707. * Disposes the camera
  99708. */
  99709. dispose(): void;
  99710. /**
  99711. * Gets a vrController by name.
  99712. * @param name The name of the controller to retreive
  99713. * @returns the controller matching the name specified or null if not found
  99714. */
  99715. getControllerByName(name: string): Nullable<WebVRController>;
  99716. private _leftController;
  99717. /**
  99718. * The controller corresponding to the users left hand.
  99719. */
  99720. get leftController(): Nullable<WebVRController>;
  99721. private _rightController;
  99722. /**
  99723. * The controller corresponding to the users right hand.
  99724. */
  99725. get rightController(): Nullable<WebVRController>;
  99726. /**
  99727. * Casts a ray forward from the vrCamera's gaze.
  99728. * @param length Length of the ray (default: 100)
  99729. * @returns the ray corresponding to the gaze
  99730. */
  99731. getForwardRay(length?: number): Ray;
  99732. /**
  99733. * @hidden
  99734. * Updates the camera based on device's frame data
  99735. */
  99736. _checkInputs(): void;
  99737. /**
  99738. * Updates the poseControlled values based on the input device pose.
  99739. * @param poseData Pose coming from the device
  99740. */
  99741. updateFromDevice(poseData: DevicePose): void;
  99742. private _htmlElementAttached;
  99743. private _detachIfAttached;
  99744. /**
  99745. * WebVR's attach control will start broadcasting frames to the device.
  99746. * Note that in certain browsers (chrome for example) this function must be called
  99747. * within a user-interaction callback. Example:
  99748. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  99749. *
  99750. * @param element html element to attach the vrDevice to
  99751. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  99752. */
  99753. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99754. /**
  99755. * Detaches the camera from the html element and disables VR
  99756. *
  99757. * @param element html element to detach from
  99758. */
  99759. detachControl(element: HTMLElement): void;
  99760. /**
  99761. * @returns the name of this class
  99762. */
  99763. getClassName(): string;
  99764. /**
  99765. * Calls resetPose on the vrDisplay
  99766. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  99767. */
  99768. resetToCurrentRotation(): void;
  99769. /**
  99770. * @hidden
  99771. * Updates the rig cameras (left and right eye)
  99772. */
  99773. _updateRigCameras(): void;
  99774. private _workingVector;
  99775. private _oneVector;
  99776. private _workingMatrix;
  99777. private updateCacheCalled;
  99778. private _correctPositionIfNotTrackPosition;
  99779. /**
  99780. * @hidden
  99781. * Updates the cached values of the camera
  99782. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  99783. */
  99784. _updateCache(ignoreParentClass?: boolean): void;
  99785. /**
  99786. * @hidden
  99787. * Get current device position in babylon world
  99788. */
  99789. _computeDevicePosition(): void;
  99790. /**
  99791. * Updates the current device position and rotation in the babylon world
  99792. */
  99793. update(): void;
  99794. /**
  99795. * @hidden
  99796. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  99797. * @returns an identity matrix
  99798. */
  99799. _getViewMatrix(): Matrix;
  99800. private _tmpMatrix;
  99801. /**
  99802. * This function is called by the two RIG cameras.
  99803. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  99804. * @hidden
  99805. */
  99806. _getWebVRViewMatrix(): Matrix;
  99807. /** @hidden */
  99808. _getWebVRProjectionMatrix(): Matrix;
  99809. private _onGamepadConnectedObserver;
  99810. private _onGamepadDisconnectedObserver;
  99811. private _updateCacheWhenTrackingDisabledObserver;
  99812. /**
  99813. * Initializes the controllers and their meshes
  99814. */
  99815. initControllers(): void;
  99816. }
  99817. }
  99818. declare module BABYLON {
  99819. /**
  99820. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  99821. *
  99822. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  99823. *
  99824. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  99825. */
  99826. export class MaterialHelper {
  99827. /**
  99828. * Bind the current view position to an effect.
  99829. * @param effect The effect to be bound
  99830. * @param scene The scene the eyes position is used from
  99831. * @param variableName name of the shader variable that will hold the eye position
  99832. */
  99833. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  99834. /**
  99835. * Helps preparing the defines values about the UVs in used in the effect.
  99836. * UVs are shared as much as we can accross channels in the shaders.
  99837. * @param texture The texture we are preparing the UVs for
  99838. * @param defines The defines to update
  99839. * @param key The channel key "diffuse", "specular"... used in the shader
  99840. */
  99841. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  99842. /**
  99843. * Binds a texture matrix value to its corrsponding uniform
  99844. * @param texture The texture to bind the matrix for
  99845. * @param uniformBuffer The uniform buffer receivin the data
  99846. * @param key The channel key "diffuse", "specular"... used in the shader
  99847. */
  99848. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  99849. /**
  99850. * Gets the current status of the fog (should it be enabled?)
  99851. * @param mesh defines the mesh to evaluate for fog support
  99852. * @param scene defines the hosting scene
  99853. * @returns true if fog must be enabled
  99854. */
  99855. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  99856. /**
  99857. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  99858. * @param mesh defines the current mesh
  99859. * @param scene defines the current scene
  99860. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  99861. * @param pointsCloud defines if point cloud rendering has to be turned on
  99862. * @param fogEnabled defines if fog has to be turned on
  99863. * @param alphaTest defines if alpha testing has to be turned on
  99864. * @param defines defines the current list of defines
  99865. */
  99866. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  99867. /**
  99868. * Helper used to prepare the list of defines associated with frame values for shader compilation
  99869. * @param scene defines the current scene
  99870. * @param engine defines the current engine
  99871. * @param defines specifies the list of active defines
  99872. * @param useInstances defines if instances have to be turned on
  99873. * @param useClipPlane defines if clip plane have to be turned on
  99874. * @param useInstances defines if instances have to be turned on
  99875. * @param useThinInstances defines if thin instances have to be turned on
  99876. */
  99877. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  99878. /**
  99879. * Prepares the defines for bones
  99880. * @param mesh The mesh containing the geometry data we will draw
  99881. * @param defines The defines to update
  99882. */
  99883. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  99884. /**
  99885. * Prepares the defines for morph targets
  99886. * @param mesh The mesh containing the geometry data we will draw
  99887. * @param defines The defines to update
  99888. */
  99889. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  99890. /**
  99891. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  99892. * @param mesh The mesh containing the geometry data we will draw
  99893. * @param defines The defines to update
  99894. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  99895. * @param useBones Precise whether bones should be used or not (override mesh info)
  99896. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  99897. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  99898. * @returns false if defines are considered not dirty and have not been checked
  99899. */
  99900. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  99901. /**
  99902. * Prepares the defines related to multiview
  99903. * @param scene The scene we are intending to draw
  99904. * @param defines The defines to update
  99905. */
  99906. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  99907. /**
  99908. * Prepares the defines related to the prepass
  99909. * @param scene The scene we are intending to draw
  99910. * @param defines The defines to update
  99911. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  99912. */
  99913. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  99914. /**
  99915. * Prepares the defines related to the light information passed in parameter
  99916. * @param scene The scene we are intending to draw
  99917. * @param mesh The mesh the effect is compiling for
  99918. * @param light The light the effect is compiling for
  99919. * @param lightIndex The index of the light
  99920. * @param defines The defines to update
  99921. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99922. * @param state Defines the current state regarding what is needed (normals, etc...)
  99923. */
  99924. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  99925. needNormals: boolean;
  99926. needRebuild: boolean;
  99927. shadowEnabled: boolean;
  99928. specularEnabled: boolean;
  99929. lightmapMode: boolean;
  99930. }): void;
  99931. /**
  99932. * Prepares the defines related to the light information passed in parameter
  99933. * @param scene The scene we are intending to draw
  99934. * @param mesh The mesh the effect is compiling for
  99935. * @param defines The defines to update
  99936. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99937. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  99938. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  99939. * @returns true if normals will be required for the rest of the effect
  99940. */
  99941. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  99942. /**
  99943. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  99944. * @param lightIndex defines the light index
  99945. * @param uniformsList The uniform list
  99946. * @param samplersList The sampler list
  99947. * @param projectedLightTexture defines if projected texture must be used
  99948. * @param uniformBuffersList defines an optional list of uniform buffers
  99949. */
  99950. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  99951. /**
  99952. * Prepares the uniforms and samplers list to be used in the effect
  99953. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  99954. * @param samplersList The sampler list
  99955. * @param defines The defines helping in the list generation
  99956. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  99957. */
  99958. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  99959. /**
  99960. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  99961. * @param defines The defines to update while falling back
  99962. * @param fallbacks The authorized effect fallbacks
  99963. * @param maxSimultaneousLights The maximum number of lights allowed
  99964. * @param rank the current rank of the Effect
  99965. * @returns The newly affected rank
  99966. */
  99967. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  99968. private static _TmpMorphInfluencers;
  99969. /**
  99970. * Prepares the list of attributes required for morph targets according to the effect defines.
  99971. * @param attribs The current list of supported attribs
  99972. * @param mesh The mesh to prepare the morph targets attributes for
  99973. * @param influencers The number of influencers
  99974. */
  99975. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  99976. /**
  99977. * Prepares the list of attributes required for morph targets according to the effect defines.
  99978. * @param attribs The current list of supported attribs
  99979. * @param mesh The mesh to prepare the morph targets attributes for
  99980. * @param defines The current Defines of the effect
  99981. */
  99982. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  99983. /**
  99984. * Prepares the list of attributes required for bones according to the effect defines.
  99985. * @param attribs The current list of supported attribs
  99986. * @param mesh The mesh to prepare the bones attributes for
  99987. * @param defines The current Defines of the effect
  99988. * @param fallbacks The current efffect fallback strategy
  99989. */
  99990. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  99991. /**
  99992. * Check and prepare the list of attributes required for instances according to the effect defines.
  99993. * @param attribs The current list of supported attribs
  99994. * @param defines The current MaterialDefines of the effect
  99995. */
  99996. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  99997. /**
  99998. * Add the list of attributes required for instances to the attribs array.
  99999. * @param attribs The current list of supported attribs
  100000. */
  100001. static PushAttributesForInstances(attribs: string[]): void;
  100002. /**
  100003. * Binds the light information to the effect.
  100004. * @param light The light containing the generator
  100005. * @param effect The effect we are binding the data to
  100006. * @param lightIndex The light index in the effect used to render
  100007. */
  100008. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  100009. /**
  100010. * Binds the lights information from the scene to the effect for the given mesh.
  100011. * @param light Light to bind
  100012. * @param lightIndex Light index
  100013. * @param scene The scene where the light belongs to
  100014. * @param effect The effect we are binding the data to
  100015. * @param useSpecular Defines if specular is supported
  100016. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100017. */
  100018. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  100019. /**
  100020. * Binds the lights information from the scene to the effect for the given mesh.
  100021. * @param scene The scene the lights belongs to
  100022. * @param mesh The mesh we are binding the information to render
  100023. * @param effect The effect we are binding the data to
  100024. * @param defines The generated defines for the effect
  100025. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  100026. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100027. */
  100028. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  100029. private static _tempFogColor;
  100030. /**
  100031. * Binds the fog information from the scene to the effect for the given mesh.
  100032. * @param scene The scene the lights belongs to
  100033. * @param mesh The mesh we are binding the information to render
  100034. * @param effect The effect we are binding the data to
  100035. * @param linearSpace Defines if the fog effect is applied in linear space
  100036. */
  100037. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  100038. /**
  100039. * Binds the bones information from the mesh to the effect.
  100040. * @param mesh The mesh we are binding the information to render
  100041. * @param effect The effect we are binding the data to
  100042. */
  100043. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  100044. /**
  100045. * Binds the morph targets information from the mesh to the effect.
  100046. * @param abstractMesh The mesh we are binding the information to render
  100047. * @param effect The effect we are binding the data to
  100048. */
  100049. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  100050. /**
  100051. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  100052. * @param defines The generated defines used in the effect
  100053. * @param effect The effect we are binding the data to
  100054. * @param scene The scene we are willing to render with logarithmic scale for
  100055. */
  100056. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  100057. /**
  100058. * Binds the clip plane information from the scene to the effect.
  100059. * @param scene The scene the clip plane information are extracted from
  100060. * @param effect The effect we are binding the data to
  100061. */
  100062. static BindClipPlane(effect: Effect, scene: Scene): void;
  100063. }
  100064. }
  100065. declare module BABYLON {
  100066. /**
  100067. * Block used to expose an input value
  100068. */
  100069. export class InputBlock extends NodeMaterialBlock {
  100070. private _mode;
  100071. private _associatedVariableName;
  100072. private _storedValue;
  100073. private _valueCallback;
  100074. private _type;
  100075. private _animationType;
  100076. /** Gets or set a value used to limit the range of float values */
  100077. min: number;
  100078. /** Gets or set a value used to limit the range of float values */
  100079. max: number;
  100080. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  100081. isBoolean: boolean;
  100082. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  100083. matrixMode: number;
  100084. /** @hidden */
  100085. _systemValue: Nullable<NodeMaterialSystemValues>;
  100086. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  100087. visibleInInspector: boolean;
  100088. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  100089. isConstant: boolean;
  100090. /** Gets or sets the group to use to display this block in the Inspector */
  100091. groupInInspector: string;
  100092. /** Gets an observable raised when the value is changed */
  100093. onValueChangedObservable: Observable<InputBlock>;
  100094. /**
  100095. * Gets or sets the connection point type (default is float)
  100096. */
  100097. get type(): NodeMaterialBlockConnectionPointTypes;
  100098. /**
  100099. * Creates a new InputBlock
  100100. * @param name defines the block name
  100101. * @param target defines the target of that block (Vertex by default)
  100102. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  100103. */
  100104. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  100105. /**
  100106. * Validates if a name is a reserve word.
  100107. * @param newName the new name to be given to the node.
  100108. * @returns false if the name is a reserve word, else true.
  100109. */
  100110. validateBlockName(newName: string): boolean;
  100111. /**
  100112. * Gets the output component
  100113. */
  100114. get output(): NodeMaterialConnectionPoint;
  100115. /**
  100116. * Set the source of this connection point to a vertex attribute
  100117. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  100118. * @returns the current connection point
  100119. */
  100120. setAsAttribute(attributeName?: string): InputBlock;
  100121. /**
  100122. * Set the source of this connection point to a system value
  100123. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  100124. * @returns the current connection point
  100125. */
  100126. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  100127. /**
  100128. * Gets or sets the value of that point.
  100129. * Please note that this value will be ignored if valueCallback is defined
  100130. */
  100131. get value(): any;
  100132. set value(value: any);
  100133. /**
  100134. * Gets or sets a callback used to get the value of that point.
  100135. * Please note that setting this value will force the connection point to ignore the value property
  100136. */
  100137. get valueCallback(): () => any;
  100138. set valueCallback(value: () => any);
  100139. /**
  100140. * Gets or sets the associated variable name in the shader
  100141. */
  100142. get associatedVariableName(): string;
  100143. set associatedVariableName(value: string);
  100144. /** Gets or sets the type of animation applied to the input */
  100145. get animationType(): AnimatedInputBlockTypes;
  100146. set animationType(value: AnimatedInputBlockTypes);
  100147. /**
  100148. * Gets a boolean indicating that this connection point not defined yet
  100149. */
  100150. get isUndefined(): boolean;
  100151. /**
  100152. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  100153. * In this case the connection point name must be the name of the uniform to use.
  100154. * Can only be set on inputs
  100155. */
  100156. get isUniform(): boolean;
  100157. set isUniform(value: boolean);
  100158. /**
  100159. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  100160. * In this case the connection point name must be the name of the attribute to use
  100161. * Can only be set on inputs
  100162. */
  100163. get isAttribute(): boolean;
  100164. set isAttribute(value: boolean);
  100165. /**
  100166. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  100167. * Can only be set on exit points
  100168. */
  100169. get isVarying(): boolean;
  100170. set isVarying(value: boolean);
  100171. /**
  100172. * Gets a boolean indicating that the current connection point is a system value
  100173. */
  100174. get isSystemValue(): boolean;
  100175. /**
  100176. * Gets or sets the current well known value or null if not defined as a system value
  100177. */
  100178. get systemValue(): Nullable<NodeMaterialSystemValues>;
  100179. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  100180. /**
  100181. * Gets the current class name
  100182. * @returns the class name
  100183. */
  100184. getClassName(): string;
  100185. /**
  100186. * Animate the input if animationType !== None
  100187. * @param scene defines the rendering scene
  100188. */
  100189. animate(scene: Scene): void;
  100190. private _emitDefine;
  100191. initialize(state: NodeMaterialBuildState): void;
  100192. /**
  100193. * Set the input block to its default value (based on its type)
  100194. */
  100195. setDefaultValue(): void;
  100196. private _emitConstant;
  100197. /** @hidden */
  100198. get _noContextSwitch(): boolean;
  100199. private _emit;
  100200. /** @hidden */
  100201. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  100202. /** @hidden */
  100203. _transmit(effect: Effect, scene: Scene): void;
  100204. protected _buildBlock(state: NodeMaterialBuildState): void;
  100205. protected _dumpPropertiesCode(): string;
  100206. dispose(): void;
  100207. serialize(): any;
  100208. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100209. }
  100210. }
  100211. declare module BABYLON {
  100212. /**
  100213. * Enum used to define the compatibility state between two connection points
  100214. */
  100215. export enum NodeMaterialConnectionPointCompatibilityStates {
  100216. /** Points are compatibles */
  100217. Compatible = 0,
  100218. /** Points are incompatible because of their types */
  100219. TypeIncompatible = 1,
  100220. /** Points are incompatible because of their targets (vertex vs fragment) */
  100221. TargetIncompatible = 2
  100222. }
  100223. /**
  100224. * Defines the direction of a connection point
  100225. */
  100226. export enum NodeMaterialConnectionPointDirection {
  100227. /** Input */
  100228. Input = 0,
  100229. /** Output */
  100230. Output = 1
  100231. }
  100232. /**
  100233. * Defines a connection point for a block
  100234. */
  100235. export class NodeMaterialConnectionPoint {
  100236. /** @hidden */
  100237. _ownerBlock: NodeMaterialBlock;
  100238. /** @hidden */
  100239. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  100240. private _endpoints;
  100241. private _associatedVariableName;
  100242. private _direction;
  100243. /** @hidden */
  100244. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100245. /** @hidden */
  100246. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100247. private _type;
  100248. /** @hidden */
  100249. _enforceAssociatedVariableName: boolean;
  100250. /** Gets the direction of the point */
  100251. get direction(): NodeMaterialConnectionPointDirection;
  100252. /** Indicates that this connection point needs dual validation before being connected to another point */
  100253. needDualDirectionValidation: boolean;
  100254. /**
  100255. * Gets or sets the additional types supported by this connection point
  100256. */
  100257. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100258. /**
  100259. * Gets or sets the additional types excluded by this connection point
  100260. */
  100261. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100262. /**
  100263. * Observable triggered when this point is connected
  100264. */
  100265. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100266. /**
  100267. * Gets or sets the associated variable name in the shader
  100268. */
  100269. get associatedVariableName(): string;
  100270. set associatedVariableName(value: string);
  100271. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100272. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100273. /**
  100274. * Gets or sets the connection point type (default is float)
  100275. */
  100276. get type(): NodeMaterialBlockConnectionPointTypes;
  100277. set type(value: NodeMaterialBlockConnectionPointTypes);
  100278. /**
  100279. * Gets or sets the connection point name
  100280. */
  100281. name: string;
  100282. /**
  100283. * Gets or sets the connection point name
  100284. */
  100285. displayName: string;
  100286. /**
  100287. * Gets or sets a boolean indicating that this connection point can be omitted
  100288. */
  100289. isOptional: boolean;
  100290. /**
  100291. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  100292. */
  100293. isExposedOnFrame: boolean;
  100294. /**
  100295. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  100296. */
  100297. define: string;
  100298. /** @hidden */
  100299. _prioritizeVertex: boolean;
  100300. private _target;
  100301. /** Gets or sets the target of that connection point */
  100302. get target(): NodeMaterialBlockTargets;
  100303. set target(value: NodeMaterialBlockTargets);
  100304. /**
  100305. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  100306. */
  100307. get isConnected(): boolean;
  100308. /**
  100309. * Gets a boolean indicating that the current point is connected to an input block
  100310. */
  100311. get isConnectedToInputBlock(): boolean;
  100312. /**
  100313. * Gets a the connected input block (if any)
  100314. */
  100315. get connectInputBlock(): Nullable<InputBlock>;
  100316. /** Get the other side of the connection (if any) */
  100317. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  100318. /** Get the block that owns this connection point */
  100319. get ownerBlock(): NodeMaterialBlock;
  100320. /** Get the block connected on the other side of this connection (if any) */
  100321. get sourceBlock(): Nullable<NodeMaterialBlock>;
  100322. /** Get the block connected on the endpoints of this connection (if any) */
  100323. get connectedBlocks(): Array<NodeMaterialBlock>;
  100324. /** Gets the list of connected endpoints */
  100325. get endpoints(): NodeMaterialConnectionPoint[];
  100326. /** Gets a boolean indicating if that output point is connected to at least one input */
  100327. get hasEndpoints(): boolean;
  100328. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  100329. get isConnectedInVertexShader(): boolean;
  100330. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  100331. get isConnectedInFragmentShader(): boolean;
  100332. /**
  100333. * Creates a block suitable to be used as an input for this input point.
  100334. * If null is returned, a block based on the point type will be created.
  100335. * @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
  100336. */
  100337. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100338. /**
  100339. * Creates a new connection point
  100340. * @param name defines the connection point name
  100341. * @param ownerBlock defines the block hosting this connection point
  100342. * @param direction defines the direction of the connection point
  100343. */
  100344. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  100345. /**
  100346. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  100347. * @returns the class name
  100348. */
  100349. getClassName(): string;
  100350. /**
  100351. * Gets a boolean indicating if the current point can be connected to another point
  100352. * @param connectionPoint defines the other connection point
  100353. * @returns a boolean
  100354. */
  100355. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  100356. /**
  100357. * Gets a number indicating if the current point can be connected to another point
  100358. * @param connectionPoint defines the other connection point
  100359. * @returns a number defining the compatibility state
  100360. */
  100361. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100362. /**
  100363. * Connect this point to another connection point
  100364. * @param connectionPoint defines the other connection point
  100365. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  100366. * @returns the current connection point
  100367. */
  100368. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  100369. /**
  100370. * Disconnect this point from one of his endpoint
  100371. * @param endpoint defines the other connection point
  100372. * @returns the current connection point
  100373. */
  100374. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  100375. /**
  100376. * Serializes this point in a JSON representation
  100377. * @param isInput defines if the connection point is an input (default is true)
  100378. * @returns the serialized point object
  100379. */
  100380. serialize(isInput?: boolean): any;
  100381. /**
  100382. * Release resources
  100383. */
  100384. dispose(): void;
  100385. }
  100386. }
  100387. declare module BABYLON {
  100388. /**
  100389. * Enum used to define the material modes
  100390. */
  100391. export enum NodeMaterialModes {
  100392. /** Regular material */
  100393. Material = 0,
  100394. /** For post process */
  100395. PostProcess = 1,
  100396. /** For particle system */
  100397. Particle = 2
  100398. }
  100399. }
  100400. declare module BABYLON {
  100401. /**
  100402. * Block used to read a texture from a sampler
  100403. */
  100404. export class TextureBlock extends NodeMaterialBlock {
  100405. private _defineName;
  100406. private _linearDefineName;
  100407. private _gammaDefineName;
  100408. private _tempTextureRead;
  100409. private _samplerName;
  100410. private _transformedUVName;
  100411. private _textureTransformName;
  100412. private _textureInfoName;
  100413. private _mainUVName;
  100414. private _mainUVDefineName;
  100415. private _fragmentOnly;
  100416. /**
  100417. * Gets or sets the texture associated with the node
  100418. */
  100419. texture: Nullable<Texture>;
  100420. /**
  100421. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100422. */
  100423. convertToGammaSpace: boolean;
  100424. /**
  100425. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100426. */
  100427. convertToLinearSpace: boolean;
  100428. /**
  100429. * Create a new TextureBlock
  100430. * @param name defines the block name
  100431. */
  100432. constructor(name: string, fragmentOnly?: boolean);
  100433. /**
  100434. * Gets the current class name
  100435. * @returns the class name
  100436. */
  100437. getClassName(): string;
  100438. /**
  100439. * Gets the uv input component
  100440. */
  100441. get uv(): NodeMaterialConnectionPoint;
  100442. /**
  100443. * Gets the rgba output component
  100444. */
  100445. get rgba(): NodeMaterialConnectionPoint;
  100446. /**
  100447. * Gets the rgb output component
  100448. */
  100449. get rgb(): NodeMaterialConnectionPoint;
  100450. /**
  100451. * Gets the r output component
  100452. */
  100453. get r(): NodeMaterialConnectionPoint;
  100454. /**
  100455. * Gets the g output component
  100456. */
  100457. get g(): NodeMaterialConnectionPoint;
  100458. /**
  100459. * Gets the b output component
  100460. */
  100461. get b(): NodeMaterialConnectionPoint;
  100462. /**
  100463. * Gets the a output component
  100464. */
  100465. get a(): NodeMaterialConnectionPoint;
  100466. get target(): NodeMaterialBlockTargets;
  100467. autoConfigure(material: NodeMaterial): void;
  100468. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100469. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100470. isReady(): boolean;
  100471. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100472. private get _isMixed();
  100473. private _injectVertexCode;
  100474. private _writeTextureRead;
  100475. private _writeOutput;
  100476. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100477. protected _dumpPropertiesCode(): string;
  100478. serialize(): any;
  100479. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100480. }
  100481. }
  100482. declare module BABYLON {
  100483. /** @hidden */
  100484. export var reflectionFunction: {
  100485. name: string;
  100486. shader: string;
  100487. };
  100488. }
  100489. declare module BABYLON {
  100490. /**
  100491. * Base block used to read a reflection texture from a sampler
  100492. */
  100493. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  100494. /** @hidden */
  100495. _define3DName: string;
  100496. /** @hidden */
  100497. _defineCubicName: string;
  100498. /** @hidden */
  100499. _defineExplicitName: string;
  100500. /** @hidden */
  100501. _defineProjectionName: string;
  100502. /** @hidden */
  100503. _defineLocalCubicName: string;
  100504. /** @hidden */
  100505. _defineSphericalName: string;
  100506. /** @hidden */
  100507. _definePlanarName: string;
  100508. /** @hidden */
  100509. _defineEquirectangularName: string;
  100510. /** @hidden */
  100511. _defineMirroredEquirectangularFixedName: string;
  100512. /** @hidden */
  100513. _defineEquirectangularFixedName: string;
  100514. /** @hidden */
  100515. _defineSkyboxName: string;
  100516. /** @hidden */
  100517. _defineOppositeZ: string;
  100518. /** @hidden */
  100519. _cubeSamplerName: string;
  100520. /** @hidden */
  100521. _2DSamplerName: string;
  100522. protected _positionUVWName: string;
  100523. protected _directionWName: string;
  100524. protected _reflectionVectorName: string;
  100525. /** @hidden */
  100526. _reflectionCoordsName: string;
  100527. /** @hidden */
  100528. _reflectionMatrixName: string;
  100529. protected _reflectionColorName: string;
  100530. /**
  100531. * Gets or sets the texture associated with the node
  100532. */
  100533. texture: Nullable<BaseTexture>;
  100534. /**
  100535. * Create a new ReflectionTextureBaseBlock
  100536. * @param name defines the block name
  100537. */
  100538. constructor(name: string);
  100539. /**
  100540. * Gets the current class name
  100541. * @returns the class name
  100542. */
  100543. getClassName(): string;
  100544. /**
  100545. * Gets the world position input component
  100546. */
  100547. abstract get position(): NodeMaterialConnectionPoint;
  100548. /**
  100549. * Gets the world position input component
  100550. */
  100551. abstract get worldPosition(): NodeMaterialConnectionPoint;
  100552. /**
  100553. * Gets the world normal input component
  100554. */
  100555. abstract get worldNormal(): NodeMaterialConnectionPoint;
  100556. /**
  100557. * Gets the world input component
  100558. */
  100559. abstract get world(): NodeMaterialConnectionPoint;
  100560. /**
  100561. * Gets the camera (or eye) position component
  100562. */
  100563. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  100564. /**
  100565. * Gets the view input component
  100566. */
  100567. abstract get view(): NodeMaterialConnectionPoint;
  100568. protected _getTexture(): Nullable<BaseTexture>;
  100569. autoConfigure(material: NodeMaterial): void;
  100570. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100571. isReady(): boolean;
  100572. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100573. /**
  100574. * Gets the code to inject in the vertex shader
  100575. * @param state current state of the node material building
  100576. * @returns the shader code
  100577. */
  100578. handleVertexSide(state: NodeMaterialBuildState): string;
  100579. /**
  100580. * Handles the inits for the fragment code path
  100581. * @param state node material build state
  100582. */
  100583. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  100584. /**
  100585. * Generates the reflection coords code for the fragment code path
  100586. * @param worldNormalVarName name of the world normal variable
  100587. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  100588. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  100589. * @returns the shader code
  100590. */
  100591. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  100592. /**
  100593. * Generates the reflection color code for the fragment code path
  100594. * @param lodVarName name of the lod variable
  100595. * @param swizzleLookupTexture swizzle to use for the final color variable
  100596. * @returns the shader code
  100597. */
  100598. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  100599. /**
  100600. * Generates the code corresponding to the connected output points
  100601. * @param state node material build state
  100602. * @param varName name of the variable to output
  100603. * @returns the shader code
  100604. */
  100605. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  100606. protected _buildBlock(state: NodeMaterialBuildState): this;
  100607. protected _dumpPropertiesCode(): string;
  100608. serialize(): any;
  100609. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100610. }
  100611. }
  100612. declare module BABYLON {
  100613. /**
  100614. * Defines a connection point to be used for points with a custom object type
  100615. */
  100616. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  100617. private _blockType;
  100618. private _blockName;
  100619. private _nameForCheking?;
  100620. /**
  100621. * Creates a new connection point
  100622. * @param name defines the connection point name
  100623. * @param ownerBlock defines the block hosting this connection point
  100624. * @param direction defines the direction of the connection point
  100625. */
  100626. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  100627. /**
  100628. * Gets a number indicating if the current point can be connected to another point
  100629. * @param connectionPoint defines the other connection point
  100630. * @returns a number defining the compatibility state
  100631. */
  100632. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100633. /**
  100634. * Creates a block suitable to be used as an input for this input point.
  100635. * If null is returned, a block based on the point type will be created.
  100636. * @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
  100637. */
  100638. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100639. }
  100640. }
  100641. declare module BABYLON {
  100642. /**
  100643. * Enum defining the type of properties that can be edited in the property pages in the NME
  100644. */
  100645. export enum PropertyTypeForEdition {
  100646. /** property is a boolean */
  100647. Boolean = 0,
  100648. /** property is a float */
  100649. Float = 1,
  100650. /** property is a Vector2 */
  100651. Vector2 = 2,
  100652. /** property is a list of values */
  100653. List = 3
  100654. }
  100655. /**
  100656. * Interface that defines an option in a variable of type list
  100657. */
  100658. export interface IEditablePropertyListOption {
  100659. /** label of the option */
  100660. "label": string;
  100661. /** value of the option */
  100662. "value": number;
  100663. }
  100664. /**
  100665. * Interface that defines the options available for an editable property
  100666. */
  100667. export interface IEditablePropertyOption {
  100668. /** min value */
  100669. "min"?: number;
  100670. /** max value */
  100671. "max"?: number;
  100672. /** notifiers: indicates which actions to take when the property is changed */
  100673. "notifiers"?: {
  100674. /** the material should be rebuilt */
  100675. "rebuild"?: boolean;
  100676. /** the preview should be updated */
  100677. "update"?: boolean;
  100678. };
  100679. /** list of the options for a variable of type list */
  100680. "options"?: IEditablePropertyListOption[];
  100681. }
  100682. /**
  100683. * Interface that describes an editable property
  100684. */
  100685. export interface IPropertyDescriptionForEdition {
  100686. /** name of the property */
  100687. "propertyName": string;
  100688. /** display name of the property */
  100689. "displayName": string;
  100690. /** type of the property */
  100691. "type": PropertyTypeForEdition;
  100692. /** group of the property - all properties with the same group value will be displayed in a specific section */
  100693. "groupName": string;
  100694. /** options for the property */
  100695. "options": IEditablePropertyOption;
  100696. }
  100697. /**
  100698. * Decorator that flags a property in a node material block as being editable
  100699. */
  100700. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  100701. }
  100702. declare module BABYLON {
  100703. /**
  100704. * Block used to implement the refraction part of the sub surface module of the PBR material
  100705. */
  100706. export class RefractionBlock extends NodeMaterialBlock {
  100707. /** @hidden */
  100708. _define3DName: string;
  100709. /** @hidden */
  100710. _refractionMatrixName: string;
  100711. /** @hidden */
  100712. _defineLODRefractionAlpha: string;
  100713. /** @hidden */
  100714. _defineLinearSpecularRefraction: string;
  100715. /** @hidden */
  100716. _defineOppositeZ: string;
  100717. /** @hidden */
  100718. _cubeSamplerName: string;
  100719. /** @hidden */
  100720. _2DSamplerName: string;
  100721. /** @hidden */
  100722. _vRefractionMicrosurfaceInfosName: string;
  100723. /** @hidden */
  100724. _vRefractionInfosName: string;
  100725. private _scene;
  100726. /**
  100727. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  100728. * Materials half opaque for instance using refraction could benefit from this control.
  100729. */
  100730. linkRefractionWithTransparency: boolean;
  100731. /**
  100732. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  100733. */
  100734. invertRefractionY: boolean;
  100735. /**
  100736. * Gets or sets the texture associated with the node
  100737. */
  100738. texture: Nullable<BaseTexture>;
  100739. /**
  100740. * Create a new RefractionBlock
  100741. * @param name defines the block name
  100742. */
  100743. constructor(name: string);
  100744. /**
  100745. * Gets the current class name
  100746. * @returns the class name
  100747. */
  100748. getClassName(): string;
  100749. /**
  100750. * Gets the intensity input component
  100751. */
  100752. get intensity(): NodeMaterialConnectionPoint;
  100753. /**
  100754. * Gets the index of refraction input component
  100755. */
  100756. get indexOfRefraction(): NodeMaterialConnectionPoint;
  100757. /**
  100758. * Gets the tint at distance input component
  100759. */
  100760. get tintAtDistance(): NodeMaterialConnectionPoint;
  100761. /**
  100762. * Gets the view input component
  100763. */
  100764. get view(): NodeMaterialConnectionPoint;
  100765. /**
  100766. * Gets the refraction object output component
  100767. */
  100768. get refraction(): NodeMaterialConnectionPoint;
  100769. /**
  100770. * Returns true if the block has a texture
  100771. */
  100772. get hasTexture(): boolean;
  100773. protected _getTexture(): Nullable<BaseTexture>;
  100774. autoConfigure(material: NodeMaterial): void;
  100775. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100776. isReady(): boolean;
  100777. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100778. /**
  100779. * Gets the main code of the block (fragment side)
  100780. * @param state current state of the node material building
  100781. * @returns the shader code
  100782. */
  100783. getCode(state: NodeMaterialBuildState): string;
  100784. protected _buildBlock(state: NodeMaterialBuildState): this;
  100785. protected _dumpPropertiesCode(): string;
  100786. serialize(): any;
  100787. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100788. }
  100789. }
  100790. declare module BABYLON {
  100791. /**
  100792. * Base block used as input for post process
  100793. */
  100794. export class CurrentScreenBlock extends NodeMaterialBlock {
  100795. private _samplerName;
  100796. private _linearDefineName;
  100797. private _gammaDefineName;
  100798. private _mainUVName;
  100799. private _tempTextureRead;
  100800. /**
  100801. * Gets or sets the texture associated with the node
  100802. */
  100803. texture: Nullable<BaseTexture>;
  100804. /**
  100805. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100806. */
  100807. convertToGammaSpace: boolean;
  100808. /**
  100809. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100810. */
  100811. convertToLinearSpace: boolean;
  100812. /**
  100813. * Create a new CurrentScreenBlock
  100814. * @param name defines the block name
  100815. */
  100816. constructor(name: string);
  100817. /**
  100818. * Gets the current class name
  100819. * @returns the class name
  100820. */
  100821. getClassName(): string;
  100822. /**
  100823. * Gets the uv input component
  100824. */
  100825. get uv(): NodeMaterialConnectionPoint;
  100826. /**
  100827. * Gets the rgba output component
  100828. */
  100829. get rgba(): NodeMaterialConnectionPoint;
  100830. /**
  100831. * Gets the rgb output component
  100832. */
  100833. get rgb(): NodeMaterialConnectionPoint;
  100834. /**
  100835. * Gets the r output component
  100836. */
  100837. get r(): NodeMaterialConnectionPoint;
  100838. /**
  100839. * Gets the g output component
  100840. */
  100841. get g(): NodeMaterialConnectionPoint;
  100842. /**
  100843. * Gets the b output component
  100844. */
  100845. get b(): NodeMaterialConnectionPoint;
  100846. /**
  100847. * Gets the a output component
  100848. */
  100849. get a(): NodeMaterialConnectionPoint;
  100850. /**
  100851. * Initialize the block and prepare the context for build
  100852. * @param state defines the state that will be used for the build
  100853. */
  100854. initialize(state: NodeMaterialBuildState): void;
  100855. get target(): NodeMaterialBlockTargets;
  100856. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100857. isReady(): boolean;
  100858. private _injectVertexCode;
  100859. private _writeTextureRead;
  100860. private _writeOutput;
  100861. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100862. serialize(): any;
  100863. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100864. }
  100865. }
  100866. declare module BABYLON {
  100867. /**
  100868. * Base block used for the particle texture
  100869. */
  100870. export class ParticleTextureBlock extends NodeMaterialBlock {
  100871. private _samplerName;
  100872. private _linearDefineName;
  100873. private _gammaDefineName;
  100874. private _tempTextureRead;
  100875. /**
  100876. * Gets or sets the texture associated with the node
  100877. */
  100878. texture: Nullable<BaseTexture>;
  100879. /**
  100880. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100881. */
  100882. convertToGammaSpace: boolean;
  100883. /**
  100884. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100885. */
  100886. convertToLinearSpace: boolean;
  100887. /**
  100888. * Create a new ParticleTextureBlock
  100889. * @param name defines the block name
  100890. */
  100891. constructor(name: string);
  100892. /**
  100893. * Gets the current class name
  100894. * @returns the class name
  100895. */
  100896. getClassName(): string;
  100897. /**
  100898. * Gets the uv input component
  100899. */
  100900. get uv(): NodeMaterialConnectionPoint;
  100901. /**
  100902. * Gets the rgba output component
  100903. */
  100904. get rgba(): NodeMaterialConnectionPoint;
  100905. /**
  100906. * Gets the rgb output component
  100907. */
  100908. get rgb(): NodeMaterialConnectionPoint;
  100909. /**
  100910. * Gets the r output component
  100911. */
  100912. get r(): NodeMaterialConnectionPoint;
  100913. /**
  100914. * Gets the g output component
  100915. */
  100916. get g(): NodeMaterialConnectionPoint;
  100917. /**
  100918. * Gets the b output component
  100919. */
  100920. get b(): NodeMaterialConnectionPoint;
  100921. /**
  100922. * Gets the a output component
  100923. */
  100924. get a(): NodeMaterialConnectionPoint;
  100925. /**
  100926. * Initialize the block and prepare the context for build
  100927. * @param state defines the state that will be used for the build
  100928. */
  100929. initialize(state: NodeMaterialBuildState): void;
  100930. autoConfigure(material: NodeMaterial): void;
  100931. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100932. isReady(): boolean;
  100933. private _writeOutput;
  100934. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100935. serialize(): any;
  100936. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100937. }
  100938. }
  100939. declare module BABYLON {
  100940. /**
  100941. * Class used to store shared data between 2 NodeMaterialBuildState
  100942. */
  100943. export class NodeMaterialBuildStateSharedData {
  100944. /**
  100945. * Gets the list of emitted varyings
  100946. */
  100947. temps: string[];
  100948. /**
  100949. * Gets the list of emitted varyings
  100950. */
  100951. varyings: string[];
  100952. /**
  100953. * Gets the varying declaration string
  100954. */
  100955. varyingDeclaration: string;
  100956. /**
  100957. * Input blocks
  100958. */
  100959. inputBlocks: InputBlock[];
  100960. /**
  100961. * Input blocks
  100962. */
  100963. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  100964. /**
  100965. * Bindable blocks (Blocks that need to set data to the effect)
  100966. */
  100967. bindableBlocks: NodeMaterialBlock[];
  100968. /**
  100969. * List of blocks that can provide a compilation fallback
  100970. */
  100971. blocksWithFallbacks: NodeMaterialBlock[];
  100972. /**
  100973. * List of blocks that can provide a define update
  100974. */
  100975. blocksWithDefines: NodeMaterialBlock[];
  100976. /**
  100977. * List of blocks that can provide a repeatable content
  100978. */
  100979. repeatableContentBlocks: NodeMaterialBlock[];
  100980. /**
  100981. * List of blocks that can provide a dynamic list of uniforms
  100982. */
  100983. dynamicUniformBlocks: NodeMaterialBlock[];
  100984. /**
  100985. * List of blocks that can block the isReady function for the material
  100986. */
  100987. blockingBlocks: NodeMaterialBlock[];
  100988. /**
  100989. * Gets the list of animated inputs
  100990. */
  100991. animatedInputs: InputBlock[];
  100992. /**
  100993. * Build Id used to avoid multiple recompilations
  100994. */
  100995. buildId: number;
  100996. /** List of emitted variables */
  100997. variableNames: {
  100998. [key: string]: number;
  100999. };
  101000. /** List of emitted defines */
  101001. defineNames: {
  101002. [key: string]: number;
  101003. };
  101004. /** Should emit comments? */
  101005. emitComments: boolean;
  101006. /** Emit build activity */
  101007. verbose: boolean;
  101008. /** Gets or sets the hosting scene */
  101009. scene: Scene;
  101010. /**
  101011. * Gets the compilation hints emitted at compilation time
  101012. */
  101013. hints: {
  101014. needWorldViewMatrix: boolean;
  101015. needWorldViewProjectionMatrix: boolean;
  101016. needAlphaBlending: boolean;
  101017. needAlphaTesting: boolean;
  101018. };
  101019. /**
  101020. * List of compilation checks
  101021. */
  101022. checks: {
  101023. emitVertex: boolean;
  101024. emitFragment: boolean;
  101025. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  101026. };
  101027. /**
  101028. * Is vertex program allowed to be empty?
  101029. */
  101030. allowEmptyVertexProgram: boolean;
  101031. /** Creates a new shared data */
  101032. constructor();
  101033. /**
  101034. * Emits console errors and exceptions if there is a failing check
  101035. */
  101036. emitErrors(): void;
  101037. }
  101038. }
  101039. declare module BABYLON {
  101040. /**
  101041. * Class used to store node based material build state
  101042. */
  101043. export class NodeMaterialBuildState {
  101044. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  101045. supportUniformBuffers: boolean;
  101046. /**
  101047. * Gets the list of emitted attributes
  101048. */
  101049. attributes: string[];
  101050. /**
  101051. * Gets the list of emitted uniforms
  101052. */
  101053. uniforms: string[];
  101054. /**
  101055. * Gets the list of emitted constants
  101056. */
  101057. constants: string[];
  101058. /**
  101059. * Gets the list of emitted samplers
  101060. */
  101061. samplers: string[];
  101062. /**
  101063. * Gets the list of emitted functions
  101064. */
  101065. functions: {
  101066. [key: string]: string;
  101067. };
  101068. /**
  101069. * Gets the list of emitted extensions
  101070. */
  101071. extensions: {
  101072. [key: string]: string;
  101073. };
  101074. /**
  101075. * Gets the target of the compilation state
  101076. */
  101077. target: NodeMaterialBlockTargets;
  101078. /**
  101079. * Gets the list of emitted counters
  101080. */
  101081. counters: {
  101082. [key: string]: number;
  101083. };
  101084. /**
  101085. * Shared data between multiple NodeMaterialBuildState instances
  101086. */
  101087. sharedData: NodeMaterialBuildStateSharedData;
  101088. /** @hidden */
  101089. _vertexState: NodeMaterialBuildState;
  101090. /** @hidden */
  101091. _attributeDeclaration: string;
  101092. /** @hidden */
  101093. _uniformDeclaration: string;
  101094. /** @hidden */
  101095. _constantDeclaration: string;
  101096. /** @hidden */
  101097. _samplerDeclaration: string;
  101098. /** @hidden */
  101099. _varyingTransfer: string;
  101100. /** @hidden */
  101101. _injectAtEnd: string;
  101102. private _repeatableContentAnchorIndex;
  101103. /** @hidden */
  101104. _builtCompilationString: string;
  101105. /**
  101106. * Gets the emitted compilation strings
  101107. */
  101108. compilationString: string;
  101109. /**
  101110. * Finalize the compilation strings
  101111. * @param state defines the current compilation state
  101112. */
  101113. finalize(state: NodeMaterialBuildState): void;
  101114. /** @hidden */
  101115. get _repeatableContentAnchor(): string;
  101116. /** @hidden */
  101117. _getFreeVariableName(prefix: string): string;
  101118. /** @hidden */
  101119. _getFreeDefineName(prefix: string): string;
  101120. /** @hidden */
  101121. _excludeVariableName(name: string): void;
  101122. /** @hidden */
  101123. _emit2DSampler(name: string): void;
  101124. /** @hidden */
  101125. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  101126. /** @hidden */
  101127. _emitExtension(name: string, extension: string, define?: string): void;
  101128. /** @hidden */
  101129. _emitFunction(name: string, code: string, comments: string): void;
  101130. /** @hidden */
  101131. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  101132. replaceStrings?: {
  101133. search: RegExp;
  101134. replace: string;
  101135. }[];
  101136. repeatKey?: string;
  101137. }): string;
  101138. /** @hidden */
  101139. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  101140. repeatKey?: string;
  101141. removeAttributes?: boolean;
  101142. removeUniforms?: boolean;
  101143. removeVaryings?: boolean;
  101144. removeIfDef?: boolean;
  101145. replaceStrings?: {
  101146. search: RegExp;
  101147. replace: string;
  101148. }[];
  101149. }, storeKey?: string): void;
  101150. /** @hidden */
  101151. _registerTempVariable(name: string): boolean;
  101152. /** @hidden */
  101153. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  101154. /** @hidden */
  101155. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  101156. /** @hidden */
  101157. _emitFloat(value: number): string;
  101158. }
  101159. }
  101160. declare module BABYLON {
  101161. /**
  101162. * Helper class used to generate session unique ID
  101163. */
  101164. export class UniqueIdGenerator {
  101165. private static _UniqueIdCounter;
  101166. /**
  101167. * Gets an unique (relatively to the current scene) Id
  101168. */
  101169. static get UniqueId(): number;
  101170. }
  101171. }
  101172. declare module BABYLON {
  101173. /**
  101174. * Defines a block that can be used inside a node based material
  101175. */
  101176. export class NodeMaterialBlock {
  101177. private _buildId;
  101178. private _buildTarget;
  101179. private _target;
  101180. private _isFinalMerger;
  101181. private _isInput;
  101182. private _name;
  101183. protected _isUnique: boolean;
  101184. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  101185. inputsAreExclusive: boolean;
  101186. /** @hidden */
  101187. _codeVariableName: string;
  101188. /** @hidden */
  101189. _inputs: NodeMaterialConnectionPoint[];
  101190. /** @hidden */
  101191. _outputs: NodeMaterialConnectionPoint[];
  101192. /** @hidden */
  101193. _preparationId: number;
  101194. /**
  101195. * Gets the name of the block
  101196. */
  101197. get name(): string;
  101198. /**
  101199. * Sets the name of the block. Will check if the name is valid.
  101200. */
  101201. set name(newName: string);
  101202. /**
  101203. * Gets or sets the unique id of the node
  101204. */
  101205. uniqueId: number;
  101206. /**
  101207. * Gets or sets the comments associated with this block
  101208. */
  101209. comments: string;
  101210. /**
  101211. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  101212. */
  101213. get isUnique(): boolean;
  101214. /**
  101215. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  101216. */
  101217. get isFinalMerger(): boolean;
  101218. /**
  101219. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  101220. */
  101221. get isInput(): boolean;
  101222. /**
  101223. * Gets or sets the build Id
  101224. */
  101225. get buildId(): number;
  101226. set buildId(value: number);
  101227. /**
  101228. * Gets or sets the target of the block
  101229. */
  101230. get target(): NodeMaterialBlockTargets;
  101231. set target(value: NodeMaterialBlockTargets);
  101232. /**
  101233. * Gets the list of input points
  101234. */
  101235. get inputs(): NodeMaterialConnectionPoint[];
  101236. /** Gets the list of output points */
  101237. get outputs(): NodeMaterialConnectionPoint[];
  101238. /**
  101239. * Find an input by its name
  101240. * @param name defines the name of the input to look for
  101241. * @returns the input or null if not found
  101242. */
  101243. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101244. /**
  101245. * Find an output by its name
  101246. * @param name defines the name of the outputto look for
  101247. * @returns the output or null if not found
  101248. */
  101249. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101250. /**
  101251. * Creates a new NodeMaterialBlock
  101252. * @param name defines the block name
  101253. * @param target defines the target of that block (Vertex by default)
  101254. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  101255. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  101256. */
  101257. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  101258. /**
  101259. * Initialize the block and prepare the context for build
  101260. * @param state defines the state that will be used for the build
  101261. */
  101262. initialize(state: NodeMaterialBuildState): void;
  101263. /**
  101264. * Bind data to effect. Will only be called for blocks with isBindable === true
  101265. * @param effect defines the effect to bind data to
  101266. * @param nodeMaterial defines the hosting NodeMaterial
  101267. * @param mesh defines the mesh that will be rendered
  101268. * @param subMesh defines the submesh that will be rendered
  101269. */
  101270. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101271. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101272. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101273. protected _writeFloat(value: number): string;
  101274. /**
  101275. * Gets the current class name e.g. "NodeMaterialBlock"
  101276. * @returns the class name
  101277. */
  101278. getClassName(): string;
  101279. /**
  101280. * Register a new input. Must be called inside a block constructor
  101281. * @param name defines the connection point name
  101282. * @param type defines the connection point type
  101283. * @param isOptional defines a boolean indicating that this input can be omitted
  101284. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101285. * @param point an already created connection point. If not provided, create a new one
  101286. * @returns the current block
  101287. */
  101288. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101289. /**
  101290. * Register a new output. Must be called inside a block constructor
  101291. * @param name defines the connection point name
  101292. * @param type defines the connection point type
  101293. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101294. * @param point an already created connection point. If not provided, create a new one
  101295. * @returns the current block
  101296. */
  101297. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101298. /**
  101299. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  101300. * @param forOutput defines an optional connection point to check compatibility with
  101301. * @returns the first available input or null
  101302. */
  101303. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  101304. /**
  101305. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  101306. * @param forBlock defines an optional block to check compatibility with
  101307. * @returns the first available input or null
  101308. */
  101309. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  101310. /**
  101311. * Gets the sibling of the given output
  101312. * @param current defines the current output
  101313. * @returns the next output in the list or null
  101314. */
  101315. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  101316. /**
  101317. * Connect current block with another block
  101318. * @param other defines the block to connect with
  101319. * @param options define the various options to help pick the right connections
  101320. * @returns the current block
  101321. */
  101322. connectTo(other: NodeMaterialBlock, options?: {
  101323. input?: string;
  101324. output?: string;
  101325. outputSwizzle?: string;
  101326. }): this | undefined;
  101327. protected _buildBlock(state: NodeMaterialBuildState): void;
  101328. /**
  101329. * Add uniforms, samplers and uniform buffers at compilation time
  101330. * @param state defines the state to update
  101331. * @param nodeMaterial defines the node material requesting the update
  101332. * @param defines defines the material defines to update
  101333. * @param uniformBuffers defines the list of uniform buffer names
  101334. */
  101335. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  101336. /**
  101337. * Add potential fallbacks if shader compilation fails
  101338. * @param mesh defines the mesh to be rendered
  101339. * @param fallbacks defines the current prioritized list of fallbacks
  101340. */
  101341. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  101342. /**
  101343. * Initialize defines for shader compilation
  101344. * @param mesh defines the mesh to be rendered
  101345. * @param nodeMaterial defines the node material requesting the update
  101346. * @param defines defines the material defines to update
  101347. * @param useInstances specifies that instances should be used
  101348. */
  101349. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101350. /**
  101351. * Update defines for shader compilation
  101352. * @param mesh defines the mesh to be rendered
  101353. * @param nodeMaterial defines the node material requesting the update
  101354. * @param defines defines the material defines to update
  101355. * @param useInstances specifies that instances should be used
  101356. * @param subMesh defines which submesh to render
  101357. */
  101358. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101359. /**
  101360. * Lets the block try to connect some inputs automatically
  101361. * @param material defines the hosting NodeMaterial
  101362. */
  101363. autoConfigure(material: NodeMaterial): void;
  101364. /**
  101365. * Function called when a block is declared as repeatable content generator
  101366. * @param vertexShaderState defines the current compilation state for the vertex shader
  101367. * @param fragmentShaderState defines the current compilation state for the fragment shader
  101368. * @param mesh defines the mesh to be rendered
  101369. * @param defines defines the material defines to update
  101370. */
  101371. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  101372. /**
  101373. * Checks if the block is ready
  101374. * @param mesh defines the mesh to be rendered
  101375. * @param nodeMaterial defines the node material requesting the update
  101376. * @param defines defines the material defines to update
  101377. * @param useInstances specifies that instances should be used
  101378. * @returns true if the block is ready
  101379. */
  101380. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  101381. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  101382. private _processBuild;
  101383. /**
  101384. * Validates the new name for the block node.
  101385. * @param newName the new name to be given to the node.
  101386. * @returns false if the name is a reserve word, else true.
  101387. */
  101388. validateBlockName(newName: string): boolean;
  101389. /**
  101390. * Compile the current node and generate the shader code
  101391. * @param state defines the current compilation state (uniforms, samplers, current string)
  101392. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  101393. * @returns true if already built
  101394. */
  101395. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  101396. protected _inputRename(name: string): string;
  101397. protected _outputRename(name: string): string;
  101398. protected _dumpPropertiesCode(): string;
  101399. /** @hidden */
  101400. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  101401. /** @hidden */
  101402. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  101403. /**
  101404. * Clone the current block to a new identical block
  101405. * @param scene defines the hosting scene
  101406. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101407. * @returns a copy of the current block
  101408. */
  101409. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  101410. /**
  101411. * Serializes this block in a JSON representation
  101412. * @returns the serialized block object
  101413. */
  101414. serialize(): any;
  101415. /** @hidden */
  101416. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101417. private _deserializePortDisplayNamesAndExposedOnFrame;
  101418. /**
  101419. * Release resources
  101420. */
  101421. dispose(): void;
  101422. }
  101423. }
  101424. declare module BABYLON {
  101425. /**
  101426. * Base class of materials working in push mode in babylon JS
  101427. * @hidden
  101428. */
  101429. export class PushMaterial extends Material {
  101430. protected _activeEffect: Effect;
  101431. protected _normalMatrix: Matrix;
  101432. constructor(name: string, scene: Scene);
  101433. getEffect(): Effect;
  101434. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101435. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  101436. /**
  101437. * Binds the given world matrix to the active effect
  101438. *
  101439. * @param world the matrix to bind
  101440. */
  101441. bindOnlyWorldMatrix(world: Matrix): void;
  101442. /**
  101443. * Binds the given normal matrix to the active effect
  101444. *
  101445. * @param normalMatrix the matrix to bind
  101446. */
  101447. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  101448. bind(world: Matrix, mesh?: Mesh): void;
  101449. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  101450. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  101451. }
  101452. }
  101453. declare module BABYLON {
  101454. /**
  101455. * Root class for all node material optimizers
  101456. */
  101457. export class NodeMaterialOptimizer {
  101458. /**
  101459. * Function used to optimize a NodeMaterial graph
  101460. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  101461. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  101462. */
  101463. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  101464. }
  101465. }
  101466. declare module BABYLON {
  101467. /**
  101468. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  101469. */
  101470. export class TransformBlock extends NodeMaterialBlock {
  101471. /**
  101472. * Defines the value to use to complement W value to transform it to a Vector4
  101473. */
  101474. complementW: number;
  101475. /**
  101476. * Defines the value to use to complement z value to transform it to a Vector4
  101477. */
  101478. complementZ: number;
  101479. /**
  101480. * Creates a new TransformBlock
  101481. * @param name defines the block name
  101482. */
  101483. constructor(name: string);
  101484. /**
  101485. * Gets the current class name
  101486. * @returns the class name
  101487. */
  101488. getClassName(): string;
  101489. /**
  101490. * Gets the vector input
  101491. */
  101492. get vector(): NodeMaterialConnectionPoint;
  101493. /**
  101494. * Gets the output component
  101495. */
  101496. get output(): NodeMaterialConnectionPoint;
  101497. /**
  101498. * Gets the xyz output component
  101499. */
  101500. get xyz(): NodeMaterialConnectionPoint;
  101501. /**
  101502. * Gets the matrix transform input
  101503. */
  101504. get transform(): NodeMaterialConnectionPoint;
  101505. protected _buildBlock(state: NodeMaterialBuildState): this;
  101506. /**
  101507. * Update defines for shader compilation
  101508. * @param mesh defines the mesh to be rendered
  101509. * @param nodeMaterial defines the node material requesting the update
  101510. * @param defines defines the material defines to update
  101511. * @param useInstances specifies that instances should be used
  101512. * @param subMesh defines which submesh to render
  101513. */
  101514. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101515. serialize(): any;
  101516. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101517. protected _dumpPropertiesCode(): string;
  101518. }
  101519. }
  101520. declare module BABYLON {
  101521. /**
  101522. * Block used to output the vertex position
  101523. */
  101524. export class VertexOutputBlock extends NodeMaterialBlock {
  101525. /**
  101526. * Creates a new VertexOutputBlock
  101527. * @param name defines the block name
  101528. */
  101529. constructor(name: string);
  101530. /**
  101531. * Gets the current class name
  101532. * @returns the class name
  101533. */
  101534. getClassName(): string;
  101535. /**
  101536. * Gets the vector input component
  101537. */
  101538. get vector(): NodeMaterialConnectionPoint;
  101539. protected _buildBlock(state: NodeMaterialBuildState): this;
  101540. }
  101541. }
  101542. declare module BABYLON {
  101543. /**
  101544. * Block used to output the final color
  101545. */
  101546. export class FragmentOutputBlock extends NodeMaterialBlock {
  101547. /**
  101548. * Create a new FragmentOutputBlock
  101549. * @param name defines the block name
  101550. */
  101551. constructor(name: string);
  101552. /**
  101553. * Gets the current class name
  101554. * @returns the class name
  101555. */
  101556. getClassName(): string;
  101557. /**
  101558. * Gets the rgba input component
  101559. */
  101560. get rgba(): NodeMaterialConnectionPoint;
  101561. /**
  101562. * Gets the rgb input component
  101563. */
  101564. get rgb(): NodeMaterialConnectionPoint;
  101565. /**
  101566. * Gets the a input component
  101567. */
  101568. get a(): NodeMaterialConnectionPoint;
  101569. protected _buildBlock(state: NodeMaterialBuildState): this;
  101570. }
  101571. }
  101572. declare module BABYLON {
  101573. /**
  101574. * Block used for the particle ramp gradient section
  101575. */
  101576. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  101577. /**
  101578. * Create a new ParticleRampGradientBlock
  101579. * @param name defines the block name
  101580. */
  101581. constructor(name: string);
  101582. /**
  101583. * Gets the current class name
  101584. * @returns the class name
  101585. */
  101586. getClassName(): string;
  101587. /**
  101588. * Gets the color input component
  101589. */
  101590. get color(): NodeMaterialConnectionPoint;
  101591. /**
  101592. * Gets the rampColor output component
  101593. */
  101594. get rampColor(): NodeMaterialConnectionPoint;
  101595. /**
  101596. * Initialize the block and prepare the context for build
  101597. * @param state defines the state that will be used for the build
  101598. */
  101599. initialize(state: NodeMaterialBuildState): void;
  101600. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101601. }
  101602. }
  101603. declare module BABYLON {
  101604. /**
  101605. * Block used for the particle blend multiply section
  101606. */
  101607. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  101608. /**
  101609. * Create a new ParticleBlendMultiplyBlock
  101610. * @param name defines the block name
  101611. */
  101612. constructor(name: string);
  101613. /**
  101614. * Gets the current class name
  101615. * @returns the class name
  101616. */
  101617. getClassName(): string;
  101618. /**
  101619. * Gets the color input component
  101620. */
  101621. get color(): NodeMaterialConnectionPoint;
  101622. /**
  101623. * Gets the alphaTexture input component
  101624. */
  101625. get alphaTexture(): NodeMaterialConnectionPoint;
  101626. /**
  101627. * Gets the alphaColor input component
  101628. */
  101629. get alphaColor(): NodeMaterialConnectionPoint;
  101630. /**
  101631. * Gets the blendColor output component
  101632. */
  101633. get blendColor(): NodeMaterialConnectionPoint;
  101634. /**
  101635. * Initialize the block and prepare the context for build
  101636. * @param state defines the state that will be used for the build
  101637. */
  101638. initialize(state: NodeMaterialBuildState): void;
  101639. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101640. }
  101641. }
  101642. declare module BABYLON {
  101643. /**
  101644. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  101645. */
  101646. export class VectorMergerBlock extends NodeMaterialBlock {
  101647. /**
  101648. * Create a new VectorMergerBlock
  101649. * @param name defines the block name
  101650. */
  101651. constructor(name: string);
  101652. /**
  101653. * Gets the current class name
  101654. * @returns the class name
  101655. */
  101656. getClassName(): string;
  101657. /**
  101658. * Gets the xyz component (input)
  101659. */
  101660. get xyzIn(): NodeMaterialConnectionPoint;
  101661. /**
  101662. * Gets the xy component (input)
  101663. */
  101664. get xyIn(): NodeMaterialConnectionPoint;
  101665. /**
  101666. * Gets the x component (input)
  101667. */
  101668. get x(): NodeMaterialConnectionPoint;
  101669. /**
  101670. * Gets the y component (input)
  101671. */
  101672. get y(): NodeMaterialConnectionPoint;
  101673. /**
  101674. * Gets the z component (input)
  101675. */
  101676. get z(): NodeMaterialConnectionPoint;
  101677. /**
  101678. * Gets the w component (input)
  101679. */
  101680. get w(): NodeMaterialConnectionPoint;
  101681. /**
  101682. * Gets the xyzw component (output)
  101683. */
  101684. get xyzw(): NodeMaterialConnectionPoint;
  101685. /**
  101686. * Gets the xyz component (output)
  101687. */
  101688. get xyzOut(): NodeMaterialConnectionPoint;
  101689. /**
  101690. * Gets the xy component (output)
  101691. */
  101692. get xyOut(): NodeMaterialConnectionPoint;
  101693. /**
  101694. * Gets the xy component (output)
  101695. * @deprecated Please use xyOut instead.
  101696. */
  101697. get xy(): NodeMaterialConnectionPoint;
  101698. /**
  101699. * Gets the xyz component (output)
  101700. * @deprecated Please use xyzOut instead.
  101701. */
  101702. get xyz(): NodeMaterialConnectionPoint;
  101703. protected _buildBlock(state: NodeMaterialBuildState): this;
  101704. }
  101705. }
  101706. declare module BABYLON {
  101707. /**
  101708. * Block used to remap a float from a range to a new one
  101709. */
  101710. export class RemapBlock extends NodeMaterialBlock {
  101711. /**
  101712. * Gets or sets the source range
  101713. */
  101714. sourceRange: Vector2;
  101715. /**
  101716. * Gets or sets the target range
  101717. */
  101718. targetRange: Vector2;
  101719. /**
  101720. * Creates a new RemapBlock
  101721. * @param name defines the block name
  101722. */
  101723. constructor(name: string);
  101724. /**
  101725. * Gets the current class name
  101726. * @returns the class name
  101727. */
  101728. getClassName(): string;
  101729. /**
  101730. * Gets the input component
  101731. */
  101732. get input(): NodeMaterialConnectionPoint;
  101733. /**
  101734. * Gets the source min input component
  101735. */
  101736. get sourceMin(): NodeMaterialConnectionPoint;
  101737. /**
  101738. * Gets the source max input component
  101739. */
  101740. get sourceMax(): NodeMaterialConnectionPoint;
  101741. /**
  101742. * Gets the target min input component
  101743. */
  101744. get targetMin(): NodeMaterialConnectionPoint;
  101745. /**
  101746. * Gets the target max input component
  101747. */
  101748. get targetMax(): NodeMaterialConnectionPoint;
  101749. /**
  101750. * Gets the output component
  101751. */
  101752. get output(): NodeMaterialConnectionPoint;
  101753. protected _buildBlock(state: NodeMaterialBuildState): this;
  101754. protected _dumpPropertiesCode(): string;
  101755. serialize(): any;
  101756. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101757. }
  101758. }
  101759. declare module BABYLON {
  101760. /**
  101761. * Block used to multiply 2 values
  101762. */
  101763. export class MultiplyBlock extends NodeMaterialBlock {
  101764. /**
  101765. * Creates a new MultiplyBlock
  101766. * @param name defines the block name
  101767. */
  101768. constructor(name: string);
  101769. /**
  101770. * Gets the current class name
  101771. * @returns the class name
  101772. */
  101773. getClassName(): string;
  101774. /**
  101775. * Gets the left operand input component
  101776. */
  101777. get left(): NodeMaterialConnectionPoint;
  101778. /**
  101779. * Gets the right operand input component
  101780. */
  101781. get right(): NodeMaterialConnectionPoint;
  101782. /**
  101783. * Gets the output component
  101784. */
  101785. get output(): NodeMaterialConnectionPoint;
  101786. protected _buildBlock(state: NodeMaterialBuildState): this;
  101787. }
  101788. }
  101789. declare module BABYLON {
  101790. /**
  101791. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  101792. */
  101793. export class ColorSplitterBlock extends NodeMaterialBlock {
  101794. /**
  101795. * Create a new ColorSplitterBlock
  101796. * @param name defines the block name
  101797. */
  101798. constructor(name: string);
  101799. /**
  101800. * Gets the current class name
  101801. * @returns the class name
  101802. */
  101803. getClassName(): string;
  101804. /**
  101805. * Gets the rgba component (input)
  101806. */
  101807. get rgba(): NodeMaterialConnectionPoint;
  101808. /**
  101809. * Gets the rgb component (input)
  101810. */
  101811. get rgbIn(): NodeMaterialConnectionPoint;
  101812. /**
  101813. * Gets the rgb component (output)
  101814. */
  101815. get rgbOut(): NodeMaterialConnectionPoint;
  101816. /**
  101817. * Gets the r component (output)
  101818. */
  101819. get r(): NodeMaterialConnectionPoint;
  101820. /**
  101821. * Gets the g component (output)
  101822. */
  101823. get g(): NodeMaterialConnectionPoint;
  101824. /**
  101825. * Gets the b component (output)
  101826. */
  101827. get b(): NodeMaterialConnectionPoint;
  101828. /**
  101829. * Gets the a component (output)
  101830. */
  101831. get a(): NodeMaterialConnectionPoint;
  101832. protected _inputRename(name: string): string;
  101833. protected _outputRename(name: string): string;
  101834. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101835. }
  101836. }
  101837. declare module BABYLON {
  101838. /**
  101839. * Interface used to configure the node material editor
  101840. */
  101841. export interface INodeMaterialEditorOptions {
  101842. /** Define the URl to load node editor script */
  101843. editorURL?: string;
  101844. }
  101845. /** @hidden */
  101846. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  101847. NORMAL: boolean;
  101848. TANGENT: boolean;
  101849. UV1: boolean;
  101850. /** BONES */
  101851. NUM_BONE_INFLUENCERS: number;
  101852. BonesPerMesh: number;
  101853. BONETEXTURE: boolean;
  101854. /** MORPH TARGETS */
  101855. MORPHTARGETS: boolean;
  101856. MORPHTARGETS_NORMAL: boolean;
  101857. MORPHTARGETS_TANGENT: boolean;
  101858. MORPHTARGETS_UV: boolean;
  101859. NUM_MORPH_INFLUENCERS: number;
  101860. /** IMAGE PROCESSING */
  101861. IMAGEPROCESSING: boolean;
  101862. VIGNETTE: boolean;
  101863. VIGNETTEBLENDMODEMULTIPLY: boolean;
  101864. VIGNETTEBLENDMODEOPAQUE: boolean;
  101865. TONEMAPPING: boolean;
  101866. TONEMAPPING_ACES: boolean;
  101867. CONTRAST: boolean;
  101868. EXPOSURE: boolean;
  101869. COLORCURVES: boolean;
  101870. COLORGRADING: boolean;
  101871. COLORGRADING3D: boolean;
  101872. SAMPLER3DGREENDEPTH: boolean;
  101873. SAMPLER3DBGRMAP: boolean;
  101874. IMAGEPROCESSINGPOSTPROCESS: boolean;
  101875. /** MISC. */
  101876. BUMPDIRECTUV: number;
  101877. constructor();
  101878. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  101879. }
  101880. /**
  101881. * Class used to configure NodeMaterial
  101882. */
  101883. export interface INodeMaterialOptions {
  101884. /**
  101885. * Defines if blocks should emit comments
  101886. */
  101887. emitComments: boolean;
  101888. }
  101889. /**
  101890. * Class used to create a node based material built by assembling shader blocks
  101891. */
  101892. export class NodeMaterial extends PushMaterial {
  101893. private static _BuildIdGenerator;
  101894. private _options;
  101895. private _vertexCompilationState;
  101896. private _fragmentCompilationState;
  101897. private _sharedData;
  101898. private _buildId;
  101899. private _buildWasSuccessful;
  101900. private _cachedWorldViewMatrix;
  101901. private _cachedWorldViewProjectionMatrix;
  101902. private _optimizers;
  101903. private _animationFrame;
  101904. /** Define the Url to load node editor script */
  101905. static EditorURL: string;
  101906. /** Define the Url to load snippets */
  101907. static SnippetUrl: string;
  101908. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  101909. static IgnoreTexturesAtLoadTime: boolean;
  101910. private BJSNODEMATERIALEDITOR;
  101911. /** Get the inspector from bundle or global */
  101912. private _getGlobalNodeMaterialEditor;
  101913. /**
  101914. * Snippet ID if the material was created from the snippet server
  101915. */
  101916. snippetId: string;
  101917. /**
  101918. * Gets or sets data used by visual editor
  101919. * @see https://nme.babylonjs.com
  101920. */
  101921. editorData: any;
  101922. /**
  101923. * 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)
  101924. */
  101925. ignoreAlpha: boolean;
  101926. /**
  101927. * Defines the maximum number of lights that can be used in the material
  101928. */
  101929. maxSimultaneousLights: number;
  101930. /**
  101931. * Observable raised when the material is built
  101932. */
  101933. onBuildObservable: Observable<NodeMaterial>;
  101934. /**
  101935. * Gets or sets the root nodes of the material vertex shader
  101936. */
  101937. _vertexOutputNodes: NodeMaterialBlock[];
  101938. /**
  101939. * Gets or sets the root nodes of the material fragment (pixel) shader
  101940. */
  101941. _fragmentOutputNodes: NodeMaterialBlock[];
  101942. /** Gets or sets options to control the node material overall behavior */
  101943. get options(): INodeMaterialOptions;
  101944. set options(options: INodeMaterialOptions);
  101945. /**
  101946. * Default configuration related to image processing available in the standard Material.
  101947. */
  101948. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101949. /**
  101950. * Gets the image processing configuration used either in this material.
  101951. */
  101952. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  101953. /**
  101954. * Sets the Default image processing configuration used either in the this material.
  101955. *
  101956. * If sets to null, the scene one is in use.
  101957. */
  101958. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  101959. /**
  101960. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  101961. */
  101962. attachedBlocks: NodeMaterialBlock[];
  101963. /**
  101964. * Specifies the mode of the node material
  101965. * @hidden
  101966. */
  101967. _mode: NodeMaterialModes;
  101968. /**
  101969. * Gets the mode property
  101970. */
  101971. get mode(): NodeMaterialModes;
  101972. /**
  101973. * Create a new node based material
  101974. * @param name defines the material name
  101975. * @param scene defines the hosting scene
  101976. * @param options defines creation option
  101977. */
  101978. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  101979. /**
  101980. * Gets the current class name of the material e.g. "NodeMaterial"
  101981. * @returns the class name
  101982. */
  101983. getClassName(): string;
  101984. /**
  101985. * Keep track of the image processing observer to allow dispose and replace.
  101986. */
  101987. private _imageProcessingObserver;
  101988. /**
  101989. * Attaches a new image processing configuration to the Standard Material.
  101990. * @param configuration
  101991. */
  101992. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  101993. /**
  101994. * Get a block by its name
  101995. * @param name defines the name of the block to retrieve
  101996. * @returns the required block or null if not found
  101997. */
  101998. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  101999. /**
  102000. * Get a block by its name
  102001. * @param predicate defines the predicate used to find the good candidate
  102002. * @returns the required block or null if not found
  102003. */
  102004. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  102005. /**
  102006. * Get an input block by its name
  102007. * @param predicate defines the predicate used to find the good candidate
  102008. * @returns the required input block or null if not found
  102009. */
  102010. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  102011. /**
  102012. * Gets the list of input blocks attached to this material
  102013. * @returns an array of InputBlocks
  102014. */
  102015. getInputBlocks(): InputBlock[];
  102016. /**
  102017. * Adds a new optimizer to the list of optimizers
  102018. * @param optimizer defines the optimizers to add
  102019. * @returns the current material
  102020. */
  102021. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102022. /**
  102023. * Remove an optimizer from the list of optimizers
  102024. * @param optimizer defines the optimizers to remove
  102025. * @returns the current material
  102026. */
  102027. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102028. /**
  102029. * Add a new block to the list of output nodes
  102030. * @param node defines the node to add
  102031. * @returns the current material
  102032. */
  102033. addOutputNode(node: NodeMaterialBlock): this;
  102034. /**
  102035. * Remove a block from the list of root nodes
  102036. * @param node defines the node to remove
  102037. * @returns the current material
  102038. */
  102039. removeOutputNode(node: NodeMaterialBlock): this;
  102040. private _addVertexOutputNode;
  102041. private _removeVertexOutputNode;
  102042. private _addFragmentOutputNode;
  102043. private _removeFragmentOutputNode;
  102044. /**
  102045. * Specifies if the material will require alpha blending
  102046. * @returns a boolean specifying if alpha blending is needed
  102047. */
  102048. needAlphaBlending(): boolean;
  102049. /**
  102050. * Specifies if this material should be rendered in alpha test mode
  102051. * @returns a boolean specifying if an alpha test is needed.
  102052. */
  102053. needAlphaTesting(): boolean;
  102054. private _initializeBlock;
  102055. private _resetDualBlocks;
  102056. /**
  102057. * Remove a block from the current node material
  102058. * @param block defines the block to remove
  102059. */
  102060. removeBlock(block: NodeMaterialBlock): void;
  102061. /**
  102062. * Build the material and generates the inner effect
  102063. * @param verbose defines if the build should log activity
  102064. */
  102065. build(verbose?: boolean): void;
  102066. /**
  102067. * Runs an otpimization phase to try to improve the shader code
  102068. */
  102069. optimize(): void;
  102070. private _prepareDefinesForAttributes;
  102071. /**
  102072. * Create a post process from the material
  102073. * @param camera The camera to apply the render pass to.
  102074. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102075. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102076. * @param engine The engine which the post process will be applied. (default: current engine)
  102077. * @param reusable If the post process can be reused on the same frame. (default: false)
  102078. * @param textureType Type of textures used when performing the post process. (default: 0)
  102079. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102080. * @returns the post process created
  102081. */
  102082. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  102083. /**
  102084. * Create the post process effect from the material
  102085. * @param postProcess The post process to create the effect for
  102086. */
  102087. createEffectForPostProcess(postProcess: PostProcess): void;
  102088. private _createEffectOrPostProcess;
  102089. private _createEffectForParticles;
  102090. /**
  102091. * Create the effect to be used as the custom effect for a particle system
  102092. * @param particleSystem Particle system to create the effect for
  102093. * @param onCompiled defines a function to call when the effect creation is successful
  102094. * @param onError defines a function to call when the effect creation has failed
  102095. */
  102096. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102097. private _processDefines;
  102098. /**
  102099. * Get if the submesh is ready to be used and all its information available.
  102100. * Child classes can use it to update shaders
  102101. * @param mesh defines the mesh to check
  102102. * @param subMesh defines which submesh to check
  102103. * @param useInstances specifies that instances should be used
  102104. * @returns a boolean indicating that the submesh is ready or not
  102105. */
  102106. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102107. /**
  102108. * Get a string representing the shaders built by the current node graph
  102109. */
  102110. get compiledShaders(): string;
  102111. /**
  102112. * Binds the world matrix to the material
  102113. * @param world defines the world transformation matrix
  102114. */
  102115. bindOnlyWorldMatrix(world: Matrix): void;
  102116. /**
  102117. * Binds the submesh to this material by preparing the effect and shader to draw
  102118. * @param world defines the world transformation matrix
  102119. * @param mesh defines the mesh containing the submesh
  102120. * @param subMesh defines the submesh to bind the material to
  102121. */
  102122. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  102123. /**
  102124. * Gets the active textures from the material
  102125. * @returns an array of textures
  102126. */
  102127. getActiveTextures(): BaseTexture[];
  102128. /**
  102129. * Gets the list of texture blocks
  102130. * @returns an array of texture blocks
  102131. */
  102132. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102133. /**
  102134. * Specifies if the material uses a texture
  102135. * @param texture defines the texture to check against the material
  102136. * @returns a boolean specifying if the material uses the texture
  102137. */
  102138. hasTexture(texture: BaseTexture): boolean;
  102139. /**
  102140. * Disposes the material
  102141. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102142. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102143. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102144. */
  102145. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102146. /** Creates the node editor window. */
  102147. private _createNodeEditor;
  102148. /**
  102149. * Launch the node material editor
  102150. * @param config Define the configuration of the editor
  102151. * @return a promise fulfilled when the node editor is visible
  102152. */
  102153. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  102154. /**
  102155. * Clear the current material
  102156. */
  102157. clear(): void;
  102158. /**
  102159. * Clear the current material and set it to a default state
  102160. */
  102161. setToDefault(): void;
  102162. /**
  102163. * Clear the current material and set it to a default state for post process
  102164. */
  102165. setToDefaultPostProcess(): void;
  102166. /**
  102167. * Clear the current material and set it to a default state for particle
  102168. */
  102169. setToDefaultParticle(): void;
  102170. /**
  102171. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  102172. * @param url defines the url to load from
  102173. * @returns a promise that will fullfil when the material is fully loaded
  102174. */
  102175. loadAsync(url: string): Promise<void>;
  102176. private _gatherBlocks;
  102177. /**
  102178. * Generate a string containing the code declaration required to create an equivalent of this material
  102179. * @returns a string
  102180. */
  102181. generateCode(): string;
  102182. /**
  102183. * Serializes this material in a JSON representation
  102184. * @returns the serialized material object
  102185. */
  102186. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  102187. private _restoreConnections;
  102188. /**
  102189. * Clear the current graph and load a new one from a serialization object
  102190. * @param source defines the JSON representation of the material
  102191. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102192. * @param merge defines whether or not the source must be merged or replace the current content
  102193. */
  102194. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  102195. /**
  102196. * Makes a duplicate of the current material.
  102197. * @param name - name to use for the new material.
  102198. */
  102199. clone(name: string): NodeMaterial;
  102200. /**
  102201. * Creates a node material from parsed material data
  102202. * @param source defines the JSON representation of the material
  102203. * @param scene defines the hosting scene
  102204. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102205. * @returns a new node material
  102206. */
  102207. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  102208. /**
  102209. * Creates a node material from a snippet saved in a remote file
  102210. * @param name defines the name of the material to create
  102211. * @param url defines the url to load from
  102212. * @param scene defines the hosting scene
  102213. * @returns a promise that will resolve to the new node material
  102214. */
  102215. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  102216. /**
  102217. * Creates a node material from a snippet saved by the node material editor
  102218. * @param snippetId defines the snippet to load
  102219. * @param scene defines the hosting scene
  102220. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102221. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  102222. * @returns a promise that will resolve to the new node material
  102223. */
  102224. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  102225. /**
  102226. * Creates a new node material set to default basic configuration
  102227. * @param name defines the name of the material
  102228. * @param scene defines the hosting scene
  102229. * @returns a new NodeMaterial
  102230. */
  102231. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  102232. }
  102233. }
  102234. declare module BABYLON {
  102235. /**
  102236. * Size options for a post process
  102237. */
  102238. export type PostProcessOptions = {
  102239. width: number;
  102240. height: number;
  102241. };
  102242. /**
  102243. * PostProcess can be used to apply a shader to a texture after it has been rendered
  102244. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  102245. */
  102246. export class PostProcess {
  102247. /**
  102248. * Gets or sets the unique id of the post process
  102249. */
  102250. uniqueId: number;
  102251. /** Name of the PostProcess. */
  102252. name: string;
  102253. /**
  102254. * Width of the texture to apply the post process on
  102255. */
  102256. width: number;
  102257. /**
  102258. * Height of the texture to apply the post process on
  102259. */
  102260. height: number;
  102261. /**
  102262. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  102263. */
  102264. nodeMaterialSource: Nullable<NodeMaterial>;
  102265. /**
  102266. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  102267. * @hidden
  102268. */
  102269. _outputTexture: Nullable<InternalTexture>;
  102270. /**
  102271. * Sampling mode used by the shader
  102272. * See https://doc.babylonjs.com/classes/3.1/texture
  102273. */
  102274. renderTargetSamplingMode: number;
  102275. /**
  102276. * Clear color to use when screen clearing
  102277. */
  102278. clearColor: Color4;
  102279. /**
  102280. * If the buffer needs to be cleared before applying the post process. (default: true)
  102281. * Should be set to false if shader will overwrite all previous pixels.
  102282. */
  102283. autoClear: boolean;
  102284. /**
  102285. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  102286. */
  102287. alphaMode: number;
  102288. /**
  102289. * Sets the setAlphaBlendConstants of the babylon engine
  102290. */
  102291. alphaConstants: Color4;
  102292. /**
  102293. * Animations to be used for the post processing
  102294. */
  102295. animations: Animation[];
  102296. /**
  102297. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  102298. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  102299. */
  102300. enablePixelPerfectMode: boolean;
  102301. /**
  102302. * Force the postprocess to be applied without taking in account viewport
  102303. */
  102304. forceFullscreenViewport: boolean;
  102305. /**
  102306. * List of inspectable custom properties (used by the Inspector)
  102307. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102308. */
  102309. inspectableCustomProperties: IInspectable[];
  102310. /**
  102311. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  102312. *
  102313. * | Value | Type | Description |
  102314. * | ----- | ----------------------------------- | ----------- |
  102315. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  102316. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  102317. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  102318. *
  102319. */
  102320. scaleMode: number;
  102321. /**
  102322. * Force textures to be a power of two (default: false)
  102323. */
  102324. alwaysForcePOT: boolean;
  102325. private _samples;
  102326. /**
  102327. * Number of sample textures (default: 1)
  102328. */
  102329. get samples(): number;
  102330. set samples(n: number);
  102331. /**
  102332. * Modify the scale of the post process to be the same as the viewport (default: false)
  102333. */
  102334. adaptScaleToCurrentViewport: boolean;
  102335. private _camera;
  102336. protected _scene: Scene;
  102337. private _engine;
  102338. private _options;
  102339. private _reusable;
  102340. private _textureType;
  102341. private _textureFormat;
  102342. /**
  102343. * Smart array of input and output textures for the post process.
  102344. * @hidden
  102345. */
  102346. _textures: SmartArray<InternalTexture>;
  102347. /**
  102348. * The index in _textures that corresponds to the output texture.
  102349. * @hidden
  102350. */
  102351. _currentRenderTextureInd: number;
  102352. private _effect;
  102353. private _samplers;
  102354. private _fragmentUrl;
  102355. private _vertexUrl;
  102356. private _parameters;
  102357. private _scaleRatio;
  102358. protected _indexParameters: any;
  102359. private _shareOutputWithPostProcess;
  102360. private _texelSize;
  102361. private _forcedOutputTexture;
  102362. /**
  102363. * Returns the fragment url or shader name used in the post process.
  102364. * @returns the fragment url or name in the shader store.
  102365. */
  102366. getEffectName(): string;
  102367. /**
  102368. * An event triggered when the postprocess is activated.
  102369. */
  102370. onActivateObservable: Observable<Camera>;
  102371. private _onActivateObserver;
  102372. /**
  102373. * A function that is added to the onActivateObservable
  102374. */
  102375. set onActivate(callback: Nullable<(camera: Camera) => void>);
  102376. /**
  102377. * An event triggered when the postprocess changes its size.
  102378. */
  102379. onSizeChangedObservable: Observable<PostProcess>;
  102380. private _onSizeChangedObserver;
  102381. /**
  102382. * A function that is added to the onSizeChangedObservable
  102383. */
  102384. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  102385. /**
  102386. * An event triggered when the postprocess applies its effect.
  102387. */
  102388. onApplyObservable: Observable<Effect>;
  102389. private _onApplyObserver;
  102390. /**
  102391. * A function that is added to the onApplyObservable
  102392. */
  102393. set onApply(callback: (effect: Effect) => void);
  102394. /**
  102395. * An event triggered before rendering the postprocess
  102396. */
  102397. onBeforeRenderObservable: Observable<Effect>;
  102398. private _onBeforeRenderObserver;
  102399. /**
  102400. * A function that is added to the onBeforeRenderObservable
  102401. */
  102402. set onBeforeRender(callback: (effect: Effect) => void);
  102403. /**
  102404. * An event triggered after rendering the postprocess
  102405. */
  102406. onAfterRenderObservable: Observable<Effect>;
  102407. private _onAfterRenderObserver;
  102408. /**
  102409. * A function that is added to the onAfterRenderObservable
  102410. */
  102411. set onAfterRender(callback: (efect: Effect) => void);
  102412. /**
  102413. * 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
  102414. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  102415. */
  102416. get inputTexture(): InternalTexture;
  102417. set inputTexture(value: InternalTexture);
  102418. /**
  102419. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  102420. * the only way to unset it is to use this function to restore its internal state
  102421. */
  102422. restoreDefaultInputTexture(): void;
  102423. /**
  102424. * Gets the camera which post process is applied to.
  102425. * @returns The camera the post process is applied to.
  102426. */
  102427. getCamera(): Camera;
  102428. /**
  102429. * Gets the texel size of the postprocess.
  102430. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  102431. */
  102432. get texelSize(): Vector2;
  102433. /**
  102434. * Creates a new instance PostProcess
  102435. * @param name The name of the PostProcess.
  102436. * @param fragmentUrl The url of the fragment shader to be used.
  102437. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  102438. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  102439. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102440. * @param camera The camera to apply the render pass to.
  102441. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102442. * @param engine The engine which the post process will be applied. (default: current engine)
  102443. * @param reusable If the post process can be reused on the same frame. (default: false)
  102444. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  102445. * @param textureType Type of textures used when performing the post process. (default: 0)
  102446. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  102447. * @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
  102448. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  102449. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102450. */
  102451. 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);
  102452. /**
  102453. * Gets a string identifying the name of the class
  102454. * @returns "PostProcess" string
  102455. */
  102456. getClassName(): string;
  102457. /**
  102458. * Gets the engine which this post process belongs to.
  102459. * @returns The engine the post process was enabled with.
  102460. */
  102461. getEngine(): Engine;
  102462. /**
  102463. * The effect that is created when initializing the post process.
  102464. * @returns The created effect corresponding the the postprocess.
  102465. */
  102466. getEffect(): Effect;
  102467. /**
  102468. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  102469. * @param postProcess The post process to share the output with.
  102470. * @returns This post process.
  102471. */
  102472. shareOutputWith(postProcess: PostProcess): PostProcess;
  102473. /**
  102474. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  102475. * This should be called if the post process that shares output with this post process is disabled/disposed.
  102476. */
  102477. useOwnOutput(): void;
  102478. /**
  102479. * Updates the effect with the current post process compile time values and recompiles the shader.
  102480. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102481. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102482. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102483. * @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
  102484. * @param onCompiled Called when the shader has been compiled.
  102485. * @param onError Called if there is an error when compiling a shader.
  102486. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  102487. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  102488. */
  102489. 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;
  102490. /**
  102491. * The post process is reusable if it can be used multiple times within one frame.
  102492. * @returns If the post process is reusable
  102493. */
  102494. isReusable(): boolean;
  102495. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  102496. markTextureDirty(): void;
  102497. /**
  102498. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  102499. * 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.
  102500. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  102501. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  102502. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  102503. * @returns The target texture that was bound to be written to.
  102504. */
  102505. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  102506. /**
  102507. * If the post process is supported.
  102508. */
  102509. get isSupported(): boolean;
  102510. /**
  102511. * The aspect ratio of the output texture.
  102512. */
  102513. get aspectRatio(): number;
  102514. /**
  102515. * Get a value indicating if the post-process is ready to be used
  102516. * @returns true if the post-process is ready (shader is compiled)
  102517. */
  102518. isReady(): boolean;
  102519. /**
  102520. * Binds all textures and uniforms to the shader, this will be run on every pass.
  102521. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  102522. */
  102523. apply(): Nullable<Effect>;
  102524. private _disposeTextures;
  102525. /**
  102526. * Disposes the post process.
  102527. * @param camera The camera to dispose the post process on.
  102528. */
  102529. dispose(camera?: Camera): void;
  102530. /**
  102531. * Serializes the particle system to a JSON object
  102532. * @returns the JSON object
  102533. */
  102534. serialize(): any;
  102535. /**
  102536. * Creates a material from parsed material data
  102537. * @param parsedPostProcess defines parsed post process data
  102538. * @param scene defines the hosting scene
  102539. * @param rootUrl defines the root URL to use to load textures
  102540. * @returns a new post process
  102541. */
  102542. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  102543. }
  102544. }
  102545. declare module BABYLON {
  102546. /** @hidden */
  102547. export var kernelBlurVaryingDeclaration: {
  102548. name: string;
  102549. shader: string;
  102550. };
  102551. }
  102552. declare module BABYLON {
  102553. /** @hidden */
  102554. export var kernelBlurFragment: {
  102555. name: string;
  102556. shader: string;
  102557. };
  102558. }
  102559. declare module BABYLON {
  102560. /** @hidden */
  102561. export var kernelBlurFragment2: {
  102562. name: string;
  102563. shader: string;
  102564. };
  102565. }
  102566. declare module BABYLON {
  102567. /** @hidden */
  102568. export var kernelBlurPixelShader: {
  102569. name: string;
  102570. shader: string;
  102571. };
  102572. }
  102573. declare module BABYLON {
  102574. /** @hidden */
  102575. export var kernelBlurVertex: {
  102576. name: string;
  102577. shader: string;
  102578. };
  102579. }
  102580. declare module BABYLON {
  102581. /** @hidden */
  102582. export var kernelBlurVertexShader: {
  102583. name: string;
  102584. shader: string;
  102585. };
  102586. }
  102587. declare module BABYLON {
  102588. /**
  102589. * The Blur Post Process which blurs an image based on a kernel and direction.
  102590. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  102591. */
  102592. export class BlurPostProcess extends PostProcess {
  102593. private blockCompilation;
  102594. protected _kernel: number;
  102595. protected _idealKernel: number;
  102596. protected _packedFloat: boolean;
  102597. private _staticDefines;
  102598. /** The direction in which to blur the image. */
  102599. direction: Vector2;
  102600. /**
  102601. * Sets the length in pixels of the blur sample region
  102602. */
  102603. set kernel(v: number);
  102604. /**
  102605. * Gets the length in pixels of the blur sample region
  102606. */
  102607. get kernel(): number;
  102608. /**
  102609. * Sets wether or not the blur needs to unpack/repack floats
  102610. */
  102611. set packedFloat(v: boolean);
  102612. /**
  102613. * Gets wether or not the blur is unpacking/repacking floats
  102614. */
  102615. get packedFloat(): boolean;
  102616. /**
  102617. * Gets a string identifying the name of the class
  102618. * @returns "BlurPostProcess" string
  102619. */
  102620. getClassName(): string;
  102621. /**
  102622. * Creates a new instance BlurPostProcess
  102623. * @param name The name of the effect.
  102624. * @param direction The direction in which to blur the image.
  102625. * @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.
  102626. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102627. * @param camera The camera to apply the render pass to.
  102628. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102629. * @param engine The engine which the post process will be applied. (default: current engine)
  102630. * @param reusable If the post process can be reused on the same frame. (default: false)
  102631. * @param textureType Type of textures used when performing the post process. (default: 0)
  102632. * @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)
  102633. */
  102634. 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);
  102635. /**
  102636. * Updates the effect with the current post process compile time values and recompiles the shader.
  102637. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102638. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102639. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102640. * @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
  102641. * @param onCompiled Called when the shader has been compiled.
  102642. * @param onError Called if there is an error when compiling a shader.
  102643. */
  102644. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102645. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102646. /**
  102647. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  102648. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  102649. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  102650. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  102651. * The gaps between physical kernels are compensated for in the weighting of the samples
  102652. * @param idealKernel Ideal blur kernel.
  102653. * @return Nearest best kernel.
  102654. */
  102655. protected _nearestBestKernel(idealKernel: number): number;
  102656. /**
  102657. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  102658. * @param x The point on the Gaussian distribution to sample.
  102659. * @return the value of the Gaussian function at x.
  102660. */
  102661. protected _gaussianWeight(x: number): number;
  102662. /**
  102663. * Generates a string that can be used as a floating point number in GLSL.
  102664. * @param x Value to print.
  102665. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  102666. * @return GLSL float string.
  102667. */
  102668. protected _glslFloat(x: number, decimalFigures?: number): string;
  102669. /** @hidden */
  102670. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  102671. }
  102672. }
  102673. declare module BABYLON {
  102674. /**
  102675. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102676. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102677. * You can then easily use it as a reflectionTexture on a flat surface.
  102678. * In case the surface is not a plane, please consider relying on reflection probes.
  102679. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102680. */
  102681. export class MirrorTexture extends RenderTargetTexture {
  102682. private scene;
  102683. /**
  102684. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  102685. * 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.
  102686. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102687. */
  102688. mirrorPlane: Plane;
  102689. /**
  102690. * Define the blur ratio used to blur the reflection if needed.
  102691. */
  102692. set blurRatio(value: number);
  102693. get blurRatio(): number;
  102694. /**
  102695. * Define the adaptive blur kernel used to blur the reflection if needed.
  102696. * This will autocompute the closest best match for the `blurKernel`
  102697. */
  102698. set adaptiveBlurKernel(value: number);
  102699. /**
  102700. * Define the blur kernel used to blur the reflection if needed.
  102701. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102702. */
  102703. set blurKernel(value: number);
  102704. /**
  102705. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  102706. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102707. */
  102708. set blurKernelX(value: number);
  102709. get blurKernelX(): number;
  102710. /**
  102711. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  102712. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102713. */
  102714. set blurKernelY(value: number);
  102715. get blurKernelY(): number;
  102716. private _autoComputeBlurKernel;
  102717. protected _onRatioRescale(): void;
  102718. private _updateGammaSpace;
  102719. private _imageProcessingConfigChangeObserver;
  102720. private _transformMatrix;
  102721. private _mirrorMatrix;
  102722. private _savedViewMatrix;
  102723. private _blurX;
  102724. private _blurY;
  102725. private _adaptiveBlurKernel;
  102726. private _blurKernelX;
  102727. private _blurKernelY;
  102728. private _blurRatio;
  102729. /**
  102730. * Instantiates a Mirror Texture.
  102731. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102732. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102733. * You can then easily use it as a reflectionTexture on a flat surface.
  102734. * In case the surface is not a plane, please consider relying on reflection probes.
  102735. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102736. * @param name
  102737. * @param size
  102738. * @param scene
  102739. * @param generateMipMaps
  102740. * @param type
  102741. * @param samplingMode
  102742. * @param generateDepthBuffer
  102743. */
  102744. constructor(name: string, size: number | {
  102745. width: number;
  102746. height: number;
  102747. } | {
  102748. ratio: number;
  102749. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  102750. private _preparePostProcesses;
  102751. /**
  102752. * Clone the mirror texture.
  102753. * @returns the cloned texture
  102754. */
  102755. clone(): MirrorTexture;
  102756. /**
  102757. * Serialize the texture to a JSON representation you could use in Parse later on
  102758. * @returns the serialized JSON representation
  102759. */
  102760. serialize(): any;
  102761. /**
  102762. * Dispose the texture and release its associated resources.
  102763. */
  102764. dispose(): void;
  102765. }
  102766. }
  102767. declare module BABYLON {
  102768. /**
  102769. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102770. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102771. */
  102772. export class Texture extends BaseTexture {
  102773. /**
  102774. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  102775. */
  102776. static SerializeBuffers: boolean;
  102777. /** @hidden */
  102778. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  102779. /** @hidden */
  102780. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  102781. /** @hidden */
  102782. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  102783. /** nearest is mag = nearest and min = nearest and mip = linear */
  102784. static readonly NEAREST_SAMPLINGMODE: number;
  102785. /** nearest is mag = nearest and min = nearest and mip = linear */
  102786. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  102787. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102788. static readonly BILINEAR_SAMPLINGMODE: number;
  102789. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102790. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  102791. /** Trilinear is mag = linear and min = linear and mip = linear */
  102792. static readonly TRILINEAR_SAMPLINGMODE: number;
  102793. /** Trilinear is mag = linear and min = linear and mip = linear */
  102794. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  102795. /** mag = nearest and min = nearest and mip = nearest */
  102796. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  102797. /** mag = nearest and min = linear and mip = nearest */
  102798. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  102799. /** mag = nearest and min = linear and mip = linear */
  102800. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  102801. /** mag = nearest and min = linear and mip = none */
  102802. static readonly NEAREST_LINEAR: number;
  102803. /** mag = nearest and min = nearest and mip = none */
  102804. static readonly NEAREST_NEAREST: number;
  102805. /** mag = linear and min = nearest and mip = nearest */
  102806. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  102807. /** mag = linear and min = nearest and mip = linear */
  102808. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  102809. /** mag = linear and min = linear and mip = none */
  102810. static readonly LINEAR_LINEAR: number;
  102811. /** mag = linear and min = nearest and mip = none */
  102812. static readonly LINEAR_NEAREST: number;
  102813. /** Explicit coordinates mode */
  102814. static readonly EXPLICIT_MODE: number;
  102815. /** Spherical coordinates mode */
  102816. static readonly SPHERICAL_MODE: number;
  102817. /** Planar coordinates mode */
  102818. static readonly PLANAR_MODE: number;
  102819. /** Cubic coordinates mode */
  102820. static readonly CUBIC_MODE: number;
  102821. /** Projection coordinates mode */
  102822. static readonly PROJECTION_MODE: number;
  102823. /** Inverse Cubic coordinates mode */
  102824. static readonly SKYBOX_MODE: number;
  102825. /** Inverse Cubic coordinates mode */
  102826. static readonly INVCUBIC_MODE: number;
  102827. /** Equirectangular coordinates mode */
  102828. static readonly EQUIRECTANGULAR_MODE: number;
  102829. /** Equirectangular Fixed coordinates mode */
  102830. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  102831. /** Equirectangular Fixed Mirrored coordinates mode */
  102832. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  102833. /** Texture is not repeating outside of 0..1 UVs */
  102834. static readonly CLAMP_ADDRESSMODE: number;
  102835. /** Texture is repeating outside of 0..1 UVs */
  102836. static readonly WRAP_ADDRESSMODE: number;
  102837. /** Texture is repeating and mirrored */
  102838. static readonly MIRROR_ADDRESSMODE: number;
  102839. /**
  102840. * 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
  102841. */
  102842. static UseSerializedUrlIfAny: boolean;
  102843. /**
  102844. * Define the url of the texture.
  102845. */
  102846. url: Nullable<string>;
  102847. /**
  102848. * Define an offset on the texture to offset the u coordinates of the UVs
  102849. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102850. */
  102851. uOffset: number;
  102852. /**
  102853. * Define an offset on the texture to offset the v coordinates of the UVs
  102854. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102855. */
  102856. vOffset: number;
  102857. /**
  102858. * Define an offset on the texture to scale the u coordinates of the UVs
  102859. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102860. */
  102861. uScale: number;
  102862. /**
  102863. * Define an offset on the texture to scale the v coordinates of the UVs
  102864. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102865. */
  102866. vScale: number;
  102867. /**
  102868. * Define an offset on the texture to rotate around the u coordinates of the UVs
  102869. * @see https://doc.babylonjs.com/how_to/more_materials
  102870. */
  102871. uAng: number;
  102872. /**
  102873. * Define an offset on the texture to rotate around the v coordinates of the UVs
  102874. * @see https://doc.babylonjs.com/how_to/more_materials
  102875. */
  102876. vAng: number;
  102877. /**
  102878. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  102879. * @see https://doc.babylonjs.com/how_to/more_materials
  102880. */
  102881. wAng: number;
  102882. /**
  102883. * Defines the center of rotation (U)
  102884. */
  102885. uRotationCenter: number;
  102886. /**
  102887. * Defines the center of rotation (V)
  102888. */
  102889. vRotationCenter: number;
  102890. /**
  102891. * Defines the center of rotation (W)
  102892. */
  102893. wRotationCenter: number;
  102894. /**
  102895. * Are mip maps generated for this texture or not.
  102896. */
  102897. get noMipmap(): boolean;
  102898. /**
  102899. * List of inspectable custom properties (used by the Inspector)
  102900. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102901. */
  102902. inspectableCustomProperties: Nullable<IInspectable[]>;
  102903. private _noMipmap;
  102904. /** @hidden */
  102905. _invertY: boolean;
  102906. private _rowGenerationMatrix;
  102907. private _cachedTextureMatrix;
  102908. private _projectionModeMatrix;
  102909. private _t0;
  102910. private _t1;
  102911. private _t2;
  102912. private _cachedUOffset;
  102913. private _cachedVOffset;
  102914. private _cachedUScale;
  102915. private _cachedVScale;
  102916. private _cachedUAng;
  102917. private _cachedVAng;
  102918. private _cachedWAng;
  102919. private _cachedProjectionMatrixId;
  102920. private _cachedCoordinatesMode;
  102921. /** @hidden */
  102922. protected _initialSamplingMode: number;
  102923. /** @hidden */
  102924. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  102925. private _deleteBuffer;
  102926. protected _format: Nullable<number>;
  102927. private _delayedOnLoad;
  102928. private _delayedOnError;
  102929. private _mimeType?;
  102930. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  102931. get mimeType(): string | undefined;
  102932. /**
  102933. * Observable triggered once the texture has been loaded.
  102934. */
  102935. onLoadObservable: Observable<Texture>;
  102936. protected _isBlocking: boolean;
  102937. /**
  102938. * Is the texture preventing material to render while loading.
  102939. * If false, a default texture will be used instead of the loading one during the preparation step.
  102940. */
  102941. set isBlocking(value: boolean);
  102942. get isBlocking(): boolean;
  102943. /**
  102944. * Get the current sampling mode associated with the texture.
  102945. */
  102946. get samplingMode(): number;
  102947. /**
  102948. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  102949. */
  102950. get invertY(): boolean;
  102951. /**
  102952. * Instantiates a new texture.
  102953. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102954. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102955. * @param url defines the url of the picture to load as a texture
  102956. * @param sceneOrEngine defines the scene or engine the texture will belong to
  102957. * @param noMipmap defines if the texture will require mip maps or not
  102958. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  102959. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102960. * @param onLoad defines a callback triggered when the texture has been loaded
  102961. * @param onError defines a callback triggered when an error occurred during the loading session
  102962. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  102963. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  102964. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102965. * @param mimeType defines an optional mime type information
  102966. */
  102967. 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);
  102968. /**
  102969. * Update the url (and optional buffer) of this texture if url was null during construction.
  102970. * @param url the url of the texture
  102971. * @param buffer the buffer of the texture (defaults to null)
  102972. * @param onLoad callback called when the texture is loaded (defaults to null)
  102973. */
  102974. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  102975. /**
  102976. * Finish the loading sequence of a texture flagged as delayed load.
  102977. * @hidden
  102978. */
  102979. delayLoad(): void;
  102980. private _prepareRowForTextureGeneration;
  102981. /**
  102982. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  102983. * @returns the transform matrix of the texture.
  102984. */
  102985. getTextureMatrix(uBase?: number): Matrix;
  102986. /**
  102987. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  102988. * @returns The reflection texture transform
  102989. */
  102990. getReflectionTextureMatrix(): Matrix;
  102991. /**
  102992. * Clones the texture.
  102993. * @returns the cloned texture
  102994. */
  102995. clone(): Texture;
  102996. /**
  102997. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  102998. * @returns The JSON representation of the texture
  102999. */
  103000. serialize(): any;
  103001. /**
  103002. * Get the current class name of the texture useful for serialization or dynamic coding.
  103003. * @returns "Texture"
  103004. */
  103005. getClassName(): string;
  103006. /**
  103007. * Dispose the texture and release its associated resources.
  103008. */
  103009. dispose(): void;
  103010. /**
  103011. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  103012. * @param parsedTexture Define the JSON representation of the texture
  103013. * @param scene Define the scene the parsed texture should be instantiated in
  103014. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  103015. * @returns The parsed texture if successful
  103016. */
  103017. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  103018. /**
  103019. * Creates a texture from its base 64 representation.
  103020. * @param data Define the base64 payload without the data: prefix
  103021. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103022. * @param scene Define the scene the texture should belong to
  103023. * @param noMipmap Forces the texture to not create mip map information if true
  103024. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103025. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103026. * @param onLoad define a callback triggered when the texture has been loaded
  103027. * @param onError define a callback triggered when an error occurred during the loading session
  103028. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103029. * @returns the created texture
  103030. */
  103031. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  103032. /**
  103033. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  103034. * @param data Define the base64 payload without the data: prefix
  103035. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103036. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  103037. * @param scene Define the scene the texture should belong to
  103038. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  103039. * @param noMipmap Forces the texture to not create mip map information if true
  103040. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103041. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103042. * @param onLoad define a callback triggered when the texture has been loaded
  103043. * @param onError define a callback triggered when an error occurred during the loading session
  103044. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103045. * @returns the created texture
  103046. */
  103047. 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;
  103048. }
  103049. }
  103050. declare module BABYLON {
  103051. /**
  103052. * PostProcessManager is used to manage one or more post processes or post process pipelines
  103053. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103054. */
  103055. export class PostProcessManager {
  103056. private _scene;
  103057. private _indexBuffer;
  103058. private _vertexBuffers;
  103059. /**
  103060. * Creates a new instance PostProcess
  103061. * @param scene The scene that the post process is associated with.
  103062. */
  103063. constructor(scene: Scene);
  103064. private _prepareBuffers;
  103065. private _buildIndexBuffer;
  103066. /**
  103067. * Rebuilds the vertex buffers of the manager.
  103068. * @hidden
  103069. */
  103070. _rebuild(): void;
  103071. /**
  103072. * Prepares a frame to be run through a post process.
  103073. * @param sourceTexture The input texture to the post procesess. (default: null)
  103074. * @param postProcesses An array of post processes to be run. (default: null)
  103075. * @returns True if the post processes were able to be run.
  103076. * @hidden
  103077. */
  103078. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  103079. /**
  103080. * Manually render a set of post processes to a texture.
  103081. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  103082. * @param postProcesses An array of post processes to be run.
  103083. * @param targetTexture The target texture to render to.
  103084. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  103085. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  103086. * @param lodLevel defines which lod of the texture to render to
  103087. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  103088. */
  103089. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  103090. /**
  103091. * Finalize the result of the output of the postprocesses.
  103092. * @param doNotPresent If true the result will not be displayed to the screen.
  103093. * @param targetTexture The target texture to render to.
  103094. * @param faceIndex The index of the face to bind the target texture to.
  103095. * @param postProcesses The array of post processes to render.
  103096. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  103097. * @hidden
  103098. */
  103099. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  103100. /**
  103101. * Disposes of the post process manager.
  103102. */
  103103. dispose(): void;
  103104. }
  103105. }
  103106. declare module BABYLON {
  103107. /**
  103108. * This Helps creating a texture that will be created from a camera in your scene.
  103109. * It is basically a dynamic texture that could be used to create special effects for instance.
  103110. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  103111. */
  103112. export class RenderTargetTexture extends Texture {
  103113. /**
  103114. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  103115. */
  103116. static readonly REFRESHRATE_RENDER_ONCE: number;
  103117. /**
  103118. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  103119. */
  103120. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  103121. /**
  103122. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  103123. * the central point of your effect and can save a lot of performances.
  103124. */
  103125. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  103126. /**
  103127. * Use this predicate to dynamically define the list of mesh you want to render.
  103128. * If set, the renderList property will be overwritten.
  103129. */
  103130. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  103131. private _renderList;
  103132. /**
  103133. * Use this list to define the list of mesh you want to render.
  103134. */
  103135. get renderList(): Nullable<Array<AbstractMesh>>;
  103136. set renderList(value: Nullable<Array<AbstractMesh>>);
  103137. /**
  103138. * Use this function to overload the renderList array at rendering time.
  103139. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  103140. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  103141. * the cube (if the RTT is a cube, else layerOrFace=0).
  103142. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  103143. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  103144. * hold dummy elements!
  103145. */
  103146. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  103147. private _hookArray;
  103148. /**
  103149. * Define if particles should be rendered in your texture.
  103150. */
  103151. renderParticles: boolean;
  103152. /**
  103153. * Define if sprites should be rendered in your texture.
  103154. */
  103155. renderSprites: boolean;
  103156. /**
  103157. * Define the camera used to render the texture.
  103158. */
  103159. activeCamera: Nullable<Camera>;
  103160. /**
  103161. * Override the mesh isReady function with your own one.
  103162. */
  103163. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  103164. /**
  103165. * Override the render function of the texture with your own one.
  103166. */
  103167. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  103168. /**
  103169. * Define if camera post processes should be use while rendering the texture.
  103170. */
  103171. useCameraPostProcesses: boolean;
  103172. /**
  103173. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  103174. */
  103175. ignoreCameraViewport: boolean;
  103176. private _postProcessManager;
  103177. private _postProcesses;
  103178. private _resizeObserver;
  103179. /**
  103180. * An event triggered when the texture is unbind.
  103181. */
  103182. onBeforeBindObservable: Observable<RenderTargetTexture>;
  103183. /**
  103184. * An event triggered when the texture is unbind.
  103185. */
  103186. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  103187. private _onAfterUnbindObserver;
  103188. /**
  103189. * Set a after unbind callback in the texture.
  103190. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  103191. */
  103192. set onAfterUnbind(callback: () => void);
  103193. /**
  103194. * An event triggered before rendering the texture
  103195. */
  103196. onBeforeRenderObservable: Observable<number>;
  103197. private _onBeforeRenderObserver;
  103198. /**
  103199. * Set a before render callback in the texture.
  103200. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  103201. */
  103202. set onBeforeRender(callback: (faceIndex: number) => void);
  103203. /**
  103204. * An event triggered after rendering the texture
  103205. */
  103206. onAfterRenderObservable: Observable<number>;
  103207. private _onAfterRenderObserver;
  103208. /**
  103209. * Set a after render callback in the texture.
  103210. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  103211. */
  103212. set onAfterRender(callback: (faceIndex: number) => void);
  103213. /**
  103214. * An event triggered after the texture clear
  103215. */
  103216. onClearObservable: Observable<Engine>;
  103217. private _onClearObserver;
  103218. /**
  103219. * Set a clear callback in the texture.
  103220. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  103221. */
  103222. set onClear(callback: (Engine: Engine) => void);
  103223. /**
  103224. * An event triggered when the texture is resized.
  103225. */
  103226. onResizeObservable: Observable<RenderTargetTexture>;
  103227. /**
  103228. * Define the clear color of the Render Target if it should be different from the scene.
  103229. */
  103230. clearColor: Color4;
  103231. protected _size: number | {
  103232. width: number;
  103233. height: number;
  103234. layers?: number;
  103235. };
  103236. protected _initialSizeParameter: number | {
  103237. width: number;
  103238. height: number;
  103239. } | {
  103240. ratio: number;
  103241. };
  103242. protected _sizeRatio: Nullable<number>;
  103243. /** @hidden */
  103244. _generateMipMaps: boolean;
  103245. protected _renderingManager: RenderingManager;
  103246. /** @hidden */
  103247. _waitingRenderList?: string[];
  103248. protected _doNotChangeAspectRatio: boolean;
  103249. protected _currentRefreshId: number;
  103250. protected _refreshRate: number;
  103251. protected _textureMatrix: Matrix;
  103252. protected _samples: number;
  103253. protected _renderTargetOptions: RenderTargetCreationOptions;
  103254. /**
  103255. * Gets render target creation options that were used.
  103256. */
  103257. get renderTargetOptions(): RenderTargetCreationOptions;
  103258. protected _onRatioRescale(): void;
  103259. /**
  103260. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  103261. * It must define where the camera used to render the texture is set
  103262. */
  103263. boundingBoxPosition: Vector3;
  103264. private _boundingBoxSize;
  103265. /**
  103266. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  103267. * When defined, the cubemap will switch to local mode
  103268. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  103269. * @example https://www.babylonjs-playground.com/#RNASML
  103270. */
  103271. set boundingBoxSize(value: Vector3);
  103272. get boundingBoxSize(): Vector3;
  103273. /**
  103274. * In case the RTT has been created with a depth texture, get the associated
  103275. * depth texture.
  103276. * Otherwise, return null.
  103277. */
  103278. get depthStencilTexture(): Nullable<InternalTexture>;
  103279. /**
  103280. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  103281. * or used a shadow, depth texture...
  103282. * @param name The friendly name of the texture
  103283. * @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)
  103284. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  103285. * @param generateMipMaps True if mip maps need to be generated after render.
  103286. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  103287. * @param type The type of the buffer in the RTT (int, half float, float...)
  103288. * @param isCube True if a cube texture needs to be created
  103289. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  103290. * @param generateDepthBuffer True to generate a depth buffer
  103291. * @param generateStencilBuffer True to generate a stencil buffer
  103292. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  103293. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  103294. * @param delayAllocation if the texture allocation should be delayed (default: false)
  103295. */
  103296. constructor(name: string, size: number | {
  103297. width: number;
  103298. height: number;
  103299. layers?: number;
  103300. } | {
  103301. ratio: number;
  103302. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  103303. /**
  103304. * Creates a depth stencil texture.
  103305. * This is only available in WebGL 2 or with the depth texture extension available.
  103306. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  103307. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  103308. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  103309. */
  103310. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  103311. private _processSizeParameter;
  103312. /**
  103313. * Define the number of samples to use in case of MSAA.
  103314. * It defaults to one meaning no MSAA has been enabled.
  103315. */
  103316. get samples(): number;
  103317. set samples(value: number);
  103318. /**
  103319. * Resets the refresh counter of the texture and start bak from scratch.
  103320. * Could be useful to regenerate the texture if it is setup to render only once.
  103321. */
  103322. resetRefreshCounter(): void;
  103323. /**
  103324. * Define the refresh rate of the texture or the rendering frequency.
  103325. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  103326. */
  103327. get refreshRate(): number;
  103328. set refreshRate(value: number);
  103329. /**
  103330. * Adds a post process to the render target rendering passes.
  103331. * @param postProcess define the post process to add
  103332. */
  103333. addPostProcess(postProcess: PostProcess): void;
  103334. /**
  103335. * Clear all the post processes attached to the render target
  103336. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  103337. */
  103338. clearPostProcesses(dispose?: boolean): void;
  103339. /**
  103340. * Remove one of the post process from the list of attached post processes to the texture
  103341. * @param postProcess define the post process to remove from the list
  103342. */
  103343. removePostProcess(postProcess: PostProcess): void;
  103344. /** @hidden */
  103345. _shouldRender(): boolean;
  103346. /**
  103347. * Gets the actual render size of the texture.
  103348. * @returns the width of the render size
  103349. */
  103350. getRenderSize(): number;
  103351. /**
  103352. * Gets the actual render width of the texture.
  103353. * @returns the width of the render size
  103354. */
  103355. getRenderWidth(): number;
  103356. /**
  103357. * Gets the actual render height of the texture.
  103358. * @returns the height of the render size
  103359. */
  103360. getRenderHeight(): number;
  103361. /**
  103362. * Gets the actual number of layers of the texture.
  103363. * @returns the number of layers
  103364. */
  103365. getRenderLayers(): number;
  103366. /**
  103367. * Get if the texture can be rescaled or not.
  103368. */
  103369. get canRescale(): boolean;
  103370. /**
  103371. * Resize the texture using a ratio.
  103372. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  103373. */
  103374. scale(ratio: number): void;
  103375. /**
  103376. * Get the texture reflection matrix used to rotate/transform the reflection.
  103377. * @returns the reflection matrix
  103378. */
  103379. getReflectionTextureMatrix(): Matrix;
  103380. /**
  103381. * Resize the texture to a new desired size.
  103382. * Be carrefull as it will recreate all the data in the new texture.
  103383. * @param size Define the new size. It can be:
  103384. * - a number for squared texture,
  103385. * - an object containing { width: number, height: number }
  103386. * - or an object containing a ratio { ratio: number }
  103387. */
  103388. resize(size: number | {
  103389. width: number;
  103390. height: number;
  103391. } | {
  103392. ratio: number;
  103393. }): void;
  103394. private _defaultRenderListPrepared;
  103395. /**
  103396. * Renders all the objects from the render list into the texture.
  103397. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  103398. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  103399. */
  103400. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  103401. private _bestReflectionRenderTargetDimension;
  103402. private _prepareRenderingManager;
  103403. /**
  103404. * @hidden
  103405. * @param faceIndex face index to bind to if this is a cubetexture
  103406. * @param layer defines the index of the texture to bind in the array
  103407. */
  103408. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  103409. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103410. private renderToTarget;
  103411. /**
  103412. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103413. * This allowed control for front to back rendering or reversly depending of the special needs.
  103414. *
  103415. * @param renderingGroupId The rendering group id corresponding to its index
  103416. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103417. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103418. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103419. */
  103420. 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;
  103421. /**
  103422. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103423. *
  103424. * @param renderingGroupId The rendering group id corresponding to its index
  103425. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103426. */
  103427. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  103428. /**
  103429. * Clones the texture.
  103430. * @returns the cloned texture
  103431. */
  103432. clone(): RenderTargetTexture;
  103433. /**
  103434. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103435. * @returns The JSON representation of the texture
  103436. */
  103437. serialize(): any;
  103438. /**
  103439. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  103440. */
  103441. disposeFramebufferObjects(): void;
  103442. /**
  103443. * Dispose the texture and release its associated resources.
  103444. */
  103445. dispose(): void;
  103446. /** @hidden */
  103447. _rebuild(): void;
  103448. /**
  103449. * Clear the info related to rendering groups preventing retention point in material dispose.
  103450. */
  103451. freeRenderingGroups(): void;
  103452. /**
  103453. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  103454. * @returns the view count
  103455. */
  103456. getViewCount(): number;
  103457. }
  103458. }
  103459. declare module BABYLON {
  103460. /**
  103461. * Class used to manipulate GUIDs
  103462. */
  103463. export class GUID {
  103464. /**
  103465. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  103466. * Be aware Math.random() could cause collisions, but:
  103467. * "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"
  103468. * @returns a pseudo random id
  103469. */
  103470. static RandomId(): string;
  103471. }
  103472. }
  103473. declare module BABYLON {
  103474. /**
  103475. * Options to be used when creating a shadow depth material
  103476. */
  103477. export interface IIOptionShadowDepthMaterial {
  103478. /** Variables in the vertex shader code that need to have their names remapped.
  103479. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  103480. * "var_name" should be either: worldPos or vNormalW
  103481. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  103482. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  103483. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  103484. */
  103485. remappedVariables?: string[];
  103486. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  103487. standalone?: boolean;
  103488. }
  103489. /**
  103490. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  103491. */
  103492. export class ShadowDepthWrapper {
  103493. private _scene;
  103494. private _options?;
  103495. private _baseMaterial;
  103496. private _onEffectCreatedObserver;
  103497. private _subMeshToEffect;
  103498. private _subMeshToDepthEffect;
  103499. private _meshes;
  103500. /** @hidden */
  103501. _matriceNames: any;
  103502. /** Gets the standalone status of the wrapper */
  103503. get standalone(): boolean;
  103504. /** Gets the base material the wrapper is built upon */
  103505. get baseMaterial(): Material;
  103506. /**
  103507. * Instantiate a new shadow depth wrapper.
  103508. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  103509. * generate the shadow depth map. For more information, please refer to the documentation:
  103510. * https://doc.babylonjs.com/babylon101/shadows
  103511. * @param baseMaterial Material to wrap
  103512. * @param scene Define the scene the material belongs to
  103513. * @param options Options used to create the wrapper
  103514. */
  103515. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  103516. /**
  103517. * Gets the effect to use to generate the depth map
  103518. * @param subMesh subMesh to get the effect for
  103519. * @param shadowGenerator shadow generator to get the effect for
  103520. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  103521. */
  103522. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  103523. /**
  103524. * Specifies that the submesh is ready to be used for depth rendering
  103525. * @param subMesh submesh to check
  103526. * @param defines the list of defines to take into account when checking the effect
  103527. * @param shadowGenerator combined with subMesh, it defines the effect to check
  103528. * @param useInstances specifies that instances should be used
  103529. * @returns a boolean indicating that the submesh is ready or not
  103530. */
  103531. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  103532. /**
  103533. * Disposes the resources
  103534. */
  103535. dispose(): void;
  103536. private _makeEffect;
  103537. }
  103538. }
  103539. declare module BABYLON {
  103540. interface ThinEngine {
  103541. /**
  103542. * Unbind a list of render target textures from the webGL context
  103543. * This is used only when drawBuffer extension or webGL2 are active
  103544. * @param textures defines the render target textures to unbind
  103545. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103546. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103547. */
  103548. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103549. /**
  103550. * Create a multi render target texture
  103551. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103552. * @param size defines the size of the texture
  103553. * @param options defines the creation options
  103554. * @returns the cube texture as an InternalTexture
  103555. */
  103556. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103557. /**
  103558. * Update the sample count for a given multiple render target texture
  103559. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103560. * @param textures defines the textures to update
  103561. * @param samples defines the sample count to set
  103562. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103563. */
  103564. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103565. /**
  103566. * Select a subsets of attachments to draw to.
  103567. * @param attachments gl attachments
  103568. */
  103569. bindAttachments(attachments: number[]): void;
  103570. }
  103571. }
  103572. declare module BABYLON {
  103573. /**
  103574. * Creation options of the multi render target texture.
  103575. */
  103576. export interface IMultiRenderTargetOptions {
  103577. /**
  103578. * Define if the texture needs to create mip maps after render.
  103579. */
  103580. generateMipMaps?: boolean;
  103581. /**
  103582. * Define the types of all the draw buffers we want to create
  103583. */
  103584. types?: number[];
  103585. /**
  103586. * Define the sampling modes of all the draw buffers we want to create
  103587. */
  103588. samplingModes?: number[];
  103589. /**
  103590. * Define if a depth buffer is required
  103591. */
  103592. generateDepthBuffer?: boolean;
  103593. /**
  103594. * Define if a stencil buffer is required
  103595. */
  103596. generateStencilBuffer?: boolean;
  103597. /**
  103598. * Define if a depth texture is required instead of a depth buffer
  103599. */
  103600. generateDepthTexture?: boolean;
  103601. /**
  103602. * Define the number of desired draw buffers
  103603. */
  103604. textureCount?: number;
  103605. /**
  103606. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103607. */
  103608. doNotChangeAspectRatio?: boolean;
  103609. /**
  103610. * Define the default type of the buffers we are creating
  103611. */
  103612. defaultType?: number;
  103613. }
  103614. /**
  103615. * A multi render target, like a render target provides the ability to render to a texture.
  103616. * Unlike the render target, it can render to several draw buffers in one draw.
  103617. * This is specially interesting in deferred rendering or for any effects requiring more than
  103618. * just one color from a single pass.
  103619. */
  103620. export class MultiRenderTarget extends RenderTargetTexture {
  103621. private _internalTextures;
  103622. private _textures;
  103623. private _multiRenderTargetOptions;
  103624. private _count;
  103625. /**
  103626. * Get if draw buffers are currently supported by the used hardware and browser.
  103627. */
  103628. get isSupported(): boolean;
  103629. /**
  103630. * Get the list of textures generated by the multi render target.
  103631. */
  103632. get textures(): Texture[];
  103633. /**
  103634. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103635. */
  103636. get count(): number;
  103637. /**
  103638. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103639. */
  103640. get depthTexture(): Texture;
  103641. /**
  103642. * Set the wrapping mode on U of all the textures we are rendering to.
  103643. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103644. */
  103645. set wrapU(wrap: number);
  103646. /**
  103647. * Set the wrapping mode on V of all the textures we are rendering to.
  103648. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103649. */
  103650. set wrapV(wrap: number);
  103651. /**
  103652. * Instantiate a new multi render target texture.
  103653. * A multi render target, like a render target provides the ability to render to a texture.
  103654. * Unlike the render target, it can render to several draw buffers in one draw.
  103655. * This is specially interesting in deferred rendering or for any effects requiring more than
  103656. * just one color from a single pass.
  103657. * @param name Define the name of the texture
  103658. * @param size Define the size of the buffers to render to
  103659. * @param count Define the number of target we are rendering into
  103660. * @param scene Define the scene the texture belongs to
  103661. * @param options Define the options used to create the multi render target
  103662. */
  103663. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103664. /** @hidden */
  103665. _rebuild(): void;
  103666. private _createInternalTextures;
  103667. private _createTextures;
  103668. /**
  103669. * Define the number of samples used if MSAA is enabled.
  103670. */
  103671. get samples(): number;
  103672. set samples(value: number);
  103673. /**
  103674. * Resize all the textures in the multi render target.
  103675. * Be carrefull as it will recreate all the data in the new texture.
  103676. * @param size Define the new size
  103677. */
  103678. resize(size: any): void;
  103679. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103680. /**
  103681. * Dispose the render targets and their associated resources
  103682. */
  103683. dispose(): void;
  103684. /**
  103685. * Release all the underlying texture used as draw buffers.
  103686. */
  103687. releaseInternalTextures(): void;
  103688. }
  103689. }
  103690. declare module BABYLON {
  103691. /** @hidden */
  103692. export var imageProcessingPixelShader: {
  103693. name: string;
  103694. shader: string;
  103695. };
  103696. }
  103697. declare module BABYLON {
  103698. /**
  103699. * ImageProcessingPostProcess
  103700. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103701. */
  103702. export class ImageProcessingPostProcess extends PostProcess {
  103703. /**
  103704. * Default configuration related to image processing available in the PBR Material.
  103705. */
  103706. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103707. /**
  103708. * Gets the image processing configuration used either in this material.
  103709. */
  103710. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103711. /**
  103712. * Sets the Default image processing configuration used either in the this material.
  103713. *
  103714. * If sets to null, the scene one is in use.
  103715. */
  103716. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103717. /**
  103718. * Keep track of the image processing observer to allow dispose and replace.
  103719. */
  103720. private _imageProcessingObserver;
  103721. /**
  103722. * Attaches a new image processing configuration to the PBR Material.
  103723. * @param configuration
  103724. */
  103725. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103726. /**
  103727. * If the post process is supported.
  103728. */
  103729. get isSupported(): boolean;
  103730. /**
  103731. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103732. */
  103733. get colorCurves(): Nullable<ColorCurves>;
  103734. /**
  103735. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103736. */
  103737. set colorCurves(value: Nullable<ColorCurves>);
  103738. /**
  103739. * Gets wether the color curves effect is enabled.
  103740. */
  103741. get colorCurvesEnabled(): boolean;
  103742. /**
  103743. * Sets wether the color curves effect is enabled.
  103744. */
  103745. set colorCurvesEnabled(value: boolean);
  103746. /**
  103747. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103748. */
  103749. get colorGradingTexture(): Nullable<BaseTexture>;
  103750. /**
  103751. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103752. */
  103753. set colorGradingTexture(value: Nullable<BaseTexture>);
  103754. /**
  103755. * Gets wether the color grading effect is enabled.
  103756. */
  103757. get colorGradingEnabled(): boolean;
  103758. /**
  103759. * Gets wether the color grading effect is enabled.
  103760. */
  103761. set colorGradingEnabled(value: boolean);
  103762. /**
  103763. * Gets exposure used in the effect.
  103764. */
  103765. get exposure(): number;
  103766. /**
  103767. * Sets exposure used in the effect.
  103768. */
  103769. set exposure(value: number);
  103770. /**
  103771. * Gets wether tonemapping is enabled or not.
  103772. */
  103773. get toneMappingEnabled(): boolean;
  103774. /**
  103775. * Sets wether tonemapping is enabled or not
  103776. */
  103777. set toneMappingEnabled(value: boolean);
  103778. /**
  103779. * Gets the type of tone mapping effect.
  103780. */
  103781. get toneMappingType(): number;
  103782. /**
  103783. * Sets the type of tone mapping effect.
  103784. */
  103785. set toneMappingType(value: number);
  103786. /**
  103787. * Gets contrast used in the effect.
  103788. */
  103789. get contrast(): number;
  103790. /**
  103791. * Sets contrast used in the effect.
  103792. */
  103793. set contrast(value: number);
  103794. /**
  103795. * Gets Vignette stretch size.
  103796. */
  103797. get vignetteStretch(): number;
  103798. /**
  103799. * Sets Vignette stretch size.
  103800. */
  103801. set vignetteStretch(value: number);
  103802. /**
  103803. * Gets Vignette centre X Offset.
  103804. */
  103805. get vignetteCentreX(): number;
  103806. /**
  103807. * Sets Vignette centre X Offset.
  103808. */
  103809. set vignetteCentreX(value: number);
  103810. /**
  103811. * Gets Vignette centre Y Offset.
  103812. */
  103813. get vignetteCentreY(): number;
  103814. /**
  103815. * Sets Vignette centre Y Offset.
  103816. */
  103817. set vignetteCentreY(value: number);
  103818. /**
  103819. * Gets Vignette weight or intensity of the vignette effect.
  103820. */
  103821. get vignetteWeight(): number;
  103822. /**
  103823. * Sets Vignette weight or intensity of the vignette effect.
  103824. */
  103825. set vignetteWeight(value: number);
  103826. /**
  103827. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103828. * if vignetteEnabled is set to true.
  103829. */
  103830. get vignetteColor(): Color4;
  103831. /**
  103832. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103833. * if vignetteEnabled is set to true.
  103834. */
  103835. set vignetteColor(value: Color4);
  103836. /**
  103837. * Gets Camera field of view used by the Vignette effect.
  103838. */
  103839. get vignetteCameraFov(): number;
  103840. /**
  103841. * Sets Camera field of view used by the Vignette effect.
  103842. */
  103843. set vignetteCameraFov(value: number);
  103844. /**
  103845. * Gets the vignette blend mode allowing different kind of effect.
  103846. */
  103847. get vignetteBlendMode(): number;
  103848. /**
  103849. * Sets the vignette blend mode allowing different kind of effect.
  103850. */
  103851. set vignetteBlendMode(value: number);
  103852. /**
  103853. * Gets wether the vignette effect is enabled.
  103854. */
  103855. get vignetteEnabled(): boolean;
  103856. /**
  103857. * Sets wether the vignette effect is enabled.
  103858. */
  103859. set vignetteEnabled(value: boolean);
  103860. private _fromLinearSpace;
  103861. /**
  103862. * Gets wether the input of the processing is in Gamma or Linear Space.
  103863. */
  103864. get fromLinearSpace(): boolean;
  103865. /**
  103866. * Sets wether the input of the processing is in Gamma or Linear Space.
  103867. */
  103868. set fromLinearSpace(value: boolean);
  103869. /**
  103870. * Defines cache preventing GC.
  103871. */
  103872. private _defines;
  103873. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  103874. /**
  103875. * "ImageProcessingPostProcess"
  103876. * @returns "ImageProcessingPostProcess"
  103877. */
  103878. getClassName(): string;
  103879. /**
  103880. * @hidden
  103881. */
  103882. _updateParameters(): void;
  103883. dispose(camera?: Camera): void;
  103884. }
  103885. }
  103886. declare module BABYLON {
  103887. /** @hidden */
  103888. export var fibonacci: {
  103889. name: string;
  103890. shader: string;
  103891. };
  103892. }
  103893. declare module BABYLON {
  103894. /** @hidden */
  103895. export var subSurfaceScatteringFunctions: {
  103896. name: string;
  103897. shader: string;
  103898. };
  103899. }
  103900. declare module BABYLON {
  103901. /** @hidden */
  103902. export var diffusionProfile: {
  103903. name: string;
  103904. shader: string;
  103905. };
  103906. }
  103907. declare module BABYLON {
  103908. /** @hidden */
  103909. export var subSurfaceScatteringPixelShader: {
  103910. name: string;
  103911. shader: string;
  103912. };
  103913. }
  103914. declare module BABYLON {
  103915. /**
  103916. * Sub surface scattering post process
  103917. */
  103918. export class SubSurfaceScatteringPostProcess extends PostProcess {
  103919. /**
  103920. * Gets a string identifying the name of the class
  103921. * @returns "SubSurfaceScatteringPostProcess" string
  103922. */
  103923. getClassName(): string;
  103924. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  103925. }
  103926. }
  103927. declare module BABYLON {
  103928. /**
  103929. * Interface for defining prepass effects in the prepass post-process pipeline
  103930. */
  103931. export interface PrePassEffectConfiguration {
  103932. /**
  103933. * Post process to attach for this effect
  103934. */
  103935. postProcess: PostProcess;
  103936. /**
  103937. * Is the effect enabled
  103938. */
  103939. enabled: boolean;
  103940. /**
  103941. * Disposes the effect configuration
  103942. */
  103943. dispose(): void;
  103944. /**
  103945. * Disposes the effect configuration
  103946. */
  103947. createPostProcess: () => PostProcess;
  103948. }
  103949. }
  103950. declare module BABYLON {
  103951. /**
  103952. * Contains all parameters needed for the prepass to perform
  103953. * screen space subsurface scattering
  103954. */
  103955. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  103956. private _ssDiffusionS;
  103957. private _ssFilterRadii;
  103958. private _ssDiffusionD;
  103959. /**
  103960. * Post process to attach for screen space subsurface scattering
  103961. */
  103962. postProcess: SubSurfaceScatteringPostProcess;
  103963. /**
  103964. * Diffusion profile color for subsurface scattering
  103965. */
  103966. get ssDiffusionS(): number[];
  103967. /**
  103968. * Diffusion profile max color channel value for subsurface scattering
  103969. */
  103970. get ssDiffusionD(): number[];
  103971. /**
  103972. * Diffusion profile filter radius for subsurface scattering
  103973. */
  103974. get ssFilterRadii(): number[];
  103975. /**
  103976. * Is subsurface enabled
  103977. */
  103978. enabled: boolean;
  103979. /**
  103980. * Diffusion profile colors for subsurface scattering
  103981. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  103982. * See ...
  103983. * Note that you can only store up to 5 of them
  103984. */
  103985. ssDiffusionProfileColors: Color3[];
  103986. /**
  103987. * Defines the ratio real world => scene units.
  103988. * Used for subsurface scattering
  103989. */
  103990. metersPerUnit: number;
  103991. private _scene;
  103992. /**
  103993. * Builds a subsurface configuration object
  103994. * @param scene The scene
  103995. */
  103996. constructor(scene: Scene);
  103997. /**
  103998. * Adds a new diffusion profile.
  103999. * Useful for more realistic subsurface scattering on diverse materials.
  104000. * @param color The color of the diffusion profile. Should be the average color of the material.
  104001. * @return The index of the diffusion profile for the material subsurface configuration
  104002. */
  104003. addDiffusionProfile(color: Color3): number;
  104004. /**
  104005. * Creates the sss post process
  104006. * @return The created post process
  104007. */
  104008. createPostProcess(): SubSurfaceScatteringPostProcess;
  104009. /**
  104010. * Deletes all diffusion profiles.
  104011. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  104012. */
  104013. clearAllDiffusionProfiles(): void;
  104014. /**
  104015. * Disposes this object
  104016. */
  104017. dispose(): void;
  104018. /**
  104019. * @hidden
  104020. * https://zero-radiance.github.io/post/sampling-diffusion/
  104021. *
  104022. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  104023. * ------------------------------------------------------------------------------------
  104024. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  104025. * PDF[r, phi, s] = r * R[r, phi, s]
  104026. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  104027. * ------------------------------------------------------------------------------------
  104028. * We importance sample the color channel with the widest scattering distance.
  104029. */
  104030. getDiffusionProfileParameters(color: Color3): number;
  104031. /**
  104032. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  104033. * 'u' is the random number (the value of the CDF): [0, 1).
  104034. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  104035. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  104036. */
  104037. private _sampleBurleyDiffusionProfile;
  104038. }
  104039. }
  104040. declare module BABYLON {
  104041. /**
  104042. * Renders a pre pass of the scene
  104043. * This means every mesh in the scene will be rendered to a render target texture
  104044. * And then this texture will be composited to the rendering canvas with post processes
  104045. * It is necessary for effects like subsurface scattering or deferred shading
  104046. */
  104047. export class PrePassRenderer {
  104048. /** @hidden */
  104049. static _SceneComponentInitialization: (scene: Scene) => void;
  104050. private _scene;
  104051. private _engine;
  104052. private _isDirty;
  104053. /**
  104054. * Number of textures in the multi render target texture where the scene is directly rendered
  104055. */
  104056. readonly mrtCount: number;
  104057. /**
  104058. * The render target where the scene is directly rendered
  104059. */
  104060. prePassRT: MultiRenderTarget;
  104061. private _mrtTypes;
  104062. private _multiRenderAttachments;
  104063. private _defaultAttachments;
  104064. private _clearAttachments;
  104065. private _postProcesses;
  104066. private readonly _clearColor;
  104067. /**
  104068. * Image processing post process for composition
  104069. */
  104070. imageProcessingPostProcess: ImageProcessingPostProcess;
  104071. /**
  104072. * Configuration for sub surface scattering post process
  104073. */
  104074. subSurfaceConfiguration: SubSurfaceConfiguration;
  104075. /**
  104076. * Should materials render their geometry on the MRT
  104077. */
  104078. materialsShouldRenderGeometry: boolean;
  104079. /**
  104080. * Should materials render the irradiance information on the MRT
  104081. */
  104082. materialsShouldRenderIrradiance: boolean;
  104083. private _enabled;
  104084. /**
  104085. * Indicates if the prepass is enabled
  104086. */
  104087. get enabled(): boolean;
  104088. /**
  104089. * How many samples are used for MSAA of the scene render target
  104090. */
  104091. get samples(): number;
  104092. set samples(n: number);
  104093. /**
  104094. * Instanciates a prepass renderer
  104095. * @param scene The scene
  104096. */
  104097. constructor(scene: Scene);
  104098. private _initializeAttachments;
  104099. private _createCompositionEffect;
  104100. /**
  104101. * Indicates if rendering a prepass is supported
  104102. */
  104103. get isSupported(): boolean;
  104104. /**
  104105. * Sets the proper output textures to draw in the engine.
  104106. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  104107. */
  104108. bindAttachmentsForEffect(effect: Effect): void;
  104109. /**
  104110. * @hidden
  104111. */
  104112. _beforeCameraDraw(): void;
  104113. /**
  104114. * @hidden
  104115. */
  104116. _afterCameraDraw(): void;
  104117. private _checkRTSize;
  104118. private _bindFrameBuffer;
  104119. /**
  104120. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  104121. */
  104122. clear(): void;
  104123. private _setState;
  104124. private _enable;
  104125. private _disable;
  104126. private _resetPostProcessChain;
  104127. private _bindPostProcessChain;
  104128. /**
  104129. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  104130. */
  104131. markAsDirty(): void;
  104132. private _update;
  104133. /**
  104134. * Disposes the prepass renderer.
  104135. */
  104136. dispose(): void;
  104137. }
  104138. }
  104139. declare module BABYLON {
  104140. /**
  104141. * Options for compiling materials.
  104142. */
  104143. export interface IMaterialCompilationOptions {
  104144. /**
  104145. * Defines whether clip planes are enabled.
  104146. */
  104147. clipPlane: boolean;
  104148. /**
  104149. * Defines whether instances are enabled.
  104150. */
  104151. useInstances: boolean;
  104152. }
  104153. /**
  104154. * Options passed when calling customShaderNameResolve
  104155. */
  104156. export interface ICustomShaderNameResolveOptions {
  104157. /**
  104158. * 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
  104159. */
  104160. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  104161. }
  104162. /**
  104163. * Base class for the main features of a material in Babylon.js
  104164. */
  104165. export class Material implements IAnimatable {
  104166. /**
  104167. * Returns the triangle fill mode
  104168. */
  104169. static readonly TriangleFillMode: number;
  104170. /**
  104171. * Returns the wireframe mode
  104172. */
  104173. static readonly WireFrameFillMode: number;
  104174. /**
  104175. * Returns the point fill mode
  104176. */
  104177. static readonly PointFillMode: number;
  104178. /**
  104179. * Returns the point list draw mode
  104180. */
  104181. static readonly PointListDrawMode: number;
  104182. /**
  104183. * Returns the line list draw mode
  104184. */
  104185. static readonly LineListDrawMode: number;
  104186. /**
  104187. * Returns the line loop draw mode
  104188. */
  104189. static readonly LineLoopDrawMode: number;
  104190. /**
  104191. * Returns the line strip draw mode
  104192. */
  104193. static readonly LineStripDrawMode: number;
  104194. /**
  104195. * Returns the triangle strip draw mode
  104196. */
  104197. static readonly TriangleStripDrawMode: number;
  104198. /**
  104199. * Returns the triangle fan draw mode
  104200. */
  104201. static readonly TriangleFanDrawMode: number;
  104202. /**
  104203. * Stores the clock-wise side orientation
  104204. */
  104205. static readonly ClockWiseSideOrientation: number;
  104206. /**
  104207. * Stores the counter clock-wise side orientation
  104208. */
  104209. static readonly CounterClockWiseSideOrientation: number;
  104210. /**
  104211. * The dirty texture flag value
  104212. */
  104213. static readonly TextureDirtyFlag: number;
  104214. /**
  104215. * The dirty light flag value
  104216. */
  104217. static readonly LightDirtyFlag: number;
  104218. /**
  104219. * The dirty fresnel flag value
  104220. */
  104221. static readonly FresnelDirtyFlag: number;
  104222. /**
  104223. * The dirty attribute flag value
  104224. */
  104225. static readonly AttributesDirtyFlag: number;
  104226. /**
  104227. * The dirty misc flag value
  104228. */
  104229. static readonly MiscDirtyFlag: number;
  104230. /**
  104231. * The all dirty flag value
  104232. */
  104233. static readonly AllDirtyFlag: number;
  104234. /**
  104235. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  104236. */
  104237. static readonly MATERIAL_OPAQUE: number;
  104238. /**
  104239. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  104240. */
  104241. static readonly MATERIAL_ALPHATEST: number;
  104242. /**
  104243. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104244. */
  104245. static readonly MATERIAL_ALPHABLEND: number;
  104246. /**
  104247. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104248. * They are also discarded below the alpha cutoff threshold to improve performances.
  104249. */
  104250. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  104251. /**
  104252. * The Whiteout method is used to blend normals.
  104253. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104254. */
  104255. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  104256. /**
  104257. * The Reoriented Normal Mapping method is used to blend normals.
  104258. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104259. */
  104260. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104261. /**
  104262. * Custom callback helping to override the default shader used in the material.
  104263. */
  104264. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104265. /**
  104266. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104267. */
  104268. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104269. /**
  104270. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104271. * This means that the material can keep using a previous shader while a new one is being compiled.
  104272. * This is mostly used when shader parallel compilation is supported (true by default)
  104273. */
  104274. allowShaderHotSwapping: boolean;
  104275. /**
  104276. * The ID of the material
  104277. */
  104278. id: string;
  104279. /**
  104280. * Gets or sets the unique id of the material
  104281. */
  104282. uniqueId: number;
  104283. /**
  104284. * The name of the material
  104285. */
  104286. name: string;
  104287. /**
  104288. * Gets or sets user defined metadata
  104289. */
  104290. metadata: any;
  104291. /**
  104292. * For internal use only. Please do not use.
  104293. */
  104294. reservedDataStore: any;
  104295. /**
  104296. * Specifies if the ready state should be checked on each call
  104297. */
  104298. checkReadyOnEveryCall: boolean;
  104299. /**
  104300. * Specifies if the ready state should be checked once
  104301. */
  104302. checkReadyOnlyOnce: boolean;
  104303. /**
  104304. * The state of the material
  104305. */
  104306. state: string;
  104307. /**
  104308. * If the material can be rendered to several textures with MRT extension
  104309. */
  104310. get canRenderToMRT(): boolean;
  104311. /**
  104312. * The alpha value of the material
  104313. */
  104314. protected _alpha: number;
  104315. /**
  104316. * List of inspectable custom properties (used by the Inspector)
  104317. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  104318. */
  104319. inspectableCustomProperties: IInspectable[];
  104320. /**
  104321. * Sets the alpha value of the material
  104322. */
  104323. set alpha(value: number);
  104324. /**
  104325. * Gets the alpha value of the material
  104326. */
  104327. get alpha(): number;
  104328. /**
  104329. * Specifies if back face culling is enabled
  104330. */
  104331. protected _backFaceCulling: boolean;
  104332. /**
  104333. * Sets the back-face culling state
  104334. */
  104335. set backFaceCulling(value: boolean);
  104336. /**
  104337. * Gets the back-face culling state
  104338. */
  104339. get backFaceCulling(): boolean;
  104340. /**
  104341. * Stores the value for side orientation
  104342. */
  104343. sideOrientation: number;
  104344. /**
  104345. * Callback triggered when the material is compiled
  104346. */
  104347. onCompiled: Nullable<(effect: Effect) => void>;
  104348. /**
  104349. * Callback triggered when an error occurs
  104350. */
  104351. onError: Nullable<(effect: Effect, errors: string) => void>;
  104352. /**
  104353. * Callback triggered to get the render target textures
  104354. */
  104355. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  104356. /**
  104357. * Gets a boolean indicating that current material needs to register RTT
  104358. */
  104359. get hasRenderTargetTextures(): boolean;
  104360. /**
  104361. * Specifies if the material should be serialized
  104362. */
  104363. doNotSerialize: boolean;
  104364. /**
  104365. * @hidden
  104366. */
  104367. _storeEffectOnSubMeshes: boolean;
  104368. /**
  104369. * Stores the animations for the material
  104370. */
  104371. animations: Nullable<Array<Animation>>;
  104372. /**
  104373. * An event triggered when the material is disposed
  104374. */
  104375. onDisposeObservable: Observable<Material>;
  104376. /**
  104377. * An observer which watches for dispose events
  104378. */
  104379. private _onDisposeObserver;
  104380. private _onUnBindObservable;
  104381. /**
  104382. * Called during a dispose event
  104383. */
  104384. set onDispose(callback: () => void);
  104385. private _onBindObservable;
  104386. /**
  104387. * An event triggered when the material is bound
  104388. */
  104389. get onBindObservable(): Observable<AbstractMesh>;
  104390. /**
  104391. * An observer which watches for bind events
  104392. */
  104393. private _onBindObserver;
  104394. /**
  104395. * Called during a bind event
  104396. */
  104397. set onBind(callback: (Mesh: AbstractMesh) => void);
  104398. /**
  104399. * An event triggered when the material is unbound
  104400. */
  104401. get onUnBindObservable(): Observable<Material>;
  104402. protected _onEffectCreatedObservable: Nullable<Observable<{
  104403. effect: Effect;
  104404. subMesh: Nullable<SubMesh>;
  104405. }>>;
  104406. /**
  104407. * An event triggered when the effect is (re)created
  104408. */
  104409. get onEffectCreatedObservable(): Observable<{
  104410. effect: Effect;
  104411. subMesh: Nullable<SubMesh>;
  104412. }>;
  104413. /**
  104414. * Stores the value of the alpha mode
  104415. */
  104416. private _alphaMode;
  104417. /**
  104418. * Sets the value of the alpha mode.
  104419. *
  104420. * | Value | Type | Description |
  104421. * | --- | --- | --- |
  104422. * | 0 | ALPHA_DISABLE | |
  104423. * | 1 | ALPHA_ADD | |
  104424. * | 2 | ALPHA_COMBINE | |
  104425. * | 3 | ALPHA_SUBTRACT | |
  104426. * | 4 | ALPHA_MULTIPLY | |
  104427. * | 5 | ALPHA_MAXIMIZED | |
  104428. * | 6 | ALPHA_ONEONE | |
  104429. * | 7 | ALPHA_PREMULTIPLIED | |
  104430. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  104431. * | 9 | ALPHA_INTERPOLATE | |
  104432. * | 10 | ALPHA_SCREENMODE | |
  104433. *
  104434. */
  104435. set alphaMode(value: number);
  104436. /**
  104437. * Gets the value of the alpha mode
  104438. */
  104439. get alphaMode(): number;
  104440. /**
  104441. * Stores the state of the need depth pre-pass value
  104442. */
  104443. private _needDepthPrePass;
  104444. /**
  104445. * Sets the need depth pre-pass value
  104446. */
  104447. set needDepthPrePass(value: boolean);
  104448. /**
  104449. * Gets the depth pre-pass value
  104450. */
  104451. get needDepthPrePass(): boolean;
  104452. /**
  104453. * Specifies if depth writing should be disabled
  104454. */
  104455. disableDepthWrite: boolean;
  104456. /**
  104457. * Specifies if color writing should be disabled
  104458. */
  104459. disableColorWrite: boolean;
  104460. /**
  104461. * Specifies if depth writing should be forced
  104462. */
  104463. forceDepthWrite: boolean;
  104464. /**
  104465. * Specifies the depth function that should be used. 0 means the default engine function
  104466. */
  104467. depthFunction: number;
  104468. /**
  104469. * Specifies if there should be a separate pass for culling
  104470. */
  104471. separateCullingPass: boolean;
  104472. /**
  104473. * Stores the state specifing if fog should be enabled
  104474. */
  104475. private _fogEnabled;
  104476. /**
  104477. * Sets the state for enabling fog
  104478. */
  104479. set fogEnabled(value: boolean);
  104480. /**
  104481. * Gets the value of the fog enabled state
  104482. */
  104483. get fogEnabled(): boolean;
  104484. /**
  104485. * Stores the size of points
  104486. */
  104487. pointSize: number;
  104488. /**
  104489. * Stores the z offset value
  104490. */
  104491. zOffset: number;
  104492. get wireframe(): boolean;
  104493. /**
  104494. * Sets the state of wireframe mode
  104495. */
  104496. set wireframe(value: boolean);
  104497. /**
  104498. * Gets the value specifying if point clouds are enabled
  104499. */
  104500. get pointsCloud(): boolean;
  104501. /**
  104502. * Sets the state of point cloud mode
  104503. */
  104504. set pointsCloud(value: boolean);
  104505. /**
  104506. * Gets the material fill mode
  104507. */
  104508. get fillMode(): number;
  104509. /**
  104510. * Sets the material fill mode
  104511. */
  104512. set fillMode(value: number);
  104513. /**
  104514. * @hidden
  104515. * Stores the effects for the material
  104516. */
  104517. _effect: Nullable<Effect>;
  104518. /**
  104519. * Specifies if uniform buffers should be used
  104520. */
  104521. private _useUBO;
  104522. /**
  104523. * Stores a reference to the scene
  104524. */
  104525. private _scene;
  104526. /**
  104527. * Stores the fill mode state
  104528. */
  104529. private _fillMode;
  104530. /**
  104531. * Specifies if the depth write state should be cached
  104532. */
  104533. private _cachedDepthWriteState;
  104534. /**
  104535. * Specifies if the color write state should be cached
  104536. */
  104537. private _cachedColorWriteState;
  104538. /**
  104539. * Specifies if the depth function state should be cached
  104540. */
  104541. private _cachedDepthFunctionState;
  104542. /**
  104543. * Stores the uniform buffer
  104544. */
  104545. protected _uniformBuffer: UniformBuffer;
  104546. /** @hidden */
  104547. _indexInSceneMaterialArray: number;
  104548. /** @hidden */
  104549. meshMap: Nullable<{
  104550. [id: string]: AbstractMesh | undefined;
  104551. }>;
  104552. /**
  104553. * Creates a material instance
  104554. * @param name defines the name of the material
  104555. * @param scene defines the scene to reference
  104556. * @param doNotAdd specifies if the material should be added to the scene
  104557. */
  104558. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  104559. /**
  104560. * Returns a string representation of the current material
  104561. * @param fullDetails defines a boolean indicating which levels of logging is desired
  104562. * @returns a string with material information
  104563. */
  104564. toString(fullDetails?: boolean): string;
  104565. /**
  104566. * Gets the class name of the material
  104567. * @returns a string with the class name of the material
  104568. */
  104569. getClassName(): string;
  104570. /**
  104571. * Specifies if updates for the material been locked
  104572. */
  104573. get isFrozen(): boolean;
  104574. /**
  104575. * Locks updates for the material
  104576. */
  104577. freeze(): void;
  104578. /**
  104579. * Unlocks updates for the material
  104580. */
  104581. unfreeze(): void;
  104582. /**
  104583. * Specifies if the material is ready to be used
  104584. * @param mesh defines the mesh to check
  104585. * @param useInstances specifies if instances should be used
  104586. * @returns a boolean indicating if the material is ready to be used
  104587. */
  104588. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  104589. /**
  104590. * Specifies that the submesh is ready to be used
  104591. * @param mesh defines the mesh to check
  104592. * @param subMesh defines which submesh to check
  104593. * @param useInstances specifies that instances should be used
  104594. * @returns a boolean indicating that the submesh is ready or not
  104595. */
  104596. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104597. /**
  104598. * Returns the material effect
  104599. * @returns the effect associated with the material
  104600. */
  104601. getEffect(): Nullable<Effect>;
  104602. /**
  104603. * Returns the current scene
  104604. * @returns a Scene
  104605. */
  104606. getScene(): Scene;
  104607. /**
  104608. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  104609. */
  104610. protected _forceAlphaTest: boolean;
  104611. /**
  104612. * The transparency mode of the material.
  104613. */
  104614. protected _transparencyMode: Nullable<number>;
  104615. /**
  104616. * Gets the current transparency mode.
  104617. */
  104618. get transparencyMode(): Nullable<number>;
  104619. /**
  104620. * Sets the transparency mode of the material.
  104621. *
  104622. * | Value | Type | Description |
  104623. * | ----- | ----------------------------------- | ----------- |
  104624. * | 0 | OPAQUE | |
  104625. * | 1 | ALPHATEST | |
  104626. * | 2 | ALPHABLEND | |
  104627. * | 3 | ALPHATESTANDBLEND | |
  104628. *
  104629. */
  104630. set transparencyMode(value: Nullable<number>);
  104631. /**
  104632. * Returns true if alpha blending should be disabled.
  104633. */
  104634. protected get _disableAlphaBlending(): boolean;
  104635. /**
  104636. * Specifies whether or not this material should be rendered in alpha blend mode.
  104637. * @returns a boolean specifying if alpha blending is needed
  104638. */
  104639. needAlphaBlending(): boolean;
  104640. /**
  104641. * Specifies if the mesh will require alpha blending
  104642. * @param mesh defines the mesh to check
  104643. * @returns a boolean specifying if alpha blending is needed for the mesh
  104644. */
  104645. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  104646. /**
  104647. * Specifies whether or not this material should be rendered in alpha test mode.
  104648. * @returns a boolean specifying if an alpha test is needed.
  104649. */
  104650. needAlphaTesting(): boolean;
  104651. /**
  104652. * Specifies if material alpha testing should be turned on for the mesh
  104653. * @param mesh defines the mesh to check
  104654. */
  104655. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  104656. /**
  104657. * Gets the texture used for the alpha test
  104658. * @returns the texture to use for alpha testing
  104659. */
  104660. getAlphaTestTexture(): Nullable<BaseTexture>;
  104661. /**
  104662. * Marks the material to indicate that it needs to be re-calculated
  104663. */
  104664. markDirty(): void;
  104665. /** @hidden */
  104666. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  104667. /**
  104668. * Binds the material to the mesh
  104669. * @param world defines the world transformation matrix
  104670. * @param mesh defines the mesh to bind the material to
  104671. */
  104672. bind(world: Matrix, mesh?: Mesh): void;
  104673. /**
  104674. * Binds the submesh to the material
  104675. * @param world defines the world transformation matrix
  104676. * @param mesh defines the mesh containing the submesh
  104677. * @param subMesh defines the submesh to bind the material to
  104678. */
  104679. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104680. /**
  104681. * Binds the world matrix to the material
  104682. * @param world defines the world transformation matrix
  104683. */
  104684. bindOnlyWorldMatrix(world: Matrix): void;
  104685. /**
  104686. * Binds the scene's uniform buffer to the effect.
  104687. * @param effect defines the effect to bind to the scene uniform buffer
  104688. * @param sceneUbo defines the uniform buffer storing scene data
  104689. */
  104690. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  104691. /**
  104692. * Binds the view matrix to the effect
  104693. * @param effect defines the effect to bind the view matrix to
  104694. */
  104695. bindView(effect: Effect): void;
  104696. /**
  104697. * Binds the view projection matrix to the effect
  104698. * @param effect defines the effect to bind the view projection matrix to
  104699. */
  104700. bindViewProjection(effect: Effect): void;
  104701. /**
  104702. * Processes to execute after binding the material to a mesh
  104703. * @param mesh defines the rendered mesh
  104704. */
  104705. protected _afterBind(mesh?: Mesh): void;
  104706. /**
  104707. * Unbinds the material from the mesh
  104708. */
  104709. unbind(): void;
  104710. /**
  104711. * Gets the active textures from the material
  104712. * @returns an array of textures
  104713. */
  104714. getActiveTextures(): BaseTexture[];
  104715. /**
  104716. * Specifies if the material uses a texture
  104717. * @param texture defines the texture to check against the material
  104718. * @returns a boolean specifying if the material uses the texture
  104719. */
  104720. hasTexture(texture: BaseTexture): boolean;
  104721. /**
  104722. * Makes a duplicate of the material, and gives it a new name
  104723. * @param name defines the new name for the duplicated material
  104724. * @returns the cloned material
  104725. */
  104726. clone(name: string): Nullable<Material>;
  104727. /**
  104728. * Gets the meshes bound to the material
  104729. * @returns an array of meshes bound to the material
  104730. */
  104731. getBindedMeshes(): AbstractMesh[];
  104732. /**
  104733. * Force shader compilation
  104734. * @param mesh defines the mesh associated with this material
  104735. * @param onCompiled defines a function to execute once the material is compiled
  104736. * @param options defines the options to configure the compilation
  104737. * @param onError defines a function to execute if the material fails compiling
  104738. */
  104739. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  104740. /**
  104741. * Force shader compilation
  104742. * @param mesh defines the mesh that will use this material
  104743. * @param options defines additional options for compiling the shaders
  104744. * @returns a promise that resolves when the compilation completes
  104745. */
  104746. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  104747. private static readonly _AllDirtyCallBack;
  104748. private static readonly _ImageProcessingDirtyCallBack;
  104749. private static readonly _TextureDirtyCallBack;
  104750. private static readonly _FresnelDirtyCallBack;
  104751. private static readonly _MiscDirtyCallBack;
  104752. private static readonly _LightsDirtyCallBack;
  104753. private static readonly _AttributeDirtyCallBack;
  104754. private static _FresnelAndMiscDirtyCallBack;
  104755. private static _TextureAndMiscDirtyCallBack;
  104756. private static readonly _DirtyCallbackArray;
  104757. private static readonly _RunDirtyCallBacks;
  104758. /**
  104759. * Marks a define in the material to indicate that it needs to be re-computed
  104760. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  104761. */
  104762. markAsDirty(flag: number): void;
  104763. /**
  104764. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  104765. * @param func defines a function which checks material defines against the submeshes
  104766. */
  104767. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  104768. /**
  104769. * Indicates that the scene should check if the rendering now needs a prepass
  104770. */
  104771. protected _markScenePrePassDirty(): void;
  104772. /**
  104773. * Indicates that we need to re-calculated for all submeshes
  104774. */
  104775. protected _markAllSubMeshesAsAllDirty(): void;
  104776. /**
  104777. * Indicates that image processing needs to be re-calculated for all submeshes
  104778. */
  104779. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  104780. /**
  104781. * Indicates that textures need to be re-calculated for all submeshes
  104782. */
  104783. protected _markAllSubMeshesAsTexturesDirty(): void;
  104784. /**
  104785. * Indicates that fresnel needs to be re-calculated for all submeshes
  104786. */
  104787. protected _markAllSubMeshesAsFresnelDirty(): void;
  104788. /**
  104789. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  104790. */
  104791. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  104792. /**
  104793. * Indicates that lights need to be re-calculated for all submeshes
  104794. */
  104795. protected _markAllSubMeshesAsLightsDirty(): void;
  104796. /**
  104797. * Indicates that attributes need to be re-calculated for all submeshes
  104798. */
  104799. protected _markAllSubMeshesAsAttributesDirty(): void;
  104800. /**
  104801. * Indicates that misc needs to be re-calculated for all submeshes
  104802. */
  104803. protected _markAllSubMeshesAsMiscDirty(): void;
  104804. /**
  104805. * Indicates that textures and misc need to be re-calculated for all submeshes
  104806. */
  104807. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  104808. /**
  104809. * Sets the required values to the prepass renderer.
  104810. * @param prePassRenderer defines the prepass renderer to setup.
  104811. * @returns true if the pre pass is needed.
  104812. */
  104813. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  104814. /**
  104815. * Disposes the material
  104816. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104817. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104818. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  104819. */
  104820. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  104821. /** @hidden */
  104822. private releaseVertexArrayObject;
  104823. /**
  104824. * Serializes this material
  104825. * @returns the serialized material object
  104826. */
  104827. serialize(): any;
  104828. /**
  104829. * Creates a material from parsed material data
  104830. * @param parsedMaterial defines parsed material data
  104831. * @param scene defines the hosting scene
  104832. * @param rootUrl defines the root URL to use to load textures
  104833. * @returns a new material
  104834. */
  104835. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  104836. }
  104837. }
  104838. declare module BABYLON {
  104839. /**
  104840. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104841. * separate meshes. This can be use to improve performances.
  104842. * @see https://doc.babylonjs.com/how_to/multi_materials
  104843. */
  104844. export class MultiMaterial extends Material {
  104845. private _subMaterials;
  104846. /**
  104847. * Gets or Sets the list of Materials used within the multi material.
  104848. * They need to be ordered according to the submeshes order in the associated mesh
  104849. */
  104850. get subMaterials(): Nullable<Material>[];
  104851. set subMaterials(value: Nullable<Material>[]);
  104852. /**
  104853. * Function used to align with Node.getChildren()
  104854. * @returns the list of Materials used within the multi material
  104855. */
  104856. getChildren(): Nullable<Material>[];
  104857. /**
  104858. * Instantiates a new Multi Material
  104859. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104860. * separate meshes. This can be use to improve performances.
  104861. * @see https://doc.babylonjs.com/how_to/multi_materials
  104862. * @param name Define the name in the scene
  104863. * @param scene Define the scene the material belongs to
  104864. */
  104865. constructor(name: string, scene: Scene);
  104866. private _hookArray;
  104867. /**
  104868. * Get one of the submaterial by its index in the submaterials array
  104869. * @param index The index to look the sub material at
  104870. * @returns The Material if the index has been defined
  104871. */
  104872. getSubMaterial(index: number): Nullable<Material>;
  104873. /**
  104874. * Get the list of active textures for the whole sub materials list.
  104875. * @returns All the textures that will be used during the rendering
  104876. */
  104877. getActiveTextures(): BaseTexture[];
  104878. /**
  104879. * Gets the current class name of the material e.g. "MultiMaterial"
  104880. * Mainly use in serialization.
  104881. * @returns the class name
  104882. */
  104883. getClassName(): string;
  104884. /**
  104885. * Checks if the material is ready to render the requested sub mesh
  104886. * @param mesh Define the mesh the submesh belongs to
  104887. * @param subMesh Define the sub mesh to look readyness for
  104888. * @param useInstances Define whether or not the material is used with instances
  104889. * @returns true if ready, otherwise false
  104890. */
  104891. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104892. /**
  104893. * Clones the current material and its related sub materials
  104894. * @param name Define the name of the newly cloned material
  104895. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  104896. * @returns the cloned material
  104897. */
  104898. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  104899. /**
  104900. * Serializes the materials into a JSON representation.
  104901. * @returns the JSON representation
  104902. */
  104903. serialize(): any;
  104904. /**
  104905. * Dispose the material and release its associated resources
  104906. * @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)
  104907. * @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)
  104908. * @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)
  104909. */
  104910. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  104911. /**
  104912. * Creates a MultiMaterial from parsed MultiMaterial data.
  104913. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  104914. * @param scene defines the hosting scene
  104915. * @returns a new MultiMaterial
  104916. */
  104917. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  104918. }
  104919. }
  104920. declare module BABYLON {
  104921. /**
  104922. * Defines a subdivision inside a mesh
  104923. */
  104924. export class SubMesh implements ICullable {
  104925. /** the material index to use */
  104926. materialIndex: number;
  104927. /** vertex index start */
  104928. verticesStart: number;
  104929. /** vertices count */
  104930. verticesCount: number;
  104931. /** index start */
  104932. indexStart: number;
  104933. /** indices count */
  104934. indexCount: number;
  104935. /** @hidden */
  104936. _materialDefines: Nullable<MaterialDefines>;
  104937. /** @hidden */
  104938. _materialEffect: Nullable<Effect>;
  104939. /** @hidden */
  104940. _effectOverride: Nullable<Effect>;
  104941. /**
  104942. * Gets material defines used by the effect associated to the sub mesh
  104943. */
  104944. get materialDefines(): Nullable<MaterialDefines>;
  104945. /**
  104946. * Sets material defines used by the effect associated to the sub mesh
  104947. */
  104948. set materialDefines(defines: Nullable<MaterialDefines>);
  104949. /**
  104950. * Gets associated effect
  104951. */
  104952. get effect(): Nullable<Effect>;
  104953. /**
  104954. * Sets associated effect (effect used to render this submesh)
  104955. * @param effect defines the effect to associate with
  104956. * @param defines defines the set of defines used to compile this effect
  104957. */
  104958. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  104959. /** @hidden */
  104960. _linesIndexCount: number;
  104961. private _mesh;
  104962. private _renderingMesh;
  104963. private _boundingInfo;
  104964. private _linesIndexBuffer;
  104965. /** @hidden */
  104966. _lastColliderWorldVertices: Nullable<Vector3[]>;
  104967. /** @hidden */
  104968. _trianglePlanes: Plane[];
  104969. /** @hidden */
  104970. _lastColliderTransformMatrix: Nullable<Matrix>;
  104971. /** @hidden */
  104972. _renderId: number;
  104973. /** @hidden */
  104974. _alphaIndex: number;
  104975. /** @hidden */
  104976. _distanceToCamera: number;
  104977. /** @hidden */
  104978. _id: number;
  104979. private _currentMaterial;
  104980. /**
  104981. * Add a new submesh to a mesh
  104982. * @param materialIndex defines the material index to use
  104983. * @param verticesStart defines vertex index start
  104984. * @param verticesCount defines vertices count
  104985. * @param indexStart defines index start
  104986. * @param indexCount defines indices count
  104987. * @param mesh defines the parent mesh
  104988. * @param renderingMesh defines an optional rendering mesh
  104989. * @param createBoundingBox defines if bounding box should be created for this submesh
  104990. * @returns the new submesh
  104991. */
  104992. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  104993. /**
  104994. * Creates a new submesh
  104995. * @param materialIndex defines the material index to use
  104996. * @param verticesStart defines vertex index start
  104997. * @param verticesCount defines vertices count
  104998. * @param indexStart defines index start
  104999. * @param indexCount defines indices count
  105000. * @param mesh defines the parent mesh
  105001. * @param renderingMesh defines an optional rendering mesh
  105002. * @param createBoundingBox defines if bounding box should be created for this submesh
  105003. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  105004. */
  105005. constructor(
  105006. /** the material index to use */
  105007. materialIndex: number,
  105008. /** vertex index start */
  105009. verticesStart: number,
  105010. /** vertices count */
  105011. verticesCount: number,
  105012. /** index start */
  105013. indexStart: number,
  105014. /** indices count */
  105015. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  105016. /**
  105017. * Returns true if this submesh covers the entire parent mesh
  105018. * @ignorenaming
  105019. */
  105020. get IsGlobal(): boolean;
  105021. /**
  105022. * Returns the submesh BoudingInfo object
  105023. * @returns current bounding info (or mesh's one if the submesh is global)
  105024. */
  105025. getBoundingInfo(): BoundingInfo;
  105026. /**
  105027. * Sets the submesh BoundingInfo
  105028. * @param boundingInfo defines the new bounding info to use
  105029. * @returns the SubMesh
  105030. */
  105031. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  105032. /**
  105033. * Returns the mesh of the current submesh
  105034. * @return the parent mesh
  105035. */
  105036. getMesh(): AbstractMesh;
  105037. /**
  105038. * Returns the rendering mesh of the submesh
  105039. * @returns the rendering mesh (could be different from parent mesh)
  105040. */
  105041. getRenderingMesh(): Mesh;
  105042. /**
  105043. * Returns the replacement mesh of the submesh
  105044. * @returns the replacement mesh (could be different from parent mesh)
  105045. */
  105046. getReplacementMesh(): Nullable<AbstractMesh>;
  105047. /**
  105048. * Returns the effective mesh of the submesh
  105049. * @returns the effective mesh (could be different from parent mesh)
  105050. */
  105051. getEffectiveMesh(): AbstractMesh;
  105052. /**
  105053. * Returns the submesh material
  105054. * @returns null or the current material
  105055. */
  105056. getMaterial(): Nullable<Material>;
  105057. private _IsMultiMaterial;
  105058. /**
  105059. * Sets a new updated BoundingInfo object to the submesh
  105060. * @param data defines an optional position array to use to determine the bounding info
  105061. * @returns the SubMesh
  105062. */
  105063. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  105064. /** @hidden */
  105065. _checkCollision(collider: Collider): boolean;
  105066. /**
  105067. * Updates the submesh BoundingInfo
  105068. * @param world defines the world matrix to use to update the bounding info
  105069. * @returns the submesh
  105070. */
  105071. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  105072. /**
  105073. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  105074. * @param frustumPlanes defines the frustum planes
  105075. * @returns true if the submesh is intersecting with the frustum
  105076. */
  105077. isInFrustum(frustumPlanes: Plane[]): boolean;
  105078. /**
  105079. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  105080. * @param frustumPlanes defines the frustum planes
  105081. * @returns true if the submesh is inside the frustum
  105082. */
  105083. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  105084. /**
  105085. * Renders the submesh
  105086. * @param enableAlphaMode defines if alpha needs to be used
  105087. * @returns the submesh
  105088. */
  105089. render(enableAlphaMode: boolean): SubMesh;
  105090. /**
  105091. * @hidden
  105092. */
  105093. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  105094. /**
  105095. * Checks if the submesh intersects with a ray
  105096. * @param ray defines the ray to test
  105097. * @returns true is the passed ray intersects the submesh bounding box
  105098. */
  105099. canIntersects(ray: Ray): boolean;
  105100. /**
  105101. * Intersects current submesh with a ray
  105102. * @param ray defines the ray to test
  105103. * @param positions defines mesh's positions array
  105104. * @param indices defines mesh's indices array
  105105. * @param fastCheck defines if the first intersection will be used (and not the closest)
  105106. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  105107. * @returns intersection info or null if no intersection
  105108. */
  105109. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  105110. /** @hidden */
  105111. private _intersectLines;
  105112. /** @hidden */
  105113. private _intersectUnIndexedLines;
  105114. /** @hidden */
  105115. private _intersectTriangles;
  105116. /** @hidden */
  105117. private _intersectUnIndexedTriangles;
  105118. /** @hidden */
  105119. _rebuild(): void;
  105120. /**
  105121. * Creates a new submesh from the passed mesh
  105122. * @param newMesh defines the new hosting mesh
  105123. * @param newRenderingMesh defines an optional rendering mesh
  105124. * @returns the new submesh
  105125. */
  105126. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  105127. /**
  105128. * Release associated resources
  105129. */
  105130. dispose(): void;
  105131. /**
  105132. * Gets the class name
  105133. * @returns the string "SubMesh".
  105134. */
  105135. getClassName(): string;
  105136. /**
  105137. * Creates a new submesh from indices data
  105138. * @param materialIndex the index of the main mesh material
  105139. * @param startIndex the index where to start the copy in the mesh indices array
  105140. * @param indexCount the number of indices to copy then from the startIndex
  105141. * @param mesh the main mesh to create the submesh from
  105142. * @param renderingMesh the optional rendering mesh
  105143. * @returns a new submesh
  105144. */
  105145. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  105146. }
  105147. }
  105148. declare module BABYLON {
  105149. /**
  105150. * Class used to represent data loading progression
  105151. */
  105152. export class SceneLoaderFlags {
  105153. private static _ForceFullSceneLoadingForIncremental;
  105154. private static _ShowLoadingScreen;
  105155. private static _CleanBoneMatrixWeights;
  105156. private static _loggingLevel;
  105157. /**
  105158. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105159. */
  105160. static get ForceFullSceneLoadingForIncremental(): boolean;
  105161. static set ForceFullSceneLoadingForIncremental(value: boolean);
  105162. /**
  105163. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105164. */
  105165. static get ShowLoadingScreen(): boolean;
  105166. static set ShowLoadingScreen(value: boolean);
  105167. /**
  105168. * Defines the current logging level (while loading the scene)
  105169. * @ignorenaming
  105170. */
  105171. static get loggingLevel(): number;
  105172. static set loggingLevel(value: number);
  105173. /**
  105174. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105175. */
  105176. static get CleanBoneMatrixWeights(): boolean;
  105177. static set CleanBoneMatrixWeights(value: boolean);
  105178. }
  105179. }
  105180. declare module BABYLON {
  105181. /**
  105182. * Class used to store geometry data (vertex buffers + index buffer)
  105183. */
  105184. export class Geometry implements IGetSetVerticesData {
  105185. /**
  105186. * Gets or sets the ID of the geometry
  105187. */
  105188. id: string;
  105189. /**
  105190. * Gets or sets the unique ID of the geometry
  105191. */
  105192. uniqueId: number;
  105193. /**
  105194. * Gets the delay loading state of the geometry (none by default which means not delayed)
  105195. */
  105196. delayLoadState: number;
  105197. /**
  105198. * Gets the file containing the data to load when running in delay load state
  105199. */
  105200. delayLoadingFile: Nullable<string>;
  105201. /**
  105202. * Callback called when the geometry is updated
  105203. */
  105204. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  105205. private _scene;
  105206. private _engine;
  105207. private _meshes;
  105208. private _totalVertices;
  105209. /** @hidden */
  105210. _indices: IndicesArray;
  105211. /** @hidden */
  105212. _vertexBuffers: {
  105213. [key: string]: VertexBuffer;
  105214. };
  105215. private _isDisposed;
  105216. private _extend;
  105217. private _boundingBias;
  105218. /** @hidden */
  105219. _delayInfo: Array<string>;
  105220. private _indexBuffer;
  105221. private _indexBufferIsUpdatable;
  105222. /** @hidden */
  105223. _boundingInfo: Nullable<BoundingInfo>;
  105224. /** @hidden */
  105225. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  105226. /** @hidden */
  105227. _softwareSkinningFrameId: number;
  105228. private _vertexArrayObjects;
  105229. private _updatable;
  105230. /** @hidden */
  105231. _positions: Nullable<Vector3[]>;
  105232. /**
  105233. * 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
  105234. */
  105235. get boundingBias(): Vector2;
  105236. /**
  105237. * 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
  105238. */
  105239. set boundingBias(value: Vector2);
  105240. /**
  105241. * Static function used to attach a new empty geometry to a mesh
  105242. * @param mesh defines the mesh to attach the geometry to
  105243. * @returns the new Geometry
  105244. */
  105245. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  105246. /** Get the list of meshes using this geometry */
  105247. get meshes(): Mesh[];
  105248. /**
  105249. * 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
  105250. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  105251. */
  105252. useBoundingInfoFromGeometry: boolean;
  105253. /**
  105254. * Creates a new geometry
  105255. * @param id defines the unique ID
  105256. * @param scene defines the hosting scene
  105257. * @param vertexData defines the VertexData used to get geometry data
  105258. * @param updatable defines if geometry must be updatable (false by default)
  105259. * @param mesh defines the mesh that will be associated with the geometry
  105260. */
  105261. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105262. /**
  105263. * Gets the current extend of the geometry
  105264. */
  105265. get extend(): {
  105266. minimum: Vector3;
  105267. maximum: Vector3;
  105268. };
  105269. /**
  105270. * Gets the hosting scene
  105271. * @returns the hosting Scene
  105272. */
  105273. getScene(): Scene;
  105274. /**
  105275. * Gets the hosting engine
  105276. * @returns the hosting Engine
  105277. */
  105278. getEngine(): Engine;
  105279. /**
  105280. * Defines if the geometry is ready to use
  105281. * @returns true if the geometry is ready to be used
  105282. */
  105283. isReady(): boolean;
  105284. /**
  105285. * Gets a value indicating that the geometry should not be serialized
  105286. */
  105287. get doNotSerialize(): boolean;
  105288. /** @hidden */
  105289. _rebuild(): void;
  105290. /**
  105291. * Affects all geometry data in one call
  105292. * @param vertexData defines the geometry data
  105293. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  105294. */
  105295. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  105296. /**
  105297. * Set specific vertex data
  105298. * @param kind defines the data kind (Position, normal, etc...)
  105299. * @param data defines the vertex data to use
  105300. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105301. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105302. */
  105303. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  105304. /**
  105305. * Removes a specific vertex data
  105306. * @param kind defines the data kind (Position, normal, etc...)
  105307. */
  105308. removeVerticesData(kind: string): void;
  105309. /**
  105310. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  105311. * @param buffer defines the vertex buffer to use
  105312. * @param totalVertices defines the total number of vertices for position kind (could be null)
  105313. */
  105314. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  105315. /**
  105316. * Update a specific vertex buffer
  105317. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  105318. * It will do nothing if the buffer is not updatable
  105319. * @param kind defines the data kind (Position, normal, etc...)
  105320. * @param data defines the data to use
  105321. * @param offset defines the offset in the target buffer where to store the data
  105322. * @param useBytes set to true if the offset is in bytes
  105323. */
  105324. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  105325. /**
  105326. * Update a specific vertex buffer
  105327. * This function will create a new buffer if the current one is not updatable
  105328. * @param kind defines the data kind (Position, normal, etc...)
  105329. * @param data defines the data to use
  105330. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  105331. */
  105332. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  105333. private _updateBoundingInfo;
  105334. /** @hidden */
  105335. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  105336. /**
  105337. * Gets total number of vertices
  105338. * @returns the total number of vertices
  105339. */
  105340. getTotalVertices(): number;
  105341. /**
  105342. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105343. * @param kind defines the data kind (Position, normal, etc...)
  105344. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105345. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105346. * @returns a float array containing vertex data
  105347. */
  105348. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105349. /**
  105350. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  105351. * @param kind defines the data kind (Position, normal, etc...)
  105352. * @returns true if the vertex buffer with the specified kind is updatable
  105353. */
  105354. isVertexBufferUpdatable(kind: string): boolean;
  105355. /**
  105356. * Gets a specific vertex buffer
  105357. * @param kind defines the data kind (Position, normal, etc...)
  105358. * @returns a VertexBuffer
  105359. */
  105360. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105361. /**
  105362. * Returns all vertex buffers
  105363. * @return an object holding all vertex buffers indexed by kind
  105364. */
  105365. getVertexBuffers(): Nullable<{
  105366. [key: string]: VertexBuffer;
  105367. }>;
  105368. /**
  105369. * Gets a boolean indicating if specific vertex buffer is present
  105370. * @param kind defines the data kind (Position, normal, etc...)
  105371. * @returns true if data is present
  105372. */
  105373. isVerticesDataPresent(kind: string): boolean;
  105374. /**
  105375. * Gets a list of all attached data kinds (Position, normal, etc...)
  105376. * @returns a list of string containing all kinds
  105377. */
  105378. getVerticesDataKinds(): string[];
  105379. /**
  105380. * Update index buffer
  105381. * @param indices defines the indices to store in the index buffer
  105382. * @param offset defines the offset in the target buffer where to store the data
  105383. * @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)
  105384. */
  105385. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  105386. /**
  105387. * Creates a new index buffer
  105388. * @param indices defines the indices to store in the index buffer
  105389. * @param totalVertices defines the total number of vertices (could be null)
  105390. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105391. */
  105392. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  105393. /**
  105394. * Return the total number of indices
  105395. * @returns the total number of indices
  105396. */
  105397. getTotalIndices(): number;
  105398. /**
  105399. * Gets the index buffer array
  105400. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105401. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105402. * @returns the index buffer array
  105403. */
  105404. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105405. /**
  105406. * Gets the index buffer
  105407. * @return the index buffer
  105408. */
  105409. getIndexBuffer(): Nullable<DataBuffer>;
  105410. /** @hidden */
  105411. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  105412. /**
  105413. * Release the associated resources for a specific mesh
  105414. * @param mesh defines the source mesh
  105415. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  105416. */
  105417. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  105418. /**
  105419. * Apply current geometry to a given mesh
  105420. * @param mesh defines the mesh to apply geometry to
  105421. */
  105422. applyToMesh(mesh: Mesh): void;
  105423. private _updateExtend;
  105424. private _applyToMesh;
  105425. private notifyUpdate;
  105426. /**
  105427. * Load the geometry if it was flagged as delay loaded
  105428. * @param scene defines the hosting scene
  105429. * @param onLoaded defines a callback called when the geometry is loaded
  105430. */
  105431. load(scene: Scene, onLoaded?: () => void): void;
  105432. private _queueLoad;
  105433. /**
  105434. * Invert the geometry to move from a right handed system to a left handed one.
  105435. */
  105436. toLeftHanded(): void;
  105437. /** @hidden */
  105438. _resetPointsArrayCache(): void;
  105439. /** @hidden */
  105440. _generatePointsArray(): boolean;
  105441. /**
  105442. * Gets a value indicating if the geometry is disposed
  105443. * @returns true if the geometry was disposed
  105444. */
  105445. isDisposed(): boolean;
  105446. private _disposeVertexArrayObjects;
  105447. /**
  105448. * Free all associated resources
  105449. */
  105450. dispose(): void;
  105451. /**
  105452. * Clone the current geometry into a new geometry
  105453. * @param id defines the unique ID of the new geometry
  105454. * @returns a new geometry object
  105455. */
  105456. copy(id: string): Geometry;
  105457. /**
  105458. * Serialize the current geometry info (and not the vertices data) into a JSON object
  105459. * @return a JSON representation of the current geometry data (without the vertices data)
  105460. */
  105461. serialize(): any;
  105462. private toNumberArray;
  105463. /**
  105464. * Serialize all vertices data into a JSON oject
  105465. * @returns a JSON representation of the current geometry data
  105466. */
  105467. serializeVerticeData(): any;
  105468. /**
  105469. * Extracts a clone of a mesh geometry
  105470. * @param mesh defines the source mesh
  105471. * @param id defines the unique ID of the new geometry object
  105472. * @returns the new geometry object
  105473. */
  105474. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  105475. /**
  105476. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  105477. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  105478. * Be aware Math.random() could cause collisions, but:
  105479. * "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"
  105480. * @returns a string containing a new GUID
  105481. */
  105482. static RandomId(): string;
  105483. /** @hidden */
  105484. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  105485. private static _CleanMatricesWeights;
  105486. /**
  105487. * Create a new geometry from persisted data (Using .babylon file format)
  105488. * @param parsedVertexData defines the persisted data
  105489. * @param scene defines the hosting scene
  105490. * @param rootUrl defines the root url to use to load assets (like delayed data)
  105491. * @returns the new geometry object
  105492. */
  105493. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  105494. }
  105495. }
  105496. declare module BABYLON {
  105497. /**
  105498. * Define an interface for all classes that will get and set the data on vertices
  105499. */
  105500. export interface IGetSetVerticesData {
  105501. /**
  105502. * Gets a boolean indicating if specific vertex data is present
  105503. * @param kind defines the vertex data kind to use
  105504. * @returns true is data kind is present
  105505. */
  105506. isVerticesDataPresent(kind: string): boolean;
  105507. /**
  105508. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105509. * @param kind defines the data kind (Position, normal, etc...)
  105510. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105511. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105512. * @returns a float array containing vertex data
  105513. */
  105514. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105515. /**
  105516. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105517. * @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.
  105518. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105519. * @returns the indices array or an empty array if the mesh has no geometry
  105520. */
  105521. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105522. /**
  105523. * Set specific vertex data
  105524. * @param kind defines the data kind (Position, normal, etc...)
  105525. * @param data defines the vertex data to use
  105526. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105527. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105528. */
  105529. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  105530. /**
  105531. * Update a specific associated vertex buffer
  105532. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105533. * - VertexBuffer.PositionKind
  105534. * - VertexBuffer.UVKind
  105535. * - VertexBuffer.UV2Kind
  105536. * - VertexBuffer.UV3Kind
  105537. * - VertexBuffer.UV4Kind
  105538. * - VertexBuffer.UV5Kind
  105539. * - VertexBuffer.UV6Kind
  105540. * - VertexBuffer.ColorKind
  105541. * - VertexBuffer.MatricesIndicesKind
  105542. * - VertexBuffer.MatricesIndicesExtraKind
  105543. * - VertexBuffer.MatricesWeightsKind
  105544. * - VertexBuffer.MatricesWeightsExtraKind
  105545. * @param data defines the data source
  105546. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105547. * @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)
  105548. */
  105549. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  105550. /**
  105551. * Creates a new index buffer
  105552. * @param indices defines the indices to store in the index buffer
  105553. * @param totalVertices defines the total number of vertices (could be null)
  105554. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105555. */
  105556. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  105557. }
  105558. /**
  105559. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  105560. */
  105561. export class VertexData {
  105562. /**
  105563. * Mesh side orientation : usually the external or front surface
  105564. */
  105565. static readonly FRONTSIDE: number;
  105566. /**
  105567. * Mesh side orientation : usually the internal or back surface
  105568. */
  105569. static readonly BACKSIDE: number;
  105570. /**
  105571. * Mesh side orientation : both internal and external or front and back surfaces
  105572. */
  105573. static readonly DOUBLESIDE: number;
  105574. /**
  105575. * Mesh side orientation : by default, `FRONTSIDE`
  105576. */
  105577. static readonly DEFAULTSIDE: number;
  105578. /**
  105579. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  105580. */
  105581. positions: Nullable<FloatArray>;
  105582. /**
  105583. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  105584. */
  105585. normals: Nullable<FloatArray>;
  105586. /**
  105587. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  105588. */
  105589. tangents: Nullable<FloatArray>;
  105590. /**
  105591. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105592. */
  105593. uvs: Nullable<FloatArray>;
  105594. /**
  105595. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105596. */
  105597. uvs2: Nullable<FloatArray>;
  105598. /**
  105599. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105600. */
  105601. uvs3: Nullable<FloatArray>;
  105602. /**
  105603. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105604. */
  105605. uvs4: Nullable<FloatArray>;
  105606. /**
  105607. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105608. */
  105609. uvs5: Nullable<FloatArray>;
  105610. /**
  105611. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105612. */
  105613. uvs6: Nullable<FloatArray>;
  105614. /**
  105615. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  105616. */
  105617. colors: Nullable<FloatArray>;
  105618. /**
  105619. * 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).
  105620. */
  105621. matricesIndices: Nullable<FloatArray>;
  105622. /**
  105623. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  105624. */
  105625. matricesWeights: Nullable<FloatArray>;
  105626. /**
  105627. * An array extending the number of possible indices
  105628. */
  105629. matricesIndicesExtra: Nullable<FloatArray>;
  105630. /**
  105631. * An array extending the number of possible weights when the number of indices is extended
  105632. */
  105633. matricesWeightsExtra: Nullable<FloatArray>;
  105634. /**
  105635. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  105636. */
  105637. indices: Nullable<IndicesArray>;
  105638. /**
  105639. * Uses the passed data array to set the set the values for the specified kind of data
  105640. * @param data a linear array of floating numbers
  105641. * @param kind the type of data that is being set, eg positions, colors etc
  105642. */
  105643. set(data: FloatArray, kind: string): void;
  105644. /**
  105645. * Associates the vertexData to the passed Mesh.
  105646. * Sets it as updatable or not (default `false`)
  105647. * @param mesh the mesh the vertexData is applied to
  105648. * @param updatable when used and having the value true allows new data to update the vertexData
  105649. * @returns the VertexData
  105650. */
  105651. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  105652. /**
  105653. * Associates the vertexData to the passed Geometry.
  105654. * Sets it as updatable or not (default `false`)
  105655. * @param geometry the geometry the vertexData is applied to
  105656. * @param updatable when used and having the value true allows new data to update the vertexData
  105657. * @returns VertexData
  105658. */
  105659. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  105660. /**
  105661. * Updates the associated mesh
  105662. * @param mesh the mesh to be updated
  105663. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105664. * @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
  105665. * @returns VertexData
  105666. */
  105667. updateMesh(mesh: Mesh): VertexData;
  105668. /**
  105669. * Updates the associated geometry
  105670. * @param geometry the geometry to be updated
  105671. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105672. * @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
  105673. * @returns VertexData.
  105674. */
  105675. updateGeometry(geometry: Geometry): VertexData;
  105676. private _applyTo;
  105677. private _update;
  105678. /**
  105679. * Transforms each position and each normal of the vertexData according to the passed Matrix
  105680. * @param matrix the transforming matrix
  105681. * @returns the VertexData
  105682. */
  105683. transform(matrix: Matrix): VertexData;
  105684. /**
  105685. * Merges the passed VertexData into the current one
  105686. * @param other the VertexData to be merged into the current one
  105687. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  105688. * @returns the modified VertexData
  105689. */
  105690. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  105691. private _mergeElement;
  105692. private _validate;
  105693. /**
  105694. * Serializes the VertexData
  105695. * @returns a serialized object
  105696. */
  105697. serialize(): any;
  105698. /**
  105699. * Extracts the vertexData from a mesh
  105700. * @param mesh the mesh from which to extract the VertexData
  105701. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  105702. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105703. * @returns the object VertexData associated to the passed mesh
  105704. */
  105705. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105706. /**
  105707. * Extracts the vertexData from the geometry
  105708. * @param geometry the geometry from which to extract the VertexData
  105709. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  105710. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105711. * @returns the object VertexData associated to the passed mesh
  105712. */
  105713. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105714. private static _ExtractFrom;
  105715. /**
  105716. * Creates the VertexData for a Ribbon
  105717. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  105718. * * pathArray array of paths, each of which an array of successive Vector3
  105719. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  105720. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  105721. * * 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
  105722. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105723. * * 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)
  105724. * * 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)
  105725. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  105726. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  105727. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  105728. * @returns the VertexData of the ribbon
  105729. */
  105730. static CreateRibbon(options: {
  105731. pathArray: Vector3[][];
  105732. closeArray?: boolean;
  105733. closePath?: boolean;
  105734. offset?: number;
  105735. sideOrientation?: number;
  105736. frontUVs?: Vector4;
  105737. backUVs?: Vector4;
  105738. invertUV?: boolean;
  105739. uvs?: Vector2[];
  105740. colors?: Color4[];
  105741. }): VertexData;
  105742. /**
  105743. * Creates the VertexData for a box
  105744. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105745. * * size sets the width, height and depth of the box to the value of size, optional default 1
  105746. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  105747. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  105748. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  105749. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105750. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105751. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105752. * * 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)
  105753. * * 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)
  105754. * @returns the VertexData of the box
  105755. */
  105756. static CreateBox(options: {
  105757. size?: number;
  105758. width?: number;
  105759. height?: number;
  105760. depth?: number;
  105761. faceUV?: Vector4[];
  105762. faceColors?: Color4[];
  105763. sideOrientation?: number;
  105764. frontUVs?: Vector4;
  105765. backUVs?: Vector4;
  105766. }): VertexData;
  105767. /**
  105768. * Creates the VertexData for a tiled box
  105769. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105770. * * faceTiles sets the pattern, tile size and number of tiles for a face
  105771. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105772. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105773. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105774. * @returns the VertexData of the box
  105775. */
  105776. static CreateTiledBox(options: {
  105777. pattern?: number;
  105778. width?: number;
  105779. height?: number;
  105780. depth?: number;
  105781. tileSize?: number;
  105782. tileWidth?: number;
  105783. tileHeight?: number;
  105784. alignHorizontal?: number;
  105785. alignVertical?: number;
  105786. faceUV?: Vector4[];
  105787. faceColors?: Color4[];
  105788. sideOrientation?: number;
  105789. }): VertexData;
  105790. /**
  105791. * Creates the VertexData for a tiled plane
  105792. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105793. * * pattern a limited pattern arrangement depending on the number
  105794. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  105795. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  105796. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  105797. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105798. * * 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)
  105799. * * 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)
  105800. * @returns the VertexData of the tiled plane
  105801. */
  105802. static CreateTiledPlane(options: {
  105803. pattern?: number;
  105804. tileSize?: number;
  105805. tileWidth?: number;
  105806. tileHeight?: number;
  105807. size?: number;
  105808. width?: number;
  105809. height?: number;
  105810. alignHorizontal?: number;
  105811. alignVertical?: number;
  105812. sideOrientation?: number;
  105813. frontUVs?: Vector4;
  105814. backUVs?: Vector4;
  105815. }): VertexData;
  105816. /**
  105817. * Creates the VertexData for an ellipsoid, defaults to a sphere
  105818. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105819. * * segments sets the number of horizontal strips optional, default 32
  105820. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  105821. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  105822. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  105823. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  105824. * * 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
  105825. * * 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
  105826. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105827. * * 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)
  105828. * * 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)
  105829. * @returns the VertexData of the ellipsoid
  105830. */
  105831. static CreateSphere(options: {
  105832. segments?: number;
  105833. diameter?: number;
  105834. diameterX?: number;
  105835. diameterY?: number;
  105836. diameterZ?: number;
  105837. arc?: number;
  105838. slice?: number;
  105839. sideOrientation?: number;
  105840. frontUVs?: Vector4;
  105841. backUVs?: Vector4;
  105842. }): VertexData;
  105843. /**
  105844. * Creates the VertexData for a cylinder, cone or prism
  105845. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105846. * * height sets the height (y direction) of the cylinder, optional, default 2
  105847. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  105848. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  105849. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  105850. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105851. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  105852. * * 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
  105853. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105854. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105855. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  105856. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  105857. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105858. * * 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)
  105859. * * 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)
  105860. * @returns the VertexData of the cylinder, cone or prism
  105861. */
  105862. static CreateCylinder(options: {
  105863. height?: number;
  105864. diameterTop?: number;
  105865. diameterBottom?: number;
  105866. diameter?: number;
  105867. tessellation?: number;
  105868. subdivisions?: number;
  105869. arc?: number;
  105870. faceColors?: Color4[];
  105871. faceUV?: Vector4[];
  105872. hasRings?: boolean;
  105873. enclose?: boolean;
  105874. sideOrientation?: number;
  105875. frontUVs?: Vector4;
  105876. backUVs?: Vector4;
  105877. }): VertexData;
  105878. /**
  105879. * Creates the VertexData for a torus
  105880. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105881. * * diameter the diameter of the torus, optional default 1
  105882. * * thickness the diameter of the tube forming the torus, optional default 0.5
  105883. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105884. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105885. * * 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)
  105886. * * 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)
  105887. * @returns the VertexData of the torus
  105888. */
  105889. static CreateTorus(options: {
  105890. diameter?: number;
  105891. thickness?: number;
  105892. tessellation?: number;
  105893. sideOrientation?: number;
  105894. frontUVs?: Vector4;
  105895. backUVs?: Vector4;
  105896. }): VertexData;
  105897. /**
  105898. * Creates the VertexData of the LineSystem
  105899. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  105900. * - lines an array of lines, each line being an array of successive Vector3
  105901. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  105902. * @returns the VertexData of the LineSystem
  105903. */
  105904. static CreateLineSystem(options: {
  105905. lines: Vector3[][];
  105906. colors?: Nullable<Color4[][]>;
  105907. }): VertexData;
  105908. /**
  105909. * Create the VertexData for a DashedLines
  105910. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  105911. * - points an array successive Vector3
  105912. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  105913. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  105914. * - dashNb the intended total number of dashes, optional, default 200
  105915. * @returns the VertexData for the DashedLines
  105916. */
  105917. static CreateDashedLines(options: {
  105918. points: Vector3[];
  105919. dashSize?: number;
  105920. gapSize?: number;
  105921. dashNb?: number;
  105922. }): VertexData;
  105923. /**
  105924. * Creates the VertexData for a Ground
  105925. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105926. * - width the width (x direction) of the ground, optional, default 1
  105927. * - height the height (z direction) of the ground, optional, default 1
  105928. * - subdivisions the number of subdivisions per side, optional, default 1
  105929. * @returns the VertexData of the Ground
  105930. */
  105931. static CreateGround(options: {
  105932. width?: number;
  105933. height?: number;
  105934. subdivisions?: number;
  105935. subdivisionsX?: number;
  105936. subdivisionsY?: number;
  105937. }): VertexData;
  105938. /**
  105939. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  105940. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105941. * * xmin the ground minimum X coordinate, optional, default -1
  105942. * * zmin the ground minimum Z coordinate, optional, default -1
  105943. * * xmax the ground maximum X coordinate, optional, default 1
  105944. * * zmax the ground maximum Z coordinate, optional, default 1
  105945. * * 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}
  105946. * * 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}
  105947. * @returns the VertexData of the TiledGround
  105948. */
  105949. static CreateTiledGround(options: {
  105950. xmin: number;
  105951. zmin: number;
  105952. xmax: number;
  105953. zmax: number;
  105954. subdivisions?: {
  105955. w: number;
  105956. h: number;
  105957. };
  105958. precision?: {
  105959. w: number;
  105960. h: number;
  105961. };
  105962. }): VertexData;
  105963. /**
  105964. * Creates the VertexData of the Ground designed from a heightmap
  105965. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  105966. * * width the width (x direction) of the ground
  105967. * * height the height (z direction) of the ground
  105968. * * subdivisions the number of subdivisions per side
  105969. * * minHeight the minimum altitude on the ground, optional, default 0
  105970. * * maxHeight the maximum altitude on the ground, optional default 1
  105971. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  105972. * * buffer the array holding the image color data
  105973. * * bufferWidth the width of image
  105974. * * bufferHeight the height of image
  105975. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  105976. * @returns the VertexData of the Ground designed from a heightmap
  105977. */
  105978. static CreateGroundFromHeightMap(options: {
  105979. width: number;
  105980. height: number;
  105981. subdivisions: number;
  105982. minHeight: number;
  105983. maxHeight: number;
  105984. colorFilter: Color3;
  105985. buffer: Uint8Array;
  105986. bufferWidth: number;
  105987. bufferHeight: number;
  105988. alphaFilter: number;
  105989. }): VertexData;
  105990. /**
  105991. * Creates the VertexData for a Plane
  105992. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  105993. * * size sets the width and height of the plane to the value of size, optional default 1
  105994. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  105995. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  105996. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105997. * * 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)
  105998. * * 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)
  105999. * @returns the VertexData of the box
  106000. */
  106001. static CreatePlane(options: {
  106002. size?: number;
  106003. width?: number;
  106004. height?: number;
  106005. sideOrientation?: number;
  106006. frontUVs?: Vector4;
  106007. backUVs?: Vector4;
  106008. }): VertexData;
  106009. /**
  106010. * Creates the VertexData of the Disc or regular Polygon
  106011. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  106012. * * radius the radius of the disc, optional default 0.5
  106013. * * tessellation the number of polygon sides, optional, default 64
  106014. * * 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
  106015. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106016. * * 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)
  106017. * * 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)
  106018. * @returns the VertexData of the box
  106019. */
  106020. static CreateDisc(options: {
  106021. radius?: number;
  106022. tessellation?: number;
  106023. arc?: number;
  106024. sideOrientation?: number;
  106025. frontUVs?: Vector4;
  106026. backUVs?: Vector4;
  106027. }): VertexData;
  106028. /**
  106029. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  106030. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  106031. * @param polygon a mesh built from polygonTriangulation.build()
  106032. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106033. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106034. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106035. * @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)
  106036. * @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)
  106037. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  106038. * @returns the VertexData of the Polygon
  106039. */
  106040. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  106041. /**
  106042. * Creates the VertexData of the IcoSphere
  106043. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  106044. * * radius the radius of the IcoSphere, optional default 1
  106045. * * radiusX allows stretching in the x direction, optional, default radius
  106046. * * radiusY allows stretching in the y direction, optional, default radius
  106047. * * radiusZ allows stretching in the z direction, optional, default radius
  106048. * * flat when true creates a flat shaded mesh, optional, default true
  106049. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106050. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106051. * * 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)
  106052. * * 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)
  106053. * @returns the VertexData of the IcoSphere
  106054. */
  106055. static CreateIcoSphere(options: {
  106056. radius?: number;
  106057. radiusX?: number;
  106058. radiusY?: number;
  106059. radiusZ?: number;
  106060. flat?: boolean;
  106061. subdivisions?: number;
  106062. sideOrientation?: number;
  106063. frontUVs?: Vector4;
  106064. backUVs?: Vector4;
  106065. }): VertexData;
  106066. /**
  106067. * Creates the VertexData for a Polyhedron
  106068. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  106069. * * type provided types are:
  106070. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  106071. * * 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)
  106072. * * size the size of the IcoSphere, optional default 1
  106073. * * sizeX allows stretching in the x direction, optional, default size
  106074. * * sizeY allows stretching in the y direction, optional, default size
  106075. * * sizeZ allows stretching in the z direction, optional, default size
  106076. * * 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
  106077. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106078. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106079. * * flat when true creates a flat shaded mesh, optional, default true
  106080. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106081. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106082. * * 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)
  106083. * * 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)
  106084. * @returns the VertexData of the Polyhedron
  106085. */
  106086. static CreatePolyhedron(options: {
  106087. type?: number;
  106088. size?: number;
  106089. sizeX?: number;
  106090. sizeY?: number;
  106091. sizeZ?: number;
  106092. custom?: any;
  106093. faceUV?: Vector4[];
  106094. faceColors?: Color4[];
  106095. flat?: boolean;
  106096. sideOrientation?: number;
  106097. frontUVs?: Vector4;
  106098. backUVs?: Vector4;
  106099. }): VertexData;
  106100. /**
  106101. * Creates the VertexData for a TorusKnot
  106102. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  106103. * * radius the radius of the torus knot, optional, default 2
  106104. * * tube the thickness of the tube, optional, default 0.5
  106105. * * radialSegments the number of sides on each tube segments, optional, default 32
  106106. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  106107. * * p the number of windings around the z axis, optional, default 2
  106108. * * q the number of windings around the x axis, optional, default 3
  106109. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106110. * * 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)
  106111. * * 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)
  106112. * @returns the VertexData of the Torus Knot
  106113. */
  106114. static CreateTorusKnot(options: {
  106115. radius?: number;
  106116. tube?: number;
  106117. radialSegments?: number;
  106118. tubularSegments?: number;
  106119. p?: number;
  106120. q?: number;
  106121. sideOrientation?: number;
  106122. frontUVs?: Vector4;
  106123. backUVs?: Vector4;
  106124. }): VertexData;
  106125. /**
  106126. * Compute normals for given positions and indices
  106127. * @param positions an array of vertex positions, [...., x, y, z, ......]
  106128. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  106129. * @param normals an array of vertex normals, [...., x, y, z, ......]
  106130. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  106131. * * facetNormals : optional array of facet normals (vector3)
  106132. * * facetPositions : optional array of facet positions (vector3)
  106133. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  106134. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  106135. * * bInfo : optional bounding info, required for facetPartitioning computation
  106136. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  106137. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  106138. * * useRightHandedSystem: optional boolean to for right handed system computation
  106139. * * depthSort : optional boolean to enable the facet depth sort computation
  106140. * * distanceTo : optional Vector3 to compute the facet depth from this location
  106141. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  106142. */
  106143. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  106144. facetNormals?: any;
  106145. facetPositions?: any;
  106146. facetPartitioning?: any;
  106147. ratio?: number;
  106148. bInfo?: any;
  106149. bbSize?: Vector3;
  106150. subDiv?: any;
  106151. useRightHandedSystem?: boolean;
  106152. depthSort?: boolean;
  106153. distanceTo?: Vector3;
  106154. depthSortedFacets?: any;
  106155. }): void;
  106156. /** @hidden */
  106157. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  106158. /**
  106159. * Applies VertexData created from the imported parameters to the geometry
  106160. * @param parsedVertexData the parsed data from an imported file
  106161. * @param geometry the geometry to apply the VertexData to
  106162. */
  106163. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  106164. }
  106165. }
  106166. declare module BABYLON {
  106167. /**
  106168. * Defines a target to use with MorphTargetManager
  106169. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106170. */
  106171. export class MorphTarget implements IAnimatable {
  106172. /** defines the name of the target */
  106173. name: string;
  106174. /**
  106175. * Gets or sets the list of animations
  106176. */
  106177. animations: Animation[];
  106178. private _scene;
  106179. private _positions;
  106180. private _normals;
  106181. private _tangents;
  106182. private _uvs;
  106183. private _influence;
  106184. private _uniqueId;
  106185. /**
  106186. * Observable raised when the influence changes
  106187. */
  106188. onInfluenceChanged: Observable<boolean>;
  106189. /** @hidden */
  106190. _onDataLayoutChanged: Observable<void>;
  106191. /**
  106192. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  106193. */
  106194. get influence(): number;
  106195. set influence(influence: number);
  106196. /**
  106197. * Gets or sets the id of the morph Target
  106198. */
  106199. id: string;
  106200. private _animationPropertiesOverride;
  106201. /**
  106202. * Gets or sets the animation properties override
  106203. */
  106204. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  106205. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  106206. /**
  106207. * Creates a new MorphTarget
  106208. * @param name defines the name of the target
  106209. * @param influence defines the influence to use
  106210. * @param scene defines the scene the morphtarget belongs to
  106211. */
  106212. constructor(
  106213. /** defines the name of the target */
  106214. name: string, influence?: number, scene?: Nullable<Scene>);
  106215. /**
  106216. * Gets the unique ID of this manager
  106217. */
  106218. get uniqueId(): number;
  106219. /**
  106220. * Gets a boolean defining if the target contains position data
  106221. */
  106222. get hasPositions(): boolean;
  106223. /**
  106224. * Gets a boolean defining if the target contains normal data
  106225. */
  106226. get hasNormals(): boolean;
  106227. /**
  106228. * Gets a boolean defining if the target contains tangent data
  106229. */
  106230. get hasTangents(): boolean;
  106231. /**
  106232. * Gets a boolean defining if the target contains texture coordinates data
  106233. */
  106234. get hasUVs(): boolean;
  106235. /**
  106236. * Affects position data to this target
  106237. * @param data defines the position data to use
  106238. */
  106239. setPositions(data: Nullable<FloatArray>): void;
  106240. /**
  106241. * Gets the position data stored in this target
  106242. * @returns a FloatArray containing the position data (or null if not present)
  106243. */
  106244. getPositions(): Nullable<FloatArray>;
  106245. /**
  106246. * Affects normal data to this target
  106247. * @param data defines the normal data to use
  106248. */
  106249. setNormals(data: Nullable<FloatArray>): void;
  106250. /**
  106251. * Gets the normal data stored in this target
  106252. * @returns a FloatArray containing the normal data (or null if not present)
  106253. */
  106254. getNormals(): Nullable<FloatArray>;
  106255. /**
  106256. * Affects tangent data to this target
  106257. * @param data defines the tangent data to use
  106258. */
  106259. setTangents(data: Nullable<FloatArray>): void;
  106260. /**
  106261. * Gets the tangent data stored in this target
  106262. * @returns a FloatArray containing the tangent data (or null if not present)
  106263. */
  106264. getTangents(): Nullable<FloatArray>;
  106265. /**
  106266. * Affects texture coordinates data to this target
  106267. * @param data defines the texture coordinates data to use
  106268. */
  106269. setUVs(data: Nullable<FloatArray>): void;
  106270. /**
  106271. * Gets the texture coordinates data stored in this target
  106272. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  106273. */
  106274. getUVs(): Nullable<FloatArray>;
  106275. /**
  106276. * Clone the current target
  106277. * @returns a new MorphTarget
  106278. */
  106279. clone(): MorphTarget;
  106280. /**
  106281. * Serializes the current target into a Serialization object
  106282. * @returns the serialized object
  106283. */
  106284. serialize(): any;
  106285. /**
  106286. * Returns the string "MorphTarget"
  106287. * @returns "MorphTarget"
  106288. */
  106289. getClassName(): string;
  106290. /**
  106291. * Creates a new target from serialized data
  106292. * @param serializationObject defines the serialized data to use
  106293. * @returns a new MorphTarget
  106294. */
  106295. static Parse(serializationObject: any): MorphTarget;
  106296. /**
  106297. * Creates a MorphTarget from mesh data
  106298. * @param mesh defines the source mesh
  106299. * @param name defines the name to use for the new target
  106300. * @param influence defines the influence to attach to the target
  106301. * @returns a new MorphTarget
  106302. */
  106303. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  106304. }
  106305. }
  106306. declare module BABYLON {
  106307. /**
  106308. * This class is used to deform meshes using morphing between different targets
  106309. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106310. */
  106311. export class MorphTargetManager {
  106312. private _targets;
  106313. private _targetInfluenceChangedObservers;
  106314. private _targetDataLayoutChangedObservers;
  106315. private _activeTargets;
  106316. private _scene;
  106317. private _influences;
  106318. private _supportsNormals;
  106319. private _supportsTangents;
  106320. private _supportsUVs;
  106321. private _vertexCount;
  106322. private _uniqueId;
  106323. private _tempInfluences;
  106324. /**
  106325. * Gets or sets a boolean indicating if normals must be morphed
  106326. */
  106327. enableNormalMorphing: boolean;
  106328. /**
  106329. * Gets or sets a boolean indicating if tangents must be morphed
  106330. */
  106331. enableTangentMorphing: boolean;
  106332. /**
  106333. * Gets or sets a boolean indicating if UV must be morphed
  106334. */
  106335. enableUVMorphing: boolean;
  106336. /**
  106337. * Creates a new MorphTargetManager
  106338. * @param scene defines the current scene
  106339. */
  106340. constructor(scene?: Nullable<Scene>);
  106341. /**
  106342. * Gets the unique ID of this manager
  106343. */
  106344. get uniqueId(): number;
  106345. /**
  106346. * Gets the number of vertices handled by this manager
  106347. */
  106348. get vertexCount(): number;
  106349. /**
  106350. * Gets a boolean indicating if this manager supports morphing of normals
  106351. */
  106352. get supportsNormals(): boolean;
  106353. /**
  106354. * Gets a boolean indicating if this manager supports morphing of tangents
  106355. */
  106356. get supportsTangents(): boolean;
  106357. /**
  106358. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  106359. */
  106360. get supportsUVs(): boolean;
  106361. /**
  106362. * Gets the number of targets stored in this manager
  106363. */
  106364. get numTargets(): number;
  106365. /**
  106366. * Gets the number of influencers (ie. the number of targets with influences > 0)
  106367. */
  106368. get numInfluencers(): number;
  106369. /**
  106370. * Gets the list of influences (one per target)
  106371. */
  106372. get influences(): Float32Array;
  106373. /**
  106374. * Gets the active target at specified index. An active target is a target with an influence > 0
  106375. * @param index defines the index to check
  106376. * @returns the requested target
  106377. */
  106378. getActiveTarget(index: number): MorphTarget;
  106379. /**
  106380. * Gets the target at specified index
  106381. * @param index defines the index to check
  106382. * @returns the requested target
  106383. */
  106384. getTarget(index: number): MorphTarget;
  106385. /**
  106386. * Add a new target to this manager
  106387. * @param target defines the target to add
  106388. */
  106389. addTarget(target: MorphTarget): void;
  106390. /**
  106391. * Removes a target from the manager
  106392. * @param target defines the target to remove
  106393. */
  106394. removeTarget(target: MorphTarget): void;
  106395. /**
  106396. * Clone the current manager
  106397. * @returns a new MorphTargetManager
  106398. */
  106399. clone(): MorphTargetManager;
  106400. /**
  106401. * Serializes the current manager into a Serialization object
  106402. * @returns the serialized object
  106403. */
  106404. serialize(): any;
  106405. private _syncActiveTargets;
  106406. /**
  106407. * Syncrhonize the targets with all the meshes using this morph target manager
  106408. */
  106409. synchronize(): void;
  106410. /**
  106411. * Creates a new MorphTargetManager from serialized data
  106412. * @param serializationObject defines the serialized data
  106413. * @param scene defines the hosting scene
  106414. * @returns the new MorphTargetManager
  106415. */
  106416. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  106417. }
  106418. }
  106419. declare module BABYLON {
  106420. /**
  106421. * Class used to represent a specific level of detail of a mesh
  106422. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106423. */
  106424. export class MeshLODLevel {
  106425. /** Defines the distance where this level should start being displayed */
  106426. distance: number;
  106427. /** Defines the mesh to use to render this level */
  106428. mesh: Nullable<Mesh>;
  106429. /**
  106430. * Creates a new LOD level
  106431. * @param distance defines the distance where this level should star being displayed
  106432. * @param mesh defines the mesh to use to render this level
  106433. */
  106434. constructor(
  106435. /** Defines the distance where this level should start being displayed */
  106436. distance: number,
  106437. /** Defines the mesh to use to render this level */
  106438. mesh: Nullable<Mesh>);
  106439. }
  106440. }
  106441. declare module BABYLON {
  106442. /**
  106443. * Helper class used to generate a canvas to manipulate images
  106444. */
  106445. export class CanvasGenerator {
  106446. /**
  106447. * Create a new canvas (or offscreen canvas depending on the context)
  106448. * @param width defines the expected width
  106449. * @param height defines the expected height
  106450. * @return a new canvas or offscreen canvas
  106451. */
  106452. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  106453. }
  106454. }
  106455. declare module BABYLON {
  106456. /**
  106457. * Mesh representing the gorund
  106458. */
  106459. export class GroundMesh extends Mesh {
  106460. /** If octree should be generated */
  106461. generateOctree: boolean;
  106462. private _heightQuads;
  106463. /** @hidden */
  106464. _subdivisionsX: number;
  106465. /** @hidden */
  106466. _subdivisionsY: number;
  106467. /** @hidden */
  106468. _width: number;
  106469. /** @hidden */
  106470. _height: number;
  106471. /** @hidden */
  106472. _minX: number;
  106473. /** @hidden */
  106474. _maxX: number;
  106475. /** @hidden */
  106476. _minZ: number;
  106477. /** @hidden */
  106478. _maxZ: number;
  106479. constructor(name: string, scene: Scene);
  106480. /**
  106481. * "GroundMesh"
  106482. * @returns "GroundMesh"
  106483. */
  106484. getClassName(): string;
  106485. /**
  106486. * The minimum of x and y subdivisions
  106487. */
  106488. get subdivisions(): number;
  106489. /**
  106490. * X subdivisions
  106491. */
  106492. get subdivisionsX(): number;
  106493. /**
  106494. * Y subdivisions
  106495. */
  106496. get subdivisionsY(): number;
  106497. /**
  106498. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  106499. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106500. * @param chunksCount the number of subdivisions for x and y
  106501. * @param octreeBlocksSize (Default: 32)
  106502. */
  106503. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  106504. /**
  106505. * Returns a height (y) value in the Worl system :
  106506. * the ground altitude at the coordinates (x, z) expressed in the World system.
  106507. * @param x x coordinate
  106508. * @param z z coordinate
  106509. * @returns the ground y position if (x, z) are outside the ground surface.
  106510. */
  106511. getHeightAtCoordinates(x: number, z: number): number;
  106512. /**
  106513. * Returns a normalized vector (Vector3) orthogonal to the ground
  106514. * at the ground coordinates (x, z) expressed in the World system.
  106515. * @param x x coordinate
  106516. * @param z z coordinate
  106517. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  106518. */
  106519. getNormalAtCoordinates(x: number, z: number): Vector3;
  106520. /**
  106521. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  106522. * at the ground coordinates (x, z) expressed in the World system.
  106523. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  106524. * @param x x coordinate
  106525. * @param z z coordinate
  106526. * @param ref vector to store the result
  106527. * @returns the GroundMesh.
  106528. */
  106529. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  106530. /**
  106531. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  106532. * if the ground has been updated.
  106533. * This can be used in the render loop.
  106534. * @returns the GroundMesh.
  106535. */
  106536. updateCoordinateHeights(): GroundMesh;
  106537. private _getFacetAt;
  106538. private _initHeightQuads;
  106539. private _computeHeightQuads;
  106540. /**
  106541. * Serializes this ground mesh
  106542. * @param serializationObject object to write serialization to
  106543. */
  106544. serialize(serializationObject: any): void;
  106545. /**
  106546. * Parses a serialized ground mesh
  106547. * @param parsedMesh the serialized mesh
  106548. * @param scene the scene to create the ground mesh in
  106549. * @returns the created ground mesh
  106550. */
  106551. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  106552. }
  106553. }
  106554. declare module BABYLON {
  106555. /**
  106556. * Interface for Physics-Joint data
  106557. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106558. */
  106559. export interface PhysicsJointData {
  106560. /**
  106561. * The main pivot of the joint
  106562. */
  106563. mainPivot?: Vector3;
  106564. /**
  106565. * The connected pivot of the joint
  106566. */
  106567. connectedPivot?: Vector3;
  106568. /**
  106569. * The main axis of the joint
  106570. */
  106571. mainAxis?: Vector3;
  106572. /**
  106573. * The connected axis of the joint
  106574. */
  106575. connectedAxis?: Vector3;
  106576. /**
  106577. * The collision of the joint
  106578. */
  106579. collision?: boolean;
  106580. /**
  106581. * Native Oimo/Cannon/Energy data
  106582. */
  106583. nativeParams?: any;
  106584. }
  106585. /**
  106586. * This is a holder class for the physics joint created by the physics plugin
  106587. * It holds a set of functions to control the underlying joint
  106588. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106589. */
  106590. export class PhysicsJoint {
  106591. /**
  106592. * The type of the physics joint
  106593. */
  106594. type: number;
  106595. /**
  106596. * The data for the physics joint
  106597. */
  106598. jointData: PhysicsJointData;
  106599. private _physicsJoint;
  106600. protected _physicsPlugin: IPhysicsEnginePlugin;
  106601. /**
  106602. * Initializes the physics joint
  106603. * @param type The type of the physics joint
  106604. * @param jointData The data for the physics joint
  106605. */
  106606. constructor(
  106607. /**
  106608. * The type of the physics joint
  106609. */
  106610. type: number,
  106611. /**
  106612. * The data for the physics joint
  106613. */
  106614. jointData: PhysicsJointData);
  106615. /**
  106616. * Gets the physics joint
  106617. */
  106618. get physicsJoint(): any;
  106619. /**
  106620. * Sets the physics joint
  106621. */
  106622. set physicsJoint(newJoint: any);
  106623. /**
  106624. * Sets the physics plugin
  106625. */
  106626. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  106627. /**
  106628. * Execute a function that is physics-plugin specific.
  106629. * @param {Function} func the function that will be executed.
  106630. * It accepts two parameters: the physics world and the physics joint
  106631. */
  106632. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  106633. /**
  106634. * Distance-Joint type
  106635. */
  106636. static DistanceJoint: number;
  106637. /**
  106638. * Hinge-Joint type
  106639. */
  106640. static HingeJoint: number;
  106641. /**
  106642. * Ball-and-Socket joint type
  106643. */
  106644. static BallAndSocketJoint: number;
  106645. /**
  106646. * Wheel-Joint type
  106647. */
  106648. static WheelJoint: number;
  106649. /**
  106650. * Slider-Joint type
  106651. */
  106652. static SliderJoint: number;
  106653. /**
  106654. * Prismatic-Joint type
  106655. */
  106656. static PrismaticJoint: number;
  106657. /**
  106658. * Universal-Joint type
  106659. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  106660. */
  106661. static UniversalJoint: number;
  106662. /**
  106663. * Hinge-Joint 2 type
  106664. */
  106665. static Hinge2Joint: number;
  106666. /**
  106667. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  106668. */
  106669. static PointToPointJoint: number;
  106670. /**
  106671. * Spring-Joint type
  106672. */
  106673. static SpringJoint: number;
  106674. /**
  106675. * Lock-Joint type
  106676. */
  106677. static LockJoint: number;
  106678. }
  106679. /**
  106680. * A class representing a physics distance joint
  106681. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106682. */
  106683. export class DistanceJoint extends PhysicsJoint {
  106684. /**
  106685. *
  106686. * @param jointData The data for the Distance-Joint
  106687. */
  106688. constructor(jointData: DistanceJointData);
  106689. /**
  106690. * Update the predefined distance.
  106691. * @param maxDistance The maximum preferred distance
  106692. * @param minDistance The minimum preferred distance
  106693. */
  106694. updateDistance(maxDistance: number, minDistance?: number): void;
  106695. }
  106696. /**
  106697. * Represents a Motor-Enabled Joint
  106698. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106699. */
  106700. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  106701. /**
  106702. * Initializes the Motor-Enabled Joint
  106703. * @param type The type of the joint
  106704. * @param jointData The physica joint data for the joint
  106705. */
  106706. constructor(type: number, jointData: PhysicsJointData);
  106707. /**
  106708. * Set the motor values.
  106709. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106710. * @param force the force to apply
  106711. * @param maxForce max force for this motor.
  106712. */
  106713. setMotor(force?: number, maxForce?: number): void;
  106714. /**
  106715. * Set the motor's limits.
  106716. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106717. * @param upperLimit The upper limit of the motor
  106718. * @param lowerLimit The lower limit of the motor
  106719. */
  106720. setLimit(upperLimit: number, lowerLimit?: number): void;
  106721. }
  106722. /**
  106723. * This class represents a single physics Hinge-Joint
  106724. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106725. */
  106726. export class HingeJoint extends MotorEnabledJoint {
  106727. /**
  106728. * Initializes the Hinge-Joint
  106729. * @param jointData The joint data for the Hinge-Joint
  106730. */
  106731. constructor(jointData: PhysicsJointData);
  106732. /**
  106733. * Set the motor values.
  106734. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106735. * @param {number} force the force to apply
  106736. * @param {number} maxForce max force for this motor.
  106737. */
  106738. setMotor(force?: number, maxForce?: number): void;
  106739. /**
  106740. * Set the motor's limits.
  106741. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106742. * @param upperLimit The upper limit of the motor
  106743. * @param lowerLimit The lower limit of the motor
  106744. */
  106745. setLimit(upperLimit: number, lowerLimit?: number): void;
  106746. }
  106747. /**
  106748. * This class represents a dual hinge physics joint (same as wheel joint)
  106749. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106750. */
  106751. export class Hinge2Joint extends MotorEnabledJoint {
  106752. /**
  106753. * Initializes the Hinge2-Joint
  106754. * @param jointData The joint data for the Hinge2-Joint
  106755. */
  106756. constructor(jointData: PhysicsJointData);
  106757. /**
  106758. * Set the motor values.
  106759. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106760. * @param {number} targetSpeed the speed the motor is to reach
  106761. * @param {number} maxForce max force for this motor.
  106762. * @param {motorIndex} the motor's index, 0 or 1.
  106763. */
  106764. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  106765. /**
  106766. * Set the motor limits.
  106767. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106768. * @param {number} upperLimit the upper limit
  106769. * @param {number} lowerLimit lower limit
  106770. * @param {motorIndex} the motor's index, 0 or 1.
  106771. */
  106772. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106773. }
  106774. /**
  106775. * Interface for a motor enabled joint
  106776. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106777. */
  106778. export interface IMotorEnabledJoint {
  106779. /**
  106780. * Physics joint
  106781. */
  106782. physicsJoint: any;
  106783. /**
  106784. * Sets the motor of the motor-enabled joint
  106785. * @param force The force of the motor
  106786. * @param maxForce The maximum force of the motor
  106787. * @param motorIndex The index of the motor
  106788. */
  106789. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  106790. /**
  106791. * Sets the limit of the motor
  106792. * @param upperLimit The upper limit of the motor
  106793. * @param lowerLimit The lower limit of the motor
  106794. * @param motorIndex The index of the motor
  106795. */
  106796. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106797. }
  106798. /**
  106799. * Joint data for a Distance-Joint
  106800. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106801. */
  106802. export interface DistanceJointData extends PhysicsJointData {
  106803. /**
  106804. * Max distance the 2 joint objects can be apart
  106805. */
  106806. maxDistance: number;
  106807. }
  106808. /**
  106809. * Joint data from a spring joint
  106810. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106811. */
  106812. export interface SpringJointData extends PhysicsJointData {
  106813. /**
  106814. * Length of the spring
  106815. */
  106816. length: number;
  106817. /**
  106818. * Stiffness of the spring
  106819. */
  106820. stiffness: number;
  106821. /**
  106822. * Damping of the spring
  106823. */
  106824. damping: number;
  106825. /** this callback will be called when applying the force to the impostors. */
  106826. forceApplicationCallback: () => void;
  106827. }
  106828. }
  106829. declare module BABYLON {
  106830. /**
  106831. * Holds the data for the raycast result
  106832. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106833. */
  106834. export class PhysicsRaycastResult {
  106835. private _hasHit;
  106836. private _hitDistance;
  106837. private _hitNormalWorld;
  106838. private _hitPointWorld;
  106839. private _rayFromWorld;
  106840. private _rayToWorld;
  106841. /**
  106842. * Gets if there was a hit
  106843. */
  106844. get hasHit(): boolean;
  106845. /**
  106846. * Gets the distance from the hit
  106847. */
  106848. get hitDistance(): number;
  106849. /**
  106850. * Gets the hit normal/direction in the world
  106851. */
  106852. get hitNormalWorld(): Vector3;
  106853. /**
  106854. * Gets the hit point in the world
  106855. */
  106856. get hitPointWorld(): Vector3;
  106857. /**
  106858. * Gets the ray "start point" of the ray in the world
  106859. */
  106860. get rayFromWorld(): Vector3;
  106861. /**
  106862. * Gets the ray "end point" of the ray in the world
  106863. */
  106864. get rayToWorld(): Vector3;
  106865. /**
  106866. * Sets the hit data (normal & point in world space)
  106867. * @param hitNormalWorld defines the normal in world space
  106868. * @param hitPointWorld defines the point in world space
  106869. */
  106870. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  106871. /**
  106872. * Sets the distance from the start point to the hit point
  106873. * @param distance
  106874. */
  106875. setHitDistance(distance: number): void;
  106876. /**
  106877. * Calculates the distance manually
  106878. */
  106879. calculateHitDistance(): void;
  106880. /**
  106881. * Resets all the values to default
  106882. * @param from The from point on world space
  106883. * @param to The to point on world space
  106884. */
  106885. reset(from?: Vector3, to?: Vector3): void;
  106886. }
  106887. /**
  106888. * Interface for the size containing width and height
  106889. */
  106890. interface IXYZ {
  106891. /**
  106892. * X
  106893. */
  106894. x: number;
  106895. /**
  106896. * Y
  106897. */
  106898. y: number;
  106899. /**
  106900. * Z
  106901. */
  106902. z: number;
  106903. }
  106904. }
  106905. declare module BABYLON {
  106906. /**
  106907. * Interface used to describe a physics joint
  106908. */
  106909. export interface PhysicsImpostorJoint {
  106910. /** Defines the main impostor to which the joint is linked */
  106911. mainImpostor: PhysicsImpostor;
  106912. /** Defines the impostor that is connected to the main impostor using this joint */
  106913. connectedImpostor: PhysicsImpostor;
  106914. /** Defines the joint itself */
  106915. joint: PhysicsJoint;
  106916. }
  106917. /** @hidden */
  106918. export interface IPhysicsEnginePlugin {
  106919. world: any;
  106920. name: string;
  106921. setGravity(gravity: Vector3): void;
  106922. setTimeStep(timeStep: number): void;
  106923. getTimeStep(): number;
  106924. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  106925. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106926. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106927. generatePhysicsBody(impostor: PhysicsImpostor): void;
  106928. removePhysicsBody(impostor: PhysicsImpostor): void;
  106929. generateJoint(joint: PhysicsImpostorJoint): void;
  106930. removeJoint(joint: PhysicsImpostorJoint): void;
  106931. isSupported(): boolean;
  106932. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  106933. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  106934. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106935. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106936. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106937. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106938. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  106939. getBodyMass(impostor: PhysicsImpostor): number;
  106940. getBodyFriction(impostor: PhysicsImpostor): number;
  106941. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  106942. getBodyRestitution(impostor: PhysicsImpostor): number;
  106943. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  106944. getBodyPressure?(impostor: PhysicsImpostor): number;
  106945. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  106946. getBodyStiffness?(impostor: PhysicsImpostor): number;
  106947. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  106948. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  106949. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  106950. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  106951. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  106952. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106953. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106954. sleepBody(impostor: PhysicsImpostor): void;
  106955. wakeUpBody(impostor: PhysicsImpostor): void;
  106956. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  106957. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  106958. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  106959. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106960. getRadius(impostor: PhysicsImpostor): number;
  106961. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  106962. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  106963. dispose(): void;
  106964. }
  106965. /**
  106966. * Interface used to define a physics engine
  106967. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106968. */
  106969. export interface IPhysicsEngine {
  106970. /**
  106971. * Gets the gravity vector used by the simulation
  106972. */
  106973. gravity: Vector3;
  106974. /**
  106975. * Sets the gravity vector used by the simulation
  106976. * @param gravity defines the gravity vector to use
  106977. */
  106978. setGravity(gravity: Vector3): void;
  106979. /**
  106980. * Set the time step of the physics engine.
  106981. * Default is 1/60.
  106982. * To slow it down, enter 1/600 for example.
  106983. * To speed it up, 1/30
  106984. * @param newTimeStep the new timestep to apply to this world.
  106985. */
  106986. setTimeStep(newTimeStep: number): void;
  106987. /**
  106988. * Get the time step of the physics engine.
  106989. * @returns the current time step
  106990. */
  106991. getTimeStep(): number;
  106992. /**
  106993. * Set the sub time step of the physics engine.
  106994. * Default is 0 meaning there is no sub steps
  106995. * To increase physics resolution precision, set a small value (like 1 ms)
  106996. * @param subTimeStep defines the new sub timestep used for physics resolution.
  106997. */
  106998. setSubTimeStep(subTimeStep: number): void;
  106999. /**
  107000. * Get the sub time step of the physics engine.
  107001. * @returns the current sub time step
  107002. */
  107003. getSubTimeStep(): number;
  107004. /**
  107005. * Release all resources
  107006. */
  107007. dispose(): void;
  107008. /**
  107009. * Gets the name of the current physics plugin
  107010. * @returns the name of the plugin
  107011. */
  107012. getPhysicsPluginName(): string;
  107013. /**
  107014. * Adding a new impostor for the impostor tracking.
  107015. * This will be done by the impostor itself.
  107016. * @param impostor the impostor to add
  107017. */
  107018. addImpostor(impostor: PhysicsImpostor): void;
  107019. /**
  107020. * Remove an impostor from the engine.
  107021. * This impostor and its mesh will not longer be updated by the physics engine.
  107022. * @param impostor the impostor to remove
  107023. */
  107024. removeImpostor(impostor: PhysicsImpostor): void;
  107025. /**
  107026. * Add a joint to the physics engine
  107027. * @param mainImpostor defines the main impostor to which the joint is added.
  107028. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  107029. * @param joint defines the joint that will connect both impostors.
  107030. */
  107031. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107032. /**
  107033. * Removes a joint from the simulation
  107034. * @param mainImpostor defines the impostor used with the joint
  107035. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  107036. * @param joint defines the joint to remove
  107037. */
  107038. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107039. /**
  107040. * Gets the current plugin used to run the simulation
  107041. * @returns current plugin
  107042. */
  107043. getPhysicsPlugin(): IPhysicsEnginePlugin;
  107044. /**
  107045. * Gets the list of physic impostors
  107046. * @returns an array of PhysicsImpostor
  107047. */
  107048. getImpostors(): Array<PhysicsImpostor>;
  107049. /**
  107050. * Gets the impostor for a physics enabled object
  107051. * @param object defines the object impersonated by the impostor
  107052. * @returns the PhysicsImpostor or null if not found
  107053. */
  107054. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107055. /**
  107056. * Gets the impostor for a physics body object
  107057. * @param body defines physics body used by the impostor
  107058. * @returns the PhysicsImpostor or null if not found
  107059. */
  107060. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  107061. /**
  107062. * Does a raycast in the physics world
  107063. * @param from when should the ray start?
  107064. * @param to when should the ray end?
  107065. * @returns PhysicsRaycastResult
  107066. */
  107067. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107068. /**
  107069. * Called by the scene. No need to call it.
  107070. * @param delta defines the timespam between frames
  107071. */
  107072. _step(delta: number): void;
  107073. }
  107074. }
  107075. declare module BABYLON {
  107076. /**
  107077. * The interface for the physics imposter parameters
  107078. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107079. */
  107080. export interface PhysicsImpostorParameters {
  107081. /**
  107082. * The mass of the physics imposter
  107083. */
  107084. mass: number;
  107085. /**
  107086. * The friction of the physics imposter
  107087. */
  107088. friction?: number;
  107089. /**
  107090. * The coefficient of restitution of the physics imposter
  107091. */
  107092. restitution?: number;
  107093. /**
  107094. * The native options of the physics imposter
  107095. */
  107096. nativeOptions?: any;
  107097. /**
  107098. * Specifies if the parent should be ignored
  107099. */
  107100. ignoreParent?: boolean;
  107101. /**
  107102. * Specifies if bi-directional transformations should be disabled
  107103. */
  107104. disableBidirectionalTransformation?: boolean;
  107105. /**
  107106. * The pressure inside the physics imposter, soft object only
  107107. */
  107108. pressure?: number;
  107109. /**
  107110. * The stiffness the physics imposter, soft object only
  107111. */
  107112. stiffness?: number;
  107113. /**
  107114. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  107115. */
  107116. velocityIterations?: number;
  107117. /**
  107118. * The number of iterations used in maintaining consistent vertex positions, soft object only
  107119. */
  107120. positionIterations?: number;
  107121. /**
  107122. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  107123. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  107124. * Add to fix multiple points
  107125. */
  107126. fixedPoints?: number;
  107127. /**
  107128. * The collision margin around a soft object
  107129. */
  107130. margin?: number;
  107131. /**
  107132. * The collision margin around a soft object
  107133. */
  107134. damping?: number;
  107135. /**
  107136. * The path for a rope based on an extrusion
  107137. */
  107138. path?: any;
  107139. /**
  107140. * The shape of an extrusion used for a rope based on an extrusion
  107141. */
  107142. shape?: any;
  107143. }
  107144. /**
  107145. * Interface for a physics-enabled object
  107146. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107147. */
  107148. export interface IPhysicsEnabledObject {
  107149. /**
  107150. * The position of the physics-enabled object
  107151. */
  107152. position: Vector3;
  107153. /**
  107154. * The rotation of the physics-enabled object
  107155. */
  107156. rotationQuaternion: Nullable<Quaternion>;
  107157. /**
  107158. * The scale of the physics-enabled object
  107159. */
  107160. scaling: Vector3;
  107161. /**
  107162. * The rotation of the physics-enabled object
  107163. */
  107164. rotation?: Vector3;
  107165. /**
  107166. * The parent of the physics-enabled object
  107167. */
  107168. parent?: any;
  107169. /**
  107170. * The bounding info of the physics-enabled object
  107171. * @returns The bounding info of the physics-enabled object
  107172. */
  107173. getBoundingInfo(): BoundingInfo;
  107174. /**
  107175. * Computes the world matrix
  107176. * @param force Specifies if the world matrix should be computed by force
  107177. * @returns A world matrix
  107178. */
  107179. computeWorldMatrix(force: boolean): Matrix;
  107180. /**
  107181. * Gets the world matrix
  107182. * @returns A world matrix
  107183. */
  107184. getWorldMatrix?(): Matrix;
  107185. /**
  107186. * Gets the child meshes
  107187. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  107188. * @returns An array of abstract meshes
  107189. */
  107190. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  107191. /**
  107192. * Gets the vertex data
  107193. * @param kind The type of vertex data
  107194. * @returns A nullable array of numbers, or a float32 array
  107195. */
  107196. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  107197. /**
  107198. * Gets the indices from the mesh
  107199. * @returns A nullable array of index arrays
  107200. */
  107201. getIndices?(): Nullable<IndicesArray>;
  107202. /**
  107203. * Gets the scene from the mesh
  107204. * @returns the indices array or null
  107205. */
  107206. getScene?(): Scene;
  107207. /**
  107208. * Gets the absolute position from the mesh
  107209. * @returns the absolute position
  107210. */
  107211. getAbsolutePosition(): Vector3;
  107212. /**
  107213. * Gets the absolute pivot point from the mesh
  107214. * @returns the absolute pivot point
  107215. */
  107216. getAbsolutePivotPoint(): Vector3;
  107217. /**
  107218. * Rotates the mesh
  107219. * @param axis The axis of rotation
  107220. * @param amount The amount of rotation
  107221. * @param space The space of the rotation
  107222. * @returns The rotation transform node
  107223. */
  107224. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  107225. /**
  107226. * Translates the mesh
  107227. * @param axis The axis of translation
  107228. * @param distance The distance of translation
  107229. * @param space The space of the translation
  107230. * @returns The transform node
  107231. */
  107232. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  107233. /**
  107234. * Sets the absolute position of the mesh
  107235. * @param absolutePosition The absolute position of the mesh
  107236. * @returns The transform node
  107237. */
  107238. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  107239. /**
  107240. * Gets the class name of the mesh
  107241. * @returns The class name
  107242. */
  107243. getClassName(): string;
  107244. }
  107245. /**
  107246. * Represents a physics imposter
  107247. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107248. */
  107249. export class PhysicsImpostor {
  107250. /**
  107251. * The physics-enabled object used as the physics imposter
  107252. */
  107253. object: IPhysicsEnabledObject;
  107254. /**
  107255. * The type of the physics imposter
  107256. */
  107257. type: number;
  107258. private _options;
  107259. private _scene?;
  107260. /**
  107261. * The default object size of the imposter
  107262. */
  107263. static DEFAULT_OBJECT_SIZE: Vector3;
  107264. /**
  107265. * The identity quaternion of the imposter
  107266. */
  107267. static IDENTITY_QUATERNION: Quaternion;
  107268. /** @hidden */
  107269. _pluginData: any;
  107270. private _physicsEngine;
  107271. private _physicsBody;
  107272. private _bodyUpdateRequired;
  107273. private _onBeforePhysicsStepCallbacks;
  107274. private _onAfterPhysicsStepCallbacks;
  107275. /** @hidden */
  107276. _onPhysicsCollideCallbacks: Array<{
  107277. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  107278. otherImpostors: Array<PhysicsImpostor>;
  107279. }>;
  107280. private _deltaPosition;
  107281. private _deltaRotation;
  107282. private _deltaRotationConjugated;
  107283. /** @hidden */
  107284. _isFromLine: boolean;
  107285. private _parent;
  107286. private _isDisposed;
  107287. private static _tmpVecs;
  107288. private static _tmpQuat;
  107289. /**
  107290. * Specifies if the physics imposter is disposed
  107291. */
  107292. get isDisposed(): boolean;
  107293. /**
  107294. * Gets the mass of the physics imposter
  107295. */
  107296. get mass(): number;
  107297. set mass(value: number);
  107298. /**
  107299. * Gets the coefficient of friction
  107300. */
  107301. get friction(): number;
  107302. /**
  107303. * Sets the coefficient of friction
  107304. */
  107305. set friction(value: number);
  107306. /**
  107307. * Gets the coefficient of restitution
  107308. */
  107309. get restitution(): number;
  107310. /**
  107311. * Sets the coefficient of restitution
  107312. */
  107313. set restitution(value: number);
  107314. /**
  107315. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  107316. */
  107317. get pressure(): number;
  107318. /**
  107319. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  107320. */
  107321. set pressure(value: number);
  107322. /**
  107323. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107324. */
  107325. get stiffness(): number;
  107326. /**
  107327. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107328. */
  107329. set stiffness(value: number);
  107330. /**
  107331. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107332. */
  107333. get velocityIterations(): number;
  107334. /**
  107335. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107336. */
  107337. set velocityIterations(value: number);
  107338. /**
  107339. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107340. */
  107341. get positionIterations(): number;
  107342. /**
  107343. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107344. */
  107345. set positionIterations(value: number);
  107346. /**
  107347. * The unique id of the physics imposter
  107348. * set by the physics engine when adding this impostor to the array
  107349. */
  107350. uniqueId: number;
  107351. /**
  107352. * @hidden
  107353. */
  107354. soft: boolean;
  107355. /**
  107356. * @hidden
  107357. */
  107358. segments: number;
  107359. private _joints;
  107360. /**
  107361. * Initializes the physics imposter
  107362. * @param object The physics-enabled object used as the physics imposter
  107363. * @param type The type of the physics imposter
  107364. * @param _options The options for the physics imposter
  107365. * @param _scene The Babylon scene
  107366. */
  107367. constructor(
  107368. /**
  107369. * The physics-enabled object used as the physics imposter
  107370. */
  107371. object: IPhysicsEnabledObject,
  107372. /**
  107373. * The type of the physics imposter
  107374. */
  107375. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  107376. /**
  107377. * This function will completly initialize this impostor.
  107378. * It will create a new body - but only if this mesh has no parent.
  107379. * If it has, this impostor will not be used other than to define the impostor
  107380. * of the child mesh.
  107381. * @hidden
  107382. */
  107383. _init(): void;
  107384. private _getPhysicsParent;
  107385. /**
  107386. * Should a new body be generated.
  107387. * @returns boolean specifying if body initialization is required
  107388. */
  107389. isBodyInitRequired(): boolean;
  107390. /**
  107391. * Sets the updated scaling
  107392. * @param updated Specifies if the scaling is updated
  107393. */
  107394. setScalingUpdated(): void;
  107395. /**
  107396. * Force a regeneration of this or the parent's impostor's body.
  107397. * Use under cautious - This will remove all joints already implemented.
  107398. */
  107399. forceUpdate(): void;
  107400. /**
  107401. * Gets the body that holds this impostor. Either its own, or its parent.
  107402. */
  107403. get physicsBody(): any;
  107404. /**
  107405. * Get the parent of the physics imposter
  107406. * @returns Physics imposter or null
  107407. */
  107408. get parent(): Nullable<PhysicsImpostor>;
  107409. /**
  107410. * Sets the parent of the physics imposter
  107411. */
  107412. set parent(value: Nullable<PhysicsImpostor>);
  107413. /**
  107414. * Set the physics body. Used mainly by the physics engine/plugin
  107415. */
  107416. set physicsBody(physicsBody: any);
  107417. /**
  107418. * Resets the update flags
  107419. */
  107420. resetUpdateFlags(): void;
  107421. /**
  107422. * Gets the object extend size
  107423. * @returns the object extend size
  107424. */
  107425. getObjectExtendSize(): Vector3;
  107426. /**
  107427. * Gets the object center
  107428. * @returns The object center
  107429. */
  107430. getObjectCenter(): Vector3;
  107431. /**
  107432. * Get a specific parameter from the options parameters
  107433. * @param paramName The object parameter name
  107434. * @returns The object parameter
  107435. */
  107436. getParam(paramName: string): any;
  107437. /**
  107438. * Sets a specific parameter in the options given to the physics plugin
  107439. * @param paramName The parameter name
  107440. * @param value The value of the parameter
  107441. */
  107442. setParam(paramName: string, value: number): void;
  107443. /**
  107444. * Specifically change the body's mass option. Won't recreate the physics body object
  107445. * @param mass The mass of the physics imposter
  107446. */
  107447. setMass(mass: number): void;
  107448. /**
  107449. * Gets the linear velocity
  107450. * @returns linear velocity or null
  107451. */
  107452. getLinearVelocity(): Nullable<Vector3>;
  107453. /**
  107454. * Sets the linear velocity
  107455. * @param velocity linear velocity or null
  107456. */
  107457. setLinearVelocity(velocity: Nullable<Vector3>): void;
  107458. /**
  107459. * Gets the angular velocity
  107460. * @returns angular velocity or null
  107461. */
  107462. getAngularVelocity(): Nullable<Vector3>;
  107463. /**
  107464. * Sets the angular velocity
  107465. * @param velocity The velocity or null
  107466. */
  107467. setAngularVelocity(velocity: Nullable<Vector3>): void;
  107468. /**
  107469. * Execute a function with the physics plugin native code
  107470. * Provide a function the will have two variables - the world object and the physics body object
  107471. * @param func The function to execute with the physics plugin native code
  107472. */
  107473. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  107474. /**
  107475. * Register a function that will be executed before the physics world is stepping forward
  107476. * @param func The function to execute before the physics world is stepped forward
  107477. */
  107478. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107479. /**
  107480. * Unregister a function that will be executed before the physics world is stepping forward
  107481. * @param func The function to execute before the physics world is stepped forward
  107482. */
  107483. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107484. /**
  107485. * Register a function that will be executed after the physics step
  107486. * @param func The function to execute after physics step
  107487. */
  107488. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107489. /**
  107490. * Unregisters a function that will be executed after the physics step
  107491. * @param func The function to execute after physics step
  107492. */
  107493. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107494. /**
  107495. * register a function that will be executed when this impostor collides against a different body
  107496. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  107497. * @param func Callback that is executed on collision
  107498. */
  107499. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  107500. /**
  107501. * Unregisters the physics imposter on contact
  107502. * @param collideAgainst The physics object to collide against
  107503. * @param func Callback to execute on collision
  107504. */
  107505. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  107506. private _tmpQuat;
  107507. private _tmpQuat2;
  107508. /**
  107509. * Get the parent rotation
  107510. * @returns The parent rotation
  107511. */
  107512. getParentsRotation(): Quaternion;
  107513. /**
  107514. * this function is executed by the physics engine.
  107515. */
  107516. beforeStep: () => void;
  107517. /**
  107518. * this function is executed by the physics engine
  107519. */
  107520. afterStep: () => void;
  107521. /**
  107522. * Legacy collision detection event support
  107523. */
  107524. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  107525. /**
  107526. * event and body object due to cannon's event-based architecture.
  107527. */
  107528. onCollide: (e: {
  107529. body: any;
  107530. }) => void;
  107531. /**
  107532. * Apply a force
  107533. * @param force The force to apply
  107534. * @param contactPoint The contact point for the force
  107535. * @returns The physics imposter
  107536. */
  107537. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107538. /**
  107539. * Apply an impulse
  107540. * @param force The impulse force
  107541. * @param contactPoint The contact point for the impulse force
  107542. * @returns The physics imposter
  107543. */
  107544. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107545. /**
  107546. * A help function to create a joint
  107547. * @param otherImpostor A physics imposter used to create a joint
  107548. * @param jointType The type of joint
  107549. * @param jointData The data for the joint
  107550. * @returns The physics imposter
  107551. */
  107552. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  107553. /**
  107554. * Add a joint to this impostor with a different impostor
  107555. * @param otherImpostor A physics imposter used to add a joint
  107556. * @param joint The joint to add
  107557. * @returns The physics imposter
  107558. */
  107559. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  107560. /**
  107561. * Add an anchor to a cloth impostor
  107562. * @param otherImpostor rigid impostor to anchor to
  107563. * @param width ratio across width from 0 to 1
  107564. * @param height ratio up height from 0 to 1
  107565. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  107566. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  107567. * @returns impostor the soft imposter
  107568. */
  107569. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107570. /**
  107571. * Add a hook to a rope impostor
  107572. * @param otherImpostor rigid impostor to anchor to
  107573. * @param length ratio across rope from 0 to 1
  107574. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  107575. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  107576. * @returns impostor the rope imposter
  107577. */
  107578. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107579. /**
  107580. * Will keep this body still, in a sleep mode.
  107581. * @returns the physics imposter
  107582. */
  107583. sleep(): PhysicsImpostor;
  107584. /**
  107585. * Wake the body up.
  107586. * @returns The physics imposter
  107587. */
  107588. wakeUp(): PhysicsImpostor;
  107589. /**
  107590. * Clones the physics imposter
  107591. * @param newObject The physics imposter clones to this physics-enabled object
  107592. * @returns A nullable physics imposter
  107593. */
  107594. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107595. /**
  107596. * Disposes the physics imposter
  107597. */
  107598. dispose(): void;
  107599. /**
  107600. * Sets the delta position
  107601. * @param position The delta position amount
  107602. */
  107603. setDeltaPosition(position: Vector3): void;
  107604. /**
  107605. * Sets the delta rotation
  107606. * @param rotation The delta rotation amount
  107607. */
  107608. setDeltaRotation(rotation: Quaternion): void;
  107609. /**
  107610. * Gets the box size of the physics imposter and stores the result in the input parameter
  107611. * @param result Stores the box size
  107612. * @returns The physics imposter
  107613. */
  107614. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  107615. /**
  107616. * Gets the radius of the physics imposter
  107617. * @returns Radius of the physics imposter
  107618. */
  107619. getRadius(): number;
  107620. /**
  107621. * Sync a bone with this impostor
  107622. * @param bone The bone to sync to the impostor.
  107623. * @param boneMesh The mesh that the bone is influencing.
  107624. * @param jointPivot The pivot of the joint / bone in local space.
  107625. * @param distToJoint Optional distance from the impostor to the joint.
  107626. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107627. */
  107628. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  107629. /**
  107630. * Sync impostor to a bone
  107631. * @param bone The bone that the impostor will be synced to.
  107632. * @param boneMesh The mesh that the bone is influencing.
  107633. * @param jointPivot The pivot of the joint / bone in local space.
  107634. * @param distToJoint Optional distance from the impostor to the joint.
  107635. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107636. * @param boneAxis Optional vector3 axis the bone is aligned with
  107637. */
  107638. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  107639. /**
  107640. * No-Imposter type
  107641. */
  107642. static NoImpostor: number;
  107643. /**
  107644. * Sphere-Imposter type
  107645. */
  107646. static SphereImpostor: number;
  107647. /**
  107648. * Box-Imposter type
  107649. */
  107650. static BoxImpostor: number;
  107651. /**
  107652. * Plane-Imposter type
  107653. */
  107654. static PlaneImpostor: number;
  107655. /**
  107656. * Mesh-imposter type
  107657. */
  107658. static MeshImpostor: number;
  107659. /**
  107660. * Capsule-Impostor type (Ammo.js plugin only)
  107661. */
  107662. static CapsuleImpostor: number;
  107663. /**
  107664. * Cylinder-Imposter type
  107665. */
  107666. static CylinderImpostor: number;
  107667. /**
  107668. * Particle-Imposter type
  107669. */
  107670. static ParticleImpostor: number;
  107671. /**
  107672. * Heightmap-Imposter type
  107673. */
  107674. static HeightmapImpostor: number;
  107675. /**
  107676. * ConvexHull-Impostor type (Ammo.js plugin only)
  107677. */
  107678. static ConvexHullImpostor: number;
  107679. /**
  107680. * Custom-Imposter type (Ammo.js plugin only)
  107681. */
  107682. static CustomImpostor: number;
  107683. /**
  107684. * Rope-Imposter type
  107685. */
  107686. static RopeImpostor: number;
  107687. /**
  107688. * Cloth-Imposter type
  107689. */
  107690. static ClothImpostor: number;
  107691. /**
  107692. * Softbody-Imposter type
  107693. */
  107694. static SoftbodyImpostor: number;
  107695. }
  107696. }
  107697. declare module BABYLON {
  107698. /**
  107699. * @hidden
  107700. **/
  107701. export class _CreationDataStorage {
  107702. closePath?: boolean;
  107703. closeArray?: boolean;
  107704. idx: number[];
  107705. dashSize: number;
  107706. gapSize: number;
  107707. path3D: Path3D;
  107708. pathArray: Vector3[][];
  107709. arc: number;
  107710. radius: number;
  107711. cap: number;
  107712. tessellation: number;
  107713. }
  107714. /**
  107715. * @hidden
  107716. **/
  107717. class _InstanceDataStorage {
  107718. visibleInstances: any;
  107719. batchCache: _InstancesBatch;
  107720. instancesBufferSize: number;
  107721. instancesBuffer: Nullable<Buffer>;
  107722. instancesData: Float32Array;
  107723. overridenInstanceCount: number;
  107724. isFrozen: boolean;
  107725. previousBatch: Nullable<_InstancesBatch>;
  107726. hardwareInstancedRendering: boolean;
  107727. sideOrientation: number;
  107728. manualUpdate: boolean;
  107729. }
  107730. /**
  107731. * @hidden
  107732. **/
  107733. export class _InstancesBatch {
  107734. mustReturn: boolean;
  107735. visibleInstances: Nullable<InstancedMesh[]>[];
  107736. renderSelf: boolean[];
  107737. hardwareInstancedRendering: boolean[];
  107738. }
  107739. /**
  107740. * @hidden
  107741. **/
  107742. class _ThinInstanceDataStorage {
  107743. instancesCount: number;
  107744. matrixBuffer: Nullable<Buffer>;
  107745. matrixBufferSize: number;
  107746. matrixData: Nullable<Float32Array>;
  107747. boundingVectors: Array<Vector3>;
  107748. worldMatrices: Nullable<Matrix[]>;
  107749. }
  107750. /**
  107751. * Class used to represent renderable models
  107752. */
  107753. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  107754. /**
  107755. * Mesh side orientation : usually the external or front surface
  107756. */
  107757. static readonly FRONTSIDE: number;
  107758. /**
  107759. * Mesh side orientation : usually the internal or back surface
  107760. */
  107761. static readonly BACKSIDE: number;
  107762. /**
  107763. * Mesh side orientation : both internal and external or front and back surfaces
  107764. */
  107765. static readonly DOUBLESIDE: number;
  107766. /**
  107767. * Mesh side orientation : by default, `FRONTSIDE`
  107768. */
  107769. static readonly DEFAULTSIDE: number;
  107770. /**
  107771. * Mesh cap setting : no cap
  107772. */
  107773. static readonly NO_CAP: number;
  107774. /**
  107775. * Mesh cap setting : one cap at the beginning of the mesh
  107776. */
  107777. static readonly CAP_START: number;
  107778. /**
  107779. * Mesh cap setting : one cap at the end of the mesh
  107780. */
  107781. static readonly CAP_END: number;
  107782. /**
  107783. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  107784. */
  107785. static readonly CAP_ALL: number;
  107786. /**
  107787. * Mesh pattern setting : no flip or rotate
  107788. */
  107789. static readonly NO_FLIP: number;
  107790. /**
  107791. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  107792. */
  107793. static readonly FLIP_TILE: number;
  107794. /**
  107795. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  107796. */
  107797. static readonly ROTATE_TILE: number;
  107798. /**
  107799. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  107800. */
  107801. static readonly FLIP_ROW: number;
  107802. /**
  107803. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  107804. */
  107805. static readonly ROTATE_ROW: number;
  107806. /**
  107807. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  107808. */
  107809. static readonly FLIP_N_ROTATE_TILE: number;
  107810. /**
  107811. * Mesh pattern setting : rotate pattern and rotate
  107812. */
  107813. static readonly FLIP_N_ROTATE_ROW: number;
  107814. /**
  107815. * Mesh tile positioning : part tiles same on left/right or top/bottom
  107816. */
  107817. static readonly CENTER: number;
  107818. /**
  107819. * Mesh tile positioning : part tiles on left
  107820. */
  107821. static readonly LEFT: number;
  107822. /**
  107823. * Mesh tile positioning : part tiles on right
  107824. */
  107825. static readonly RIGHT: number;
  107826. /**
  107827. * Mesh tile positioning : part tiles on top
  107828. */
  107829. static readonly TOP: number;
  107830. /**
  107831. * Mesh tile positioning : part tiles on bottom
  107832. */
  107833. static readonly BOTTOM: number;
  107834. /**
  107835. * Gets the default side orientation.
  107836. * @param orientation the orientation to value to attempt to get
  107837. * @returns the default orientation
  107838. * @hidden
  107839. */
  107840. static _GetDefaultSideOrientation(orientation?: number): number;
  107841. private _internalMeshDataInfo;
  107842. get computeBonesUsingShaders(): boolean;
  107843. set computeBonesUsingShaders(value: boolean);
  107844. /**
  107845. * An event triggered before rendering the mesh
  107846. */
  107847. get onBeforeRenderObservable(): Observable<Mesh>;
  107848. /**
  107849. * An event triggered before binding the mesh
  107850. */
  107851. get onBeforeBindObservable(): Observable<Mesh>;
  107852. /**
  107853. * An event triggered after rendering the mesh
  107854. */
  107855. get onAfterRenderObservable(): Observable<Mesh>;
  107856. /**
  107857. * An event triggered before drawing the mesh
  107858. */
  107859. get onBeforeDrawObservable(): Observable<Mesh>;
  107860. private _onBeforeDrawObserver;
  107861. /**
  107862. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  107863. */
  107864. set onBeforeDraw(callback: () => void);
  107865. get hasInstances(): boolean;
  107866. get hasThinInstances(): boolean;
  107867. /**
  107868. * Gets the delay loading state of the mesh (when delay loading is turned on)
  107869. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  107870. */
  107871. delayLoadState: number;
  107872. /**
  107873. * Gets the list of instances created from this mesh
  107874. * it is not supposed to be modified manually.
  107875. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  107876. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107877. */
  107878. instances: InstancedMesh[];
  107879. /**
  107880. * Gets the file containing delay loading data for this mesh
  107881. */
  107882. delayLoadingFile: string;
  107883. /** @hidden */
  107884. _binaryInfo: any;
  107885. /**
  107886. * User defined function used to change how LOD level selection is done
  107887. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107888. */
  107889. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  107890. /**
  107891. * Gets or sets the morph target manager
  107892. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107893. */
  107894. get morphTargetManager(): Nullable<MorphTargetManager>;
  107895. set morphTargetManager(value: Nullable<MorphTargetManager>);
  107896. /** @hidden */
  107897. _creationDataStorage: Nullable<_CreationDataStorage>;
  107898. /** @hidden */
  107899. _geometry: Nullable<Geometry>;
  107900. /** @hidden */
  107901. _delayInfo: Array<string>;
  107902. /** @hidden */
  107903. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  107904. /** @hidden */
  107905. _instanceDataStorage: _InstanceDataStorage;
  107906. /** @hidden */
  107907. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  107908. private _effectiveMaterial;
  107909. /** @hidden */
  107910. _shouldGenerateFlatShading: boolean;
  107911. /** @hidden */
  107912. _originalBuilderSideOrientation: number;
  107913. /**
  107914. * Use this property to change the original side orientation defined at construction time
  107915. */
  107916. overrideMaterialSideOrientation: Nullable<number>;
  107917. /**
  107918. * Gets the source mesh (the one used to clone this one from)
  107919. */
  107920. get source(): Nullable<Mesh>;
  107921. /**
  107922. * Gets the list of clones of this mesh
  107923. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  107924. * Note that useClonedMeshMap=true is the default setting
  107925. */
  107926. get cloneMeshMap(): Nullable<{
  107927. [id: string]: Mesh | undefined;
  107928. }>;
  107929. /**
  107930. * Gets or sets a boolean indicating that this mesh does not use index buffer
  107931. */
  107932. get isUnIndexed(): boolean;
  107933. set isUnIndexed(value: boolean);
  107934. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  107935. get worldMatrixInstancedBuffer(): Float32Array;
  107936. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  107937. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  107938. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  107939. /**
  107940. * @constructor
  107941. * @param name The value used by scene.getMeshByName() to do a lookup.
  107942. * @param scene The scene to add this mesh to.
  107943. * @param parent The parent of this mesh, if it has one
  107944. * @param source An optional Mesh from which geometry is shared, cloned.
  107945. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  107946. * When false, achieved by calling a clone(), also passing False.
  107947. * This will make creation of children, recursive.
  107948. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  107949. */
  107950. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  107951. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  107952. doNotInstantiate: boolean;
  107953. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  107954. /**
  107955. * Gets the class name
  107956. * @returns the string "Mesh".
  107957. */
  107958. getClassName(): string;
  107959. /** @hidden */
  107960. get _isMesh(): boolean;
  107961. /**
  107962. * Returns a description of this mesh
  107963. * @param fullDetails define if full details about this mesh must be used
  107964. * @returns a descriptive string representing this mesh
  107965. */
  107966. toString(fullDetails?: boolean): string;
  107967. /** @hidden */
  107968. _unBindEffect(): void;
  107969. /**
  107970. * Gets a boolean indicating if this mesh has LOD
  107971. */
  107972. get hasLODLevels(): boolean;
  107973. /**
  107974. * Gets the list of MeshLODLevel associated with the current mesh
  107975. * @returns an array of MeshLODLevel
  107976. */
  107977. getLODLevels(): MeshLODLevel[];
  107978. private _sortLODLevels;
  107979. /**
  107980. * Add a mesh as LOD level triggered at the given distance.
  107981. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107982. * @param distance The distance from the center of the object to show this level
  107983. * @param mesh The mesh to be added as LOD level (can be null)
  107984. * @return This mesh (for chaining)
  107985. */
  107986. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  107987. /**
  107988. * Returns the LOD level mesh at the passed distance or null if not found.
  107989. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107990. * @param distance The distance from the center of the object to show this level
  107991. * @returns a Mesh or `null`
  107992. */
  107993. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  107994. /**
  107995. * Remove a mesh from the LOD array
  107996. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107997. * @param mesh defines the mesh to be removed
  107998. * @return This mesh (for chaining)
  107999. */
  108000. removeLODLevel(mesh: Mesh): Mesh;
  108001. /**
  108002. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  108003. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108004. * @param camera defines the camera to use to compute distance
  108005. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  108006. * @return This mesh (for chaining)
  108007. */
  108008. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  108009. /**
  108010. * Gets the mesh internal Geometry object
  108011. */
  108012. get geometry(): Nullable<Geometry>;
  108013. /**
  108014. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  108015. * @returns the total number of vertices
  108016. */
  108017. getTotalVertices(): number;
  108018. /**
  108019. * Returns the content of an associated vertex buffer
  108020. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108021. * - VertexBuffer.PositionKind
  108022. * - VertexBuffer.UVKind
  108023. * - VertexBuffer.UV2Kind
  108024. * - VertexBuffer.UV3Kind
  108025. * - VertexBuffer.UV4Kind
  108026. * - VertexBuffer.UV5Kind
  108027. * - VertexBuffer.UV6Kind
  108028. * - VertexBuffer.ColorKind
  108029. * - VertexBuffer.MatricesIndicesKind
  108030. * - VertexBuffer.MatricesIndicesExtraKind
  108031. * - VertexBuffer.MatricesWeightsKind
  108032. * - VertexBuffer.MatricesWeightsExtraKind
  108033. * @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
  108034. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  108035. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  108036. */
  108037. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  108038. /**
  108039. * Returns the mesh VertexBuffer object from the requested `kind`
  108040. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108041. * - VertexBuffer.PositionKind
  108042. * - VertexBuffer.NormalKind
  108043. * - VertexBuffer.UVKind
  108044. * - VertexBuffer.UV2Kind
  108045. * - VertexBuffer.UV3Kind
  108046. * - VertexBuffer.UV4Kind
  108047. * - VertexBuffer.UV5Kind
  108048. * - VertexBuffer.UV6Kind
  108049. * - VertexBuffer.ColorKind
  108050. * - VertexBuffer.MatricesIndicesKind
  108051. * - VertexBuffer.MatricesIndicesExtraKind
  108052. * - VertexBuffer.MatricesWeightsKind
  108053. * - VertexBuffer.MatricesWeightsExtraKind
  108054. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  108055. */
  108056. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  108057. /**
  108058. * Tests if a specific vertex buffer is associated with this mesh
  108059. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108060. * - VertexBuffer.PositionKind
  108061. * - VertexBuffer.NormalKind
  108062. * - VertexBuffer.UVKind
  108063. * - VertexBuffer.UV2Kind
  108064. * - VertexBuffer.UV3Kind
  108065. * - VertexBuffer.UV4Kind
  108066. * - VertexBuffer.UV5Kind
  108067. * - VertexBuffer.UV6Kind
  108068. * - VertexBuffer.ColorKind
  108069. * - VertexBuffer.MatricesIndicesKind
  108070. * - VertexBuffer.MatricesIndicesExtraKind
  108071. * - VertexBuffer.MatricesWeightsKind
  108072. * - VertexBuffer.MatricesWeightsExtraKind
  108073. * @returns a boolean
  108074. */
  108075. isVerticesDataPresent(kind: string): boolean;
  108076. /**
  108077. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  108078. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108079. * - VertexBuffer.PositionKind
  108080. * - VertexBuffer.UVKind
  108081. * - VertexBuffer.UV2Kind
  108082. * - VertexBuffer.UV3Kind
  108083. * - VertexBuffer.UV4Kind
  108084. * - VertexBuffer.UV5Kind
  108085. * - VertexBuffer.UV6Kind
  108086. * - VertexBuffer.ColorKind
  108087. * - VertexBuffer.MatricesIndicesKind
  108088. * - VertexBuffer.MatricesIndicesExtraKind
  108089. * - VertexBuffer.MatricesWeightsKind
  108090. * - VertexBuffer.MatricesWeightsExtraKind
  108091. * @returns a boolean
  108092. */
  108093. isVertexBufferUpdatable(kind: string): boolean;
  108094. /**
  108095. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  108096. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108097. * - VertexBuffer.PositionKind
  108098. * - VertexBuffer.NormalKind
  108099. * - VertexBuffer.UVKind
  108100. * - VertexBuffer.UV2Kind
  108101. * - VertexBuffer.UV3Kind
  108102. * - VertexBuffer.UV4Kind
  108103. * - VertexBuffer.UV5Kind
  108104. * - VertexBuffer.UV6Kind
  108105. * - VertexBuffer.ColorKind
  108106. * - VertexBuffer.MatricesIndicesKind
  108107. * - VertexBuffer.MatricesIndicesExtraKind
  108108. * - VertexBuffer.MatricesWeightsKind
  108109. * - VertexBuffer.MatricesWeightsExtraKind
  108110. * @returns an array of strings
  108111. */
  108112. getVerticesDataKinds(): string[];
  108113. /**
  108114. * Returns a positive integer : the total number of indices in this mesh geometry.
  108115. * @returns the numner of indices or zero if the mesh has no geometry.
  108116. */
  108117. getTotalIndices(): number;
  108118. /**
  108119. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  108120. * @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.
  108121. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  108122. * @returns the indices array or an empty array if the mesh has no geometry
  108123. */
  108124. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  108125. get isBlocked(): boolean;
  108126. /**
  108127. * Determine if the current mesh is ready to be rendered
  108128. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  108129. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  108130. * @returns true if all associated assets are ready (material, textures, shaders)
  108131. */
  108132. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  108133. /**
  108134. * 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.
  108135. */
  108136. get areNormalsFrozen(): boolean;
  108137. /**
  108138. * 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.
  108139. * @returns the current mesh
  108140. */
  108141. freezeNormals(): Mesh;
  108142. /**
  108143. * 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
  108144. * @returns the current mesh
  108145. */
  108146. unfreezeNormals(): Mesh;
  108147. /**
  108148. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  108149. */
  108150. set overridenInstanceCount(count: number);
  108151. /** @hidden */
  108152. _preActivate(): Mesh;
  108153. /** @hidden */
  108154. _preActivateForIntermediateRendering(renderId: number): Mesh;
  108155. /** @hidden */
  108156. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  108157. protected _afterComputeWorldMatrix(): void;
  108158. /** @hidden */
  108159. _postActivate(): void;
  108160. /**
  108161. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  108162. * This means the mesh underlying bounding box and sphere are recomputed.
  108163. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  108164. * @returns the current mesh
  108165. */
  108166. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  108167. /** @hidden */
  108168. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  108169. /**
  108170. * This function will subdivide the mesh into multiple submeshes
  108171. * @param count defines the expected number of submeshes
  108172. */
  108173. subdivide(count: number): void;
  108174. /**
  108175. * Copy a FloatArray into a specific associated vertex buffer
  108176. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108177. * - VertexBuffer.PositionKind
  108178. * - VertexBuffer.UVKind
  108179. * - VertexBuffer.UV2Kind
  108180. * - VertexBuffer.UV3Kind
  108181. * - VertexBuffer.UV4Kind
  108182. * - VertexBuffer.UV5Kind
  108183. * - VertexBuffer.UV6Kind
  108184. * - VertexBuffer.ColorKind
  108185. * - VertexBuffer.MatricesIndicesKind
  108186. * - VertexBuffer.MatricesIndicesExtraKind
  108187. * - VertexBuffer.MatricesWeightsKind
  108188. * - VertexBuffer.MatricesWeightsExtraKind
  108189. * @param data defines the data source
  108190. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108191. * @param stride defines the data stride size (can be null)
  108192. * @returns the current mesh
  108193. */
  108194. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  108195. /**
  108196. * Delete a vertex buffer associated with this mesh
  108197. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  108198. * - VertexBuffer.PositionKind
  108199. * - VertexBuffer.UVKind
  108200. * - VertexBuffer.UV2Kind
  108201. * - VertexBuffer.UV3Kind
  108202. * - VertexBuffer.UV4Kind
  108203. * - VertexBuffer.UV5Kind
  108204. * - VertexBuffer.UV6Kind
  108205. * - VertexBuffer.ColorKind
  108206. * - VertexBuffer.MatricesIndicesKind
  108207. * - VertexBuffer.MatricesIndicesExtraKind
  108208. * - VertexBuffer.MatricesWeightsKind
  108209. * - VertexBuffer.MatricesWeightsExtraKind
  108210. */
  108211. removeVerticesData(kind: string): void;
  108212. /**
  108213. * Flags an associated vertex buffer as updatable
  108214. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  108215. * - VertexBuffer.PositionKind
  108216. * - VertexBuffer.UVKind
  108217. * - VertexBuffer.UV2Kind
  108218. * - VertexBuffer.UV3Kind
  108219. * - VertexBuffer.UV4Kind
  108220. * - VertexBuffer.UV5Kind
  108221. * - VertexBuffer.UV6Kind
  108222. * - VertexBuffer.ColorKind
  108223. * - VertexBuffer.MatricesIndicesKind
  108224. * - VertexBuffer.MatricesIndicesExtraKind
  108225. * - VertexBuffer.MatricesWeightsKind
  108226. * - VertexBuffer.MatricesWeightsExtraKind
  108227. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108228. */
  108229. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  108230. /**
  108231. * Sets the mesh global Vertex Buffer
  108232. * @param buffer defines the buffer to use
  108233. * @returns the current mesh
  108234. */
  108235. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  108236. /**
  108237. * Update a specific associated vertex buffer
  108238. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108239. * - VertexBuffer.PositionKind
  108240. * - VertexBuffer.UVKind
  108241. * - VertexBuffer.UV2Kind
  108242. * - VertexBuffer.UV3Kind
  108243. * - VertexBuffer.UV4Kind
  108244. * - VertexBuffer.UV5Kind
  108245. * - VertexBuffer.UV6Kind
  108246. * - VertexBuffer.ColorKind
  108247. * - VertexBuffer.MatricesIndicesKind
  108248. * - VertexBuffer.MatricesIndicesExtraKind
  108249. * - VertexBuffer.MatricesWeightsKind
  108250. * - VertexBuffer.MatricesWeightsExtraKind
  108251. * @param data defines the data source
  108252. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  108253. * @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)
  108254. * @returns the current mesh
  108255. */
  108256. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  108257. /**
  108258. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  108259. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  108260. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  108261. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  108262. * @returns the current mesh
  108263. */
  108264. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  108265. /**
  108266. * Creates a un-shared specific occurence of the geometry for the mesh.
  108267. * @returns the current mesh
  108268. */
  108269. makeGeometryUnique(): Mesh;
  108270. /**
  108271. * Set the index buffer of this mesh
  108272. * @param indices defines the source data
  108273. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  108274. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  108275. * @returns the current mesh
  108276. */
  108277. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  108278. /**
  108279. * Update the current index buffer
  108280. * @param indices defines the source data
  108281. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  108282. * @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)
  108283. * @returns the current mesh
  108284. */
  108285. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  108286. /**
  108287. * Invert the geometry to move from a right handed system to a left handed one.
  108288. * @returns the current mesh
  108289. */
  108290. toLeftHanded(): Mesh;
  108291. /** @hidden */
  108292. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  108293. /** @hidden */
  108294. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  108295. /**
  108296. * Registers for this mesh a javascript function called just before the rendering process
  108297. * @param func defines the function to call before rendering this mesh
  108298. * @returns the current mesh
  108299. */
  108300. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108301. /**
  108302. * Disposes a previously registered javascript function called before the rendering
  108303. * @param func defines the function to remove
  108304. * @returns the current mesh
  108305. */
  108306. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108307. /**
  108308. * Registers for this mesh a javascript function called just after the rendering is complete
  108309. * @param func defines the function to call after rendering this mesh
  108310. * @returns the current mesh
  108311. */
  108312. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108313. /**
  108314. * Disposes a previously registered javascript function called after the rendering.
  108315. * @param func defines the function to remove
  108316. * @returns the current mesh
  108317. */
  108318. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108319. /** @hidden */
  108320. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  108321. /** @hidden */
  108322. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  108323. /** @hidden */
  108324. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  108325. /** @hidden */
  108326. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  108327. /** @hidden */
  108328. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  108329. /** @hidden */
  108330. _rebuild(): void;
  108331. /** @hidden */
  108332. _freeze(): void;
  108333. /** @hidden */
  108334. _unFreeze(): void;
  108335. /**
  108336. * 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
  108337. * @param subMesh defines the subMesh to render
  108338. * @param enableAlphaMode defines if alpha mode can be changed
  108339. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  108340. * @returns the current mesh
  108341. */
  108342. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  108343. private _onBeforeDraw;
  108344. /**
  108345. * Renormalize the mesh and patch it up if there are no weights
  108346. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  108347. * However in the case of zero weights then we set just a single influence to 1.
  108348. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  108349. */
  108350. cleanMatrixWeights(): void;
  108351. private normalizeSkinFourWeights;
  108352. private normalizeSkinWeightsAndExtra;
  108353. /**
  108354. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  108355. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  108356. * the user know there was an issue with importing the mesh
  108357. * @returns a validation object with skinned, valid and report string
  108358. */
  108359. validateSkinning(): {
  108360. skinned: boolean;
  108361. valid: boolean;
  108362. report: string;
  108363. };
  108364. /** @hidden */
  108365. _checkDelayState(): Mesh;
  108366. private _queueLoad;
  108367. /**
  108368. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  108369. * A mesh is in the frustum if its bounding box intersects the frustum
  108370. * @param frustumPlanes defines the frustum to test
  108371. * @returns true if the mesh is in the frustum planes
  108372. */
  108373. isInFrustum(frustumPlanes: Plane[]): boolean;
  108374. /**
  108375. * Sets the mesh material by the material or multiMaterial `id` property
  108376. * @param id is a string identifying the material or the multiMaterial
  108377. * @returns the current mesh
  108378. */
  108379. setMaterialByID(id: string): Mesh;
  108380. /**
  108381. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  108382. * @returns an array of IAnimatable
  108383. */
  108384. getAnimatables(): IAnimatable[];
  108385. /**
  108386. * Modifies the mesh geometry according to the passed transformation matrix.
  108387. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  108388. * The mesh normals are modified using the same transformation.
  108389. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108390. * @param transform defines the transform matrix to use
  108391. * @see https://doc.babylonjs.com/resources/baking_transformations
  108392. * @returns the current mesh
  108393. */
  108394. bakeTransformIntoVertices(transform: Matrix): Mesh;
  108395. /**
  108396. * Modifies the mesh geometry according to its own current World Matrix.
  108397. * The mesh World Matrix is then reset.
  108398. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  108399. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108400. * @see https://doc.babylonjs.com/resources/baking_transformations
  108401. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  108402. * @returns the current mesh
  108403. */
  108404. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  108405. /** @hidden */
  108406. get _positions(): Nullable<Vector3[]>;
  108407. /** @hidden */
  108408. _resetPointsArrayCache(): Mesh;
  108409. /** @hidden */
  108410. _generatePointsArray(): boolean;
  108411. /**
  108412. * Returns a new Mesh object generated from the current mesh properties.
  108413. * This method must not get confused with createInstance()
  108414. * @param name is a string, the name given to the new mesh
  108415. * @param newParent can be any Node object (default `null`)
  108416. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  108417. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  108418. * @returns a new mesh
  108419. */
  108420. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  108421. /**
  108422. * Releases resources associated with this mesh.
  108423. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108424. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108425. */
  108426. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108427. /** @hidden */
  108428. _disposeInstanceSpecificData(): void;
  108429. /** @hidden */
  108430. _disposeThinInstanceSpecificData(): void;
  108431. /**
  108432. * Modifies the mesh geometry according to a displacement map.
  108433. * 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.
  108434. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108435. * @param url is a string, the URL from the image file is to be downloaded.
  108436. * @param minHeight is the lower limit of the displacement.
  108437. * @param maxHeight is the upper limit of the displacement.
  108438. * @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.
  108439. * @param uvOffset is an optional vector2 used to offset UV.
  108440. * @param uvScale is an optional vector2 used to scale UV.
  108441. * @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.
  108442. * @returns the Mesh.
  108443. */
  108444. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108445. /**
  108446. * Modifies the mesh geometry according to a displacementMap buffer.
  108447. * 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.
  108448. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108449. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  108450. * @param heightMapWidth is the width of the buffer image.
  108451. * @param heightMapHeight is the height of the buffer image.
  108452. * @param minHeight is the lower limit of the displacement.
  108453. * @param maxHeight is the upper limit of the displacement.
  108454. * @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.
  108455. * @param uvOffset is an optional vector2 used to offset UV.
  108456. * @param uvScale is an optional vector2 used to scale UV.
  108457. * @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.
  108458. * @returns the Mesh.
  108459. */
  108460. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108461. /**
  108462. * Modify the mesh to get a flat shading rendering.
  108463. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  108464. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  108465. * @returns current mesh
  108466. */
  108467. convertToFlatShadedMesh(): Mesh;
  108468. /**
  108469. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  108470. * In other words, more vertices, no more indices and a single bigger VBO.
  108471. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  108472. * @returns current mesh
  108473. */
  108474. convertToUnIndexedMesh(): Mesh;
  108475. /**
  108476. * Inverses facet orientations.
  108477. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108478. * @param flipNormals will also inverts the normals
  108479. * @returns current mesh
  108480. */
  108481. flipFaces(flipNormals?: boolean): Mesh;
  108482. /**
  108483. * Increase the number of facets and hence vertices in a mesh
  108484. * Vertex normals are interpolated from existing vertex normals
  108485. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108486. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  108487. */
  108488. increaseVertices(numberPerEdge: number): void;
  108489. /**
  108490. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  108491. * This will undo any application of covertToFlatShadedMesh
  108492. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108493. */
  108494. forceSharedVertices(): void;
  108495. /** @hidden */
  108496. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  108497. /** @hidden */
  108498. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  108499. /**
  108500. * Creates a new InstancedMesh object from the mesh model.
  108501. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108502. * @param name defines the name of the new instance
  108503. * @returns a new InstancedMesh
  108504. */
  108505. createInstance(name: string): InstancedMesh;
  108506. /**
  108507. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  108508. * After this call, all the mesh instances have the same submeshes than the current mesh.
  108509. * @returns the current mesh
  108510. */
  108511. synchronizeInstances(): Mesh;
  108512. /**
  108513. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  108514. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  108515. * This should be used together with the simplification to avoid disappearing triangles.
  108516. * @param successCallback an optional success callback to be called after the optimization finished.
  108517. * @returns the current mesh
  108518. */
  108519. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  108520. /**
  108521. * Serialize current mesh
  108522. * @param serializationObject defines the object which will receive the serialization data
  108523. */
  108524. serialize(serializationObject: any): void;
  108525. /** @hidden */
  108526. _syncGeometryWithMorphTargetManager(): void;
  108527. /** @hidden */
  108528. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  108529. /**
  108530. * Returns a new Mesh object parsed from the source provided.
  108531. * @param parsedMesh is the source
  108532. * @param scene defines the hosting scene
  108533. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  108534. * @returns a new Mesh
  108535. */
  108536. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  108537. /**
  108538. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  108539. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108540. * @param name defines the name of the mesh to create
  108541. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  108542. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  108543. * @param closePath creates a seam between the first and the last points of each path of the path array
  108544. * @param offset is taken in account only if the `pathArray` is containing a single path
  108545. * @param scene defines the hosting scene
  108546. * @param updatable defines if the mesh must be flagged as updatable
  108547. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108548. * @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)
  108549. * @returns a new Mesh
  108550. */
  108551. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108552. /**
  108553. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  108554. * @param name defines the name of the mesh to create
  108555. * @param radius sets the radius size (float) of the polygon (default 0.5)
  108556. * @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
  108557. * @param scene defines the hosting scene
  108558. * @param updatable defines if the mesh must be flagged as updatable
  108559. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108560. * @returns a new Mesh
  108561. */
  108562. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108563. /**
  108564. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  108565. * @param name defines the name of the mesh to create
  108566. * @param size sets the size (float) of each box side (default 1)
  108567. * @param scene defines the hosting scene
  108568. * @param updatable defines if the mesh must be flagged as updatable
  108569. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108570. * @returns a new Mesh
  108571. */
  108572. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108573. /**
  108574. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  108575. * @param name defines the name of the mesh to create
  108576. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108577. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108578. * @param scene defines the hosting scene
  108579. * @param updatable defines if the mesh must be flagged as updatable
  108580. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108581. * @returns a new Mesh
  108582. */
  108583. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108584. /**
  108585. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  108586. * @param name defines the name of the mesh to create
  108587. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108588. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108589. * @param scene defines the hosting scene
  108590. * @returns a new Mesh
  108591. */
  108592. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  108593. /**
  108594. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  108595. * @param name defines the name of the mesh to create
  108596. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  108597. * @param diameterTop set the top cap diameter (floats, default 1)
  108598. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  108599. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  108600. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  108601. * @param scene defines the hosting scene
  108602. * @param updatable defines if the mesh must be flagged as updatable
  108603. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108604. * @returns a new Mesh
  108605. */
  108606. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  108607. /**
  108608. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  108609. * @param name defines the name of the mesh to create
  108610. * @param diameter sets the diameter size (float) of the torus (default 1)
  108611. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  108612. * @param tessellation sets the number of torus sides (postive integer, default 16)
  108613. * @param scene defines the hosting scene
  108614. * @param updatable defines if the mesh must be flagged as updatable
  108615. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108616. * @returns a new Mesh
  108617. */
  108618. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108619. /**
  108620. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  108621. * @param name defines the name of the mesh to create
  108622. * @param radius sets the global radius size (float) of the torus knot (default 2)
  108623. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  108624. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  108625. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  108626. * @param p the number of windings on X axis (positive integers, default 2)
  108627. * @param q the number of windings on Y axis (positive integers, default 3)
  108628. * @param scene defines the hosting scene
  108629. * @param updatable defines if the mesh must be flagged as updatable
  108630. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108631. * @returns a new Mesh
  108632. */
  108633. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108634. /**
  108635. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  108636. * @param name defines the name of the mesh to create
  108637. * @param points is an array successive Vector3
  108638. * @param scene defines the hosting scene
  108639. * @param updatable defines if the mesh must be flagged as updatable
  108640. * @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).
  108641. * @returns a new Mesh
  108642. */
  108643. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  108644. /**
  108645. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  108646. * @param name defines the name of the mesh to create
  108647. * @param points is an array successive Vector3
  108648. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  108649. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108650. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  108651. * @param scene defines the hosting scene
  108652. * @param updatable defines if the mesh must be flagged as updatable
  108653. * @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)
  108654. * @returns a new Mesh
  108655. */
  108656. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  108657. /**
  108658. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  108659. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  108660. * 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.
  108661. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108662. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108663. * Remember you can only change the shape positions, not their number when updating a polygon.
  108664. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  108665. * @param name defines the name of the mesh to create
  108666. * @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
  108667. * @param scene defines the hosting scene
  108668. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108669. * @param updatable defines if the mesh must be flagged as updatable
  108670. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108671. * @param earcutInjection can be used to inject your own earcut reference
  108672. * @returns a new Mesh
  108673. */
  108674. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108675. /**
  108676. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  108677. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  108678. * @param name defines the name of the mesh to create
  108679. * @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
  108680. * @param depth defines the height of extrusion
  108681. * @param scene defines the hosting scene
  108682. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108683. * @param updatable defines if the mesh must be flagged as updatable
  108684. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108685. * @param earcutInjection can be used to inject your own earcut reference
  108686. * @returns a new Mesh
  108687. */
  108688. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108689. /**
  108690. * Creates an extruded shape mesh.
  108691. * 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
  108692. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108693. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108694. * @param name defines the name of the mesh to create
  108695. * @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
  108696. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108697. * @param scale is the value to scale the shape
  108698. * @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
  108699. * @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
  108700. * @param scene defines the hosting scene
  108701. * @param updatable defines if the mesh must be flagged as updatable
  108702. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108703. * @param 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)
  108704. * @returns a new Mesh
  108705. */
  108706. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108707. /**
  108708. * Creates an custom extruded shape mesh.
  108709. * The custom extrusion is a parametric shape.
  108710. * It has no predefined shape. Its final shape will depend on the input parameters.
  108711. * Please consider using the same method from the MeshBuilder class instead
  108712. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108713. * @param name defines the name of the mesh to create
  108714. * @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
  108715. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108716. * @param scaleFunction is a custom Javascript function called on each path point
  108717. * @param rotationFunction is a custom Javascript function called on each path point
  108718. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  108719. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  108720. * @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
  108721. * @param scene defines the hosting scene
  108722. * @param updatable defines if the mesh must be flagged as updatable
  108723. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108724. * @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)
  108725. * @returns a new Mesh
  108726. */
  108727. 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;
  108728. /**
  108729. * Creates lathe mesh.
  108730. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  108731. * Please consider using the same method from the MeshBuilder class instead
  108732. * @param name defines the name of the mesh to create
  108733. * @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
  108734. * @param radius is the radius value of the lathe
  108735. * @param tessellation is the side number of the lathe.
  108736. * @param scene defines the hosting scene
  108737. * @param updatable defines if the mesh must be flagged as updatable
  108738. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108739. * @returns a new Mesh
  108740. */
  108741. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108742. /**
  108743. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  108744. * @param name defines the name of the mesh to create
  108745. * @param size sets the size (float) of both sides of the plane at once (default 1)
  108746. * @param scene defines the hosting scene
  108747. * @param updatable defines if the mesh must be flagged as updatable
  108748. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108749. * @returns a new Mesh
  108750. */
  108751. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108752. /**
  108753. * Creates a ground mesh.
  108754. * Please consider using the same method from the MeshBuilder class instead
  108755. * @param name defines the name of the mesh to create
  108756. * @param width set the width of the ground
  108757. * @param height set the height of the ground
  108758. * @param subdivisions sets the number of subdivisions per side
  108759. * @param scene defines the hosting scene
  108760. * @param updatable defines if the mesh must be flagged as updatable
  108761. * @returns a new Mesh
  108762. */
  108763. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  108764. /**
  108765. * Creates a tiled ground mesh.
  108766. * Please consider using the same method from the MeshBuilder class instead
  108767. * @param name defines the name of the mesh to create
  108768. * @param xmin set the ground minimum X coordinate
  108769. * @param zmin set the ground minimum Y coordinate
  108770. * @param xmax set the ground maximum X coordinate
  108771. * @param zmax set the ground maximum Z coordinate
  108772. * @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
  108773. * @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
  108774. * @param scene defines the hosting scene
  108775. * @param updatable defines if the mesh must be flagged as updatable
  108776. * @returns a new Mesh
  108777. */
  108778. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  108779. w: number;
  108780. h: number;
  108781. }, precision: {
  108782. w: number;
  108783. h: number;
  108784. }, scene: Scene, updatable?: boolean): Mesh;
  108785. /**
  108786. * Creates a ground mesh from a height map.
  108787. * Please consider using the same method from the MeshBuilder class instead
  108788. * @see https://doc.babylonjs.com/babylon101/height_map
  108789. * @param name defines the name of the mesh to create
  108790. * @param url sets the URL of the height map image resource
  108791. * @param width set the ground width size
  108792. * @param height set the ground height size
  108793. * @param subdivisions sets the number of subdivision per side
  108794. * @param minHeight is the minimum altitude on the ground
  108795. * @param maxHeight is the maximum altitude on the ground
  108796. * @param scene defines the hosting scene
  108797. * @param updatable defines if the mesh must be flagged as updatable
  108798. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  108799. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108800. * @returns a new Mesh
  108801. */
  108802. 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;
  108803. /**
  108804. * Creates a tube mesh.
  108805. * The tube is a parametric shape.
  108806. * It has no predefined shape. Its final shape will depend on the input parameters.
  108807. * Please consider using the same method from the MeshBuilder class instead
  108808. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108809. * @param name defines the name of the mesh to create
  108810. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  108811. * @param radius sets the tube radius size
  108812. * @param tessellation is the number of sides on the tubular surface
  108813. * @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
  108814. * @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
  108815. * @param scene defines the hosting scene
  108816. * @param updatable defines if the mesh must be flagged as updatable
  108817. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108818. * @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)
  108819. * @returns a new Mesh
  108820. */
  108821. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  108822. (i: number, distance: number): number;
  108823. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108824. /**
  108825. * Creates a polyhedron mesh.
  108826. * Please consider using the same method from the MeshBuilder class instead.
  108827. * * 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
  108828. * * The parameter `size` (positive float, default 1) sets the polygon size
  108829. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108830. * * 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`
  108831. * * 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
  108832. * * 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)`)
  108833. * * 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
  108834. * * 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
  108835. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108836. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108837. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108838. * @param name defines the name of the mesh to create
  108839. * @param options defines the options used to create the mesh
  108840. * @param scene defines the hosting scene
  108841. * @returns a new Mesh
  108842. */
  108843. static CreatePolyhedron(name: string, options: {
  108844. type?: number;
  108845. size?: number;
  108846. sizeX?: number;
  108847. sizeY?: number;
  108848. sizeZ?: number;
  108849. custom?: any;
  108850. faceUV?: Vector4[];
  108851. faceColors?: Color4[];
  108852. updatable?: boolean;
  108853. sideOrientation?: number;
  108854. }, scene: Scene): Mesh;
  108855. /**
  108856. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  108857. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  108858. * * 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`)
  108859. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  108860. * * 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
  108861. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108862. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108863. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108864. * @param name defines the name of the mesh
  108865. * @param options defines the options used to create the mesh
  108866. * @param scene defines the hosting scene
  108867. * @returns a new Mesh
  108868. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  108869. */
  108870. static CreateIcoSphere(name: string, options: {
  108871. radius?: number;
  108872. flat?: boolean;
  108873. subdivisions?: number;
  108874. sideOrientation?: number;
  108875. updatable?: boolean;
  108876. }, scene: Scene): Mesh;
  108877. /**
  108878. * Creates a decal mesh.
  108879. * Please consider using the same method from the MeshBuilder class instead.
  108880. * A decal is a mesh usually applied as a model onto the surface of another mesh
  108881. * @param name defines the name of the mesh
  108882. * @param sourceMesh defines the mesh receiving the decal
  108883. * @param position sets the position of the decal in world coordinates
  108884. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  108885. * @param size sets the decal scaling
  108886. * @param angle sets the angle to rotate the decal
  108887. * @returns a new Mesh
  108888. */
  108889. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  108890. /**
  108891. * Prepare internal position array for software CPU skinning
  108892. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  108893. */
  108894. setPositionsForCPUSkinning(): Float32Array;
  108895. /**
  108896. * Prepare internal normal array for software CPU skinning
  108897. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  108898. */
  108899. setNormalsForCPUSkinning(): Float32Array;
  108900. /**
  108901. * Updates the vertex buffer by applying transformation from the bones
  108902. * @param skeleton defines the skeleton to apply to current mesh
  108903. * @returns the current mesh
  108904. */
  108905. applySkeleton(skeleton: Skeleton): Mesh;
  108906. /**
  108907. * 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
  108908. * @param meshes defines the list of meshes to scan
  108909. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  108910. */
  108911. static MinMax(meshes: AbstractMesh[]): {
  108912. min: Vector3;
  108913. max: Vector3;
  108914. };
  108915. /**
  108916. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  108917. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  108918. * @returns a vector3
  108919. */
  108920. static Center(meshesOrMinMaxVector: {
  108921. min: Vector3;
  108922. max: Vector3;
  108923. } | AbstractMesh[]): Vector3;
  108924. /**
  108925. * Merge the array of meshes into a single mesh for performance reasons.
  108926. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  108927. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  108928. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  108929. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  108930. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  108931. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  108932. * @returns a new mesh
  108933. */
  108934. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  108935. /** @hidden */
  108936. addInstance(instance: InstancedMesh): void;
  108937. /** @hidden */
  108938. removeInstance(instance: InstancedMesh): void;
  108939. }
  108940. }
  108941. declare module BABYLON {
  108942. /**
  108943. * This is the base class of all the camera used in the application.
  108944. * @see https://doc.babylonjs.com/features/cameras
  108945. */
  108946. export class Camera extends Node {
  108947. /** @hidden */
  108948. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  108949. /**
  108950. * This is the default projection mode used by the cameras.
  108951. * It helps recreating a feeling of perspective and better appreciate depth.
  108952. * This is the best way to simulate real life cameras.
  108953. */
  108954. static readonly PERSPECTIVE_CAMERA: number;
  108955. /**
  108956. * This helps creating camera with an orthographic mode.
  108957. * 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.
  108958. */
  108959. static readonly ORTHOGRAPHIC_CAMERA: number;
  108960. /**
  108961. * This is the default FOV mode for perspective cameras.
  108962. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  108963. */
  108964. static readonly FOVMODE_VERTICAL_FIXED: number;
  108965. /**
  108966. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  108967. */
  108968. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  108969. /**
  108970. * This specifies ther is no need for a camera rig.
  108971. * Basically only one eye is rendered corresponding to the camera.
  108972. */
  108973. static readonly RIG_MODE_NONE: number;
  108974. /**
  108975. * Simulates a camera Rig with one blue eye and one red eye.
  108976. * This can be use with 3d blue and red glasses.
  108977. */
  108978. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  108979. /**
  108980. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  108981. */
  108982. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  108983. /**
  108984. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  108985. */
  108986. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  108987. /**
  108988. * Defines that both eyes of the camera will be rendered over under each other.
  108989. */
  108990. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  108991. /**
  108992. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  108993. */
  108994. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  108995. /**
  108996. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  108997. */
  108998. static readonly RIG_MODE_VR: number;
  108999. /**
  109000. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  109001. */
  109002. static readonly RIG_MODE_WEBVR: number;
  109003. /**
  109004. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  109005. */
  109006. static readonly RIG_MODE_CUSTOM: number;
  109007. /**
  109008. * Defines if by default attaching controls should prevent the default javascript event to continue.
  109009. */
  109010. static ForceAttachControlToAlwaysPreventDefault: boolean;
  109011. /**
  109012. * Define the input manager associated with the camera.
  109013. */
  109014. inputs: CameraInputsManager<Camera>;
  109015. /** @hidden */
  109016. _position: Vector3;
  109017. /**
  109018. * Define the current local position of the camera in the scene
  109019. */
  109020. get position(): Vector3;
  109021. set position(newPosition: Vector3);
  109022. protected _upVector: Vector3;
  109023. /**
  109024. * The vector the camera should consider as up.
  109025. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  109026. */
  109027. set upVector(vec: Vector3);
  109028. get upVector(): Vector3;
  109029. /**
  109030. * Define the current limit on the left side for an orthographic camera
  109031. * In scene unit
  109032. */
  109033. orthoLeft: Nullable<number>;
  109034. /**
  109035. * Define the current limit on the right side for an orthographic camera
  109036. * In scene unit
  109037. */
  109038. orthoRight: Nullable<number>;
  109039. /**
  109040. * Define the current limit on the bottom side for an orthographic camera
  109041. * In scene unit
  109042. */
  109043. orthoBottom: Nullable<number>;
  109044. /**
  109045. * Define the current limit on the top side for an orthographic camera
  109046. * In scene unit
  109047. */
  109048. orthoTop: Nullable<number>;
  109049. /**
  109050. * Field Of View is set in Radians. (default is 0.8)
  109051. */
  109052. fov: number;
  109053. /**
  109054. * Define the minimum distance the camera can see from.
  109055. * This is important to note that the depth buffer are not infinite and the closer it starts
  109056. * the more your scene might encounter depth fighting issue.
  109057. */
  109058. minZ: number;
  109059. /**
  109060. * Define the maximum distance the camera can see to.
  109061. * This is important to note that the depth buffer are not infinite and the further it end
  109062. * the more your scene might encounter depth fighting issue.
  109063. */
  109064. maxZ: number;
  109065. /**
  109066. * Define the default inertia of the camera.
  109067. * This helps giving a smooth feeling to the camera movement.
  109068. */
  109069. inertia: number;
  109070. /**
  109071. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  109072. */
  109073. mode: number;
  109074. /**
  109075. * Define whether the camera is intermediate.
  109076. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  109077. */
  109078. isIntermediate: boolean;
  109079. /**
  109080. * Define the viewport of the camera.
  109081. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  109082. */
  109083. viewport: Viewport;
  109084. /**
  109085. * Restricts the camera to viewing objects with the same layerMask.
  109086. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  109087. */
  109088. layerMask: number;
  109089. /**
  109090. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  109091. */
  109092. fovMode: number;
  109093. /**
  109094. * Rig mode of the camera.
  109095. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  109096. * This is normally controlled byt the camera themselves as internal use.
  109097. */
  109098. cameraRigMode: number;
  109099. /**
  109100. * Defines the distance between both "eyes" in case of a RIG
  109101. */
  109102. interaxialDistance: number;
  109103. /**
  109104. * Defines if stereoscopic rendering is done side by side or over under.
  109105. */
  109106. isStereoscopicSideBySide: boolean;
  109107. /**
  109108. * 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
  109109. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  109110. * else in the scene. (Eg. security camera)
  109111. *
  109112. * 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)
  109113. */
  109114. customRenderTargets: RenderTargetTexture[];
  109115. /**
  109116. * When set, the camera will render to this render target instead of the default canvas
  109117. *
  109118. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  109119. */
  109120. outputRenderTarget: Nullable<RenderTargetTexture>;
  109121. /**
  109122. * Observable triggered when the camera view matrix has changed.
  109123. */
  109124. onViewMatrixChangedObservable: Observable<Camera>;
  109125. /**
  109126. * Observable triggered when the camera Projection matrix has changed.
  109127. */
  109128. onProjectionMatrixChangedObservable: Observable<Camera>;
  109129. /**
  109130. * Observable triggered when the inputs have been processed.
  109131. */
  109132. onAfterCheckInputsObservable: Observable<Camera>;
  109133. /**
  109134. * Observable triggered when reset has been called and applied to the camera.
  109135. */
  109136. onRestoreStateObservable: Observable<Camera>;
  109137. /**
  109138. * Is this camera a part of a rig system?
  109139. */
  109140. isRigCamera: boolean;
  109141. /**
  109142. * If isRigCamera set to true this will be set with the parent camera.
  109143. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  109144. */
  109145. rigParent?: Camera;
  109146. /** @hidden */
  109147. _cameraRigParams: any;
  109148. /** @hidden */
  109149. _rigCameras: Camera[];
  109150. /** @hidden */
  109151. _rigPostProcess: Nullable<PostProcess>;
  109152. protected _webvrViewMatrix: Matrix;
  109153. /** @hidden */
  109154. _skipRendering: boolean;
  109155. /** @hidden */
  109156. _projectionMatrix: Matrix;
  109157. /** @hidden */
  109158. _postProcesses: Nullable<PostProcess>[];
  109159. /** @hidden */
  109160. _activeMeshes: SmartArray<AbstractMesh>;
  109161. protected _globalPosition: Vector3;
  109162. /** @hidden */
  109163. _computedViewMatrix: Matrix;
  109164. private _doNotComputeProjectionMatrix;
  109165. private _transformMatrix;
  109166. private _frustumPlanes;
  109167. private _refreshFrustumPlanes;
  109168. private _storedFov;
  109169. private _stateStored;
  109170. /**
  109171. * Instantiates a new camera object.
  109172. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  109173. * @see https://doc.babylonjs.com/features/cameras
  109174. * @param name Defines the name of the camera in the scene
  109175. * @param position Defines the position of the camera
  109176. * @param scene Defines the scene the camera belongs too
  109177. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  109178. */
  109179. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  109180. /**
  109181. * Store current camera state (fov, position, etc..)
  109182. * @returns the camera
  109183. */
  109184. storeState(): Camera;
  109185. /**
  109186. * Restores the camera state values if it has been stored. You must call storeState() first
  109187. */
  109188. protected _restoreStateValues(): boolean;
  109189. /**
  109190. * Restored camera state. You must call storeState() first.
  109191. * @returns true if restored and false otherwise
  109192. */
  109193. restoreState(): boolean;
  109194. /**
  109195. * Gets the class name of the camera.
  109196. * @returns the class name
  109197. */
  109198. getClassName(): string;
  109199. /** @hidden */
  109200. readonly _isCamera: boolean;
  109201. /**
  109202. * Gets a string representation of the camera useful for debug purpose.
  109203. * @param fullDetails Defines that a more verboe level of logging is required
  109204. * @returns the string representation
  109205. */
  109206. toString(fullDetails?: boolean): string;
  109207. /**
  109208. * Gets the current world space position of the camera.
  109209. */
  109210. get globalPosition(): Vector3;
  109211. /**
  109212. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  109213. * @returns the active meshe list
  109214. */
  109215. getActiveMeshes(): SmartArray<AbstractMesh>;
  109216. /**
  109217. * Check whether a mesh is part of the current active mesh list of the camera
  109218. * @param mesh Defines the mesh to check
  109219. * @returns true if active, false otherwise
  109220. */
  109221. isActiveMesh(mesh: Mesh): boolean;
  109222. /**
  109223. * Is this camera ready to be used/rendered
  109224. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  109225. * @return true if the camera is ready
  109226. */
  109227. isReady(completeCheck?: boolean): boolean;
  109228. /** @hidden */
  109229. _initCache(): void;
  109230. /** @hidden */
  109231. _updateCache(ignoreParentClass?: boolean): void;
  109232. /** @hidden */
  109233. _isSynchronized(): boolean;
  109234. /** @hidden */
  109235. _isSynchronizedViewMatrix(): boolean;
  109236. /** @hidden */
  109237. _isSynchronizedProjectionMatrix(): boolean;
  109238. /**
  109239. * Attach the input controls to a specific dom element to get the input from.
  109240. * @param element Defines the element the controls should be listened from
  109241. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  109242. */
  109243. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  109244. /**
  109245. * Detach the current controls from the specified dom element.
  109246. * @param element Defines the element to stop listening the inputs from
  109247. */
  109248. detachControl(element: HTMLElement): void;
  109249. /**
  109250. * Update the camera state according to the different inputs gathered during the frame.
  109251. */
  109252. update(): void;
  109253. /** @hidden */
  109254. _checkInputs(): void;
  109255. /** @hidden */
  109256. get rigCameras(): Camera[];
  109257. /**
  109258. * Gets the post process used by the rig cameras
  109259. */
  109260. get rigPostProcess(): Nullable<PostProcess>;
  109261. /**
  109262. * Internal, gets the first post proces.
  109263. * @returns the first post process to be run on this camera.
  109264. */
  109265. _getFirstPostProcess(): Nullable<PostProcess>;
  109266. private _cascadePostProcessesToRigCams;
  109267. /**
  109268. * Attach a post process to the camera.
  109269. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109270. * @param postProcess The post process to attach to the camera
  109271. * @param insertAt The position of the post process in case several of them are in use in the scene
  109272. * @returns the position the post process has been inserted at
  109273. */
  109274. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  109275. /**
  109276. * Detach a post process to the camera.
  109277. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109278. * @param postProcess The post process to detach from the camera
  109279. */
  109280. detachPostProcess(postProcess: PostProcess): void;
  109281. /**
  109282. * Gets the current world matrix of the camera
  109283. */
  109284. getWorldMatrix(): Matrix;
  109285. /** @hidden */
  109286. _getViewMatrix(): Matrix;
  109287. /**
  109288. * Gets the current view matrix of the camera.
  109289. * @param force forces the camera to recompute the matrix without looking at the cached state
  109290. * @returns the view matrix
  109291. */
  109292. getViewMatrix(force?: boolean): Matrix;
  109293. /**
  109294. * Freeze the projection matrix.
  109295. * It will prevent the cache check of the camera projection compute and can speed up perf
  109296. * if no parameter of the camera are meant to change
  109297. * @param projection Defines manually a projection if necessary
  109298. */
  109299. freezeProjectionMatrix(projection?: Matrix): void;
  109300. /**
  109301. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  109302. */
  109303. unfreezeProjectionMatrix(): void;
  109304. /**
  109305. * Gets the current projection matrix of the camera.
  109306. * @param force forces the camera to recompute the matrix without looking at the cached state
  109307. * @returns the projection matrix
  109308. */
  109309. getProjectionMatrix(force?: boolean): Matrix;
  109310. /**
  109311. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  109312. * @returns a Matrix
  109313. */
  109314. getTransformationMatrix(): Matrix;
  109315. private _updateFrustumPlanes;
  109316. /**
  109317. * Checks if a cullable object (mesh...) is in the camera frustum
  109318. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  109319. * @param target The object to check
  109320. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  109321. * @returns true if the object is in frustum otherwise false
  109322. */
  109323. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  109324. /**
  109325. * Checks if a cullable object (mesh...) is in the camera frustum
  109326. * Unlike isInFrustum this cheks the full bounding box
  109327. * @param target The object to check
  109328. * @returns true if the object is in frustum otherwise false
  109329. */
  109330. isCompletelyInFrustum(target: ICullable): boolean;
  109331. /**
  109332. * Gets a ray in the forward direction from the camera.
  109333. * @param length Defines the length of the ray to create
  109334. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109335. * @param origin Defines the start point of the ray which defaults to the camera position
  109336. * @returns the forward ray
  109337. */
  109338. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109339. /**
  109340. * Gets a ray in the forward direction from the camera.
  109341. * @param refRay the ray to (re)use when setting the values
  109342. * @param length Defines the length of the ray to create
  109343. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109344. * @param origin Defines the start point of the ray which defaults to the camera position
  109345. * @returns the forward ray
  109346. */
  109347. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109348. /**
  109349. * Releases resources associated with this node.
  109350. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109351. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109352. */
  109353. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109354. /** @hidden */
  109355. _isLeftCamera: boolean;
  109356. /**
  109357. * Gets the left camera of a rig setup in case of Rigged Camera
  109358. */
  109359. get isLeftCamera(): boolean;
  109360. /** @hidden */
  109361. _isRightCamera: boolean;
  109362. /**
  109363. * Gets the right camera of a rig setup in case of Rigged Camera
  109364. */
  109365. get isRightCamera(): boolean;
  109366. /**
  109367. * Gets the left camera of a rig setup in case of Rigged Camera
  109368. */
  109369. get leftCamera(): Nullable<FreeCamera>;
  109370. /**
  109371. * Gets the right camera of a rig setup in case of Rigged Camera
  109372. */
  109373. get rightCamera(): Nullable<FreeCamera>;
  109374. /**
  109375. * Gets the left camera target of a rig setup in case of Rigged Camera
  109376. * @returns the target position
  109377. */
  109378. getLeftTarget(): Nullable<Vector3>;
  109379. /**
  109380. * Gets the right camera target of a rig setup in case of Rigged Camera
  109381. * @returns the target position
  109382. */
  109383. getRightTarget(): Nullable<Vector3>;
  109384. /**
  109385. * @hidden
  109386. */
  109387. setCameraRigMode(mode: number, rigParams: any): void;
  109388. /** @hidden */
  109389. static _setStereoscopicRigMode(camera: Camera): void;
  109390. /** @hidden */
  109391. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  109392. /** @hidden */
  109393. static _setVRRigMode(camera: Camera, rigParams: any): void;
  109394. /** @hidden */
  109395. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  109396. /** @hidden */
  109397. _getVRProjectionMatrix(): Matrix;
  109398. protected _updateCameraRotationMatrix(): void;
  109399. protected _updateWebVRCameraRotationMatrix(): void;
  109400. /**
  109401. * This function MUST be overwritten by the different WebVR cameras available.
  109402. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109403. * @hidden
  109404. */
  109405. _getWebVRProjectionMatrix(): Matrix;
  109406. /**
  109407. * This function MUST be overwritten by the different WebVR cameras available.
  109408. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109409. * @hidden
  109410. */
  109411. _getWebVRViewMatrix(): Matrix;
  109412. /** @hidden */
  109413. setCameraRigParameter(name: string, value: any): void;
  109414. /**
  109415. * needs to be overridden by children so sub has required properties to be copied
  109416. * @hidden
  109417. */
  109418. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  109419. /**
  109420. * May need to be overridden by children
  109421. * @hidden
  109422. */
  109423. _updateRigCameras(): void;
  109424. /** @hidden */
  109425. _setupInputs(): void;
  109426. /**
  109427. * Serialiaze the camera setup to a json represention
  109428. * @returns the JSON representation
  109429. */
  109430. serialize(): any;
  109431. /**
  109432. * Clones the current camera.
  109433. * @param name The cloned camera name
  109434. * @returns the cloned camera
  109435. */
  109436. clone(name: string): Camera;
  109437. /**
  109438. * Gets the direction of the camera relative to a given local axis.
  109439. * @param localAxis Defines the reference axis to provide a relative direction.
  109440. * @return the direction
  109441. */
  109442. getDirection(localAxis: Vector3): Vector3;
  109443. /**
  109444. * Returns the current camera absolute rotation
  109445. */
  109446. get absoluteRotation(): Quaternion;
  109447. /**
  109448. * Gets the direction of the camera relative to a given local axis into a passed vector.
  109449. * @param localAxis Defines the reference axis to provide a relative direction.
  109450. * @param result Defines the vector to store the result in
  109451. */
  109452. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  109453. /**
  109454. * Gets a camera constructor for a given camera type
  109455. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  109456. * @param name The name of the camera the result will be able to instantiate
  109457. * @param scene The scene the result will construct the camera in
  109458. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  109459. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  109460. * @returns a factory method to construc the camera
  109461. */
  109462. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  109463. /**
  109464. * Compute the world matrix of the camera.
  109465. * @returns the camera world matrix
  109466. */
  109467. computeWorldMatrix(): Matrix;
  109468. /**
  109469. * Parse a JSON and creates the camera from the parsed information
  109470. * @param parsedCamera The JSON to parse
  109471. * @param scene The scene to instantiate the camera in
  109472. * @returns the newly constructed camera
  109473. */
  109474. static Parse(parsedCamera: any, scene: Scene): Camera;
  109475. }
  109476. }
  109477. declare module BABYLON {
  109478. /**
  109479. * Class containing static functions to help procedurally build meshes
  109480. */
  109481. export class DiscBuilder {
  109482. /**
  109483. * Creates a plane polygonal mesh. By default, this is a disc
  109484. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  109485. * * 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
  109486. * * 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
  109487. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109488. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109489. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109490. * @param name defines the name of the mesh
  109491. * @param options defines the options used to create the mesh
  109492. * @param scene defines the hosting scene
  109493. * @returns the plane polygonal mesh
  109494. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  109495. */
  109496. static CreateDisc(name: string, options: {
  109497. radius?: number;
  109498. tessellation?: number;
  109499. arc?: number;
  109500. updatable?: boolean;
  109501. sideOrientation?: number;
  109502. frontUVs?: Vector4;
  109503. backUVs?: Vector4;
  109504. }, scene?: Nullable<Scene>): Mesh;
  109505. }
  109506. }
  109507. declare module BABYLON {
  109508. /**
  109509. * Options to be used when creating a FresnelParameters.
  109510. */
  109511. export type IFresnelParametersCreationOptions = {
  109512. /**
  109513. * Define the color used on edges (grazing angle)
  109514. */
  109515. leftColor?: Color3;
  109516. /**
  109517. * Define the color used on center
  109518. */
  109519. rightColor?: Color3;
  109520. /**
  109521. * Define bias applied to computed fresnel term
  109522. */
  109523. bias?: number;
  109524. /**
  109525. * Defined the power exponent applied to fresnel term
  109526. */
  109527. power?: number;
  109528. /**
  109529. * Define if the fresnel effect is enable or not.
  109530. */
  109531. isEnabled?: boolean;
  109532. };
  109533. /**
  109534. * Serialized format for FresnelParameters.
  109535. */
  109536. export type IFresnelParametersSerialized = {
  109537. /**
  109538. * Define the color used on edges (grazing angle) [as an array]
  109539. */
  109540. leftColor: number[];
  109541. /**
  109542. * Define the color used on center [as an array]
  109543. */
  109544. rightColor: number[];
  109545. /**
  109546. * Define bias applied to computed fresnel term
  109547. */
  109548. bias: number;
  109549. /**
  109550. * Defined the power exponent applied to fresnel term
  109551. */
  109552. power?: number;
  109553. /**
  109554. * Define if the fresnel effect is enable or not.
  109555. */
  109556. isEnabled: boolean;
  109557. };
  109558. /**
  109559. * This represents all the required information to add a fresnel effect on a material:
  109560. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109561. */
  109562. export class FresnelParameters {
  109563. private _isEnabled;
  109564. /**
  109565. * Define if the fresnel effect is enable or not.
  109566. */
  109567. get isEnabled(): boolean;
  109568. set isEnabled(value: boolean);
  109569. /**
  109570. * Define the color used on edges (grazing angle)
  109571. */
  109572. leftColor: Color3;
  109573. /**
  109574. * Define the color used on center
  109575. */
  109576. rightColor: Color3;
  109577. /**
  109578. * Define bias applied to computed fresnel term
  109579. */
  109580. bias: number;
  109581. /**
  109582. * Defined the power exponent applied to fresnel term
  109583. */
  109584. power: number;
  109585. /**
  109586. * Creates a new FresnelParameters object.
  109587. *
  109588. * @param options provide your own settings to optionally to override defaults
  109589. */
  109590. constructor(options?: IFresnelParametersCreationOptions);
  109591. /**
  109592. * Clones the current fresnel and its valuues
  109593. * @returns a clone fresnel configuration
  109594. */
  109595. clone(): FresnelParameters;
  109596. /**
  109597. * Determines equality between FresnelParameters objects
  109598. * @param otherFresnelParameters defines the second operand
  109599. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  109600. */
  109601. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  109602. /**
  109603. * Serializes the current fresnel parameters to a JSON representation.
  109604. * @return the JSON serialization
  109605. */
  109606. serialize(): IFresnelParametersSerialized;
  109607. /**
  109608. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  109609. * @param parsedFresnelParameters Define the JSON representation
  109610. * @returns the parsed parameters
  109611. */
  109612. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  109613. }
  109614. }
  109615. declare module BABYLON {
  109616. /**
  109617. * This groups all the flags used to control the materials channel.
  109618. */
  109619. export class MaterialFlags {
  109620. private static _DiffuseTextureEnabled;
  109621. /**
  109622. * Are diffuse textures enabled in the application.
  109623. */
  109624. static get DiffuseTextureEnabled(): boolean;
  109625. static set DiffuseTextureEnabled(value: boolean);
  109626. private static _DetailTextureEnabled;
  109627. /**
  109628. * Are detail textures enabled in the application.
  109629. */
  109630. static get DetailTextureEnabled(): boolean;
  109631. static set DetailTextureEnabled(value: boolean);
  109632. private static _AmbientTextureEnabled;
  109633. /**
  109634. * Are ambient textures enabled in the application.
  109635. */
  109636. static get AmbientTextureEnabled(): boolean;
  109637. static set AmbientTextureEnabled(value: boolean);
  109638. private static _OpacityTextureEnabled;
  109639. /**
  109640. * Are opacity textures enabled in the application.
  109641. */
  109642. static get OpacityTextureEnabled(): boolean;
  109643. static set OpacityTextureEnabled(value: boolean);
  109644. private static _ReflectionTextureEnabled;
  109645. /**
  109646. * Are reflection textures enabled in the application.
  109647. */
  109648. static get ReflectionTextureEnabled(): boolean;
  109649. static set ReflectionTextureEnabled(value: boolean);
  109650. private static _EmissiveTextureEnabled;
  109651. /**
  109652. * Are emissive textures enabled in the application.
  109653. */
  109654. static get EmissiveTextureEnabled(): boolean;
  109655. static set EmissiveTextureEnabled(value: boolean);
  109656. private static _SpecularTextureEnabled;
  109657. /**
  109658. * Are specular textures enabled in the application.
  109659. */
  109660. static get SpecularTextureEnabled(): boolean;
  109661. static set SpecularTextureEnabled(value: boolean);
  109662. private static _BumpTextureEnabled;
  109663. /**
  109664. * Are bump textures enabled in the application.
  109665. */
  109666. static get BumpTextureEnabled(): boolean;
  109667. static set BumpTextureEnabled(value: boolean);
  109668. private static _LightmapTextureEnabled;
  109669. /**
  109670. * Are lightmap textures enabled in the application.
  109671. */
  109672. static get LightmapTextureEnabled(): boolean;
  109673. static set LightmapTextureEnabled(value: boolean);
  109674. private static _RefractionTextureEnabled;
  109675. /**
  109676. * Are refraction textures enabled in the application.
  109677. */
  109678. static get RefractionTextureEnabled(): boolean;
  109679. static set RefractionTextureEnabled(value: boolean);
  109680. private static _ColorGradingTextureEnabled;
  109681. /**
  109682. * Are color grading textures enabled in the application.
  109683. */
  109684. static get ColorGradingTextureEnabled(): boolean;
  109685. static set ColorGradingTextureEnabled(value: boolean);
  109686. private static _FresnelEnabled;
  109687. /**
  109688. * Are fresnels enabled in the application.
  109689. */
  109690. static get FresnelEnabled(): boolean;
  109691. static set FresnelEnabled(value: boolean);
  109692. private static _ClearCoatTextureEnabled;
  109693. /**
  109694. * Are clear coat textures enabled in the application.
  109695. */
  109696. static get ClearCoatTextureEnabled(): boolean;
  109697. static set ClearCoatTextureEnabled(value: boolean);
  109698. private static _ClearCoatBumpTextureEnabled;
  109699. /**
  109700. * Are clear coat bump textures enabled in the application.
  109701. */
  109702. static get ClearCoatBumpTextureEnabled(): boolean;
  109703. static set ClearCoatBumpTextureEnabled(value: boolean);
  109704. private static _ClearCoatTintTextureEnabled;
  109705. /**
  109706. * Are clear coat tint textures enabled in the application.
  109707. */
  109708. static get ClearCoatTintTextureEnabled(): boolean;
  109709. static set ClearCoatTintTextureEnabled(value: boolean);
  109710. private static _SheenTextureEnabled;
  109711. /**
  109712. * Are sheen textures enabled in the application.
  109713. */
  109714. static get SheenTextureEnabled(): boolean;
  109715. static set SheenTextureEnabled(value: boolean);
  109716. private static _AnisotropicTextureEnabled;
  109717. /**
  109718. * Are anisotropic textures enabled in the application.
  109719. */
  109720. static get AnisotropicTextureEnabled(): boolean;
  109721. static set AnisotropicTextureEnabled(value: boolean);
  109722. private static _ThicknessTextureEnabled;
  109723. /**
  109724. * Are thickness textures enabled in the application.
  109725. */
  109726. static get ThicknessTextureEnabled(): boolean;
  109727. static set ThicknessTextureEnabled(value: boolean);
  109728. }
  109729. }
  109730. declare module BABYLON {
  109731. /** @hidden */
  109732. export var defaultFragmentDeclaration: {
  109733. name: string;
  109734. shader: string;
  109735. };
  109736. }
  109737. declare module BABYLON {
  109738. /** @hidden */
  109739. export var defaultUboDeclaration: {
  109740. name: string;
  109741. shader: string;
  109742. };
  109743. }
  109744. declare module BABYLON {
  109745. /** @hidden */
  109746. export var prePassDeclaration: {
  109747. name: string;
  109748. shader: string;
  109749. };
  109750. }
  109751. declare module BABYLON {
  109752. /** @hidden */
  109753. export var lightFragmentDeclaration: {
  109754. name: string;
  109755. shader: string;
  109756. };
  109757. }
  109758. declare module BABYLON {
  109759. /** @hidden */
  109760. export var lightUboDeclaration: {
  109761. name: string;
  109762. shader: string;
  109763. };
  109764. }
  109765. declare module BABYLON {
  109766. /** @hidden */
  109767. export var lightsFragmentFunctions: {
  109768. name: string;
  109769. shader: string;
  109770. };
  109771. }
  109772. declare module BABYLON {
  109773. /** @hidden */
  109774. export var shadowsFragmentFunctions: {
  109775. name: string;
  109776. shader: string;
  109777. };
  109778. }
  109779. declare module BABYLON {
  109780. /** @hidden */
  109781. export var fresnelFunction: {
  109782. name: string;
  109783. shader: string;
  109784. };
  109785. }
  109786. declare module BABYLON {
  109787. /** @hidden */
  109788. export var bumpFragmentMainFunctions: {
  109789. name: string;
  109790. shader: string;
  109791. };
  109792. }
  109793. declare module BABYLON {
  109794. /** @hidden */
  109795. export var bumpFragmentFunctions: {
  109796. name: string;
  109797. shader: string;
  109798. };
  109799. }
  109800. declare module BABYLON {
  109801. /** @hidden */
  109802. export var logDepthDeclaration: {
  109803. name: string;
  109804. shader: string;
  109805. };
  109806. }
  109807. declare module BABYLON {
  109808. /** @hidden */
  109809. export var bumpFragment: {
  109810. name: string;
  109811. shader: string;
  109812. };
  109813. }
  109814. declare module BABYLON {
  109815. /** @hidden */
  109816. export var depthPrePass: {
  109817. name: string;
  109818. shader: string;
  109819. };
  109820. }
  109821. declare module BABYLON {
  109822. /** @hidden */
  109823. export var lightFragment: {
  109824. name: string;
  109825. shader: string;
  109826. };
  109827. }
  109828. declare module BABYLON {
  109829. /** @hidden */
  109830. export var logDepthFragment: {
  109831. name: string;
  109832. shader: string;
  109833. };
  109834. }
  109835. declare module BABYLON {
  109836. /** @hidden */
  109837. export var defaultPixelShader: {
  109838. name: string;
  109839. shader: string;
  109840. };
  109841. }
  109842. declare module BABYLON {
  109843. /** @hidden */
  109844. export var defaultVertexDeclaration: {
  109845. name: string;
  109846. shader: string;
  109847. };
  109848. }
  109849. declare module BABYLON {
  109850. /** @hidden */
  109851. export var bumpVertexDeclaration: {
  109852. name: string;
  109853. shader: string;
  109854. };
  109855. }
  109856. declare module BABYLON {
  109857. /** @hidden */
  109858. export var bumpVertex: {
  109859. name: string;
  109860. shader: string;
  109861. };
  109862. }
  109863. declare module BABYLON {
  109864. /** @hidden */
  109865. export var fogVertex: {
  109866. name: string;
  109867. shader: string;
  109868. };
  109869. }
  109870. declare module BABYLON {
  109871. /** @hidden */
  109872. export var shadowsVertex: {
  109873. name: string;
  109874. shader: string;
  109875. };
  109876. }
  109877. declare module BABYLON {
  109878. /** @hidden */
  109879. export var pointCloudVertex: {
  109880. name: string;
  109881. shader: string;
  109882. };
  109883. }
  109884. declare module BABYLON {
  109885. /** @hidden */
  109886. export var logDepthVertex: {
  109887. name: string;
  109888. shader: string;
  109889. };
  109890. }
  109891. declare module BABYLON {
  109892. /** @hidden */
  109893. export var defaultVertexShader: {
  109894. name: string;
  109895. shader: string;
  109896. };
  109897. }
  109898. declare module BABYLON {
  109899. /**
  109900. * @hidden
  109901. */
  109902. export interface IMaterialDetailMapDefines {
  109903. DETAIL: boolean;
  109904. DETAILDIRECTUV: number;
  109905. DETAIL_NORMALBLENDMETHOD: number;
  109906. /** @hidden */
  109907. _areTexturesDirty: boolean;
  109908. }
  109909. /**
  109910. * Define the code related to the detail map parameters of a material
  109911. *
  109912. * Inspired from:
  109913. * 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
  109914. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  109915. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  109916. */
  109917. export class DetailMapConfiguration {
  109918. private _texture;
  109919. /**
  109920. * The detail texture of the material.
  109921. */
  109922. texture: Nullable<BaseTexture>;
  109923. /**
  109924. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  109925. * Bigger values mean stronger blending
  109926. */
  109927. diffuseBlendLevel: number;
  109928. /**
  109929. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  109930. * Bigger values mean stronger blending. Only used with PBR materials
  109931. */
  109932. roughnessBlendLevel: number;
  109933. /**
  109934. * Defines how strong the bump effect from the detail map is
  109935. * Bigger values mean stronger effect
  109936. */
  109937. bumpLevel: number;
  109938. private _normalBlendMethod;
  109939. /**
  109940. * The method used to blend the bump and detail normals together
  109941. */
  109942. normalBlendMethod: number;
  109943. private _isEnabled;
  109944. /**
  109945. * Enable or disable the detail map on this material
  109946. */
  109947. isEnabled: boolean;
  109948. /** @hidden */
  109949. private _internalMarkAllSubMeshesAsTexturesDirty;
  109950. /** @hidden */
  109951. _markAllSubMeshesAsTexturesDirty(): void;
  109952. /**
  109953. * Instantiate a new detail map
  109954. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  109955. */
  109956. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  109957. /**
  109958. * Gets whether the submesh is ready to be used or not.
  109959. * @param defines the list of "defines" to update.
  109960. * @param scene defines the scene the material belongs to.
  109961. * @returns - boolean indicating that the submesh is ready or not.
  109962. */
  109963. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  109964. /**
  109965. * Update the defines for detail map usage
  109966. * @param defines the list of "defines" to update.
  109967. * @param scene defines the scene the material belongs to.
  109968. */
  109969. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  109970. /**
  109971. * Binds the material data.
  109972. * @param uniformBuffer defines the Uniform buffer to fill in.
  109973. * @param scene defines the scene the material belongs to.
  109974. * @param isFrozen defines whether the material is frozen or not.
  109975. */
  109976. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  109977. /**
  109978. * Checks to see if a texture is used in the material.
  109979. * @param texture - Base texture to use.
  109980. * @returns - Boolean specifying if a texture is used in the material.
  109981. */
  109982. hasTexture(texture: BaseTexture): boolean;
  109983. /**
  109984. * Returns an array of the actively used textures.
  109985. * @param activeTextures Array of BaseTextures
  109986. */
  109987. getActiveTextures(activeTextures: BaseTexture[]): void;
  109988. /**
  109989. * Returns the animatable textures.
  109990. * @param animatables Array of animatable textures.
  109991. */
  109992. getAnimatables(animatables: IAnimatable[]): void;
  109993. /**
  109994. * Disposes the resources of the material.
  109995. * @param forceDisposeTextures - Forces the disposal of all textures.
  109996. */
  109997. dispose(forceDisposeTextures?: boolean): void;
  109998. /**
  109999. * Get the current class name useful for serialization or dynamic coding.
  110000. * @returns "DetailMap"
  110001. */
  110002. getClassName(): string;
  110003. /**
  110004. * Add the required uniforms to the current list.
  110005. * @param uniforms defines the current uniform list.
  110006. */
  110007. static AddUniforms(uniforms: string[]): void;
  110008. /**
  110009. * Add the required samplers to the current list.
  110010. * @param samplers defines the current sampler list.
  110011. */
  110012. static AddSamplers(samplers: string[]): void;
  110013. /**
  110014. * Add the required uniforms to the current buffer.
  110015. * @param uniformBuffer defines the current uniform buffer.
  110016. */
  110017. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110018. /**
  110019. * Makes a duplicate of the current instance into another one.
  110020. * @param detailMap define the instance where to copy the info
  110021. */
  110022. copyTo(detailMap: DetailMapConfiguration): void;
  110023. /**
  110024. * Serializes this detail map instance
  110025. * @returns - An object with the serialized instance.
  110026. */
  110027. serialize(): any;
  110028. /**
  110029. * Parses a detail map setting from a serialized object.
  110030. * @param source - Serialized object.
  110031. * @param scene Defines the scene we are parsing for
  110032. * @param rootUrl Defines the rootUrl to load from
  110033. */
  110034. parse(source: any, scene: Scene, rootUrl: string): void;
  110035. }
  110036. }
  110037. declare module BABYLON {
  110038. /** @hidden */
  110039. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  110040. MAINUV1: boolean;
  110041. MAINUV2: boolean;
  110042. DIFFUSE: boolean;
  110043. DIFFUSEDIRECTUV: number;
  110044. DETAIL: boolean;
  110045. DETAILDIRECTUV: number;
  110046. DETAIL_NORMALBLENDMETHOD: number;
  110047. AMBIENT: boolean;
  110048. AMBIENTDIRECTUV: number;
  110049. OPACITY: boolean;
  110050. OPACITYDIRECTUV: number;
  110051. OPACITYRGB: boolean;
  110052. REFLECTION: boolean;
  110053. EMISSIVE: boolean;
  110054. EMISSIVEDIRECTUV: number;
  110055. SPECULAR: boolean;
  110056. SPECULARDIRECTUV: number;
  110057. BUMP: boolean;
  110058. BUMPDIRECTUV: number;
  110059. PARALLAX: boolean;
  110060. PARALLAXOCCLUSION: boolean;
  110061. SPECULAROVERALPHA: boolean;
  110062. CLIPPLANE: boolean;
  110063. CLIPPLANE2: boolean;
  110064. CLIPPLANE3: boolean;
  110065. CLIPPLANE4: boolean;
  110066. CLIPPLANE5: boolean;
  110067. CLIPPLANE6: boolean;
  110068. ALPHATEST: boolean;
  110069. DEPTHPREPASS: boolean;
  110070. ALPHAFROMDIFFUSE: boolean;
  110071. POINTSIZE: boolean;
  110072. FOG: boolean;
  110073. SPECULARTERM: boolean;
  110074. DIFFUSEFRESNEL: boolean;
  110075. OPACITYFRESNEL: boolean;
  110076. REFLECTIONFRESNEL: boolean;
  110077. REFRACTIONFRESNEL: boolean;
  110078. EMISSIVEFRESNEL: boolean;
  110079. FRESNEL: boolean;
  110080. NORMAL: boolean;
  110081. UV1: boolean;
  110082. UV2: boolean;
  110083. VERTEXCOLOR: boolean;
  110084. VERTEXALPHA: boolean;
  110085. NUM_BONE_INFLUENCERS: number;
  110086. BonesPerMesh: number;
  110087. BONETEXTURE: boolean;
  110088. INSTANCES: boolean;
  110089. THIN_INSTANCES: boolean;
  110090. GLOSSINESS: boolean;
  110091. ROUGHNESS: boolean;
  110092. EMISSIVEASILLUMINATION: boolean;
  110093. LINKEMISSIVEWITHDIFFUSE: boolean;
  110094. REFLECTIONFRESNELFROMSPECULAR: boolean;
  110095. LIGHTMAP: boolean;
  110096. LIGHTMAPDIRECTUV: number;
  110097. OBJECTSPACE_NORMALMAP: boolean;
  110098. USELIGHTMAPASSHADOWMAP: boolean;
  110099. REFLECTIONMAP_3D: boolean;
  110100. REFLECTIONMAP_SPHERICAL: boolean;
  110101. REFLECTIONMAP_PLANAR: boolean;
  110102. REFLECTIONMAP_CUBIC: boolean;
  110103. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110104. REFLECTIONMAP_PROJECTION: boolean;
  110105. REFLECTIONMAP_SKYBOX: boolean;
  110106. REFLECTIONMAP_EXPLICIT: boolean;
  110107. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110108. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110109. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110110. INVERTCUBICMAP: boolean;
  110111. LOGARITHMICDEPTH: boolean;
  110112. REFRACTION: boolean;
  110113. REFRACTIONMAP_3D: boolean;
  110114. REFLECTIONOVERALPHA: boolean;
  110115. TWOSIDEDLIGHTING: boolean;
  110116. SHADOWFLOAT: boolean;
  110117. MORPHTARGETS: boolean;
  110118. MORPHTARGETS_NORMAL: boolean;
  110119. MORPHTARGETS_TANGENT: boolean;
  110120. MORPHTARGETS_UV: boolean;
  110121. NUM_MORPH_INFLUENCERS: number;
  110122. NONUNIFORMSCALING: boolean;
  110123. PREMULTIPLYALPHA: boolean;
  110124. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  110125. ALPHABLEND: boolean;
  110126. PREPASS: boolean;
  110127. SCENE_MRT_COUNT: number;
  110128. RGBDLIGHTMAP: boolean;
  110129. RGBDREFLECTION: boolean;
  110130. RGBDREFRACTION: boolean;
  110131. IMAGEPROCESSING: boolean;
  110132. VIGNETTE: boolean;
  110133. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110134. VIGNETTEBLENDMODEOPAQUE: boolean;
  110135. TONEMAPPING: boolean;
  110136. TONEMAPPING_ACES: boolean;
  110137. CONTRAST: boolean;
  110138. COLORCURVES: boolean;
  110139. COLORGRADING: boolean;
  110140. COLORGRADING3D: boolean;
  110141. SAMPLER3DGREENDEPTH: boolean;
  110142. SAMPLER3DBGRMAP: boolean;
  110143. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110144. MULTIVIEW: boolean;
  110145. /**
  110146. * If the reflection texture on this material is in linear color space
  110147. * @hidden
  110148. */
  110149. IS_REFLECTION_LINEAR: boolean;
  110150. /**
  110151. * If the refraction texture on this material is in linear color space
  110152. * @hidden
  110153. */
  110154. IS_REFRACTION_LINEAR: boolean;
  110155. EXPOSURE: boolean;
  110156. constructor();
  110157. setReflectionMode(modeToEnable: string): void;
  110158. }
  110159. /**
  110160. * This is the default material used in Babylon. It is the best trade off between quality
  110161. * and performances.
  110162. * @see https://doc.babylonjs.com/babylon101/materials
  110163. */
  110164. export class StandardMaterial extends PushMaterial {
  110165. private _diffuseTexture;
  110166. /**
  110167. * The basic texture of the material as viewed under a light.
  110168. */
  110169. diffuseTexture: Nullable<BaseTexture>;
  110170. private _ambientTexture;
  110171. /**
  110172. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  110173. */
  110174. ambientTexture: Nullable<BaseTexture>;
  110175. private _opacityTexture;
  110176. /**
  110177. * Define the transparency of the material from a texture.
  110178. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  110179. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  110180. */
  110181. opacityTexture: Nullable<BaseTexture>;
  110182. private _reflectionTexture;
  110183. /**
  110184. * Define the texture used to display the reflection.
  110185. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110186. */
  110187. reflectionTexture: Nullable<BaseTexture>;
  110188. private _emissiveTexture;
  110189. /**
  110190. * Define texture of the material as if self lit.
  110191. * This will be mixed in the final result even in the absence of light.
  110192. */
  110193. emissiveTexture: Nullable<BaseTexture>;
  110194. private _specularTexture;
  110195. /**
  110196. * Define how the color and intensity of the highlight given by the light in the material.
  110197. */
  110198. specularTexture: Nullable<BaseTexture>;
  110199. private _bumpTexture;
  110200. /**
  110201. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  110202. * 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.
  110203. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  110204. */
  110205. bumpTexture: Nullable<BaseTexture>;
  110206. private _lightmapTexture;
  110207. /**
  110208. * Complex lighting can be computationally expensive to compute at runtime.
  110209. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  110210. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  110211. */
  110212. lightmapTexture: Nullable<BaseTexture>;
  110213. private _refractionTexture;
  110214. /**
  110215. * Define the texture used to display the refraction.
  110216. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110217. */
  110218. refractionTexture: Nullable<BaseTexture>;
  110219. /**
  110220. * The color of the material lit by the environmental background lighting.
  110221. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  110222. */
  110223. ambientColor: Color3;
  110224. /**
  110225. * The basic color of the material as viewed under a light.
  110226. */
  110227. diffuseColor: Color3;
  110228. /**
  110229. * Define how the color and intensity of the highlight given by the light in the material.
  110230. */
  110231. specularColor: Color3;
  110232. /**
  110233. * Define the color of the material as if self lit.
  110234. * This will be mixed in the final result even in the absence of light.
  110235. */
  110236. emissiveColor: Color3;
  110237. /**
  110238. * Defines how sharp are the highlights in the material.
  110239. * The bigger the value the sharper giving a more glossy feeling to the result.
  110240. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  110241. */
  110242. specularPower: number;
  110243. private _useAlphaFromDiffuseTexture;
  110244. /**
  110245. * Does the transparency come from the diffuse texture alpha channel.
  110246. */
  110247. useAlphaFromDiffuseTexture: boolean;
  110248. private _useEmissiveAsIllumination;
  110249. /**
  110250. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  110251. */
  110252. useEmissiveAsIllumination: boolean;
  110253. private _linkEmissiveWithDiffuse;
  110254. /**
  110255. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  110256. * the emissive level when the final color is close to one.
  110257. */
  110258. linkEmissiveWithDiffuse: boolean;
  110259. private _useSpecularOverAlpha;
  110260. /**
  110261. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  110262. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  110263. */
  110264. useSpecularOverAlpha: boolean;
  110265. private _useReflectionOverAlpha;
  110266. /**
  110267. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110268. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110269. */
  110270. useReflectionOverAlpha: boolean;
  110271. private _disableLighting;
  110272. /**
  110273. * Does lights from the scene impacts this material.
  110274. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  110275. */
  110276. disableLighting: boolean;
  110277. private _useObjectSpaceNormalMap;
  110278. /**
  110279. * Allows using an object space normal map (instead of tangent space).
  110280. */
  110281. useObjectSpaceNormalMap: boolean;
  110282. private _useParallax;
  110283. /**
  110284. * Is parallax enabled or not.
  110285. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110286. */
  110287. useParallax: boolean;
  110288. private _useParallaxOcclusion;
  110289. /**
  110290. * Is parallax occlusion enabled or not.
  110291. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  110292. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110293. */
  110294. useParallaxOcclusion: boolean;
  110295. /**
  110296. * 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.
  110297. */
  110298. parallaxScaleBias: number;
  110299. private _roughness;
  110300. /**
  110301. * Helps to define how blurry the reflections should appears in the material.
  110302. */
  110303. roughness: number;
  110304. /**
  110305. * In case of refraction, define the value of the index of refraction.
  110306. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110307. */
  110308. indexOfRefraction: number;
  110309. /**
  110310. * Invert the refraction texture alongside the y axis.
  110311. * It can be useful with procedural textures or probe for instance.
  110312. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110313. */
  110314. invertRefractionY: boolean;
  110315. /**
  110316. * Defines the alpha limits in alpha test mode.
  110317. */
  110318. alphaCutOff: number;
  110319. private _useLightmapAsShadowmap;
  110320. /**
  110321. * In case of light mapping, define whether the map contains light or shadow informations.
  110322. */
  110323. useLightmapAsShadowmap: boolean;
  110324. private _diffuseFresnelParameters;
  110325. /**
  110326. * Define the diffuse fresnel parameters of the material.
  110327. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110328. */
  110329. diffuseFresnelParameters: FresnelParameters;
  110330. private _opacityFresnelParameters;
  110331. /**
  110332. * Define the opacity fresnel parameters of the material.
  110333. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110334. */
  110335. opacityFresnelParameters: FresnelParameters;
  110336. private _reflectionFresnelParameters;
  110337. /**
  110338. * Define the reflection fresnel parameters of the material.
  110339. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110340. */
  110341. reflectionFresnelParameters: FresnelParameters;
  110342. private _refractionFresnelParameters;
  110343. /**
  110344. * Define the refraction fresnel parameters of the material.
  110345. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110346. */
  110347. refractionFresnelParameters: FresnelParameters;
  110348. private _emissiveFresnelParameters;
  110349. /**
  110350. * Define the emissive fresnel parameters of the material.
  110351. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110352. */
  110353. emissiveFresnelParameters: FresnelParameters;
  110354. private _useReflectionFresnelFromSpecular;
  110355. /**
  110356. * If true automatically deducts the fresnels values from the material specularity.
  110357. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110358. */
  110359. useReflectionFresnelFromSpecular: boolean;
  110360. private _useGlossinessFromSpecularMapAlpha;
  110361. /**
  110362. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  110363. */
  110364. useGlossinessFromSpecularMapAlpha: boolean;
  110365. private _maxSimultaneousLights;
  110366. /**
  110367. * Defines the maximum number of lights that can be used in the material
  110368. */
  110369. maxSimultaneousLights: number;
  110370. private _invertNormalMapX;
  110371. /**
  110372. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  110373. */
  110374. invertNormalMapX: boolean;
  110375. private _invertNormalMapY;
  110376. /**
  110377. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  110378. */
  110379. invertNormalMapY: boolean;
  110380. private _twoSidedLighting;
  110381. /**
  110382. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110383. */
  110384. twoSidedLighting: boolean;
  110385. /**
  110386. * Default configuration related to image processing available in the standard Material.
  110387. */
  110388. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110389. /**
  110390. * Gets the image processing configuration used either in this material.
  110391. */
  110392. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  110393. /**
  110394. * Sets the Default image processing configuration used either in the this material.
  110395. *
  110396. * If sets to null, the scene one is in use.
  110397. */
  110398. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  110399. /**
  110400. * Keep track of the image processing observer to allow dispose and replace.
  110401. */
  110402. private _imageProcessingObserver;
  110403. /**
  110404. * Attaches a new image processing configuration to the Standard Material.
  110405. * @param configuration
  110406. */
  110407. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110408. /**
  110409. * Gets wether the color curves effect is enabled.
  110410. */
  110411. get cameraColorCurvesEnabled(): boolean;
  110412. /**
  110413. * Sets wether the color curves effect is enabled.
  110414. */
  110415. set cameraColorCurvesEnabled(value: boolean);
  110416. /**
  110417. * Gets wether the color grading effect is enabled.
  110418. */
  110419. get cameraColorGradingEnabled(): boolean;
  110420. /**
  110421. * Gets wether the color grading effect is enabled.
  110422. */
  110423. set cameraColorGradingEnabled(value: boolean);
  110424. /**
  110425. * Gets wether tonemapping is enabled or not.
  110426. */
  110427. get cameraToneMappingEnabled(): boolean;
  110428. /**
  110429. * Sets wether tonemapping is enabled or not
  110430. */
  110431. set cameraToneMappingEnabled(value: boolean);
  110432. /**
  110433. * The camera exposure used on this material.
  110434. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110435. * This corresponds to a photographic exposure.
  110436. */
  110437. get cameraExposure(): number;
  110438. /**
  110439. * The camera exposure used on this material.
  110440. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110441. * This corresponds to a photographic exposure.
  110442. */
  110443. set cameraExposure(value: number);
  110444. /**
  110445. * Gets The camera contrast used on this material.
  110446. */
  110447. get cameraContrast(): number;
  110448. /**
  110449. * Sets The camera contrast used on this material.
  110450. */
  110451. set cameraContrast(value: number);
  110452. /**
  110453. * Gets the Color Grading 2D Lookup Texture.
  110454. */
  110455. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  110456. /**
  110457. * Sets the Color Grading 2D Lookup Texture.
  110458. */
  110459. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  110460. /**
  110461. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110462. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110463. * 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;
  110464. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110465. */
  110466. get cameraColorCurves(): Nullable<ColorCurves>;
  110467. /**
  110468. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110469. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110470. * 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;
  110471. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110472. */
  110473. set cameraColorCurves(value: Nullable<ColorCurves>);
  110474. /**
  110475. * Can this material render to several textures at once
  110476. */
  110477. get canRenderToMRT(): boolean;
  110478. /**
  110479. * Defines the detail map parameters for the material.
  110480. */
  110481. readonly detailMap: DetailMapConfiguration;
  110482. protected _renderTargets: SmartArray<RenderTargetTexture>;
  110483. protected _worldViewProjectionMatrix: Matrix;
  110484. protected _globalAmbientColor: Color3;
  110485. protected _useLogarithmicDepth: boolean;
  110486. protected _rebuildInParallel: boolean;
  110487. /**
  110488. * Instantiates a new standard material.
  110489. * This is the default material used in Babylon. It is the best trade off between quality
  110490. * and performances.
  110491. * @see https://doc.babylonjs.com/babylon101/materials
  110492. * @param name Define the name of the material in the scene
  110493. * @param scene Define the scene the material belong to
  110494. */
  110495. constructor(name: string, scene: Scene);
  110496. /**
  110497. * Gets a boolean indicating that current material needs to register RTT
  110498. */
  110499. get hasRenderTargetTextures(): boolean;
  110500. /**
  110501. * Gets the current class name of the material e.g. "StandardMaterial"
  110502. * Mainly use in serialization.
  110503. * @returns the class name
  110504. */
  110505. getClassName(): string;
  110506. /**
  110507. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  110508. * You can try switching to logarithmic depth.
  110509. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  110510. */
  110511. get useLogarithmicDepth(): boolean;
  110512. set useLogarithmicDepth(value: boolean);
  110513. /**
  110514. * Specifies if the material will require alpha blending
  110515. * @returns a boolean specifying if alpha blending is needed
  110516. */
  110517. needAlphaBlending(): boolean;
  110518. /**
  110519. * Specifies if this material should be rendered in alpha test mode
  110520. * @returns a boolean specifying if an alpha test is needed.
  110521. */
  110522. needAlphaTesting(): boolean;
  110523. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  110524. /**
  110525. * Get the texture used for alpha test purpose.
  110526. * @returns the diffuse texture in case of the standard material.
  110527. */
  110528. getAlphaTestTexture(): Nullable<BaseTexture>;
  110529. /**
  110530. * Get if the submesh is ready to be used and all its information available.
  110531. * Child classes can use it to update shaders
  110532. * @param mesh defines the mesh to check
  110533. * @param subMesh defines which submesh to check
  110534. * @param useInstances specifies that instances should be used
  110535. * @returns a boolean indicating that the submesh is ready or not
  110536. */
  110537. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110538. /**
  110539. * Builds the material UBO layouts.
  110540. * Used internally during the effect preparation.
  110541. */
  110542. buildUniformLayout(): void;
  110543. /**
  110544. * Unbinds the material from the mesh
  110545. */
  110546. unbind(): void;
  110547. /**
  110548. * Binds the submesh to this material by preparing the effect and shader to draw
  110549. * @param world defines the world transformation matrix
  110550. * @param mesh defines the mesh containing the submesh
  110551. * @param subMesh defines the submesh to bind the material to
  110552. */
  110553. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110554. /**
  110555. * Get the list of animatables in the material.
  110556. * @returns the list of animatables object used in the material
  110557. */
  110558. getAnimatables(): IAnimatable[];
  110559. /**
  110560. * Gets the active textures from the material
  110561. * @returns an array of textures
  110562. */
  110563. getActiveTextures(): BaseTexture[];
  110564. /**
  110565. * Specifies if the material uses a texture
  110566. * @param texture defines the texture to check against the material
  110567. * @returns a boolean specifying if the material uses the texture
  110568. */
  110569. hasTexture(texture: BaseTexture): boolean;
  110570. /**
  110571. * Disposes the material
  110572. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110573. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110574. */
  110575. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  110576. /**
  110577. * Makes a duplicate of the material, and gives it a new name
  110578. * @param name defines the new name for the duplicated material
  110579. * @returns the cloned material
  110580. */
  110581. clone(name: string): StandardMaterial;
  110582. /**
  110583. * Serializes this material in a JSON representation
  110584. * @returns the serialized material object
  110585. */
  110586. serialize(): any;
  110587. /**
  110588. * Creates a standard material from parsed material data
  110589. * @param source defines the JSON representation of the material
  110590. * @param scene defines the hosting scene
  110591. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  110592. * @returns a new standard material
  110593. */
  110594. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  110595. /**
  110596. * Are diffuse textures enabled in the application.
  110597. */
  110598. static get DiffuseTextureEnabled(): boolean;
  110599. static set DiffuseTextureEnabled(value: boolean);
  110600. /**
  110601. * Are detail textures enabled in the application.
  110602. */
  110603. static get DetailTextureEnabled(): boolean;
  110604. static set DetailTextureEnabled(value: boolean);
  110605. /**
  110606. * Are ambient textures enabled in the application.
  110607. */
  110608. static get AmbientTextureEnabled(): boolean;
  110609. static set AmbientTextureEnabled(value: boolean);
  110610. /**
  110611. * Are opacity textures enabled in the application.
  110612. */
  110613. static get OpacityTextureEnabled(): boolean;
  110614. static set OpacityTextureEnabled(value: boolean);
  110615. /**
  110616. * Are reflection textures enabled in the application.
  110617. */
  110618. static get ReflectionTextureEnabled(): boolean;
  110619. static set ReflectionTextureEnabled(value: boolean);
  110620. /**
  110621. * Are emissive textures enabled in the application.
  110622. */
  110623. static get EmissiveTextureEnabled(): boolean;
  110624. static set EmissiveTextureEnabled(value: boolean);
  110625. /**
  110626. * Are specular textures enabled in the application.
  110627. */
  110628. static get SpecularTextureEnabled(): boolean;
  110629. static set SpecularTextureEnabled(value: boolean);
  110630. /**
  110631. * Are bump textures enabled in the application.
  110632. */
  110633. static get BumpTextureEnabled(): boolean;
  110634. static set BumpTextureEnabled(value: boolean);
  110635. /**
  110636. * Are lightmap textures enabled in the application.
  110637. */
  110638. static get LightmapTextureEnabled(): boolean;
  110639. static set LightmapTextureEnabled(value: boolean);
  110640. /**
  110641. * Are refraction textures enabled in the application.
  110642. */
  110643. static get RefractionTextureEnabled(): boolean;
  110644. static set RefractionTextureEnabled(value: boolean);
  110645. /**
  110646. * Are color grading textures enabled in the application.
  110647. */
  110648. static get ColorGradingTextureEnabled(): boolean;
  110649. static set ColorGradingTextureEnabled(value: boolean);
  110650. /**
  110651. * Are fresnels enabled in the application.
  110652. */
  110653. static get FresnelEnabled(): boolean;
  110654. static set FresnelEnabled(value: boolean);
  110655. }
  110656. }
  110657. declare module BABYLON {
  110658. /**
  110659. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  110660. *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.
  110661. * The SPS is also a particle system. It provides some methods to manage the particles.
  110662. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  110663. *
  110664. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  110665. */
  110666. export class SolidParticleSystem implements IDisposable {
  110667. /**
  110668. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  110669. * Example : var p = SPS.particles[i];
  110670. */
  110671. particles: SolidParticle[];
  110672. /**
  110673. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  110674. */
  110675. nbParticles: number;
  110676. /**
  110677. * If the particles must ever face the camera (default false). Useful for planar particles.
  110678. */
  110679. billboard: boolean;
  110680. /**
  110681. * Recompute normals when adding a shape
  110682. */
  110683. recomputeNormals: boolean;
  110684. /**
  110685. * This a counter ofr your own usage. It's not set by any SPS functions.
  110686. */
  110687. counter: number;
  110688. /**
  110689. * The SPS name. This name is also given to the underlying mesh.
  110690. */
  110691. name: string;
  110692. /**
  110693. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  110694. */
  110695. mesh: Mesh;
  110696. /**
  110697. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  110698. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  110699. */
  110700. vars: any;
  110701. /**
  110702. * This array is populated when the SPS is set as 'pickable'.
  110703. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  110704. * Each element of this array is an object `{idx: int, faceId: int}`.
  110705. * `idx` is the picked particle index in the `SPS.particles` array
  110706. * `faceId` is the picked face index counted within this particle.
  110707. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  110708. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  110709. * Use the method SPS.pickedParticle(pickingInfo) instead.
  110710. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110711. */
  110712. pickedParticles: {
  110713. idx: number;
  110714. faceId: number;
  110715. }[];
  110716. /**
  110717. * This array is populated when the SPS is set as 'pickable'
  110718. * Each key of this array is a submesh index.
  110719. * Each element of this array is a second array defined like this :
  110720. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  110721. * Each element of this second array is an object `{idx: int, faceId: int}`.
  110722. * `idx` is the picked particle index in the `SPS.particles` array
  110723. * `faceId` is the picked face index counted within this particle.
  110724. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  110725. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110726. */
  110727. pickedBySubMesh: {
  110728. idx: number;
  110729. faceId: number;
  110730. }[][];
  110731. /**
  110732. * This array is populated when `enableDepthSort` is set to true.
  110733. * Each element of this array is an instance of the class DepthSortedParticle.
  110734. */
  110735. depthSortedParticles: DepthSortedParticle[];
  110736. /**
  110737. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  110738. * @hidden
  110739. */
  110740. _bSphereOnly: boolean;
  110741. /**
  110742. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  110743. * @hidden
  110744. */
  110745. _bSphereRadiusFactor: number;
  110746. private _scene;
  110747. private _positions;
  110748. private _indices;
  110749. private _normals;
  110750. private _colors;
  110751. private _uvs;
  110752. private _indices32;
  110753. private _positions32;
  110754. private _normals32;
  110755. private _fixedNormal32;
  110756. private _colors32;
  110757. private _uvs32;
  110758. private _index;
  110759. private _updatable;
  110760. private _pickable;
  110761. private _isVisibilityBoxLocked;
  110762. private _alwaysVisible;
  110763. private _depthSort;
  110764. private _expandable;
  110765. private _shapeCounter;
  110766. private _copy;
  110767. private _color;
  110768. private _computeParticleColor;
  110769. private _computeParticleTexture;
  110770. private _computeParticleRotation;
  110771. private _computeParticleVertex;
  110772. private _computeBoundingBox;
  110773. private _depthSortParticles;
  110774. private _camera;
  110775. private _mustUnrotateFixedNormals;
  110776. private _particlesIntersect;
  110777. private _needs32Bits;
  110778. private _isNotBuilt;
  110779. private _lastParticleId;
  110780. private _idxOfId;
  110781. private _multimaterialEnabled;
  110782. private _useModelMaterial;
  110783. private _indicesByMaterial;
  110784. private _materialIndexes;
  110785. private _depthSortFunction;
  110786. private _materialSortFunction;
  110787. private _materials;
  110788. private _multimaterial;
  110789. private _materialIndexesById;
  110790. private _defaultMaterial;
  110791. private _autoUpdateSubMeshes;
  110792. private _tmpVertex;
  110793. /**
  110794. * Creates a SPS (Solid Particle System) object.
  110795. * @param name (String) is the SPS name, this will be the underlying mesh name.
  110796. * @param scene (Scene) is the scene in which the SPS is added.
  110797. * @param options defines the options of the sps e.g.
  110798. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  110799. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  110800. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  110801. * * 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.
  110802. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  110803. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  110804. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  110805. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  110806. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  110807. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  110808. */
  110809. constructor(name: string, scene: Scene, options?: {
  110810. updatable?: boolean;
  110811. isPickable?: boolean;
  110812. enableDepthSort?: boolean;
  110813. particleIntersection?: boolean;
  110814. boundingSphereOnly?: boolean;
  110815. bSphereRadiusFactor?: number;
  110816. expandable?: boolean;
  110817. useModelMaterial?: boolean;
  110818. enableMultiMaterial?: boolean;
  110819. });
  110820. /**
  110821. * Builds the SPS underlying mesh. Returns a standard Mesh.
  110822. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  110823. * @returns the created mesh
  110824. */
  110825. buildMesh(): Mesh;
  110826. /**
  110827. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  110828. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  110829. * Thus the particles generated from `digest()` have their property `position` set yet.
  110830. * @param mesh ( Mesh ) is the mesh to be digested
  110831. * @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
  110832. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  110833. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  110834. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110835. * @returns the current SPS
  110836. */
  110837. digest(mesh: Mesh, options?: {
  110838. facetNb?: number;
  110839. number?: number;
  110840. delta?: number;
  110841. storage?: [];
  110842. }): SolidParticleSystem;
  110843. /**
  110844. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  110845. * @hidden
  110846. */
  110847. private _unrotateFixedNormals;
  110848. /**
  110849. * Resets the temporary working copy particle
  110850. * @hidden
  110851. */
  110852. private _resetCopy;
  110853. /**
  110854. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  110855. * @param p the current index in the positions array to be updated
  110856. * @param ind the current index in the indices array
  110857. * @param shape a Vector3 array, the shape geometry
  110858. * @param positions the positions array to be updated
  110859. * @param meshInd the shape indices array
  110860. * @param indices the indices array to be updated
  110861. * @param meshUV the shape uv array
  110862. * @param uvs the uv array to be updated
  110863. * @param meshCol the shape color array
  110864. * @param colors the color array to be updated
  110865. * @param meshNor the shape normals array
  110866. * @param normals the normals array to be updated
  110867. * @param idx the particle index
  110868. * @param idxInShape the particle index in its shape
  110869. * @param options the addShape() method passed options
  110870. * @model the particle model
  110871. * @hidden
  110872. */
  110873. private _meshBuilder;
  110874. /**
  110875. * Returns a shape Vector3 array from positions float array
  110876. * @param positions float array
  110877. * @returns a vector3 array
  110878. * @hidden
  110879. */
  110880. private _posToShape;
  110881. /**
  110882. * Returns a shapeUV array from a float uvs (array deep copy)
  110883. * @param uvs as a float array
  110884. * @returns a shapeUV array
  110885. * @hidden
  110886. */
  110887. private _uvsToShapeUV;
  110888. /**
  110889. * Adds a new particle object in the particles array
  110890. * @param idx particle index in particles array
  110891. * @param id particle id
  110892. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  110893. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  110894. * @param model particle ModelShape object
  110895. * @param shapeId model shape identifier
  110896. * @param idxInShape index of the particle in the current model
  110897. * @param bInfo model bounding info object
  110898. * @param storage target storage array, if any
  110899. * @hidden
  110900. */
  110901. private _addParticle;
  110902. /**
  110903. * Adds some particles to the SPS from the model shape. Returns the shape id.
  110904. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  110905. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  110906. * @param nb (positive integer) the number of particles to be created from this model
  110907. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  110908. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  110909. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110910. * @returns the number of shapes in the system
  110911. */
  110912. addShape(mesh: Mesh, nb: number, options?: {
  110913. positionFunction?: any;
  110914. vertexFunction?: any;
  110915. storage?: [];
  110916. }): number;
  110917. /**
  110918. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  110919. * @hidden
  110920. */
  110921. private _rebuildParticle;
  110922. /**
  110923. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  110924. * @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.
  110925. * @returns the SPS.
  110926. */
  110927. rebuildMesh(reset?: boolean): SolidParticleSystem;
  110928. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  110929. * Returns an array with the removed particles.
  110930. * 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.
  110931. * The SPS can't be empty so at least one particle needs to remain in place.
  110932. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  110933. * @param start index of the first particle to remove
  110934. * @param end index of the last particle to remove (included)
  110935. * @returns an array populated with the removed particles
  110936. */
  110937. removeParticles(start: number, end: number): SolidParticle[];
  110938. /**
  110939. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  110940. * @param solidParticleArray an array populated with Solid Particles objects
  110941. * @returns the SPS
  110942. */
  110943. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  110944. /**
  110945. * Creates a new particle and modifies the SPS mesh geometry :
  110946. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  110947. * - calls _addParticle() to populate the particle array
  110948. * factorized code from addShape() and insertParticlesFromArray()
  110949. * @param idx particle index in the particles array
  110950. * @param i particle index in its shape
  110951. * @param modelShape particle ModelShape object
  110952. * @param shape shape vertex array
  110953. * @param meshInd shape indices array
  110954. * @param meshUV shape uv array
  110955. * @param meshCol shape color array
  110956. * @param meshNor shape normals array
  110957. * @param bbInfo shape bounding info
  110958. * @param storage target particle storage
  110959. * @options addShape() passed options
  110960. * @hidden
  110961. */
  110962. private _insertNewParticle;
  110963. /**
  110964. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  110965. * This method calls `updateParticle()` for each particle of the SPS.
  110966. * For an animated SPS, it is usually called within the render loop.
  110967. * 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.
  110968. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  110969. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  110970. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  110971. * @returns the SPS.
  110972. */
  110973. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  110974. /**
  110975. * Disposes the SPS.
  110976. */
  110977. dispose(): void;
  110978. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  110979. * idx is the particle index in the SPS
  110980. * faceId is the picked face index counted within this particle.
  110981. * Returns null if the pickInfo can't identify a picked particle.
  110982. * @param pickingInfo (PickingInfo object)
  110983. * @returns {idx: number, faceId: number} or null
  110984. */
  110985. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  110986. idx: number;
  110987. faceId: number;
  110988. }>;
  110989. /**
  110990. * Returns a SolidParticle object from its identifier : particle.id
  110991. * @param id (integer) the particle Id
  110992. * @returns the searched particle or null if not found in the SPS.
  110993. */
  110994. getParticleById(id: number): Nullable<SolidParticle>;
  110995. /**
  110996. * Returns a new array populated with the particles having the passed shapeId.
  110997. * @param shapeId (integer) the shape identifier
  110998. * @returns a new solid particle array
  110999. */
  111000. getParticlesByShapeId(shapeId: number): SolidParticle[];
  111001. /**
  111002. * Populates the passed array "ref" with the particles having the passed shapeId.
  111003. * @param shapeId the shape identifier
  111004. * @returns the SPS
  111005. * @param ref
  111006. */
  111007. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  111008. /**
  111009. * Computes the required SubMeshes according the materials assigned to the particles.
  111010. * @returns the solid particle system.
  111011. * Does nothing if called before the SPS mesh is built.
  111012. */
  111013. computeSubMeshes(): SolidParticleSystem;
  111014. /**
  111015. * Sorts the solid particles by material when MultiMaterial is enabled.
  111016. * Updates the indices32 array.
  111017. * Updates the indicesByMaterial array.
  111018. * Updates the mesh indices array.
  111019. * @returns the SPS
  111020. * @hidden
  111021. */
  111022. private _sortParticlesByMaterial;
  111023. /**
  111024. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  111025. * @hidden
  111026. */
  111027. private _setMaterialIndexesById;
  111028. /**
  111029. * Returns an array with unique values of Materials from the passed array
  111030. * @param array the material array to be checked and filtered
  111031. * @hidden
  111032. */
  111033. private _filterUniqueMaterialId;
  111034. /**
  111035. * Sets a new Standard Material as _defaultMaterial if not already set.
  111036. * @hidden
  111037. */
  111038. private _setDefaultMaterial;
  111039. /**
  111040. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  111041. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111042. * @returns the SPS.
  111043. */
  111044. refreshVisibleSize(): SolidParticleSystem;
  111045. /**
  111046. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  111047. * @param size the size (float) of the visibility box
  111048. * note : this doesn't lock the SPS mesh bounding box.
  111049. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111050. */
  111051. setVisibilityBox(size: number): void;
  111052. /**
  111053. * Gets whether the SPS as always visible or not
  111054. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111055. */
  111056. get isAlwaysVisible(): boolean;
  111057. /**
  111058. * Sets the SPS as always visible or not
  111059. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111060. */
  111061. set isAlwaysVisible(val: boolean);
  111062. /**
  111063. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111064. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111065. */
  111066. set isVisibilityBoxLocked(val: boolean);
  111067. /**
  111068. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111069. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111070. */
  111071. get isVisibilityBoxLocked(): boolean;
  111072. /**
  111073. * Tells to `setParticles()` to compute the particle rotations or not.
  111074. * Default value : true. The SPS is faster when it's set to false.
  111075. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111076. */
  111077. set computeParticleRotation(val: boolean);
  111078. /**
  111079. * Tells to `setParticles()` to compute the particle colors or not.
  111080. * Default value : true. The SPS is faster when it's set to false.
  111081. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111082. */
  111083. set computeParticleColor(val: boolean);
  111084. set computeParticleTexture(val: boolean);
  111085. /**
  111086. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  111087. * Default value : false. The SPS is faster when it's set to false.
  111088. * Note : the particle custom vertex positions aren't stored values.
  111089. */
  111090. set computeParticleVertex(val: boolean);
  111091. /**
  111092. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  111093. */
  111094. set computeBoundingBox(val: boolean);
  111095. /**
  111096. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  111097. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111098. * Default : `true`
  111099. */
  111100. set depthSortParticles(val: boolean);
  111101. /**
  111102. * Gets if `setParticles()` computes the particle rotations or not.
  111103. * Default value : true. The SPS is faster when it's set to false.
  111104. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111105. */
  111106. get computeParticleRotation(): boolean;
  111107. /**
  111108. * Gets if `setParticles()` computes the particle colors or not.
  111109. * Default value : true. The SPS is faster when it's set to false.
  111110. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111111. */
  111112. get computeParticleColor(): boolean;
  111113. /**
  111114. * Gets if `setParticles()` computes the particle textures or not.
  111115. * Default value : true. The SPS is faster when it's set to false.
  111116. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  111117. */
  111118. get computeParticleTexture(): boolean;
  111119. /**
  111120. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  111121. * Default value : false. The SPS is faster when it's set to false.
  111122. * Note : the particle custom vertex positions aren't stored values.
  111123. */
  111124. get computeParticleVertex(): boolean;
  111125. /**
  111126. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  111127. */
  111128. get computeBoundingBox(): boolean;
  111129. /**
  111130. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  111131. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111132. * Default : `true`
  111133. */
  111134. get depthSortParticles(): boolean;
  111135. /**
  111136. * Gets if the SPS is created as expandable at construction time.
  111137. * Default : `false`
  111138. */
  111139. get expandable(): boolean;
  111140. /**
  111141. * Gets if the SPS supports the Multi Materials
  111142. */
  111143. get multimaterialEnabled(): boolean;
  111144. /**
  111145. * Gets if the SPS uses the model materials for its own multimaterial.
  111146. */
  111147. get useModelMaterial(): boolean;
  111148. /**
  111149. * The SPS used material array.
  111150. */
  111151. get materials(): Material[];
  111152. /**
  111153. * Sets the SPS MultiMaterial from the passed materials.
  111154. * Note : the passed array is internally copied and not used then by reference.
  111155. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  111156. */
  111157. setMultiMaterial(materials: Material[]): void;
  111158. /**
  111159. * The SPS computed multimaterial object
  111160. */
  111161. get multimaterial(): MultiMaterial;
  111162. set multimaterial(mm: MultiMaterial);
  111163. /**
  111164. * If the subMeshes must be updated on the next call to setParticles()
  111165. */
  111166. get autoUpdateSubMeshes(): boolean;
  111167. set autoUpdateSubMeshes(val: boolean);
  111168. /**
  111169. * This function does nothing. It may be overwritten to set all the particle first values.
  111170. * The SPS doesn't call this function, you may have to call it by your own.
  111171. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111172. */
  111173. initParticles(): void;
  111174. /**
  111175. * This function does nothing. It may be overwritten to recycle a particle.
  111176. * The SPS doesn't call this function, you may have to call it by your own.
  111177. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111178. * @param particle The particle to recycle
  111179. * @returns the recycled particle
  111180. */
  111181. recycleParticle(particle: SolidParticle): SolidParticle;
  111182. /**
  111183. * Updates a particle : this function should be overwritten by the user.
  111184. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  111185. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111186. * @example : just set a particle position or velocity and recycle conditions
  111187. * @param particle The particle to update
  111188. * @returns the updated particle
  111189. */
  111190. updateParticle(particle: SolidParticle): SolidParticle;
  111191. /**
  111192. * Updates a vertex of a particle : it can be overwritten by the user.
  111193. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  111194. * @param particle the current particle
  111195. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  111196. * @param pt the index of the current vertex in the particle shape
  111197. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  111198. * @example : just set a vertex particle position or color
  111199. * @returns the sps
  111200. */
  111201. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  111202. /**
  111203. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  111204. * This does nothing and may be overwritten by the user.
  111205. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111206. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111207. * @param update the boolean update value actually passed to setParticles()
  111208. */
  111209. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111210. /**
  111211. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  111212. * This will be passed three parameters.
  111213. * This does nothing and may be overwritten by the user.
  111214. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111215. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111216. * @param update the boolean update value actually passed to setParticles()
  111217. */
  111218. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111219. }
  111220. }
  111221. declare module BABYLON {
  111222. /**
  111223. * Represents one particle of a solid particle system.
  111224. */
  111225. export class SolidParticle {
  111226. /**
  111227. * particle global index
  111228. */
  111229. idx: number;
  111230. /**
  111231. * particle identifier
  111232. */
  111233. id: number;
  111234. /**
  111235. * The color of the particle
  111236. */
  111237. color: Nullable<Color4>;
  111238. /**
  111239. * The world space position of the particle.
  111240. */
  111241. position: Vector3;
  111242. /**
  111243. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  111244. */
  111245. rotation: Vector3;
  111246. /**
  111247. * The world space rotation quaternion of the particle.
  111248. */
  111249. rotationQuaternion: Nullable<Quaternion>;
  111250. /**
  111251. * The scaling of the particle.
  111252. */
  111253. scaling: Vector3;
  111254. /**
  111255. * The uvs of the particle.
  111256. */
  111257. uvs: Vector4;
  111258. /**
  111259. * The current speed of the particle.
  111260. */
  111261. velocity: Vector3;
  111262. /**
  111263. * The pivot point in the particle local space.
  111264. */
  111265. pivot: Vector3;
  111266. /**
  111267. * Must the particle be translated from its pivot point in its local space ?
  111268. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  111269. * Default : false
  111270. */
  111271. translateFromPivot: boolean;
  111272. /**
  111273. * Is the particle active or not ?
  111274. */
  111275. alive: boolean;
  111276. /**
  111277. * Is the particle visible or not ?
  111278. */
  111279. isVisible: boolean;
  111280. /**
  111281. * Index of this particle in the global "positions" array (Internal use)
  111282. * @hidden
  111283. */
  111284. _pos: number;
  111285. /**
  111286. * @hidden Index of this particle in the global "indices" array (Internal use)
  111287. */
  111288. _ind: number;
  111289. /**
  111290. * @hidden ModelShape of this particle (Internal use)
  111291. */
  111292. _model: ModelShape;
  111293. /**
  111294. * ModelShape id of this particle
  111295. */
  111296. shapeId: number;
  111297. /**
  111298. * Index of the particle in its shape id
  111299. */
  111300. idxInShape: number;
  111301. /**
  111302. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  111303. */
  111304. _modelBoundingInfo: BoundingInfo;
  111305. /**
  111306. * @hidden Particle BoundingInfo object (Internal use)
  111307. */
  111308. _boundingInfo: BoundingInfo;
  111309. /**
  111310. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  111311. */
  111312. _sps: SolidParticleSystem;
  111313. /**
  111314. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  111315. */
  111316. _stillInvisible: boolean;
  111317. /**
  111318. * @hidden Last computed particle rotation matrix
  111319. */
  111320. _rotationMatrix: number[];
  111321. /**
  111322. * Parent particle Id, if any.
  111323. * Default null.
  111324. */
  111325. parentId: Nullable<number>;
  111326. /**
  111327. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  111328. */
  111329. materialIndex: Nullable<number>;
  111330. /**
  111331. * Custom object or properties.
  111332. */
  111333. props: Nullable<any>;
  111334. /**
  111335. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  111336. * The possible values are :
  111337. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111338. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111339. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111340. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111341. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111342. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  111343. * */
  111344. cullingStrategy: number;
  111345. /**
  111346. * @hidden Internal global position in the SPS.
  111347. */
  111348. _globalPosition: Vector3;
  111349. /**
  111350. * Creates a Solid Particle object.
  111351. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  111352. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  111353. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  111354. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  111355. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  111356. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  111357. * @param shapeId (integer) is the model shape identifier in the SPS.
  111358. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  111359. * @param sps defines the sps it is associated to
  111360. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  111361. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  111362. */
  111363. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  111364. /**
  111365. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  111366. * @param target the particle target
  111367. * @returns the current particle
  111368. */
  111369. copyToRef(target: SolidParticle): SolidParticle;
  111370. /**
  111371. * Legacy support, changed scale to scaling
  111372. */
  111373. get scale(): Vector3;
  111374. /**
  111375. * Legacy support, changed scale to scaling
  111376. */
  111377. set scale(scale: Vector3);
  111378. /**
  111379. * Legacy support, changed quaternion to rotationQuaternion
  111380. */
  111381. get quaternion(): Nullable<Quaternion>;
  111382. /**
  111383. * Legacy support, changed quaternion to rotationQuaternion
  111384. */
  111385. set quaternion(q: Nullable<Quaternion>);
  111386. /**
  111387. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  111388. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  111389. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  111390. * @returns true if it intersects
  111391. */
  111392. intersectsMesh(target: Mesh | SolidParticle): boolean;
  111393. /**
  111394. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  111395. * A particle is in the frustum if its bounding box intersects the frustum
  111396. * @param frustumPlanes defines the frustum to test
  111397. * @returns true if the particle is in the frustum planes
  111398. */
  111399. isInFrustum(frustumPlanes: Plane[]): boolean;
  111400. /**
  111401. * get the rotation matrix of the particle
  111402. * @hidden
  111403. */
  111404. getRotationMatrix(m: Matrix): void;
  111405. }
  111406. /**
  111407. * Represents the shape of the model used by one particle of a solid particle system.
  111408. * SPS internal tool, don't use it manually.
  111409. */
  111410. export class ModelShape {
  111411. /**
  111412. * The shape id
  111413. * @hidden
  111414. */
  111415. shapeID: number;
  111416. /**
  111417. * flat array of model positions (internal use)
  111418. * @hidden
  111419. */
  111420. _shape: Vector3[];
  111421. /**
  111422. * flat array of model UVs (internal use)
  111423. * @hidden
  111424. */
  111425. _shapeUV: number[];
  111426. /**
  111427. * color array of the model
  111428. * @hidden
  111429. */
  111430. _shapeColors: number[];
  111431. /**
  111432. * indices array of the model
  111433. * @hidden
  111434. */
  111435. _indices: number[];
  111436. /**
  111437. * normals array of the model
  111438. * @hidden
  111439. */
  111440. _normals: number[];
  111441. /**
  111442. * length of the shape in the model indices array (internal use)
  111443. * @hidden
  111444. */
  111445. _indicesLength: number;
  111446. /**
  111447. * Custom position function (internal use)
  111448. * @hidden
  111449. */
  111450. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  111451. /**
  111452. * Custom vertex function (internal use)
  111453. * @hidden
  111454. */
  111455. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  111456. /**
  111457. * Model material (internal use)
  111458. * @hidden
  111459. */
  111460. _material: Nullable<Material>;
  111461. /**
  111462. * 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.
  111463. * SPS internal tool, don't use it manually.
  111464. * @hidden
  111465. */
  111466. 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>);
  111467. }
  111468. /**
  111469. * Represents a Depth Sorted Particle in the solid particle system.
  111470. * @hidden
  111471. */
  111472. export class DepthSortedParticle {
  111473. /**
  111474. * Particle index
  111475. */
  111476. idx: number;
  111477. /**
  111478. * Index of the particle in the "indices" array
  111479. */
  111480. ind: number;
  111481. /**
  111482. * Length of the particle shape in the "indices" array
  111483. */
  111484. indicesLength: number;
  111485. /**
  111486. * Squared distance from the particle to the camera
  111487. */
  111488. sqDistance: number;
  111489. /**
  111490. * Material index when used with MultiMaterials
  111491. */
  111492. materialIndex: number;
  111493. /**
  111494. * Creates a new sorted particle
  111495. * @param materialIndex
  111496. */
  111497. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  111498. }
  111499. /**
  111500. * Represents a solid particle vertex
  111501. */
  111502. export class SolidParticleVertex {
  111503. /**
  111504. * Vertex position
  111505. */
  111506. position: Vector3;
  111507. /**
  111508. * Vertex color
  111509. */
  111510. color: Color4;
  111511. /**
  111512. * Vertex UV
  111513. */
  111514. uv: Vector2;
  111515. /**
  111516. * Creates a new solid particle vertex
  111517. */
  111518. constructor();
  111519. /** Vertex x coordinate */
  111520. get x(): number;
  111521. set x(val: number);
  111522. /** Vertex y coordinate */
  111523. get y(): number;
  111524. set y(val: number);
  111525. /** Vertex z coordinate */
  111526. get z(): number;
  111527. set z(val: number);
  111528. }
  111529. }
  111530. declare module BABYLON {
  111531. /**
  111532. * @hidden
  111533. */
  111534. export class _MeshCollisionData {
  111535. _checkCollisions: boolean;
  111536. _collisionMask: number;
  111537. _collisionGroup: number;
  111538. _surroundingMeshes: Nullable<AbstractMesh[]>;
  111539. _collider: Nullable<Collider>;
  111540. _oldPositionForCollisions: Vector3;
  111541. _diffPositionForCollisions: Vector3;
  111542. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  111543. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  111544. }
  111545. }
  111546. declare module BABYLON {
  111547. /** @hidden */
  111548. class _FacetDataStorage {
  111549. facetPositions: Vector3[];
  111550. facetNormals: Vector3[];
  111551. facetPartitioning: number[][];
  111552. facetNb: number;
  111553. partitioningSubdivisions: number;
  111554. partitioningBBoxRatio: number;
  111555. facetDataEnabled: boolean;
  111556. facetParameters: any;
  111557. bbSize: Vector3;
  111558. subDiv: {
  111559. max: number;
  111560. X: number;
  111561. Y: number;
  111562. Z: number;
  111563. };
  111564. facetDepthSort: boolean;
  111565. facetDepthSortEnabled: boolean;
  111566. depthSortedIndices: IndicesArray;
  111567. depthSortedFacets: {
  111568. ind: number;
  111569. sqDistance: number;
  111570. }[];
  111571. facetDepthSortFunction: (f1: {
  111572. ind: number;
  111573. sqDistance: number;
  111574. }, f2: {
  111575. ind: number;
  111576. sqDistance: number;
  111577. }) => number;
  111578. facetDepthSortFrom: Vector3;
  111579. facetDepthSortOrigin: Vector3;
  111580. invertedMatrix: Matrix;
  111581. }
  111582. /**
  111583. * @hidden
  111584. **/
  111585. class _InternalAbstractMeshDataInfo {
  111586. _hasVertexAlpha: boolean;
  111587. _useVertexColors: boolean;
  111588. _numBoneInfluencers: number;
  111589. _applyFog: boolean;
  111590. _receiveShadows: boolean;
  111591. _facetData: _FacetDataStorage;
  111592. _visibility: number;
  111593. _skeleton: Nullable<Skeleton>;
  111594. _layerMask: number;
  111595. _computeBonesUsingShaders: boolean;
  111596. _isActive: boolean;
  111597. _onlyForInstances: boolean;
  111598. _isActiveIntermediate: boolean;
  111599. _onlyForInstancesIntermediate: boolean;
  111600. _actAsRegularMesh: boolean;
  111601. }
  111602. /**
  111603. * Class used to store all common mesh properties
  111604. */
  111605. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  111606. /** No occlusion */
  111607. static OCCLUSION_TYPE_NONE: number;
  111608. /** Occlusion set to optimisitic */
  111609. static OCCLUSION_TYPE_OPTIMISTIC: number;
  111610. /** Occlusion set to strict */
  111611. static OCCLUSION_TYPE_STRICT: number;
  111612. /** Use an accurante occlusion algorithm */
  111613. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  111614. /** Use a conservative occlusion algorithm */
  111615. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  111616. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  111617. * Test order :
  111618. * Is the bounding sphere outside the frustum ?
  111619. * If not, are the bounding box vertices outside the frustum ?
  111620. * It not, then the cullable object is in the frustum.
  111621. */
  111622. static readonly CULLINGSTRATEGY_STANDARD: number;
  111623. /** Culling strategy : Bounding Sphere Only.
  111624. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  111625. * It's also less accurate than the standard because some not visible objects can still be selected.
  111626. * Test : is the bounding sphere outside the frustum ?
  111627. * If not, then the cullable object is in the frustum.
  111628. */
  111629. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  111630. /** Culling strategy : Optimistic Inclusion.
  111631. * This in an inclusion test first, then the standard exclusion test.
  111632. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  111633. * 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.
  111634. * Anyway, it's as accurate as the standard strategy.
  111635. * Test :
  111636. * Is the cullable object bounding sphere center in the frustum ?
  111637. * If not, apply the default culling strategy.
  111638. */
  111639. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  111640. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  111641. * This in an inclusion test first, then the bounding sphere only exclusion test.
  111642. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  111643. * 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.
  111644. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  111645. * Test :
  111646. * Is the cullable object bounding sphere center in the frustum ?
  111647. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  111648. */
  111649. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  111650. /**
  111651. * No billboard
  111652. */
  111653. static get BILLBOARDMODE_NONE(): number;
  111654. /** Billboard on X axis */
  111655. static get BILLBOARDMODE_X(): number;
  111656. /** Billboard on Y axis */
  111657. static get BILLBOARDMODE_Y(): number;
  111658. /** Billboard on Z axis */
  111659. static get BILLBOARDMODE_Z(): number;
  111660. /** Billboard on all axes */
  111661. static get BILLBOARDMODE_ALL(): number;
  111662. /** Billboard on using position instead of orientation */
  111663. static get BILLBOARDMODE_USE_POSITION(): number;
  111664. /** @hidden */
  111665. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  111666. /**
  111667. * The culling strategy to use to check whether the mesh must be rendered or not.
  111668. * This value can be changed at any time and will be used on the next render mesh selection.
  111669. * The possible values are :
  111670. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111671. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111672. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111673. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111674. * Please read each static variable documentation to get details about the culling process.
  111675. * */
  111676. cullingStrategy: number;
  111677. /**
  111678. * Gets the number of facets in the mesh
  111679. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111680. */
  111681. get facetNb(): number;
  111682. /**
  111683. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  111684. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111685. */
  111686. get partitioningSubdivisions(): number;
  111687. set partitioningSubdivisions(nb: number);
  111688. /**
  111689. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  111690. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  111691. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111692. */
  111693. get partitioningBBoxRatio(): number;
  111694. set partitioningBBoxRatio(ratio: number);
  111695. /**
  111696. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  111697. * Works only for updatable meshes.
  111698. * Doesn't work with multi-materials
  111699. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111700. */
  111701. get mustDepthSortFacets(): boolean;
  111702. set mustDepthSortFacets(sort: boolean);
  111703. /**
  111704. * The location (Vector3) where the facet depth sort must be computed from.
  111705. * By default, the active camera position.
  111706. * Used only when facet depth sort is enabled
  111707. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111708. */
  111709. get facetDepthSortFrom(): Vector3;
  111710. set facetDepthSortFrom(location: Vector3);
  111711. /**
  111712. * gets a boolean indicating if facetData is enabled
  111713. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111714. */
  111715. get isFacetDataEnabled(): boolean;
  111716. /** @hidden */
  111717. _updateNonUniformScalingState(value: boolean): boolean;
  111718. /**
  111719. * An event triggered when this mesh collides with another one
  111720. */
  111721. onCollideObservable: Observable<AbstractMesh>;
  111722. /** Set a function to call when this mesh collides with another one */
  111723. set onCollide(callback: () => void);
  111724. /**
  111725. * An event triggered when the collision's position changes
  111726. */
  111727. onCollisionPositionChangeObservable: Observable<Vector3>;
  111728. /** Set a function to call when the collision's position changes */
  111729. set onCollisionPositionChange(callback: () => void);
  111730. /**
  111731. * An event triggered when material is changed
  111732. */
  111733. onMaterialChangedObservable: Observable<AbstractMesh>;
  111734. /**
  111735. * Gets or sets the orientation for POV movement & rotation
  111736. */
  111737. definedFacingForward: boolean;
  111738. /** @hidden */
  111739. _occlusionQuery: Nullable<WebGLQuery>;
  111740. /** @hidden */
  111741. _renderingGroup: Nullable<RenderingGroup>;
  111742. /**
  111743. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111744. */
  111745. get visibility(): number;
  111746. /**
  111747. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111748. */
  111749. set visibility(value: number);
  111750. /** Gets or sets the alpha index used to sort transparent meshes
  111751. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  111752. */
  111753. alphaIndex: number;
  111754. /**
  111755. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  111756. */
  111757. isVisible: boolean;
  111758. /**
  111759. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  111760. */
  111761. isPickable: boolean;
  111762. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  111763. showSubMeshesBoundingBox: boolean;
  111764. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  111765. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  111766. */
  111767. isBlocker: boolean;
  111768. /**
  111769. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  111770. */
  111771. enablePointerMoveEvents: boolean;
  111772. private _renderingGroupId;
  111773. /**
  111774. * Specifies the rendering group id for this mesh (0 by default)
  111775. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  111776. */
  111777. get renderingGroupId(): number;
  111778. set renderingGroupId(value: number);
  111779. private _material;
  111780. /** Gets or sets current material */
  111781. get material(): Nullable<Material>;
  111782. set material(value: Nullable<Material>);
  111783. /**
  111784. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  111785. * @see https://doc.babylonjs.com/babylon101/shadows
  111786. */
  111787. get receiveShadows(): boolean;
  111788. set receiveShadows(value: boolean);
  111789. /** Defines color to use when rendering outline */
  111790. outlineColor: Color3;
  111791. /** Define width to use when rendering outline */
  111792. outlineWidth: number;
  111793. /** Defines color to use when rendering overlay */
  111794. overlayColor: Color3;
  111795. /** Defines alpha to use when rendering overlay */
  111796. overlayAlpha: number;
  111797. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  111798. get hasVertexAlpha(): boolean;
  111799. set hasVertexAlpha(value: boolean);
  111800. /** 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) */
  111801. get useVertexColors(): boolean;
  111802. set useVertexColors(value: boolean);
  111803. /**
  111804. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  111805. */
  111806. get computeBonesUsingShaders(): boolean;
  111807. set computeBonesUsingShaders(value: boolean);
  111808. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  111809. get numBoneInfluencers(): number;
  111810. set numBoneInfluencers(value: number);
  111811. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  111812. get applyFog(): boolean;
  111813. set applyFog(value: boolean);
  111814. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  111815. useOctreeForRenderingSelection: boolean;
  111816. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  111817. useOctreeForPicking: boolean;
  111818. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  111819. useOctreeForCollisions: boolean;
  111820. /**
  111821. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  111822. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  111823. */
  111824. get layerMask(): number;
  111825. set layerMask(value: number);
  111826. /**
  111827. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  111828. */
  111829. alwaysSelectAsActiveMesh: boolean;
  111830. /**
  111831. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  111832. */
  111833. doNotSyncBoundingInfo: boolean;
  111834. /**
  111835. * Gets or sets the current action manager
  111836. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111837. */
  111838. actionManager: Nullable<AbstractActionManager>;
  111839. private _meshCollisionData;
  111840. /**
  111841. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  111842. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111843. */
  111844. ellipsoid: Vector3;
  111845. /**
  111846. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  111847. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111848. */
  111849. ellipsoidOffset: Vector3;
  111850. /**
  111851. * Gets or sets a collision mask used to mask collisions (default is -1).
  111852. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111853. */
  111854. get collisionMask(): number;
  111855. set collisionMask(mask: number);
  111856. /**
  111857. * Gets or sets the current collision group mask (-1 by default).
  111858. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111859. */
  111860. get collisionGroup(): number;
  111861. set collisionGroup(mask: number);
  111862. /**
  111863. * Gets or sets current surrounding meshes (null by default).
  111864. *
  111865. * By default collision detection is tested against every mesh in the scene.
  111866. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  111867. * meshes will be tested for the collision.
  111868. *
  111869. * Note: if set to an empty array no collision will happen when this mesh is moved.
  111870. */
  111871. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  111872. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  111873. /**
  111874. * Defines edge width used when edgesRenderer is enabled
  111875. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111876. */
  111877. edgesWidth: number;
  111878. /**
  111879. * Defines edge color used when edgesRenderer is enabled
  111880. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111881. */
  111882. edgesColor: Color4;
  111883. /** @hidden */
  111884. _edgesRenderer: Nullable<IEdgesRenderer>;
  111885. /** @hidden */
  111886. _masterMesh: Nullable<AbstractMesh>;
  111887. /** @hidden */
  111888. _boundingInfo: Nullable<BoundingInfo>;
  111889. /** @hidden */
  111890. _renderId: number;
  111891. /**
  111892. * Gets or sets the list of subMeshes
  111893. * @see https://doc.babylonjs.com/how_to/multi_materials
  111894. */
  111895. subMeshes: SubMesh[];
  111896. /** @hidden */
  111897. _intersectionsInProgress: AbstractMesh[];
  111898. /** @hidden */
  111899. _unIndexed: boolean;
  111900. /** @hidden */
  111901. _lightSources: Light[];
  111902. /** Gets the list of lights affecting that mesh */
  111903. get lightSources(): Light[];
  111904. /** @hidden */
  111905. get _positions(): Nullable<Vector3[]>;
  111906. /** @hidden */
  111907. _waitingData: {
  111908. lods: Nullable<any>;
  111909. actions: Nullable<any>;
  111910. freezeWorldMatrix: Nullable<boolean>;
  111911. };
  111912. /** @hidden */
  111913. _bonesTransformMatrices: Nullable<Float32Array>;
  111914. /** @hidden */
  111915. _transformMatrixTexture: Nullable<RawTexture>;
  111916. /**
  111917. * Gets or sets a skeleton to apply skining transformations
  111918. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  111919. */
  111920. set skeleton(value: Nullable<Skeleton>);
  111921. get skeleton(): Nullable<Skeleton>;
  111922. /**
  111923. * An event triggered when the mesh is rebuilt.
  111924. */
  111925. onRebuildObservable: Observable<AbstractMesh>;
  111926. /**
  111927. * Creates a new AbstractMesh
  111928. * @param name defines the name of the mesh
  111929. * @param scene defines the hosting scene
  111930. */
  111931. constructor(name: string, scene?: Nullable<Scene>);
  111932. /**
  111933. * Returns the string "AbstractMesh"
  111934. * @returns "AbstractMesh"
  111935. */
  111936. getClassName(): string;
  111937. /**
  111938. * Gets a string representation of the current mesh
  111939. * @param fullDetails defines a boolean indicating if full details must be included
  111940. * @returns a string representation of the current mesh
  111941. */
  111942. toString(fullDetails?: boolean): string;
  111943. /**
  111944. * @hidden
  111945. */
  111946. protected _getEffectiveParent(): Nullable<Node>;
  111947. /** @hidden */
  111948. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  111949. /** @hidden */
  111950. _rebuild(): void;
  111951. /** @hidden */
  111952. _resyncLightSources(): void;
  111953. /** @hidden */
  111954. _resyncLightSource(light: Light): void;
  111955. /** @hidden */
  111956. _unBindEffect(): void;
  111957. /** @hidden */
  111958. _removeLightSource(light: Light, dispose: boolean): void;
  111959. private _markSubMeshesAsDirty;
  111960. /** @hidden */
  111961. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  111962. /** @hidden */
  111963. _markSubMeshesAsAttributesDirty(): void;
  111964. /** @hidden */
  111965. _markSubMeshesAsMiscDirty(): void;
  111966. /**
  111967. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  111968. */
  111969. get scaling(): Vector3;
  111970. set scaling(newScaling: Vector3);
  111971. /**
  111972. * Returns true if the mesh is blocked. Implemented by child classes
  111973. */
  111974. get isBlocked(): boolean;
  111975. /**
  111976. * Returns the mesh itself by default. Implemented by child classes
  111977. * @param camera defines the camera to use to pick the right LOD level
  111978. * @returns the currentAbstractMesh
  111979. */
  111980. getLOD(camera: Camera): Nullable<AbstractMesh>;
  111981. /**
  111982. * Returns 0 by default. Implemented by child classes
  111983. * @returns an integer
  111984. */
  111985. getTotalVertices(): number;
  111986. /**
  111987. * Returns a positive integer : the total number of indices in this mesh geometry.
  111988. * @returns the numner of indices or zero if the mesh has no geometry.
  111989. */
  111990. getTotalIndices(): number;
  111991. /**
  111992. * Returns null by default. Implemented by child classes
  111993. * @returns null
  111994. */
  111995. getIndices(): Nullable<IndicesArray>;
  111996. /**
  111997. * Returns the array of the requested vertex data kind. Implemented by child classes
  111998. * @param kind defines the vertex data kind to use
  111999. * @returns null
  112000. */
  112001. getVerticesData(kind: string): Nullable<FloatArray>;
  112002. /**
  112003. * Sets the vertex data of the mesh geometry for the requested `kind`.
  112004. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  112005. * Note that a new underlying VertexBuffer object is created each call.
  112006. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  112007. * @param kind defines vertex data kind:
  112008. * * VertexBuffer.PositionKind
  112009. * * VertexBuffer.UVKind
  112010. * * VertexBuffer.UV2Kind
  112011. * * VertexBuffer.UV3Kind
  112012. * * VertexBuffer.UV4Kind
  112013. * * VertexBuffer.UV5Kind
  112014. * * VertexBuffer.UV6Kind
  112015. * * VertexBuffer.ColorKind
  112016. * * VertexBuffer.MatricesIndicesKind
  112017. * * VertexBuffer.MatricesIndicesExtraKind
  112018. * * VertexBuffer.MatricesWeightsKind
  112019. * * VertexBuffer.MatricesWeightsExtraKind
  112020. * @param data defines the data source
  112021. * @param updatable defines if the data must be flagged as updatable (or static)
  112022. * @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
  112023. * @returns the current mesh
  112024. */
  112025. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  112026. /**
  112027. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  112028. * If the mesh has no geometry, it is simply returned as it is.
  112029. * @param kind defines vertex data kind:
  112030. * * VertexBuffer.PositionKind
  112031. * * VertexBuffer.UVKind
  112032. * * VertexBuffer.UV2Kind
  112033. * * VertexBuffer.UV3Kind
  112034. * * VertexBuffer.UV4Kind
  112035. * * VertexBuffer.UV5Kind
  112036. * * VertexBuffer.UV6Kind
  112037. * * VertexBuffer.ColorKind
  112038. * * VertexBuffer.MatricesIndicesKind
  112039. * * VertexBuffer.MatricesIndicesExtraKind
  112040. * * VertexBuffer.MatricesWeightsKind
  112041. * * VertexBuffer.MatricesWeightsExtraKind
  112042. * @param data defines the data source
  112043. * @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
  112044. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  112045. * @returns the current mesh
  112046. */
  112047. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  112048. /**
  112049. * Sets the mesh indices,
  112050. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  112051. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  112052. * @param totalVertices Defines the total number of vertices
  112053. * @returns the current mesh
  112054. */
  112055. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  112056. /**
  112057. * Gets a boolean indicating if specific vertex data is present
  112058. * @param kind defines the vertex data kind to use
  112059. * @returns true is data kind is present
  112060. */
  112061. isVerticesDataPresent(kind: string): boolean;
  112062. /**
  112063. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  112064. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  112065. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  112066. * @returns a BoundingInfo
  112067. */
  112068. getBoundingInfo(): BoundingInfo;
  112069. /**
  112070. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  112071. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  112072. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  112073. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  112074. * @returns the current mesh
  112075. */
  112076. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  112077. /**
  112078. * Overwrite the current bounding info
  112079. * @param boundingInfo defines the new bounding info
  112080. * @returns the current mesh
  112081. */
  112082. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  112083. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  112084. get useBones(): boolean;
  112085. /** @hidden */
  112086. _preActivate(): void;
  112087. /** @hidden */
  112088. _preActivateForIntermediateRendering(renderId: number): void;
  112089. /** @hidden */
  112090. _activate(renderId: number, intermediateRendering: boolean): boolean;
  112091. /** @hidden */
  112092. _postActivate(): void;
  112093. /** @hidden */
  112094. _freeze(): void;
  112095. /** @hidden */
  112096. _unFreeze(): void;
  112097. /**
  112098. * Gets the current world matrix
  112099. * @returns a Matrix
  112100. */
  112101. getWorldMatrix(): Matrix;
  112102. /** @hidden */
  112103. _getWorldMatrixDeterminant(): number;
  112104. /**
  112105. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  112106. */
  112107. get isAnInstance(): boolean;
  112108. /**
  112109. * Gets a boolean indicating if this mesh has instances
  112110. */
  112111. get hasInstances(): boolean;
  112112. /**
  112113. * Gets a boolean indicating if this mesh has thin instances
  112114. */
  112115. get hasThinInstances(): boolean;
  112116. /**
  112117. * Perform relative position change from the point of view of behind the front of the mesh.
  112118. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112119. * Supports definition of mesh facing forward or backward
  112120. * @param amountRight defines the distance on the right axis
  112121. * @param amountUp defines the distance on the up axis
  112122. * @param amountForward defines the distance on the forward axis
  112123. * @returns the current mesh
  112124. */
  112125. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  112126. /**
  112127. * Calculate relative position change from the point of view of behind the front of the mesh.
  112128. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112129. * Supports definition of mesh facing forward or backward
  112130. * @param amountRight defines the distance on the right axis
  112131. * @param amountUp defines the distance on the up axis
  112132. * @param amountForward defines the distance on the forward axis
  112133. * @returns the new displacement vector
  112134. */
  112135. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  112136. /**
  112137. * Perform relative rotation change from the point of view of behind the front of the mesh.
  112138. * Supports definition of mesh facing forward or backward
  112139. * @param flipBack defines the flip
  112140. * @param twirlClockwise defines the twirl
  112141. * @param tiltRight defines the tilt
  112142. * @returns the current mesh
  112143. */
  112144. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  112145. /**
  112146. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  112147. * Supports definition of mesh facing forward or backward.
  112148. * @param flipBack defines the flip
  112149. * @param twirlClockwise defines the twirl
  112150. * @param tiltRight defines the tilt
  112151. * @returns the new rotation vector
  112152. */
  112153. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  112154. /**
  112155. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  112156. * This means the mesh underlying bounding box and sphere are recomputed.
  112157. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  112158. * @returns the current mesh
  112159. */
  112160. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  112161. /** @hidden */
  112162. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  112163. /** @hidden */
  112164. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  112165. /** @hidden */
  112166. _updateBoundingInfo(): AbstractMesh;
  112167. /** @hidden */
  112168. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  112169. /** @hidden */
  112170. protected _afterComputeWorldMatrix(): void;
  112171. /** @hidden */
  112172. get _effectiveMesh(): AbstractMesh;
  112173. /**
  112174. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  112175. * A mesh is in the frustum if its bounding box intersects the frustum
  112176. * @param frustumPlanes defines the frustum to test
  112177. * @returns true if the mesh is in the frustum planes
  112178. */
  112179. isInFrustum(frustumPlanes: Plane[]): boolean;
  112180. /**
  112181. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  112182. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  112183. * @param frustumPlanes defines the frustum to test
  112184. * @returns true if the mesh is completely in the frustum planes
  112185. */
  112186. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  112187. /**
  112188. * True if the mesh intersects another mesh or a SolidParticle object
  112189. * @param mesh defines a target mesh or SolidParticle to test
  112190. * @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)
  112191. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  112192. * @returns true if there is an intersection
  112193. */
  112194. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  112195. /**
  112196. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  112197. * @param point defines the point to test
  112198. * @returns true if there is an intersection
  112199. */
  112200. intersectsPoint(point: Vector3): boolean;
  112201. /**
  112202. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  112203. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112204. */
  112205. get checkCollisions(): boolean;
  112206. set checkCollisions(collisionEnabled: boolean);
  112207. /**
  112208. * Gets Collider object used to compute collisions (not physics)
  112209. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112210. */
  112211. get collider(): Nullable<Collider>;
  112212. /**
  112213. * Move the mesh using collision engine
  112214. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112215. * @param displacement defines the requested displacement vector
  112216. * @returns the current mesh
  112217. */
  112218. moveWithCollisions(displacement: Vector3): AbstractMesh;
  112219. private _onCollisionPositionChange;
  112220. /** @hidden */
  112221. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  112222. /** @hidden */
  112223. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  112224. /** @hidden */
  112225. _checkCollision(collider: Collider): AbstractMesh;
  112226. /** @hidden */
  112227. _generatePointsArray(): boolean;
  112228. /**
  112229. * Checks if the passed Ray intersects with the mesh
  112230. * @param ray defines the ray to use
  112231. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  112232. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  112233. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  112234. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  112235. * @returns the picking info
  112236. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  112237. */
  112238. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  112239. /**
  112240. * Clones the current mesh
  112241. * @param name defines the mesh name
  112242. * @param newParent defines the new mesh parent
  112243. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  112244. * @returns the new mesh
  112245. */
  112246. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  112247. /**
  112248. * Disposes all the submeshes of the current meshnp
  112249. * @returns the current mesh
  112250. */
  112251. releaseSubMeshes(): AbstractMesh;
  112252. /**
  112253. * Releases resources associated with this abstract mesh.
  112254. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112255. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112256. */
  112257. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112258. /**
  112259. * Adds the passed mesh as a child to the current mesh
  112260. * @param mesh defines the child mesh
  112261. * @returns the current mesh
  112262. */
  112263. addChild(mesh: AbstractMesh): AbstractMesh;
  112264. /**
  112265. * Removes the passed mesh from the current mesh children list
  112266. * @param mesh defines the child mesh
  112267. * @returns the current mesh
  112268. */
  112269. removeChild(mesh: AbstractMesh): AbstractMesh;
  112270. /** @hidden */
  112271. private _initFacetData;
  112272. /**
  112273. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  112274. * This method can be called within the render loop.
  112275. * 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
  112276. * @returns the current mesh
  112277. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112278. */
  112279. updateFacetData(): AbstractMesh;
  112280. /**
  112281. * Returns the facetLocalNormals array.
  112282. * The normals are expressed in the mesh local spac
  112283. * @returns an array of Vector3
  112284. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112285. */
  112286. getFacetLocalNormals(): Vector3[];
  112287. /**
  112288. * Returns the facetLocalPositions array.
  112289. * The facet positions are expressed in the mesh local space
  112290. * @returns an array of Vector3
  112291. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112292. */
  112293. getFacetLocalPositions(): Vector3[];
  112294. /**
  112295. * Returns the facetLocalPartioning array
  112296. * @returns an array of array of numbers
  112297. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112298. */
  112299. getFacetLocalPartitioning(): number[][];
  112300. /**
  112301. * Returns the i-th facet position in the world system.
  112302. * This method allocates a new Vector3 per call
  112303. * @param i defines the facet index
  112304. * @returns a new Vector3
  112305. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112306. */
  112307. getFacetPosition(i: number): Vector3;
  112308. /**
  112309. * Sets the reference Vector3 with the i-th facet position in the world system
  112310. * @param i defines the facet index
  112311. * @param ref defines the target vector
  112312. * @returns the current mesh
  112313. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112314. */
  112315. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  112316. /**
  112317. * Returns the i-th facet normal in the world system.
  112318. * This method allocates a new Vector3 per call
  112319. * @param i defines the facet index
  112320. * @returns a new Vector3
  112321. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112322. */
  112323. getFacetNormal(i: number): Vector3;
  112324. /**
  112325. * Sets the reference Vector3 with the i-th facet normal in the world system
  112326. * @param i defines the facet index
  112327. * @param ref defines the target vector
  112328. * @returns the current mesh
  112329. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112330. */
  112331. getFacetNormalToRef(i: number, ref: Vector3): this;
  112332. /**
  112333. * 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)
  112334. * @param x defines x coordinate
  112335. * @param y defines y coordinate
  112336. * @param z defines z coordinate
  112337. * @returns the array of facet indexes
  112338. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112339. */
  112340. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  112341. /**
  112342. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  112343. * @param projected sets as the (x,y,z) world projection on the facet
  112344. * @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
  112345. * @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
  112346. * @param x defines x coordinate
  112347. * @param y defines y coordinate
  112348. * @param z defines z coordinate
  112349. * @returns the face index if found (or null instead)
  112350. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112351. */
  112352. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112353. /**
  112354. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  112355. * @param projected sets as the (x,y,z) local projection on the facet
  112356. * @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
  112357. * @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
  112358. * @param x defines x coordinate
  112359. * @param y defines y coordinate
  112360. * @param z defines z coordinate
  112361. * @returns the face index if found (or null instead)
  112362. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112363. */
  112364. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112365. /**
  112366. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  112367. * @returns the parameters
  112368. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112369. */
  112370. getFacetDataParameters(): any;
  112371. /**
  112372. * Disables the feature FacetData and frees the related memory
  112373. * @returns the current mesh
  112374. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112375. */
  112376. disableFacetData(): AbstractMesh;
  112377. /**
  112378. * Updates the AbstractMesh indices array
  112379. * @param indices defines the data source
  112380. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  112381. * @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)
  112382. * @returns the current mesh
  112383. */
  112384. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  112385. /**
  112386. * Creates new normals data for the mesh
  112387. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  112388. * @returns the current mesh
  112389. */
  112390. createNormals(updatable: boolean): AbstractMesh;
  112391. /**
  112392. * Align the mesh with a normal
  112393. * @param normal defines the normal to use
  112394. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  112395. * @returns the current mesh
  112396. */
  112397. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  112398. /** @hidden */
  112399. _checkOcclusionQuery(): boolean;
  112400. /**
  112401. * Disables the mesh edge rendering mode
  112402. * @returns the currentAbstractMesh
  112403. */
  112404. disableEdgesRendering(): AbstractMesh;
  112405. /**
  112406. * Enables the edge rendering mode on the mesh.
  112407. * This mode makes the mesh edges visible
  112408. * @param epsilon defines the maximal distance between two angles to detect a face
  112409. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  112410. * @returns the currentAbstractMesh
  112411. * @see https://www.babylonjs-playground.com/#19O9TU#0
  112412. */
  112413. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  112414. /**
  112415. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  112416. * @returns an array of particle systems in the scene that use the mesh as an emitter
  112417. */
  112418. getConnectedParticleSystems(): IParticleSystem[];
  112419. }
  112420. }
  112421. declare module BABYLON {
  112422. /**
  112423. * Interface used to define ActionEvent
  112424. */
  112425. export interface IActionEvent {
  112426. /** The mesh or sprite that triggered the action */
  112427. source: any;
  112428. /** The X mouse cursor position at the time of the event */
  112429. pointerX: number;
  112430. /** The Y mouse cursor position at the time of the event */
  112431. pointerY: number;
  112432. /** The mesh that is currently pointed at (can be null) */
  112433. meshUnderPointer: Nullable<AbstractMesh>;
  112434. /** the original (browser) event that triggered the ActionEvent */
  112435. sourceEvent?: any;
  112436. /** additional data for the event */
  112437. additionalData?: any;
  112438. }
  112439. /**
  112440. * ActionEvent is the event being sent when an action is triggered.
  112441. */
  112442. export class ActionEvent implements IActionEvent {
  112443. /** The mesh or sprite that triggered the action */
  112444. source: any;
  112445. /** The X mouse cursor position at the time of the event */
  112446. pointerX: number;
  112447. /** The Y mouse cursor position at the time of the event */
  112448. pointerY: number;
  112449. /** The mesh that is currently pointed at (can be null) */
  112450. meshUnderPointer: Nullable<AbstractMesh>;
  112451. /** the original (browser) event that triggered the ActionEvent */
  112452. sourceEvent?: any;
  112453. /** additional data for the event */
  112454. additionalData?: any;
  112455. /**
  112456. * Creates a new ActionEvent
  112457. * @param source The mesh or sprite that triggered the action
  112458. * @param pointerX The X mouse cursor position at the time of the event
  112459. * @param pointerY The Y mouse cursor position at the time of the event
  112460. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  112461. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  112462. * @param additionalData additional data for the event
  112463. */
  112464. constructor(
  112465. /** The mesh or sprite that triggered the action */
  112466. source: any,
  112467. /** The X mouse cursor position at the time of the event */
  112468. pointerX: number,
  112469. /** The Y mouse cursor position at the time of the event */
  112470. pointerY: number,
  112471. /** The mesh that is currently pointed at (can be null) */
  112472. meshUnderPointer: Nullable<AbstractMesh>,
  112473. /** the original (browser) event that triggered the ActionEvent */
  112474. sourceEvent?: any,
  112475. /** additional data for the event */
  112476. additionalData?: any);
  112477. /**
  112478. * Helper function to auto-create an ActionEvent from a source mesh.
  112479. * @param source The source mesh that triggered the event
  112480. * @param evt The original (browser) event
  112481. * @param additionalData additional data for the event
  112482. * @returns the new ActionEvent
  112483. */
  112484. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  112485. /**
  112486. * Helper function to auto-create an ActionEvent from a source sprite
  112487. * @param source The source sprite that triggered the event
  112488. * @param scene Scene associated with the sprite
  112489. * @param evt The original (browser) event
  112490. * @param additionalData additional data for the event
  112491. * @returns the new ActionEvent
  112492. */
  112493. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  112494. /**
  112495. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  112496. * @param scene the scene where the event occurred
  112497. * @param evt The original (browser) event
  112498. * @returns the new ActionEvent
  112499. */
  112500. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  112501. /**
  112502. * Helper function to auto-create an ActionEvent from a primitive
  112503. * @param prim defines the target primitive
  112504. * @param pointerPos defines the pointer position
  112505. * @param evt The original (browser) event
  112506. * @param additionalData additional data for the event
  112507. * @returns the new ActionEvent
  112508. */
  112509. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  112510. }
  112511. }
  112512. declare module BABYLON {
  112513. /**
  112514. * Abstract class used to decouple action Manager from scene and meshes.
  112515. * Do not instantiate.
  112516. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112517. */
  112518. export abstract class AbstractActionManager implements IDisposable {
  112519. /** Gets the list of active triggers */
  112520. static Triggers: {
  112521. [key: string]: number;
  112522. };
  112523. /** Gets the cursor to use when hovering items */
  112524. hoverCursor: string;
  112525. /** Gets the list of actions */
  112526. actions: IAction[];
  112527. /**
  112528. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  112529. */
  112530. isRecursive: boolean;
  112531. /**
  112532. * Releases all associated resources
  112533. */
  112534. abstract dispose(): void;
  112535. /**
  112536. * Does this action manager has pointer triggers
  112537. */
  112538. abstract get hasPointerTriggers(): boolean;
  112539. /**
  112540. * Does this action manager has pick triggers
  112541. */
  112542. abstract get hasPickTriggers(): boolean;
  112543. /**
  112544. * Process a specific trigger
  112545. * @param trigger defines the trigger to process
  112546. * @param evt defines the event details to be processed
  112547. */
  112548. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  112549. /**
  112550. * Does this action manager handles actions of any of the given triggers
  112551. * @param triggers defines the triggers to be tested
  112552. * @return a boolean indicating whether one (or more) of the triggers is handled
  112553. */
  112554. abstract hasSpecificTriggers(triggers: number[]): boolean;
  112555. /**
  112556. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  112557. * speed.
  112558. * @param triggerA defines the trigger to be tested
  112559. * @param triggerB defines the trigger to be tested
  112560. * @return a boolean indicating whether one (or more) of the triggers is handled
  112561. */
  112562. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  112563. /**
  112564. * Does this action manager handles actions of a given trigger
  112565. * @param trigger defines the trigger to be tested
  112566. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  112567. * @return whether the trigger is handled
  112568. */
  112569. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  112570. /**
  112571. * Serialize this manager to a JSON object
  112572. * @param name defines the property name to store this manager
  112573. * @returns a JSON representation of this manager
  112574. */
  112575. abstract serialize(name: string): any;
  112576. /**
  112577. * Registers an action to this action manager
  112578. * @param action defines the action to be registered
  112579. * @return the action amended (prepared) after registration
  112580. */
  112581. abstract registerAction(action: IAction): Nullable<IAction>;
  112582. /**
  112583. * Unregisters an action to this action manager
  112584. * @param action defines the action to be unregistered
  112585. * @return a boolean indicating whether the action has been unregistered
  112586. */
  112587. abstract unregisterAction(action: IAction): Boolean;
  112588. /**
  112589. * Does exist one action manager with at least one trigger
  112590. **/
  112591. static get HasTriggers(): boolean;
  112592. /**
  112593. * Does exist one action manager with at least one pick trigger
  112594. **/
  112595. static get HasPickTriggers(): boolean;
  112596. /**
  112597. * Does exist one action manager that handles actions of a given trigger
  112598. * @param trigger defines the trigger to be tested
  112599. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  112600. **/
  112601. static HasSpecificTrigger(trigger: number): boolean;
  112602. }
  112603. }
  112604. declare module BABYLON {
  112605. /**
  112606. * Defines how a node can be built from a string name.
  112607. */
  112608. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  112609. /**
  112610. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  112611. */
  112612. export class Node implements IBehaviorAware<Node> {
  112613. /** @hidden */
  112614. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  112615. private static _NodeConstructors;
  112616. /**
  112617. * Add a new node constructor
  112618. * @param type defines the type name of the node to construct
  112619. * @param constructorFunc defines the constructor function
  112620. */
  112621. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  112622. /**
  112623. * Returns a node constructor based on type name
  112624. * @param type defines the type name
  112625. * @param name defines the new node name
  112626. * @param scene defines the hosting scene
  112627. * @param options defines optional options to transmit to constructors
  112628. * @returns the new constructor or null
  112629. */
  112630. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  112631. /**
  112632. * Gets or sets the name of the node
  112633. */
  112634. name: string;
  112635. /**
  112636. * Gets or sets the id of the node
  112637. */
  112638. id: string;
  112639. /**
  112640. * Gets or sets the unique id of the node
  112641. */
  112642. uniqueId: number;
  112643. /**
  112644. * Gets or sets a string used to store user defined state for the node
  112645. */
  112646. state: string;
  112647. /**
  112648. * Gets or sets an object used to store user defined information for the node
  112649. */
  112650. metadata: any;
  112651. /**
  112652. * For internal use only. Please do not use.
  112653. */
  112654. reservedDataStore: any;
  112655. /**
  112656. * List of inspectable custom properties (used by the Inspector)
  112657. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  112658. */
  112659. inspectableCustomProperties: IInspectable[];
  112660. private _doNotSerialize;
  112661. /**
  112662. * Gets or sets a boolean used to define if the node must be serialized
  112663. */
  112664. get doNotSerialize(): boolean;
  112665. set doNotSerialize(value: boolean);
  112666. /** @hidden */
  112667. _isDisposed: boolean;
  112668. /**
  112669. * Gets a list of Animations associated with the node
  112670. */
  112671. animations: Animation[];
  112672. protected _ranges: {
  112673. [name: string]: Nullable<AnimationRange>;
  112674. };
  112675. /**
  112676. * Callback raised when the node is ready to be used
  112677. */
  112678. onReady: Nullable<(node: Node) => void>;
  112679. private _isEnabled;
  112680. private _isParentEnabled;
  112681. private _isReady;
  112682. /** @hidden */
  112683. _currentRenderId: number;
  112684. private _parentUpdateId;
  112685. /** @hidden */
  112686. _childUpdateId: number;
  112687. /** @hidden */
  112688. _waitingParentId: Nullable<string>;
  112689. /** @hidden */
  112690. _scene: Scene;
  112691. /** @hidden */
  112692. _cache: any;
  112693. private _parentNode;
  112694. private _children;
  112695. /** @hidden */
  112696. _worldMatrix: Matrix;
  112697. /** @hidden */
  112698. _worldMatrixDeterminant: number;
  112699. /** @hidden */
  112700. _worldMatrixDeterminantIsDirty: boolean;
  112701. /** @hidden */
  112702. private _sceneRootNodesIndex;
  112703. /**
  112704. * Gets a boolean indicating if the node has been disposed
  112705. * @returns true if the node was disposed
  112706. */
  112707. isDisposed(): boolean;
  112708. /**
  112709. * Gets or sets the parent of the node (without keeping the current position in the scene)
  112710. * @see https://doc.babylonjs.com/how_to/parenting
  112711. */
  112712. set parent(parent: Nullable<Node>);
  112713. get parent(): Nullable<Node>;
  112714. /** @hidden */
  112715. _addToSceneRootNodes(): void;
  112716. /** @hidden */
  112717. _removeFromSceneRootNodes(): void;
  112718. private _animationPropertiesOverride;
  112719. /**
  112720. * Gets or sets the animation properties override
  112721. */
  112722. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  112723. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  112724. /**
  112725. * Gets a string identifying the name of the class
  112726. * @returns "Node" string
  112727. */
  112728. getClassName(): string;
  112729. /** @hidden */
  112730. readonly _isNode: boolean;
  112731. /**
  112732. * An event triggered when the mesh is disposed
  112733. */
  112734. onDisposeObservable: Observable<Node>;
  112735. private _onDisposeObserver;
  112736. /**
  112737. * Sets a callback that will be raised when the node will be disposed
  112738. */
  112739. set onDispose(callback: () => void);
  112740. /**
  112741. * Creates a new Node
  112742. * @param name the name and id to be given to this node
  112743. * @param scene the scene this node will be added to
  112744. */
  112745. constructor(name: string, scene?: Nullable<Scene>);
  112746. /**
  112747. * Gets the scene of the node
  112748. * @returns a scene
  112749. */
  112750. getScene(): Scene;
  112751. /**
  112752. * Gets the engine of the node
  112753. * @returns a Engine
  112754. */
  112755. getEngine(): Engine;
  112756. private _behaviors;
  112757. /**
  112758. * Attach a behavior to the node
  112759. * @see https://doc.babylonjs.com/features/behaviour
  112760. * @param behavior defines the behavior to attach
  112761. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  112762. * @returns the current Node
  112763. */
  112764. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  112765. /**
  112766. * Remove an attached behavior
  112767. * @see https://doc.babylonjs.com/features/behaviour
  112768. * @param behavior defines the behavior to attach
  112769. * @returns the current Node
  112770. */
  112771. removeBehavior(behavior: Behavior<Node>): Node;
  112772. /**
  112773. * Gets the list of attached behaviors
  112774. * @see https://doc.babylonjs.com/features/behaviour
  112775. */
  112776. get behaviors(): Behavior<Node>[];
  112777. /**
  112778. * Gets an attached behavior by name
  112779. * @param name defines the name of the behavior to look for
  112780. * @see https://doc.babylonjs.com/features/behaviour
  112781. * @returns null if behavior was not found else the requested behavior
  112782. */
  112783. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  112784. /**
  112785. * Returns the latest update of the World matrix
  112786. * @returns a Matrix
  112787. */
  112788. getWorldMatrix(): Matrix;
  112789. /** @hidden */
  112790. _getWorldMatrixDeterminant(): number;
  112791. /**
  112792. * Returns directly the latest state of the mesh World matrix.
  112793. * A Matrix is returned.
  112794. */
  112795. get worldMatrixFromCache(): Matrix;
  112796. /** @hidden */
  112797. _initCache(): void;
  112798. /** @hidden */
  112799. updateCache(force?: boolean): void;
  112800. /** @hidden */
  112801. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112802. /** @hidden */
  112803. _updateCache(ignoreParentClass?: boolean): void;
  112804. /** @hidden */
  112805. _isSynchronized(): boolean;
  112806. /** @hidden */
  112807. _markSyncedWithParent(): void;
  112808. /** @hidden */
  112809. isSynchronizedWithParent(): boolean;
  112810. /** @hidden */
  112811. isSynchronized(): boolean;
  112812. /**
  112813. * Is this node ready to be used/rendered
  112814. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  112815. * @return true if the node is ready
  112816. */
  112817. isReady(completeCheck?: boolean): boolean;
  112818. /**
  112819. * Is this node enabled?
  112820. * 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
  112821. * @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
  112822. * @return whether this node (and its parent) is enabled
  112823. */
  112824. isEnabled(checkAncestors?: boolean): boolean;
  112825. /** @hidden */
  112826. protected _syncParentEnabledState(): void;
  112827. /**
  112828. * Set the enabled state of this node
  112829. * @param value defines the new enabled state
  112830. */
  112831. setEnabled(value: boolean): void;
  112832. /**
  112833. * Is this node a descendant of the given node?
  112834. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  112835. * @param ancestor defines the parent node to inspect
  112836. * @returns a boolean indicating if this node is a descendant of the given node
  112837. */
  112838. isDescendantOf(ancestor: Node): boolean;
  112839. /** @hidden */
  112840. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  112841. /**
  112842. * Will return all nodes that have this node as ascendant
  112843. * @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
  112844. * @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
  112845. * @return all children nodes of all types
  112846. */
  112847. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  112848. /**
  112849. * Get all child-meshes of this node
  112850. * @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)
  112851. * @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
  112852. * @returns an array of AbstractMesh
  112853. */
  112854. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  112855. /**
  112856. * Get all direct children of this node
  112857. * @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
  112858. * @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)
  112859. * @returns an array of Node
  112860. */
  112861. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  112862. /** @hidden */
  112863. _setReady(state: boolean): void;
  112864. /**
  112865. * Get an animation by name
  112866. * @param name defines the name of the animation to look for
  112867. * @returns null if not found else the requested animation
  112868. */
  112869. getAnimationByName(name: string): Nullable<Animation>;
  112870. /**
  112871. * Creates an animation range for this node
  112872. * @param name defines the name of the range
  112873. * @param from defines the starting key
  112874. * @param to defines the end key
  112875. */
  112876. createAnimationRange(name: string, from: number, to: number): void;
  112877. /**
  112878. * Delete a specific animation range
  112879. * @param name defines the name of the range to delete
  112880. * @param deleteFrames defines if animation frames from the range must be deleted as well
  112881. */
  112882. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  112883. /**
  112884. * Get an animation range by name
  112885. * @param name defines the name of the animation range to look for
  112886. * @returns null if not found else the requested animation range
  112887. */
  112888. getAnimationRange(name: string): Nullable<AnimationRange>;
  112889. /**
  112890. * Gets the list of all animation ranges defined on this node
  112891. * @returns an array
  112892. */
  112893. getAnimationRanges(): Nullable<AnimationRange>[];
  112894. /**
  112895. * Will start the animation sequence
  112896. * @param name defines the range frames for animation sequence
  112897. * @param loop defines if the animation should loop (false by default)
  112898. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  112899. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  112900. * @returns the object created for this animation. If range does not exist, it will return null
  112901. */
  112902. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  112903. /**
  112904. * Serialize animation ranges into a JSON compatible object
  112905. * @returns serialization object
  112906. */
  112907. serializeAnimationRanges(): any;
  112908. /**
  112909. * Computes the world matrix of the node
  112910. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  112911. * @returns the world matrix
  112912. */
  112913. computeWorldMatrix(force?: boolean): Matrix;
  112914. /**
  112915. * Releases resources associated with this node.
  112916. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112917. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112918. */
  112919. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112920. /**
  112921. * Parse animation range data from a serialization object and store them into a given node
  112922. * @param node defines where to store the animation ranges
  112923. * @param parsedNode defines the serialization object to read data from
  112924. * @param scene defines the hosting scene
  112925. */
  112926. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  112927. /**
  112928. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  112929. * @param includeDescendants Include bounding info from descendants as well (true by default)
  112930. * @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
  112931. * @returns the new bounding vectors
  112932. */
  112933. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  112934. min: Vector3;
  112935. max: Vector3;
  112936. };
  112937. }
  112938. }
  112939. declare module BABYLON {
  112940. /**
  112941. * @hidden
  112942. */
  112943. export class _IAnimationState {
  112944. key: number;
  112945. repeatCount: number;
  112946. workValue?: any;
  112947. loopMode?: number;
  112948. offsetValue?: any;
  112949. highLimitValue?: any;
  112950. }
  112951. /**
  112952. * Class used to store any kind of animation
  112953. */
  112954. export class Animation {
  112955. /**Name of the animation */
  112956. name: string;
  112957. /**Property to animate */
  112958. targetProperty: string;
  112959. /**The frames per second of the animation */
  112960. framePerSecond: number;
  112961. /**The data type of the animation */
  112962. dataType: number;
  112963. /**The loop mode of the animation */
  112964. loopMode?: number | undefined;
  112965. /**Specifies if blending should be enabled */
  112966. enableBlending?: boolean | undefined;
  112967. /**
  112968. * Use matrix interpolation instead of using direct key value when animating matrices
  112969. */
  112970. static AllowMatricesInterpolation: boolean;
  112971. /**
  112972. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  112973. */
  112974. static AllowMatrixDecomposeForInterpolation: boolean;
  112975. /** Define the Url to load snippets */
  112976. static SnippetUrl: string;
  112977. /** Snippet ID if the animation was created from the snippet server */
  112978. snippetId: string;
  112979. /**
  112980. * Stores the key frames of the animation
  112981. */
  112982. private _keys;
  112983. /**
  112984. * Stores the easing function of the animation
  112985. */
  112986. private _easingFunction;
  112987. /**
  112988. * @hidden Internal use only
  112989. */
  112990. _runtimeAnimations: RuntimeAnimation[];
  112991. /**
  112992. * The set of event that will be linked to this animation
  112993. */
  112994. private _events;
  112995. /**
  112996. * Stores an array of target property paths
  112997. */
  112998. targetPropertyPath: string[];
  112999. /**
  113000. * Stores the blending speed of the animation
  113001. */
  113002. blendingSpeed: number;
  113003. /**
  113004. * Stores the animation ranges for the animation
  113005. */
  113006. private _ranges;
  113007. /**
  113008. * @hidden Internal use
  113009. */
  113010. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  113011. /**
  113012. * Sets up an animation
  113013. * @param property The property to animate
  113014. * @param animationType The animation type to apply
  113015. * @param framePerSecond The frames per second of the animation
  113016. * @param easingFunction The easing function used in the animation
  113017. * @returns The created animation
  113018. */
  113019. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  113020. /**
  113021. * Create and start an animation on a node
  113022. * @param name defines the name of the global animation that will be run on all nodes
  113023. * @param node defines the root node where the animation will take place
  113024. * @param targetProperty defines property to animate
  113025. * @param framePerSecond defines the number of frame per second yo use
  113026. * @param totalFrame defines the number of frames in total
  113027. * @param from defines the initial value
  113028. * @param to defines the final value
  113029. * @param loopMode defines which loop mode you want to use (off by default)
  113030. * @param easingFunction defines the easing function to use (linear by default)
  113031. * @param onAnimationEnd defines the callback to call when animation end
  113032. * @returns the animatable created for this animation
  113033. */
  113034. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113035. /**
  113036. * Create and start an animation on a node and its descendants
  113037. * @param name defines the name of the global animation that will be run on all nodes
  113038. * @param node defines the root node where the animation will take place
  113039. * @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
  113040. * @param targetProperty defines property to animate
  113041. * @param framePerSecond defines the number of frame per second to use
  113042. * @param totalFrame defines the number of frames in total
  113043. * @param from defines the initial value
  113044. * @param to defines the final value
  113045. * @param loopMode defines which loop mode you want to use (off by default)
  113046. * @param easingFunction defines the easing function to use (linear by default)
  113047. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  113048. * @returns the list of animatables created for all nodes
  113049. * @example https://www.babylonjs-playground.com/#MH0VLI
  113050. */
  113051. 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[]>;
  113052. /**
  113053. * Creates a new animation, merges it with the existing animations and starts it
  113054. * @param name Name of the animation
  113055. * @param node Node which contains the scene that begins the animations
  113056. * @param targetProperty Specifies which property to animate
  113057. * @param framePerSecond The frames per second of the animation
  113058. * @param totalFrame The total number of frames
  113059. * @param from The frame at the beginning of the animation
  113060. * @param to The frame at the end of the animation
  113061. * @param loopMode Specifies the loop mode of the animation
  113062. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  113063. * @param onAnimationEnd Callback to run once the animation is complete
  113064. * @returns Nullable animation
  113065. */
  113066. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113067. /**
  113068. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  113069. * @param sourceAnimation defines the Animation containing keyframes to convert
  113070. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  113071. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  113072. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  113073. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  113074. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  113075. */
  113076. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  113077. /**
  113078. * Transition property of an host to the target Value
  113079. * @param property The property to transition
  113080. * @param targetValue The target Value of the property
  113081. * @param host The object where the property to animate belongs
  113082. * @param scene Scene used to run the animation
  113083. * @param frameRate Framerate (in frame/s) to use
  113084. * @param transition The transition type we want to use
  113085. * @param duration The duration of the animation, in milliseconds
  113086. * @param onAnimationEnd Callback trigger at the end of the animation
  113087. * @returns Nullable animation
  113088. */
  113089. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  113090. /**
  113091. * Return the array of runtime animations currently using this animation
  113092. */
  113093. get runtimeAnimations(): RuntimeAnimation[];
  113094. /**
  113095. * Specifies if any of the runtime animations are currently running
  113096. */
  113097. get hasRunningRuntimeAnimations(): boolean;
  113098. /**
  113099. * Initializes the animation
  113100. * @param name Name of the animation
  113101. * @param targetProperty Property to animate
  113102. * @param framePerSecond The frames per second of the animation
  113103. * @param dataType The data type of the animation
  113104. * @param loopMode The loop mode of the animation
  113105. * @param enableBlending Specifies if blending should be enabled
  113106. */
  113107. constructor(
  113108. /**Name of the animation */
  113109. name: string,
  113110. /**Property to animate */
  113111. targetProperty: string,
  113112. /**The frames per second of the animation */
  113113. framePerSecond: number,
  113114. /**The data type of the animation */
  113115. dataType: number,
  113116. /**The loop mode of the animation */
  113117. loopMode?: number | undefined,
  113118. /**Specifies if blending should be enabled */
  113119. enableBlending?: boolean | undefined);
  113120. /**
  113121. * Converts the animation to a string
  113122. * @param fullDetails support for multiple levels of logging within scene loading
  113123. * @returns String form of the animation
  113124. */
  113125. toString(fullDetails?: boolean): string;
  113126. /**
  113127. * Add an event to this animation
  113128. * @param event Event to add
  113129. */
  113130. addEvent(event: AnimationEvent): void;
  113131. /**
  113132. * Remove all events found at the given frame
  113133. * @param frame The frame to remove events from
  113134. */
  113135. removeEvents(frame: number): void;
  113136. /**
  113137. * Retrieves all the events from the animation
  113138. * @returns Events from the animation
  113139. */
  113140. getEvents(): AnimationEvent[];
  113141. /**
  113142. * Creates an animation range
  113143. * @param name Name of the animation range
  113144. * @param from Starting frame of the animation range
  113145. * @param to Ending frame of the animation
  113146. */
  113147. createRange(name: string, from: number, to: number): void;
  113148. /**
  113149. * Deletes an animation range by name
  113150. * @param name Name of the animation range to delete
  113151. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  113152. */
  113153. deleteRange(name: string, deleteFrames?: boolean): void;
  113154. /**
  113155. * Gets the animation range by name, or null if not defined
  113156. * @param name Name of the animation range
  113157. * @returns Nullable animation range
  113158. */
  113159. getRange(name: string): Nullable<AnimationRange>;
  113160. /**
  113161. * Gets the key frames from the animation
  113162. * @returns The key frames of the animation
  113163. */
  113164. getKeys(): Array<IAnimationKey>;
  113165. /**
  113166. * Gets the highest frame rate of the animation
  113167. * @returns Highest frame rate of the animation
  113168. */
  113169. getHighestFrame(): number;
  113170. /**
  113171. * Gets the easing function of the animation
  113172. * @returns Easing function of the animation
  113173. */
  113174. getEasingFunction(): IEasingFunction;
  113175. /**
  113176. * Sets the easing function of the animation
  113177. * @param easingFunction A custom mathematical formula for animation
  113178. */
  113179. setEasingFunction(easingFunction: EasingFunction): void;
  113180. /**
  113181. * Interpolates a scalar linearly
  113182. * @param startValue Start value of the animation curve
  113183. * @param endValue End value of the animation curve
  113184. * @param gradient Scalar amount to interpolate
  113185. * @returns Interpolated scalar value
  113186. */
  113187. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  113188. /**
  113189. * Interpolates a scalar cubically
  113190. * @param startValue Start value of the animation curve
  113191. * @param outTangent End tangent of the animation
  113192. * @param endValue End value of the animation curve
  113193. * @param inTangent Start tangent of the animation curve
  113194. * @param gradient Scalar amount to interpolate
  113195. * @returns Interpolated scalar value
  113196. */
  113197. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  113198. /**
  113199. * Interpolates a quaternion using a spherical linear interpolation
  113200. * @param startValue Start value of the animation curve
  113201. * @param endValue End value of the animation curve
  113202. * @param gradient Scalar amount to interpolate
  113203. * @returns Interpolated quaternion value
  113204. */
  113205. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  113206. /**
  113207. * Interpolates a quaternion cubically
  113208. * @param startValue Start value of the animation curve
  113209. * @param outTangent End tangent of the animation curve
  113210. * @param endValue End value of the animation curve
  113211. * @param inTangent Start tangent of the animation curve
  113212. * @param gradient Scalar amount to interpolate
  113213. * @returns Interpolated quaternion value
  113214. */
  113215. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  113216. /**
  113217. * Interpolates a Vector3 linearl
  113218. * @param startValue Start value of the animation curve
  113219. * @param endValue End value of the animation curve
  113220. * @param gradient Scalar amount to interpolate
  113221. * @returns Interpolated scalar value
  113222. */
  113223. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  113224. /**
  113225. * Interpolates a Vector3 cubically
  113226. * @param startValue Start value of the animation curve
  113227. * @param outTangent End tangent of the animation
  113228. * @param endValue End value of the animation curve
  113229. * @param inTangent Start tangent of the animation curve
  113230. * @param gradient Scalar amount to interpolate
  113231. * @returns InterpolatedVector3 value
  113232. */
  113233. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  113234. /**
  113235. * Interpolates a Vector2 linearly
  113236. * @param startValue Start value of the animation curve
  113237. * @param endValue End value of the animation curve
  113238. * @param gradient Scalar amount to interpolate
  113239. * @returns Interpolated Vector2 value
  113240. */
  113241. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  113242. /**
  113243. * Interpolates a Vector2 cubically
  113244. * @param startValue Start value of the animation curve
  113245. * @param outTangent End tangent of the animation
  113246. * @param endValue End value of the animation curve
  113247. * @param inTangent Start tangent of the animation curve
  113248. * @param gradient Scalar amount to interpolate
  113249. * @returns Interpolated Vector2 value
  113250. */
  113251. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  113252. /**
  113253. * Interpolates a size linearly
  113254. * @param startValue Start value of the animation curve
  113255. * @param endValue End value of the animation curve
  113256. * @param gradient Scalar amount to interpolate
  113257. * @returns Interpolated Size value
  113258. */
  113259. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  113260. /**
  113261. * Interpolates a Color3 linearly
  113262. * @param startValue Start value of the animation curve
  113263. * @param endValue End value of the animation curve
  113264. * @param gradient Scalar amount to interpolate
  113265. * @returns Interpolated Color3 value
  113266. */
  113267. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  113268. /**
  113269. * Interpolates a Color4 linearly
  113270. * @param startValue Start value of the animation curve
  113271. * @param endValue End value of the animation curve
  113272. * @param gradient Scalar amount to interpolate
  113273. * @returns Interpolated Color3 value
  113274. */
  113275. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  113276. /**
  113277. * @hidden Internal use only
  113278. */
  113279. _getKeyValue(value: any): any;
  113280. /**
  113281. * @hidden Internal use only
  113282. */
  113283. _interpolate(currentFrame: number, state: _IAnimationState): any;
  113284. /**
  113285. * Defines the function to use to interpolate matrices
  113286. * @param startValue defines the start matrix
  113287. * @param endValue defines the end matrix
  113288. * @param gradient defines the gradient between both matrices
  113289. * @param result defines an optional target matrix where to store the interpolation
  113290. * @returns the interpolated matrix
  113291. */
  113292. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  113293. /**
  113294. * Makes a copy of the animation
  113295. * @returns Cloned animation
  113296. */
  113297. clone(): Animation;
  113298. /**
  113299. * Sets the key frames of the animation
  113300. * @param values The animation key frames to set
  113301. */
  113302. setKeys(values: Array<IAnimationKey>): void;
  113303. /**
  113304. * Serializes the animation to an object
  113305. * @returns Serialized object
  113306. */
  113307. serialize(): any;
  113308. /**
  113309. * Float animation type
  113310. */
  113311. static readonly ANIMATIONTYPE_FLOAT: number;
  113312. /**
  113313. * Vector3 animation type
  113314. */
  113315. static readonly ANIMATIONTYPE_VECTOR3: number;
  113316. /**
  113317. * Quaternion animation type
  113318. */
  113319. static readonly ANIMATIONTYPE_QUATERNION: number;
  113320. /**
  113321. * Matrix animation type
  113322. */
  113323. static readonly ANIMATIONTYPE_MATRIX: number;
  113324. /**
  113325. * Color3 animation type
  113326. */
  113327. static readonly ANIMATIONTYPE_COLOR3: number;
  113328. /**
  113329. * Color3 animation type
  113330. */
  113331. static readonly ANIMATIONTYPE_COLOR4: number;
  113332. /**
  113333. * Vector2 animation type
  113334. */
  113335. static readonly ANIMATIONTYPE_VECTOR2: number;
  113336. /**
  113337. * Size animation type
  113338. */
  113339. static readonly ANIMATIONTYPE_SIZE: number;
  113340. /**
  113341. * Relative Loop Mode
  113342. */
  113343. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  113344. /**
  113345. * Cycle Loop Mode
  113346. */
  113347. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  113348. /**
  113349. * Constant Loop Mode
  113350. */
  113351. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  113352. /** @hidden */
  113353. static _UniversalLerp(left: any, right: any, amount: number): any;
  113354. /**
  113355. * Parses an animation object and creates an animation
  113356. * @param parsedAnimation Parsed animation object
  113357. * @returns Animation object
  113358. */
  113359. static Parse(parsedAnimation: any): Animation;
  113360. /**
  113361. * Appends the serialized animations from the source animations
  113362. * @param source Source containing the animations
  113363. * @param destination Target to store the animations
  113364. */
  113365. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113366. /**
  113367. * Creates a new animation or an array of animations from a snippet saved in a remote file
  113368. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  113369. * @param url defines the url to load from
  113370. * @returns a promise that will resolve to the new animation or an array of animations
  113371. */
  113372. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  113373. /**
  113374. * Creates an animation or an array of animations from a snippet saved by the Inspector
  113375. * @param snippetId defines the snippet to load
  113376. * @returns a promise that will resolve to the new animation or a new array of animations
  113377. */
  113378. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  113379. }
  113380. }
  113381. declare module BABYLON {
  113382. /**
  113383. * Interface containing an array of animations
  113384. */
  113385. export interface IAnimatable {
  113386. /**
  113387. * Array of animations
  113388. */
  113389. animations: Nullable<Array<Animation>>;
  113390. }
  113391. }
  113392. declare module BABYLON {
  113393. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  113394. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113395. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113396. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113397. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113398. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113399. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113400. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113401. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113402. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113403. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113404. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113405. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113406. /**
  113407. * Decorator used to define property that can be serialized as reference to a camera
  113408. * @param sourceName defines the name of the property to decorate
  113409. */
  113410. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113411. /**
  113412. * Class used to help serialization objects
  113413. */
  113414. export class SerializationHelper {
  113415. /** @hidden */
  113416. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  113417. /** @hidden */
  113418. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  113419. /** @hidden */
  113420. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  113421. /** @hidden */
  113422. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  113423. /**
  113424. * Appends the serialized animations from the source animations
  113425. * @param source Source containing the animations
  113426. * @param destination Target to store the animations
  113427. */
  113428. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113429. /**
  113430. * Static function used to serialized a specific entity
  113431. * @param entity defines the entity to serialize
  113432. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  113433. * @returns a JSON compatible object representing the serialization of the entity
  113434. */
  113435. static Serialize<T>(entity: T, serializationObject?: any): any;
  113436. /**
  113437. * Creates a new entity from a serialization data object
  113438. * @param creationFunction defines a function used to instanciated the new entity
  113439. * @param source defines the source serialization data
  113440. * @param scene defines the hosting scene
  113441. * @param rootUrl defines the root url for resources
  113442. * @returns a new entity
  113443. */
  113444. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  113445. /**
  113446. * Clones an object
  113447. * @param creationFunction defines the function used to instanciate the new object
  113448. * @param source defines the source object
  113449. * @returns the cloned object
  113450. */
  113451. static Clone<T>(creationFunction: () => T, source: T): T;
  113452. /**
  113453. * Instanciates a new object based on a source one (some data will be shared between both object)
  113454. * @param creationFunction defines the function used to instanciate the new object
  113455. * @param source defines the source object
  113456. * @returns the new object
  113457. */
  113458. static Instanciate<T>(creationFunction: () => T, source: T): T;
  113459. }
  113460. }
  113461. declare module BABYLON {
  113462. /**
  113463. * Base class of all the textures in babylon.
  113464. * It groups all the common properties the materials, post process, lights... might need
  113465. * in order to make a correct use of the texture.
  113466. */
  113467. export class BaseTexture implements IAnimatable {
  113468. /**
  113469. * Default anisotropic filtering level for the application.
  113470. * It is set to 4 as a good tradeoff between perf and quality.
  113471. */
  113472. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  113473. /**
  113474. * Gets or sets the unique id of the texture
  113475. */
  113476. uniqueId: number;
  113477. /**
  113478. * Define the name of the texture.
  113479. */
  113480. name: string;
  113481. /**
  113482. * Gets or sets an object used to store user defined information.
  113483. */
  113484. metadata: any;
  113485. /**
  113486. * For internal use only. Please do not use.
  113487. */
  113488. reservedDataStore: any;
  113489. private _hasAlpha;
  113490. /**
  113491. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  113492. */
  113493. set hasAlpha(value: boolean);
  113494. get hasAlpha(): boolean;
  113495. /**
  113496. * Defines if the alpha value should be determined via the rgb values.
  113497. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  113498. */
  113499. getAlphaFromRGB: boolean;
  113500. /**
  113501. * Intensity or strength of the texture.
  113502. * It is commonly used by materials to fine tune the intensity of the texture
  113503. */
  113504. level: number;
  113505. /**
  113506. * Define the UV chanel to use starting from 0 and defaulting to 0.
  113507. * This is part of the texture as textures usually maps to one uv set.
  113508. */
  113509. coordinatesIndex: number;
  113510. protected _coordinatesMode: number;
  113511. /**
  113512. * How a texture is mapped.
  113513. *
  113514. * | Value | Type | Description |
  113515. * | ----- | ----------------------------------- | ----------- |
  113516. * | 0 | EXPLICIT_MODE | |
  113517. * | 1 | SPHERICAL_MODE | |
  113518. * | 2 | PLANAR_MODE | |
  113519. * | 3 | CUBIC_MODE | |
  113520. * | 4 | PROJECTION_MODE | |
  113521. * | 5 | SKYBOX_MODE | |
  113522. * | 6 | INVCUBIC_MODE | |
  113523. * | 7 | EQUIRECTANGULAR_MODE | |
  113524. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  113525. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  113526. */
  113527. set coordinatesMode(value: number);
  113528. get coordinatesMode(): number;
  113529. private _wrapU;
  113530. /**
  113531. * | Value | Type | Description |
  113532. * | ----- | ------------------ | ----------- |
  113533. * | 0 | CLAMP_ADDRESSMODE | |
  113534. * | 1 | WRAP_ADDRESSMODE | |
  113535. * | 2 | MIRROR_ADDRESSMODE | |
  113536. */
  113537. get wrapU(): number;
  113538. set wrapU(value: number);
  113539. private _wrapV;
  113540. /**
  113541. * | Value | Type | Description |
  113542. * | ----- | ------------------ | ----------- |
  113543. * | 0 | CLAMP_ADDRESSMODE | |
  113544. * | 1 | WRAP_ADDRESSMODE | |
  113545. * | 2 | MIRROR_ADDRESSMODE | |
  113546. */
  113547. get wrapV(): number;
  113548. set wrapV(value: number);
  113549. /**
  113550. * | Value | Type | Description |
  113551. * | ----- | ------------------ | ----------- |
  113552. * | 0 | CLAMP_ADDRESSMODE | |
  113553. * | 1 | WRAP_ADDRESSMODE | |
  113554. * | 2 | MIRROR_ADDRESSMODE | |
  113555. */
  113556. wrapR: number;
  113557. /**
  113558. * With compliant hardware and browser (supporting anisotropic filtering)
  113559. * this defines the level of anisotropic filtering in the texture.
  113560. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  113561. */
  113562. anisotropicFilteringLevel: number;
  113563. /**
  113564. * Define if the texture is a cube texture or if false a 2d texture.
  113565. */
  113566. get isCube(): boolean;
  113567. set isCube(value: boolean);
  113568. /**
  113569. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  113570. */
  113571. get is3D(): boolean;
  113572. set is3D(value: boolean);
  113573. /**
  113574. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  113575. */
  113576. get is2DArray(): boolean;
  113577. set is2DArray(value: boolean);
  113578. /**
  113579. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  113580. * HDR texture are usually stored in linear space.
  113581. * This only impacts the PBR and Background materials
  113582. */
  113583. gammaSpace: boolean;
  113584. /**
  113585. * Gets or sets whether or not the texture contains RGBD data.
  113586. */
  113587. get isRGBD(): boolean;
  113588. set isRGBD(value: boolean);
  113589. /**
  113590. * Is Z inverted in the texture (useful in a cube texture).
  113591. */
  113592. invertZ: boolean;
  113593. /**
  113594. * Are mip maps generated for this texture or not.
  113595. */
  113596. get noMipmap(): boolean;
  113597. /**
  113598. * @hidden
  113599. */
  113600. lodLevelInAlpha: boolean;
  113601. /**
  113602. * With prefiltered texture, defined the offset used during the prefiltering steps.
  113603. */
  113604. get lodGenerationOffset(): number;
  113605. set lodGenerationOffset(value: number);
  113606. /**
  113607. * With prefiltered texture, defined the scale used during the prefiltering steps.
  113608. */
  113609. get lodGenerationScale(): number;
  113610. set lodGenerationScale(value: number);
  113611. /**
  113612. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  113613. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  113614. * average roughness values.
  113615. */
  113616. get linearSpecularLOD(): boolean;
  113617. set linearSpecularLOD(value: boolean);
  113618. /**
  113619. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  113620. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  113621. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  113622. */
  113623. get irradianceTexture(): Nullable<BaseTexture>;
  113624. set irradianceTexture(value: Nullable<BaseTexture>);
  113625. /**
  113626. * Define if the texture is a render target.
  113627. */
  113628. isRenderTarget: boolean;
  113629. /**
  113630. * Define the unique id of the texture in the scene.
  113631. */
  113632. get uid(): string;
  113633. /** @hidden */
  113634. _prefiltered: boolean;
  113635. /**
  113636. * Return a string representation of the texture.
  113637. * @returns the texture as a string
  113638. */
  113639. toString(): string;
  113640. /**
  113641. * Get the class name of the texture.
  113642. * @returns "BaseTexture"
  113643. */
  113644. getClassName(): string;
  113645. /**
  113646. * Define the list of animation attached to the texture.
  113647. */
  113648. animations: Animation[];
  113649. /**
  113650. * An event triggered when the texture is disposed.
  113651. */
  113652. onDisposeObservable: Observable<BaseTexture>;
  113653. private _onDisposeObserver;
  113654. /**
  113655. * Callback triggered when the texture has been disposed.
  113656. * Kept for back compatibility, you can use the onDisposeObservable instead.
  113657. */
  113658. set onDispose(callback: () => void);
  113659. /**
  113660. * Define the current state of the loading sequence when in delayed load mode.
  113661. */
  113662. delayLoadState: number;
  113663. protected _scene: Nullable<Scene>;
  113664. protected _engine: Nullable<ThinEngine>;
  113665. /** @hidden */
  113666. _texture: Nullable<InternalTexture>;
  113667. private _uid;
  113668. /**
  113669. * Define if the texture is preventinga material to render or not.
  113670. * If not and the texture is not ready, the engine will use a default black texture instead.
  113671. */
  113672. get isBlocking(): boolean;
  113673. /**
  113674. * Instantiates a new BaseTexture.
  113675. * Base class of all the textures in babylon.
  113676. * It groups all the common properties the materials, post process, lights... might need
  113677. * in order to make a correct use of the texture.
  113678. * @param sceneOrEngine Define the scene or engine the texture blongs to
  113679. */
  113680. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  113681. /**
  113682. * Get the scene the texture belongs to.
  113683. * @returns the scene or null if undefined
  113684. */
  113685. getScene(): Nullable<Scene>;
  113686. /** @hidden */
  113687. protected _getEngine(): Nullable<ThinEngine>;
  113688. /**
  113689. * Get the texture transform matrix used to offset tile the texture for istance.
  113690. * @returns the transformation matrix
  113691. */
  113692. getTextureMatrix(): Matrix;
  113693. /**
  113694. * Get the texture reflection matrix used to rotate/transform the reflection.
  113695. * @returns the reflection matrix
  113696. */
  113697. getReflectionTextureMatrix(): Matrix;
  113698. /**
  113699. * Get the underlying lower level texture from Babylon.
  113700. * @returns the insternal texture
  113701. */
  113702. getInternalTexture(): Nullable<InternalTexture>;
  113703. /**
  113704. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  113705. * @returns true if ready or not blocking
  113706. */
  113707. isReadyOrNotBlocking(): boolean;
  113708. /**
  113709. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  113710. * @returns true if fully ready
  113711. */
  113712. isReady(): boolean;
  113713. private _cachedSize;
  113714. /**
  113715. * Get the size of the texture.
  113716. * @returns the texture size.
  113717. */
  113718. getSize(): ISize;
  113719. /**
  113720. * Get the base size of the texture.
  113721. * It can be different from the size if the texture has been resized for POT for instance
  113722. * @returns the base size
  113723. */
  113724. getBaseSize(): ISize;
  113725. /**
  113726. * Update the sampling mode of the texture.
  113727. * Default is Trilinear mode.
  113728. *
  113729. * | Value | Type | Description |
  113730. * | ----- | ------------------ | ----------- |
  113731. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  113732. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  113733. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  113734. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  113735. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  113736. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  113737. * | 7 | NEAREST_LINEAR | |
  113738. * | 8 | NEAREST_NEAREST | |
  113739. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  113740. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  113741. * | 11 | LINEAR_LINEAR | |
  113742. * | 12 | LINEAR_NEAREST | |
  113743. *
  113744. * > _mag_: magnification filter (close to the viewer)
  113745. * > _min_: minification filter (far from the viewer)
  113746. * > _mip_: filter used between mip map levels
  113747. *@param samplingMode Define the new sampling mode of the texture
  113748. */
  113749. updateSamplingMode(samplingMode: number): void;
  113750. /**
  113751. * Scales the texture if is `canRescale()`
  113752. * @param ratio the resize factor we want to use to rescale
  113753. */
  113754. scale(ratio: number): void;
  113755. /**
  113756. * Get if the texture can rescale.
  113757. */
  113758. get canRescale(): boolean;
  113759. /** @hidden */
  113760. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  113761. /** @hidden */
  113762. _rebuild(): void;
  113763. /**
  113764. * Triggers the load sequence in delayed load mode.
  113765. */
  113766. delayLoad(): void;
  113767. /**
  113768. * Clones the texture.
  113769. * @returns the cloned texture
  113770. */
  113771. clone(): Nullable<BaseTexture>;
  113772. /**
  113773. * Get the texture underlying type (INT, FLOAT...)
  113774. */
  113775. get textureType(): number;
  113776. /**
  113777. * Get the texture underlying format (RGB, RGBA...)
  113778. */
  113779. get textureFormat(): number;
  113780. /**
  113781. * Indicates that textures need to be re-calculated for all materials
  113782. */
  113783. protected _markAllSubMeshesAsTexturesDirty(): void;
  113784. /**
  113785. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  113786. * This will returns an RGBA array buffer containing either in values (0-255) or
  113787. * float values (0-1) depending of the underlying buffer type.
  113788. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  113789. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  113790. * @param buffer defines a user defined buffer to fill with data (can be null)
  113791. * @returns The Array buffer containing the pixels data.
  113792. */
  113793. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  113794. /**
  113795. * Release and destroy the underlying lower level texture aka internalTexture.
  113796. */
  113797. releaseInternalTexture(): void;
  113798. /** @hidden */
  113799. get _lodTextureHigh(): Nullable<BaseTexture>;
  113800. /** @hidden */
  113801. get _lodTextureMid(): Nullable<BaseTexture>;
  113802. /** @hidden */
  113803. get _lodTextureLow(): Nullable<BaseTexture>;
  113804. /**
  113805. * Dispose the texture and release its associated resources.
  113806. */
  113807. dispose(): void;
  113808. /**
  113809. * Serialize the texture into a JSON representation that can be parsed later on.
  113810. * @returns the JSON representation of the texture
  113811. */
  113812. serialize(): any;
  113813. /**
  113814. * Helper function to be called back once a list of texture contains only ready textures.
  113815. * @param textures Define the list of textures to wait for
  113816. * @param callback Define the callback triggered once the entire list will be ready
  113817. */
  113818. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  113819. private static _isScene;
  113820. }
  113821. }
  113822. declare module BABYLON {
  113823. /**
  113824. * Options to be used when creating an effect.
  113825. */
  113826. export interface IEffectCreationOptions {
  113827. /**
  113828. * Atrributes that will be used in the shader.
  113829. */
  113830. attributes: string[];
  113831. /**
  113832. * Uniform varible names that will be set in the shader.
  113833. */
  113834. uniformsNames: string[];
  113835. /**
  113836. * Uniform buffer variable names that will be set in the shader.
  113837. */
  113838. uniformBuffersNames: string[];
  113839. /**
  113840. * Sampler texture variable names that will be set in the shader.
  113841. */
  113842. samplers: string[];
  113843. /**
  113844. * Define statements that will be set in the shader.
  113845. */
  113846. defines: any;
  113847. /**
  113848. * Possible fallbacks for this effect to improve performance when needed.
  113849. */
  113850. fallbacks: Nullable<IEffectFallbacks>;
  113851. /**
  113852. * Callback that will be called when the shader is compiled.
  113853. */
  113854. onCompiled: Nullable<(effect: Effect) => void>;
  113855. /**
  113856. * Callback that will be called if an error occurs during shader compilation.
  113857. */
  113858. onError: Nullable<(effect: Effect, errors: string) => void>;
  113859. /**
  113860. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113861. */
  113862. indexParameters?: any;
  113863. /**
  113864. * Max number of lights that can be used in the shader.
  113865. */
  113866. maxSimultaneousLights?: number;
  113867. /**
  113868. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  113869. */
  113870. transformFeedbackVaryings?: Nullable<string[]>;
  113871. /**
  113872. * 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
  113873. */
  113874. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  113875. /**
  113876. * Is this effect rendering to several color attachments ?
  113877. */
  113878. multiTarget?: boolean;
  113879. }
  113880. /**
  113881. * Effect containing vertex and fragment shader that can be executed on an object.
  113882. */
  113883. export class Effect implements IDisposable {
  113884. /**
  113885. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113886. */
  113887. static ShadersRepository: string;
  113888. /**
  113889. * Enable logging of the shader code when a compilation error occurs
  113890. */
  113891. static LogShaderCodeOnCompilationError: boolean;
  113892. /**
  113893. * Name of the effect.
  113894. */
  113895. name: any;
  113896. /**
  113897. * String container all the define statements that should be set on the shader.
  113898. */
  113899. defines: string;
  113900. /**
  113901. * Callback that will be called when the shader is compiled.
  113902. */
  113903. onCompiled: Nullable<(effect: Effect) => void>;
  113904. /**
  113905. * Callback that will be called if an error occurs during shader compilation.
  113906. */
  113907. onError: Nullable<(effect: Effect, errors: string) => void>;
  113908. /**
  113909. * Callback that will be called when effect is bound.
  113910. */
  113911. onBind: Nullable<(effect: Effect) => void>;
  113912. /**
  113913. * Unique ID of the effect.
  113914. */
  113915. uniqueId: number;
  113916. /**
  113917. * Observable that will be called when the shader is compiled.
  113918. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  113919. */
  113920. onCompileObservable: Observable<Effect>;
  113921. /**
  113922. * Observable that will be called if an error occurs during shader compilation.
  113923. */
  113924. onErrorObservable: Observable<Effect>;
  113925. /** @hidden */
  113926. _onBindObservable: Nullable<Observable<Effect>>;
  113927. /**
  113928. * @hidden
  113929. * Specifies if the effect was previously ready
  113930. */
  113931. _wasPreviouslyReady: boolean;
  113932. /**
  113933. * Observable that will be called when effect is bound.
  113934. */
  113935. get onBindObservable(): Observable<Effect>;
  113936. /** @hidden */
  113937. _bonesComputationForcedToCPU: boolean;
  113938. /** @hidden */
  113939. _multiTarget: boolean;
  113940. private static _uniqueIdSeed;
  113941. private _engine;
  113942. private _uniformBuffersNames;
  113943. private _uniformBuffersNamesList;
  113944. private _uniformsNames;
  113945. private _samplerList;
  113946. private _samplers;
  113947. private _isReady;
  113948. private _compilationError;
  113949. private _allFallbacksProcessed;
  113950. private _attributesNames;
  113951. private _attributes;
  113952. private _attributeLocationByName;
  113953. private _uniforms;
  113954. /**
  113955. * Key for the effect.
  113956. * @hidden
  113957. */
  113958. _key: string;
  113959. private _indexParameters;
  113960. private _fallbacks;
  113961. private _vertexSourceCode;
  113962. private _fragmentSourceCode;
  113963. private _vertexSourceCodeOverride;
  113964. private _fragmentSourceCodeOverride;
  113965. private _transformFeedbackVaryings;
  113966. /**
  113967. * Compiled shader to webGL program.
  113968. * @hidden
  113969. */
  113970. _pipelineContext: Nullable<IPipelineContext>;
  113971. private _valueCache;
  113972. private static _baseCache;
  113973. /**
  113974. * Instantiates an effect.
  113975. * An effect can be used to create/manage/execute vertex and fragment shaders.
  113976. * @param baseName Name of the effect.
  113977. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  113978. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  113979. * @param samplers List of sampler variables that will be passed to the shader.
  113980. * @param engine Engine to be used to render the effect
  113981. * @param defines Define statements to be added to the shader.
  113982. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  113983. * @param onCompiled Callback that will be called when the shader is compiled.
  113984. * @param onError Callback that will be called if an error occurs during shader compilation.
  113985. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113986. */
  113987. 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);
  113988. private _useFinalCode;
  113989. /**
  113990. * Unique key for this effect
  113991. */
  113992. get key(): string;
  113993. /**
  113994. * If the effect has been compiled and prepared.
  113995. * @returns if the effect is compiled and prepared.
  113996. */
  113997. isReady(): boolean;
  113998. private _isReadyInternal;
  113999. /**
  114000. * The engine the effect was initialized with.
  114001. * @returns the engine.
  114002. */
  114003. getEngine(): Engine;
  114004. /**
  114005. * The pipeline context for this effect
  114006. * @returns the associated pipeline context
  114007. */
  114008. getPipelineContext(): Nullable<IPipelineContext>;
  114009. /**
  114010. * The set of names of attribute variables for the shader.
  114011. * @returns An array of attribute names.
  114012. */
  114013. getAttributesNames(): string[];
  114014. /**
  114015. * Returns the attribute at the given index.
  114016. * @param index The index of the attribute.
  114017. * @returns The location of the attribute.
  114018. */
  114019. getAttributeLocation(index: number): number;
  114020. /**
  114021. * Returns the attribute based on the name of the variable.
  114022. * @param name of the attribute to look up.
  114023. * @returns the attribute location.
  114024. */
  114025. getAttributeLocationByName(name: string): number;
  114026. /**
  114027. * The number of attributes.
  114028. * @returns the numnber of attributes.
  114029. */
  114030. getAttributesCount(): number;
  114031. /**
  114032. * Gets the index of a uniform variable.
  114033. * @param uniformName of the uniform to look up.
  114034. * @returns the index.
  114035. */
  114036. getUniformIndex(uniformName: string): number;
  114037. /**
  114038. * Returns the attribute based on the name of the variable.
  114039. * @param uniformName of the uniform to look up.
  114040. * @returns the location of the uniform.
  114041. */
  114042. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  114043. /**
  114044. * Returns an array of sampler variable names
  114045. * @returns The array of sampler variable names.
  114046. */
  114047. getSamplers(): string[];
  114048. /**
  114049. * Returns an array of uniform variable names
  114050. * @returns The array of uniform variable names.
  114051. */
  114052. getUniformNames(): string[];
  114053. /**
  114054. * Returns an array of uniform buffer variable names
  114055. * @returns The array of uniform buffer variable names.
  114056. */
  114057. getUniformBuffersNames(): string[];
  114058. /**
  114059. * Returns the index parameters used to create the effect
  114060. * @returns The index parameters object
  114061. */
  114062. getIndexParameters(): any;
  114063. /**
  114064. * The error from the last compilation.
  114065. * @returns the error string.
  114066. */
  114067. getCompilationError(): string;
  114068. /**
  114069. * Gets a boolean indicating that all fallbacks were used during compilation
  114070. * @returns true if all fallbacks were used
  114071. */
  114072. allFallbacksProcessed(): boolean;
  114073. /**
  114074. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  114075. * @param func The callback to be used.
  114076. */
  114077. executeWhenCompiled(func: (effect: Effect) => void): void;
  114078. private _checkIsReady;
  114079. private _loadShader;
  114080. /**
  114081. * Gets the vertex shader source code of this effect
  114082. */
  114083. get vertexSourceCode(): string;
  114084. /**
  114085. * Gets the fragment shader source code of this effect
  114086. */
  114087. get fragmentSourceCode(): string;
  114088. /**
  114089. * Recompiles the webGL program
  114090. * @param vertexSourceCode The source code for the vertex shader.
  114091. * @param fragmentSourceCode The source code for the fragment shader.
  114092. * @param onCompiled Callback called when completed.
  114093. * @param onError Callback called on error.
  114094. * @hidden
  114095. */
  114096. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  114097. /**
  114098. * Prepares the effect
  114099. * @hidden
  114100. */
  114101. _prepareEffect(): void;
  114102. private _getShaderCodeAndErrorLine;
  114103. private _processCompilationErrors;
  114104. /**
  114105. * Checks if the effect is supported. (Must be called after compilation)
  114106. */
  114107. get isSupported(): boolean;
  114108. /**
  114109. * Binds a texture to the engine to be used as output of the shader.
  114110. * @param channel Name of the output variable.
  114111. * @param texture Texture to bind.
  114112. * @hidden
  114113. */
  114114. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  114115. /**
  114116. * Sets a texture on the engine to be used in the shader.
  114117. * @param channel Name of the sampler variable.
  114118. * @param texture Texture to set.
  114119. */
  114120. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  114121. /**
  114122. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  114123. * @param channel Name of the sampler variable.
  114124. * @param texture Texture to set.
  114125. */
  114126. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  114127. /**
  114128. * Sets an array of textures on the engine to be used in the shader.
  114129. * @param channel Name of the variable.
  114130. * @param textures Textures to set.
  114131. */
  114132. setTextureArray(channel: string, textures: BaseTexture[]): void;
  114133. /**
  114134. * 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)
  114135. * @param channel Name of the sampler variable.
  114136. * @param postProcess Post process to get the input texture from.
  114137. */
  114138. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  114139. /**
  114140. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  114141. * 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)
  114142. * @param channel Name of the sampler variable.
  114143. * @param postProcess Post process to get the output texture from.
  114144. */
  114145. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  114146. /** @hidden */
  114147. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  114148. /** @hidden */
  114149. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  114150. /** @hidden */
  114151. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  114152. /** @hidden */
  114153. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  114154. /**
  114155. * Binds a buffer to a uniform.
  114156. * @param buffer Buffer to bind.
  114157. * @param name Name of the uniform variable to bind to.
  114158. */
  114159. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  114160. /**
  114161. * Binds block to a uniform.
  114162. * @param blockName Name of the block to bind.
  114163. * @param index Index to bind.
  114164. */
  114165. bindUniformBlock(blockName: string, index: number): void;
  114166. /**
  114167. * Sets an interger value on a uniform variable.
  114168. * @param uniformName Name of the variable.
  114169. * @param value Value to be set.
  114170. * @returns this effect.
  114171. */
  114172. setInt(uniformName: string, value: number): Effect;
  114173. /**
  114174. * Sets an int array on a uniform variable.
  114175. * @param uniformName Name of the variable.
  114176. * @param array array to be set.
  114177. * @returns this effect.
  114178. */
  114179. setIntArray(uniformName: string, array: Int32Array): Effect;
  114180. /**
  114181. * 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)
  114182. * @param uniformName Name of the variable.
  114183. * @param array array to be set.
  114184. * @returns this effect.
  114185. */
  114186. setIntArray2(uniformName: string, array: Int32Array): Effect;
  114187. /**
  114188. * 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)
  114189. * @param uniformName Name of the variable.
  114190. * @param array array to be set.
  114191. * @returns this effect.
  114192. */
  114193. setIntArray3(uniformName: string, array: Int32Array): Effect;
  114194. /**
  114195. * 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)
  114196. * @param uniformName Name of the variable.
  114197. * @param array array to be set.
  114198. * @returns this effect.
  114199. */
  114200. setIntArray4(uniformName: string, array: Int32Array): Effect;
  114201. /**
  114202. * Sets an float array on a uniform variable.
  114203. * @param uniformName Name of the variable.
  114204. * @param array array to be set.
  114205. * @returns this effect.
  114206. */
  114207. setFloatArray(uniformName: string, array: Float32Array): Effect;
  114208. /**
  114209. * 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)
  114210. * @param uniformName Name of the variable.
  114211. * @param array array to be set.
  114212. * @returns this effect.
  114213. */
  114214. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  114215. /**
  114216. * 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)
  114217. * @param uniformName Name of the variable.
  114218. * @param array array to be set.
  114219. * @returns this effect.
  114220. */
  114221. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  114222. /**
  114223. * 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)
  114224. * @param uniformName Name of the variable.
  114225. * @param array array to be set.
  114226. * @returns this effect.
  114227. */
  114228. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  114229. /**
  114230. * Sets an array on a uniform variable.
  114231. * @param uniformName Name of the variable.
  114232. * @param array array to be set.
  114233. * @returns this effect.
  114234. */
  114235. setArray(uniformName: string, array: number[]): Effect;
  114236. /**
  114237. * 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)
  114238. * @param uniformName Name of the variable.
  114239. * @param array array to be set.
  114240. * @returns this effect.
  114241. */
  114242. setArray2(uniformName: string, array: number[]): Effect;
  114243. /**
  114244. * 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)
  114245. * @param uniformName Name of the variable.
  114246. * @param array array to be set.
  114247. * @returns this effect.
  114248. */
  114249. setArray3(uniformName: string, array: number[]): Effect;
  114250. /**
  114251. * 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)
  114252. * @param uniformName Name of the variable.
  114253. * @param array array to be set.
  114254. * @returns this effect.
  114255. */
  114256. setArray4(uniformName: string, array: number[]): Effect;
  114257. /**
  114258. * Sets matrices on a uniform variable.
  114259. * @param uniformName Name of the variable.
  114260. * @param matrices matrices to be set.
  114261. * @returns this effect.
  114262. */
  114263. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  114264. /**
  114265. * Sets matrix on a uniform variable.
  114266. * @param uniformName Name of the variable.
  114267. * @param matrix matrix to be set.
  114268. * @returns this effect.
  114269. */
  114270. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  114271. /**
  114272. * 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)
  114273. * @param uniformName Name of the variable.
  114274. * @param matrix matrix to be set.
  114275. * @returns this effect.
  114276. */
  114277. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114278. /**
  114279. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  114280. * @param uniformName Name of the variable.
  114281. * @param matrix matrix to be set.
  114282. * @returns this effect.
  114283. */
  114284. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114285. /**
  114286. * Sets a float on a uniform variable.
  114287. * @param uniformName Name of the variable.
  114288. * @param value value to be set.
  114289. * @returns this effect.
  114290. */
  114291. setFloat(uniformName: string, value: number): Effect;
  114292. /**
  114293. * Sets a boolean on a uniform variable.
  114294. * @param uniformName Name of the variable.
  114295. * @param bool value to be set.
  114296. * @returns this effect.
  114297. */
  114298. setBool(uniformName: string, bool: boolean): Effect;
  114299. /**
  114300. * Sets a Vector2 on a uniform variable.
  114301. * @param uniformName Name of the variable.
  114302. * @param vector2 vector2 to be set.
  114303. * @returns this effect.
  114304. */
  114305. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  114306. /**
  114307. * Sets a float2 on a uniform variable.
  114308. * @param uniformName Name of the variable.
  114309. * @param x First float in float2.
  114310. * @param y Second float in float2.
  114311. * @returns this effect.
  114312. */
  114313. setFloat2(uniformName: string, x: number, y: number): Effect;
  114314. /**
  114315. * Sets a Vector3 on a uniform variable.
  114316. * @param uniformName Name of the variable.
  114317. * @param vector3 Value to be set.
  114318. * @returns this effect.
  114319. */
  114320. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  114321. /**
  114322. * Sets a float3 on a uniform variable.
  114323. * @param uniformName Name of the variable.
  114324. * @param x First float in float3.
  114325. * @param y Second float in float3.
  114326. * @param z Third float in float3.
  114327. * @returns this effect.
  114328. */
  114329. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  114330. /**
  114331. * Sets a Vector4 on a uniform variable.
  114332. * @param uniformName Name of the variable.
  114333. * @param vector4 Value to be set.
  114334. * @returns this effect.
  114335. */
  114336. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  114337. /**
  114338. * Sets a float4 on a uniform variable.
  114339. * @param uniformName Name of the variable.
  114340. * @param x First float in float4.
  114341. * @param y Second float in float4.
  114342. * @param z Third float in float4.
  114343. * @param w Fourth float in float4.
  114344. * @returns this effect.
  114345. */
  114346. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  114347. /**
  114348. * Sets a Color3 on a uniform variable.
  114349. * @param uniformName Name of the variable.
  114350. * @param color3 Value to be set.
  114351. * @returns this effect.
  114352. */
  114353. setColor3(uniformName: string, color3: IColor3Like): Effect;
  114354. /**
  114355. * Sets a Color4 on a uniform variable.
  114356. * @param uniformName Name of the variable.
  114357. * @param color3 Value to be set.
  114358. * @param alpha Alpha value to be set.
  114359. * @returns this effect.
  114360. */
  114361. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  114362. /**
  114363. * Sets a Color4 on a uniform variable
  114364. * @param uniformName defines the name of the variable
  114365. * @param color4 defines the value to be set
  114366. * @returns this effect.
  114367. */
  114368. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  114369. /** Release all associated resources */
  114370. dispose(): void;
  114371. /**
  114372. * This function will add a new shader to the shader store
  114373. * @param name the name of the shader
  114374. * @param pixelShader optional pixel shader content
  114375. * @param vertexShader optional vertex shader content
  114376. */
  114377. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  114378. /**
  114379. * Store of each shader (The can be looked up using effect.key)
  114380. */
  114381. static ShadersStore: {
  114382. [key: string]: string;
  114383. };
  114384. /**
  114385. * Store of each included file for a shader (The can be looked up using effect.key)
  114386. */
  114387. static IncludesShadersStore: {
  114388. [key: string]: string;
  114389. };
  114390. /**
  114391. * Resets the cache of effects.
  114392. */
  114393. static ResetCache(): void;
  114394. }
  114395. }
  114396. declare module BABYLON {
  114397. /**
  114398. * Interface used to describe the capabilities of the engine relatively to the current browser
  114399. */
  114400. export interface EngineCapabilities {
  114401. /** Maximum textures units per fragment shader */
  114402. maxTexturesImageUnits: number;
  114403. /** Maximum texture units per vertex shader */
  114404. maxVertexTextureImageUnits: number;
  114405. /** Maximum textures units in the entire pipeline */
  114406. maxCombinedTexturesImageUnits: number;
  114407. /** Maximum texture size */
  114408. maxTextureSize: number;
  114409. /** Maximum texture samples */
  114410. maxSamples?: number;
  114411. /** Maximum cube texture size */
  114412. maxCubemapTextureSize: number;
  114413. /** Maximum render texture size */
  114414. maxRenderTextureSize: number;
  114415. /** Maximum number of vertex attributes */
  114416. maxVertexAttribs: number;
  114417. /** Maximum number of varyings */
  114418. maxVaryingVectors: number;
  114419. /** Maximum number of uniforms per vertex shader */
  114420. maxVertexUniformVectors: number;
  114421. /** Maximum number of uniforms per fragment shader */
  114422. maxFragmentUniformVectors: number;
  114423. /** Defines if standard derivates (dx/dy) are supported */
  114424. standardDerivatives: boolean;
  114425. /** Defines if s3tc texture compression is supported */
  114426. s3tc?: WEBGL_compressed_texture_s3tc;
  114427. /** Defines if pvrtc texture compression is supported */
  114428. pvrtc: any;
  114429. /** Defines if etc1 texture compression is supported */
  114430. etc1: any;
  114431. /** Defines if etc2 texture compression is supported */
  114432. etc2: any;
  114433. /** Defines if astc texture compression is supported */
  114434. astc: any;
  114435. /** Defines if float textures are supported */
  114436. textureFloat: boolean;
  114437. /** Defines if vertex array objects are supported */
  114438. vertexArrayObject: boolean;
  114439. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  114440. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  114441. /** Gets the maximum level of anisotropy supported */
  114442. maxAnisotropy: number;
  114443. /** Defines if instancing is supported */
  114444. instancedArrays: boolean;
  114445. /** Defines if 32 bits indices are supported */
  114446. uintIndices: boolean;
  114447. /** Defines if high precision shaders are supported */
  114448. highPrecisionShaderSupported: boolean;
  114449. /** Defines if depth reading in the fragment shader is supported */
  114450. fragmentDepthSupported: boolean;
  114451. /** Defines if float texture linear filtering is supported*/
  114452. textureFloatLinearFiltering: boolean;
  114453. /** Defines if rendering to float textures is supported */
  114454. textureFloatRender: boolean;
  114455. /** Defines if half float textures are supported*/
  114456. textureHalfFloat: boolean;
  114457. /** Defines if half float texture linear filtering is supported*/
  114458. textureHalfFloatLinearFiltering: boolean;
  114459. /** Defines if rendering to half float textures is supported */
  114460. textureHalfFloatRender: boolean;
  114461. /** Defines if textureLOD shader command is supported */
  114462. textureLOD: boolean;
  114463. /** Defines if draw buffers extension is supported */
  114464. drawBuffersExtension: boolean;
  114465. /** Defines if depth textures are supported */
  114466. depthTextureExtension: boolean;
  114467. /** Defines if float color buffer are supported */
  114468. colorBufferFloat: boolean;
  114469. /** Gets disjoint timer query extension (null if not supported) */
  114470. timerQuery?: EXT_disjoint_timer_query;
  114471. /** Defines if timestamp can be used with timer query */
  114472. canUseTimestampForTimerQuery: boolean;
  114473. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  114474. multiview?: any;
  114475. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  114476. oculusMultiview?: any;
  114477. /** Function used to let the system compiles shaders in background */
  114478. parallelShaderCompile?: {
  114479. COMPLETION_STATUS_KHR: number;
  114480. };
  114481. /** Max number of texture samples for MSAA */
  114482. maxMSAASamples: number;
  114483. /** Defines if the blend min max extension is supported */
  114484. blendMinMax: boolean;
  114485. }
  114486. }
  114487. declare module BABYLON {
  114488. /**
  114489. * @hidden
  114490. **/
  114491. export class DepthCullingState {
  114492. private _isDepthTestDirty;
  114493. private _isDepthMaskDirty;
  114494. private _isDepthFuncDirty;
  114495. private _isCullFaceDirty;
  114496. private _isCullDirty;
  114497. private _isZOffsetDirty;
  114498. private _isFrontFaceDirty;
  114499. private _depthTest;
  114500. private _depthMask;
  114501. private _depthFunc;
  114502. private _cull;
  114503. private _cullFace;
  114504. private _zOffset;
  114505. private _frontFace;
  114506. /**
  114507. * Initializes the state.
  114508. */
  114509. constructor();
  114510. get isDirty(): boolean;
  114511. get zOffset(): number;
  114512. set zOffset(value: number);
  114513. get cullFace(): Nullable<number>;
  114514. set cullFace(value: Nullable<number>);
  114515. get cull(): Nullable<boolean>;
  114516. set cull(value: Nullable<boolean>);
  114517. get depthFunc(): Nullable<number>;
  114518. set depthFunc(value: Nullable<number>);
  114519. get depthMask(): boolean;
  114520. set depthMask(value: boolean);
  114521. get depthTest(): boolean;
  114522. set depthTest(value: boolean);
  114523. get frontFace(): Nullable<number>;
  114524. set frontFace(value: Nullable<number>);
  114525. reset(): void;
  114526. apply(gl: WebGLRenderingContext): void;
  114527. }
  114528. }
  114529. declare module BABYLON {
  114530. /**
  114531. * @hidden
  114532. **/
  114533. export class StencilState {
  114534. /** 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 */
  114535. static readonly ALWAYS: number;
  114536. /** Passed to stencilOperation to specify that stencil value must be kept */
  114537. static readonly KEEP: number;
  114538. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114539. static readonly REPLACE: number;
  114540. private _isStencilTestDirty;
  114541. private _isStencilMaskDirty;
  114542. private _isStencilFuncDirty;
  114543. private _isStencilOpDirty;
  114544. private _stencilTest;
  114545. private _stencilMask;
  114546. private _stencilFunc;
  114547. private _stencilFuncRef;
  114548. private _stencilFuncMask;
  114549. private _stencilOpStencilFail;
  114550. private _stencilOpDepthFail;
  114551. private _stencilOpStencilDepthPass;
  114552. get isDirty(): boolean;
  114553. get stencilFunc(): number;
  114554. set stencilFunc(value: number);
  114555. get stencilFuncRef(): number;
  114556. set stencilFuncRef(value: number);
  114557. get stencilFuncMask(): number;
  114558. set stencilFuncMask(value: number);
  114559. get stencilOpStencilFail(): number;
  114560. set stencilOpStencilFail(value: number);
  114561. get stencilOpDepthFail(): number;
  114562. set stencilOpDepthFail(value: number);
  114563. get stencilOpStencilDepthPass(): number;
  114564. set stencilOpStencilDepthPass(value: number);
  114565. get stencilMask(): number;
  114566. set stencilMask(value: number);
  114567. get stencilTest(): boolean;
  114568. set stencilTest(value: boolean);
  114569. constructor();
  114570. reset(): void;
  114571. apply(gl: WebGLRenderingContext): void;
  114572. }
  114573. }
  114574. declare module BABYLON {
  114575. /**
  114576. * @hidden
  114577. **/
  114578. export class AlphaState {
  114579. private _isAlphaBlendDirty;
  114580. private _isBlendFunctionParametersDirty;
  114581. private _isBlendEquationParametersDirty;
  114582. private _isBlendConstantsDirty;
  114583. private _alphaBlend;
  114584. private _blendFunctionParameters;
  114585. private _blendEquationParameters;
  114586. private _blendConstants;
  114587. /**
  114588. * Initializes the state.
  114589. */
  114590. constructor();
  114591. get isDirty(): boolean;
  114592. get alphaBlend(): boolean;
  114593. set alphaBlend(value: boolean);
  114594. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  114595. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  114596. setAlphaEquationParameters(rgb: number, alpha: number): void;
  114597. reset(): void;
  114598. apply(gl: WebGLRenderingContext): void;
  114599. }
  114600. }
  114601. declare module BABYLON {
  114602. /** @hidden */
  114603. export class WebGL2ShaderProcessor implements IShaderProcessor {
  114604. attributeProcessor(attribute: string): string;
  114605. varyingProcessor(varying: string, isFragment: boolean): string;
  114606. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  114607. }
  114608. }
  114609. declare module BABYLON {
  114610. /**
  114611. * Interface for attribute information associated with buffer instanciation
  114612. */
  114613. export interface InstancingAttributeInfo {
  114614. /**
  114615. * Name of the GLSL attribute
  114616. * if attribute index is not specified, this is used to retrieve the index from the effect
  114617. */
  114618. attributeName: string;
  114619. /**
  114620. * Index/offset of the attribute in the vertex shader
  114621. * if not specified, this will be computes from the name.
  114622. */
  114623. index?: number;
  114624. /**
  114625. * size of the attribute, 1, 2, 3 or 4
  114626. */
  114627. attributeSize: number;
  114628. /**
  114629. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  114630. */
  114631. offset: number;
  114632. /**
  114633. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  114634. * default to 1
  114635. */
  114636. divisor?: number;
  114637. /**
  114638. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  114639. * default is FLOAT
  114640. */
  114641. attributeType?: number;
  114642. /**
  114643. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  114644. */
  114645. normalized?: boolean;
  114646. }
  114647. }
  114648. declare module BABYLON {
  114649. interface ThinEngine {
  114650. /**
  114651. * Update a video texture
  114652. * @param texture defines the texture to update
  114653. * @param video defines the video element to use
  114654. * @param invertY defines if data must be stored with Y axis inverted
  114655. */
  114656. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  114657. }
  114658. }
  114659. declare module BABYLON {
  114660. interface ThinEngine {
  114661. /**
  114662. * Creates a dynamic texture
  114663. * @param width defines the width of the texture
  114664. * @param height defines the height of the texture
  114665. * @param generateMipMaps defines if the engine should generate the mip levels
  114666. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  114667. * @returns the dynamic texture inside an InternalTexture
  114668. */
  114669. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  114670. /**
  114671. * Update the content of a dynamic texture
  114672. * @param texture defines the texture to update
  114673. * @param canvas defines the canvas containing the source
  114674. * @param invertY defines if data must be stored with Y axis inverted
  114675. * @param premulAlpha defines if alpha is stored as premultiplied
  114676. * @param format defines the format of the data
  114677. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  114678. */
  114679. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  114680. }
  114681. }
  114682. declare module BABYLON {
  114683. /**
  114684. * Settings for finer control over video usage
  114685. */
  114686. export interface VideoTextureSettings {
  114687. /**
  114688. * Applies `autoplay` to video, if specified
  114689. */
  114690. autoPlay?: boolean;
  114691. /**
  114692. * Applies `loop` to video, if specified
  114693. */
  114694. loop?: boolean;
  114695. /**
  114696. * Automatically updates internal texture from video at every frame in the render loop
  114697. */
  114698. autoUpdateTexture: boolean;
  114699. /**
  114700. * Image src displayed during the video loading or until the user interacts with the video.
  114701. */
  114702. poster?: string;
  114703. }
  114704. /**
  114705. * If you want to display a video in your scene, this is the special texture for that.
  114706. * This special texture works similar to other textures, with the exception of a few parameters.
  114707. * @see https://doc.babylonjs.com/how_to/video_texture
  114708. */
  114709. export class VideoTexture extends Texture {
  114710. /**
  114711. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  114712. */
  114713. readonly autoUpdateTexture: boolean;
  114714. /**
  114715. * The video instance used by the texture internally
  114716. */
  114717. readonly video: HTMLVideoElement;
  114718. private _onUserActionRequestedObservable;
  114719. /**
  114720. * Event triggerd when a dom action is required by the user to play the video.
  114721. * This happens due to recent changes in browser policies preventing video to auto start.
  114722. */
  114723. get onUserActionRequestedObservable(): Observable<Texture>;
  114724. private _generateMipMaps;
  114725. private _stillImageCaptured;
  114726. private _displayingPosterTexture;
  114727. private _settings;
  114728. private _createInternalTextureOnEvent;
  114729. private _frameId;
  114730. private _currentSrc;
  114731. /**
  114732. * Creates a video texture.
  114733. * If you want to display a video in your scene, this is the special texture for that.
  114734. * This special texture works similar to other textures, with the exception of a few parameters.
  114735. * @see https://doc.babylonjs.com/how_to/video_texture
  114736. * @param name optional name, will detect from video source, if not defined
  114737. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  114738. * @param scene is obviously the current scene.
  114739. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  114740. * @param invertY is false by default but can be used to invert video on Y axis
  114741. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  114742. * @param settings allows finer control over video usage
  114743. */
  114744. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  114745. private _getName;
  114746. private _getVideo;
  114747. private _createInternalTexture;
  114748. private reset;
  114749. /**
  114750. * @hidden Internal method to initiate `update`.
  114751. */
  114752. _rebuild(): void;
  114753. /**
  114754. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  114755. */
  114756. update(): void;
  114757. /**
  114758. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  114759. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  114760. */
  114761. updateTexture(isVisible: boolean): void;
  114762. protected _updateInternalTexture: () => void;
  114763. /**
  114764. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  114765. * @param url New url.
  114766. */
  114767. updateURL(url: string): void;
  114768. /**
  114769. * Clones the texture.
  114770. * @returns the cloned texture
  114771. */
  114772. clone(): VideoTexture;
  114773. /**
  114774. * Dispose the texture and release its associated resources.
  114775. */
  114776. dispose(): void;
  114777. /**
  114778. * Creates a video texture straight from a stream.
  114779. * @param scene Define the scene the texture should be created in
  114780. * @param stream Define the stream the texture should be created from
  114781. * @returns The created video texture as a promise
  114782. */
  114783. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  114784. /**
  114785. * Creates a video texture straight from your WebCam video feed.
  114786. * @param scene Define the scene the texture should be created in
  114787. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114788. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114789. * @returns The created video texture as a promise
  114790. */
  114791. static CreateFromWebCamAsync(scene: Scene, constraints: {
  114792. minWidth: number;
  114793. maxWidth: number;
  114794. minHeight: number;
  114795. maxHeight: number;
  114796. deviceId: string;
  114797. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  114798. /**
  114799. * Creates a video texture straight from your WebCam video feed.
  114800. * @param scene Define the scene the texture should be created in
  114801. * @param onReady Define a callback to triggered once the texture will be ready
  114802. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114803. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114804. */
  114805. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  114806. minWidth: number;
  114807. maxWidth: number;
  114808. minHeight: number;
  114809. maxHeight: number;
  114810. deviceId: string;
  114811. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  114812. }
  114813. }
  114814. declare module BABYLON {
  114815. /**
  114816. * Defines the interface used by objects working like Scene
  114817. * @hidden
  114818. */
  114819. export interface ISceneLike {
  114820. _addPendingData(data: any): void;
  114821. _removePendingData(data: any): void;
  114822. offlineProvider: IOfflineProvider;
  114823. }
  114824. /**
  114825. * Information about the current host
  114826. */
  114827. export interface HostInformation {
  114828. /**
  114829. * Defines if the current host is a mobile
  114830. */
  114831. isMobile: boolean;
  114832. }
  114833. /** Interface defining initialization parameters for Engine class */
  114834. export interface EngineOptions extends WebGLContextAttributes {
  114835. /**
  114836. * Defines if the engine should no exceed a specified device ratio
  114837. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  114838. */
  114839. limitDeviceRatio?: number;
  114840. /**
  114841. * Defines if webvr should be enabled automatically
  114842. * @see https://doc.babylonjs.com/how_to/webvr_camera
  114843. */
  114844. autoEnableWebVR?: boolean;
  114845. /**
  114846. * Defines if webgl2 should be turned off even if supported
  114847. * @see https://doc.babylonjs.com/features/webgl2
  114848. */
  114849. disableWebGL2Support?: boolean;
  114850. /**
  114851. * Defines if webaudio should be initialized as well
  114852. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114853. */
  114854. audioEngine?: boolean;
  114855. /**
  114856. * Defines if animations should run using a deterministic lock step
  114857. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114858. */
  114859. deterministicLockstep?: boolean;
  114860. /** Defines the maximum steps to use with deterministic lock step mode */
  114861. lockstepMaxSteps?: number;
  114862. /** Defines the seconds between each deterministic lock step */
  114863. timeStep?: number;
  114864. /**
  114865. * Defines that engine should ignore context lost events
  114866. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  114867. */
  114868. doNotHandleContextLost?: boolean;
  114869. /**
  114870. * Defines that engine should ignore modifying touch action attribute and style
  114871. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  114872. */
  114873. doNotHandleTouchAction?: boolean;
  114874. /**
  114875. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  114876. */
  114877. useHighPrecisionFloats?: boolean;
  114878. /**
  114879. * Make the canvas XR Compatible for XR sessions
  114880. */
  114881. xrCompatible?: boolean;
  114882. /**
  114883. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  114884. */
  114885. useHighPrecisionMatrix?: boolean;
  114886. }
  114887. /**
  114888. * The base engine class (root of all engines)
  114889. */
  114890. export class ThinEngine {
  114891. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  114892. static ExceptionList: ({
  114893. key: string;
  114894. capture: string;
  114895. captureConstraint: number;
  114896. targets: string[];
  114897. } | {
  114898. key: string;
  114899. capture: null;
  114900. captureConstraint: null;
  114901. targets: string[];
  114902. })[];
  114903. /** @hidden */
  114904. static _TextureLoaders: IInternalTextureLoader[];
  114905. /**
  114906. * Returns the current npm package of the sdk
  114907. */
  114908. static get NpmPackage(): string;
  114909. /**
  114910. * Returns the current version of the framework
  114911. */
  114912. static get Version(): string;
  114913. /**
  114914. * Returns a string describing the current engine
  114915. */
  114916. get description(): string;
  114917. /**
  114918. * Gets or sets the epsilon value used by collision engine
  114919. */
  114920. static CollisionsEpsilon: number;
  114921. /**
  114922. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114923. */
  114924. static get ShadersRepository(): string;
  114925. static set ShadersRepository(value: string);
  114926. /** @hidden */
  114927. _shaderProcessor: IShaderProcessor;
  114928. /**
  114929. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  114930. */
  114931. forcePOTTextures: boolean;
  114932. /**
  114933. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  114934. */
  114935. isFullscreen: boolean;
  114936. /**
  114937. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  114938. */
  114939. cullBackFaces: boolean;
  114940. /**
  114941. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  114942. */
  114943. renderEvenInBackground: boolean;
  114944. /**
  114945. * Gets or sets a boolean indicating that cache can be kept between frames
  114946. */
  114947. preventCacheWipeBetweenFrames: boolean;
  114948. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  114949. validateShaderPrograms: boolean;
  114950. /**
  114951. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  114952. * This can provide greater z depth for distant objects.
  114953. */
  114954. useReverseDepthBuffer: boolean;
  114955. /**
  114956. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  114957. */
  114958. disableUniformBuffers: boolean;
  114959. /** @hidden */
  114960. _uniformBuffers: UniformBuffer[];
  114961. /**
  114962. * Gets a boolean indicating that the engine supports uniform buffers
  114963. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  114964. */
  114965. get supportsUniformBuffers(): boolean;
  114966. /** @hidden */
  114967. _gl: WebGLRenderingContext;
  114968. /** @hidden */
  114969. _webGLVersion: number;
  114970. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  114971. protected _windowIsBackground: boolean;
  114972. protected _creationOptions: EngineOptions;
  114973. protected _highPrecisionShadersAllowed: boolean;
  114974. /** @hidden */
  114975. get _shouldUseHighPrecisionShader(): boolean;
  114976. /**
  114977. * Gets a boolean indicating that only power of 2 textures are supported
  114978. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  114979. */
  114980. get needPOTTextures(): boolean;
  114981. /** @hidden */
  114982. _badOS: boolean;
  114983. /** @hidden */
  114984. _badDesktopOS: boolean;
  114985. private _hardwareScalingLevel;
  114986. /** @hidden */
  114987. _caps: EngineCapabilities;
  114988. private _isStencilEnable;
  114989. private _glVersion;
  114990. private _glRenderer;
  114991. private _glVendor;
  114992. /** @hidden */
  114993. _videoTextureSupported: boolean;
  114994. protected _renderingQueueLaunched: boolean;
  114995. protected _activeRenderLoops: (() => void)[];
  114996. /**
  114997. * Observable signaled when a context lost event is raised
  114998. */
  114999. onContextLostObservable: Observable<ThinEngine>;
  115000. /**
  115001. * Observable signaled when a context restored event is raised
  115002. */
  115003. onContextRestoredObservable: Observable<ThinEngine>;
  115004. private _onContextLost;
  115005. private _onContextRestored;
  115006. protected _contextWasLost: boolean;
  115007. /** @hidden */
  115008. _doNotHandleContextLost: boolean;
  115009. /**
  115010. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  115011. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  115012. */
  115013. get doNotHandleContextLost(): boolean;
  115014. set doNotHandleContextLost(value: boolean);
  115015. /**
  115016. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  115017. */
  115018. disableVertexArrayObjects: boolean;
  115019. /** @hidden */
  115020. protected _colorWrite: boolean;
  115021. /** @hidden */
  115022. protected _colorWriteChanged: boolean;
  115023. /** @hidden */
  115024. protected _depthCullingState: DepthCullingState;
  115025. /** @hidden */
  115026. protected _stencilState: StencilState;
  115027. /** @hidden */
  115028. _alphaState: AlphaState;
  115029. /** @hidden */
  115030. _alphaMode: number;
  115031. /** @hidden */
  115032. _alphaEquation: number;
  115033. /** @hidden */
  115034. _internalTexturesCache: InternalTexture[];
  115035. /** @hidden */
  115036. protected _activeChannel: number;
  115037. private _currentTextureChannel;
  115038. /** @hidden */
  115039. protected _boundTexturesCache: {
  115040. [key: string]: Nullable<InternalTexture>;
  115041. };
  115042. /** @hidden */
  115043. protected _currentEffect: Nullable<Effect>;
  115044. /** @hidden */
  115045. protected _currentProgram: Nullable<WebGLProgram>;
  115046. private _compiledEffects;
  115047. private _vertexAttribArraysEnabled;
  115048. /** @hidden */
  115049. protected _cachedViewport: Nullable<IViewportLike>;
  115050. private _cachedVertexArrayObject;
  115051. /** @hidden */
  115052. protected _cachedVertexBuffers: any;
  115053. /** @hidden */
  115054. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  115055. /** @hidden */
  115056. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  115057. /** @hidden */
  115058. _currentRenderTarget: Nullable<InternalTexture>;
  115059. private _uintIndicesCurrentlySet;
  115060. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  115061. /** @hidden */
  115062. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  115063. /** @hidden */
  115064. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  115065. private _currentBufferPointers;
  115066. private _currentInstanceLocations;
  115067. private _currentInstanceBuffers;
  115068. private _textureUnits;
  115069. /** @hidden */
  115070. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115071. /** @hidden */
  115072. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115073. /** @hidden */
  115074. _boundRenderFunction: any;
  115075. private _vaoRecordInProgress;
  115076. private _mustWipeVertexAttributes;
  115077. private _emptyTexture;
  115078. private _emptyCubeTexture;
  115079. private _emptyTexture3D;
  115080. private _emptyTexture2DArray;
  115081. /** @hidden */
  115082. _frameHandler: number;
  115083. private _nextFreeTextureSlots;
  115084. private _maxSimultaneousTextures;
  115085. private _activeRequests;
  115086. /** @hidden */
  115087. _transformTextureUrl: Nullable<(url: string) => string>;
  115088. /**
  115089. * Gets information about the current host
  115090. */
  115091. hostInformation: HostInformation;
  115092. protected get _supportsHardwareTextureRescaling(): boolean;
  115093. private _framebufferDimensionsObject;
  115094. /**
  115095. * sets the object from which width and height will be taken from when getting render width and height
  115096. * Will fallback to the gl object
  115097. * @param dimensions the framebuffer width and height that will be used.
  115098. */
  115099. set framebufferDimensionsObject(dimensions: Nullable<{
  115100. framebufferWidth: number;
  115101. framebufferHeight: number;
  115102. }>);
  115103. /**
  115104. * Gets the current viewport
  115105. */
  115106. get currentViewport(): Nullable<IViewportLike>;
  115107. /**
  115108. * Gets the default empty texture
  115109. */
  115110. get emptyTexture(): InternalTexture;
  115111. /**
  115112. * Gets the default empty 3D texture
  115113. */
  115114. get emptyTexture3D(): InternalTexture;
  115115. /**
  115116. * Gets the default empty 2D array texture
  115117. */
  115118. get emptyTexture2DArray(): InternalTexture;
  115119. /**
  115120. * Gets the default empty cube texture
  115121. */
  115122. get emptyCubeTexture(): InternalTexture;
  115123. /**
  115124. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  115125. */
  115126. readonly premultipliedAlpha: boolean;
  115127. /**
  115128. * Observable event triggered before each texture is initialized
  115129. */
  115130. onBeforeTextureInitObservable: Observable<Texture>;
  115131. /**
  115132. * Creates a new engine
  115133. * @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
  115134. * @param antialias defines enable antialiasing (default: false)
  115135. * @param options defines further options to be sent to the getContext() function
  115136. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115137. */
  115138. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115139. private _rebuildInternalTextures;
  115140. private _rebuildEffects;
  115141. /**
  115142. * Gets a boolean indicating if all created effects are ready
  115143. * @returns true if all effects are ready
  115144. */
  115145. areAllEffectsReady(): boolean;
  115146. protected _rebuildBuffers(): void;
  115147. protected _initGLContext(): void;
  115148. /**
  115149. * Gets version of the current webGL context
  115150. */
  115151. get webGLVersion(): number;
  115152. /**
  115153. * Gets a string identifying the name of the class
  115154. * @returns "Engine" string
  115155. */
  115156. getClassName(): string;
  115157. /**
  115158. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  115159. */
  115160. get isStencilEnable(): boolean;
  115161. /** @hidden */
  115162. _prepareWorkingCanvas(): void;
  115163. /**
  115164. * Reset the texture cache to empty state
  115165. */
  115166. resetTextureCache(): void;
  115167. /**
  115168. * Gets an object containing information about the current webGL context
  115169. * @returns an object containing the vender, the renderer and the version of the current webGL context
  115170. */
  115171. getGlInfo(): {
  115172. vendor: string;
  115173. renderer: string;
  115174. version: string;
  115175. };
  115176. /**
  115177. * Defines the hardware scaling level.
  115178. * By default the hardware scaling level is computed from the window device ratio.
  115179. * 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.
  115180. * @param level defines the level to use
  115181. */
  115182. setHardwareScalingLevel(level: number): void;
  115183. /**
  115184. * Gets the current hardware scaling level.
  115185. * By default the hardware scaling level is computed from the window device ratio.
  115186. * 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.
  115187. * @returns a number indicating the current hardware scaling level
  115188. */
  115189. getHardwareScalingLevel(): number;
  115190. /**
  115191. * Gets the list of loaded textures
  115192. * @returns an array containing all loaded textures
  115193. */
  115194. getLoadedTexturesCache(): InternalTexture[];
  115195. /**
  115196. * Gets the object containing all engine capabilities
  115197. * @returns the EngineCapabilities object
  115198. */
  115199. getCaps(): EngineCapabilities;
  115200. /**
  115201. * stop executing a render loop function and remove it from the execution array
  115202. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  115203. */
  115204. stopRenderLoop(renderFunction?: () => void): void;
  115205. /** @hidden */
  115206. _renderLoop(): void;
  115207. /**
  115208. * Gets the HTML canvas attached with the current webGL context
  115209. * @returns a HTML canvas
  115210. */
  115211. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  115212. /**
  115213. * Gets host window
  115214. * @returns the host window object
  115215. */
  115216. getHostWindow(): Nullable<Window>;
  115217. /**
  115218. * Gets the current render width
  115219. * @param useScreen defines if screen size must be used (or the current render target if any)
  115220. * @returns a number defining the current render width
  115221. */
  115222. getRenderWidth(useScreen?: boolean): number;
  115223. /**
  115224. * Gets the current render height
  115225. * @param useScreen defines if screen size must be used (or the current render target if any)
  115226. * @returns a number defining the current render height
  115227. */
  115228. getRenderHeight(useScreen?: boolean): number;
  115229. /**
  115230. * Can be used to override the current requestAnimationFrame requester.
  115231. * @hidden
  115232. */
  115233. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  115234. /**
  115235. * Register and execute a render loop. The engine can have more than one render function
  115236. * @param renderFunction defines the function to continuously execute
  115237. */
  115238. runRenderLoop(renderFunction: () => void): void;
  115239. /**
  115240. * Clear the current render buffer or the current render target (if any is set up)
  115241. * @param color defines the color to use
  115242. * @param backBuffer defines if the back buffer must be cleared
  115243. * @param depth defines if the depth buffer must be cleared
  115244. * @param stencil defines if the stencil buffer must be cleared
  115245. */
  115246. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  115247. private _viewportCached;
  115248. /** @hidden */
  115249. _viewport(x: number, y: number, width: number, height: number): void;
  115250. /**
  115251. * Set the WebGL's viewport
  115252. * @param viewport defines the viewport element to be used
  115253. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  115254. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  115255. */
  115256. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  115257. /**
  115258. * Begin a new frame
  115259. */
  115260. beginFrame(): void;
  115261. /**
  115262. * Enf the current frame
  115263. */
  115264. endFrame(): void;
  115265. /**
  115266. * Resize the view according to the canvas' size
  115267. */
  115268. resize(): void;
  115269. /**
  115270. * Force a specific size of the canvas
  115271. * @param width defines the new canvas' width
  115272. * @param height defines the new canvas' height
  115273. * @returns true if the size was changed
  115274. */
  115275. setSize(width: number, height: number): boolean;
  115276. /**
  115277. * Binds the frame buffer to the specified texture.
  115278. * @param texture The texture to render to or null for the default canvas
  115279. * @param faceIndex The face of the texture to render to in case of cube texture
  115280. * @param requiredWidth The width of the target to render to
  115281. * @param requiredHeight The height of the target to render to
  115282. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  115283. * @param lodLevel defines the lod level to bind to the frame buffer
  115284. * @param layer defines the 2d array index to bind to frame buffer to
  115285. */
  115286. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  115287. /** @hidden */
  115288. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  115289. /**
  115290. * Unbind the current render target texture from the webGL context
  115291. * @param texture defines the render target texture to unbind
  115292. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  115293. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  115294. */
  115295. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  115296. /**
  115297. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  115298. */
  115299. flushFramebuffer(): void;
  115300. /**
  115301. * Unbind the current render target and bind the default framebuffer
  115302. */
  115303. restoreDefaultFramebuffer(): void;
  115304. /** @hidden */
  115305. protected _resetVertexBufferBinding(): void;
  115306. /**
  115307. * Creates a vertex buffer
  115308. * @param data the data for the vertex buffer
  115309. * @returns the new WebGL static buffer
  115310. */
  115311. createVertexBuffer(data: DataArray): DataBuffer;
  115312. private _createVertexBuffer;
  115313. /**
  115314. * Creates a dynamic vertex buffer
  115315. * @param data the data for the dynamic vertex buffer
  115316. * @returns the new WebGL dynamic buffer
  115317. */
  115318. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  115319. protected _resetIndexBufferBinding(): void;
  115320. /**
  115321. * Creates a new index buffer
  115322. * @param indices defines the content of the index buffer
  115323. * @param updatable defines if the index buffer must be updatable
  115324. * @returns a new webGL buffer
  115325. */
  115326. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  115327. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  115328. /**
  115329. * Bind a webGL buffer to the webGL context
  115330. * @param buffer defines the buffer to bind
  115331. */
  115332. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  115333. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  115334. private bindBuffer;
  115335. /**
  115336. * update the bound buffer with the given data
  115337. * @param data defines the data to update
  115338. */
  115339. updateArrayBuffer(data: Float32Array): void;
  115340. private _vertexAttribPointer;
  115341. /** @hidden */
  115342. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  115343. private _bindVertexBuffersAttributes;
  115344. /**
  115345. * Records a vertex array object
  115346. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115347. * @param vertexBuffers defines the list of vertex buffers to store
  115348. * @param indexBuffer defines the index buffer to store
  115349. * @param effect defines the effect to store
  115350. * @returns the new vertex array object
  115351. */
  115352. recordVertexArrayObject(vertexBuffers: {
  115353. [key: string]: VertexBuffer;
  115354. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  115355. /**
  115356. * Bind a specific vertex array object
  115357. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115358. * @param vertexArrayObject defines the vertex array object to bind
  115359. * @param indexBuffer defines the index buffer to bind
  115360. */
  115361. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  115362. /**
  115363. * Bind webGl buffers directly to the webGL context
  115364. * @param vertexBuffer defines the vertex buffer to bind
  115365. * @param indexBuffer defines the index buffer to bind
  115366. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  115367. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  115368. * @param effect defines the effect associated with the vertex buffer
  115369. */
  115370. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  115371. private _unbindVertexArrayObject;
  115372. /**
  115373. * Bind a list of vertex buffers to the webGL context
  115374. * @param vertexBuffers defines the list of vertex buffers to bind
  115375. * @param indexBuffer defines the index buffer to bind
  115376. * @param effect defines the effect associated with the vertex buffers
  115377. */
  115378. bindBuffers(vertexBuffers: {
  115379. [key: string]: Nullable<VertexBuffer>;
  115380. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  115381. /**
  115382. * Unbind all instance attributes
  115383. */
  115384. unbindInstanceAttributes(): void;
  115385. /**
  115386. * Release and free the memory of a vertex array object
  115387. * @param vao defines the vertex array object to delete
  115388. */
  115389. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  115390. /** @hidden */
  115391. _releaseBuffer(buffer: DataBuffer): boolean;
  115392. protected _deleteBuffer(buffer: DataBuffer): void;
  115393. /**
  115394. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  115395. * @param instancesBuffer defines the webGL buffer to update and bind
  115396. * @param data defines the data to store in the buffer
  115397. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  115398. */
  115399. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  115400. /**
  115401. * Bind the content of a webGL buffer used with instantiation
  115402. * @param instancesBuffer defines the webGL buffer to bind
  115403. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  115404. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  115405. */
  115406. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  115407. /**
  115408. * Disable the instance attribute corresponding to the name in parameter
  115409. * @param name defines the name of the attribute to disable
  115410. */
  115411. disableInstanceAttributeByName(name: string): void;
  115412. /**
  115413. * Disable the instance attribute corresponding to the location in parameter
  115414. * @param attributeLocation defines the attribute location of the attribute to disable
  115415. */
  115416. disableInstanceAttribute(attributeLocation: number): void;
  115417. /**
  115418. * Disable the attribute corresponding to the location in parameter
  115419. * @param attributeLocation defines the attribute location of the attribute to disable
  115420. */
  115421. disableAttributeByIndex(attributeLocation: number): void;
  115422. /**
  115423. * Send a draw order
  115424. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115425. * @param indexStart defines the starting index
  115426. * @param indexCount defines the number of index to draw
  115427. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115428. */
  115429. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  115430. /**
  115431. * Draw a list of points
  115432. * @param verticesStart defines the index of first vertex to draw
  115433. * @param verticesCount defines the count of vertices to draw
  115434. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115435. */
  115436. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115437. /**
  115438. * Draw a list of unindexed primitives
  115439. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115440. * @param verticesStart defines the index of first vertex to draw
  115441. * @param verticesCount defines the count of vertices to draw
  115442. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115443. */
  115444. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115445. /**
  115446. * Draw a list of indexed primitives
  115447. * @param fillMode defines the primitive to use
  115448. * @param indexStart defines the starting index
  115449. * @param indexCount defines the number of index to draw
  115450. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115451. */
  115452. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  115453. /**
  115454. * Draw a list of unindexed primitives
  115455. * @param fillMode defines the primitive to use
  115456. * @param verticesStart defines the index of first vertex to draw
  115457. * @param verticesCount defines the count of vertices to draw
  115458. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115459. */
  115460. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115461. private _drawMode;
  115462. /** @hidden */
  115463. protected _reportDrawCall(): void;
  115464. /** @hidden */
  115465. _releaseEffect(effect: Effect): void;
  115466. /** @hidden */
  115467. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  115468. /**
  115469. * Create a new effect (used to store vertex/fragment shaders)
  115470. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  115471. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  115472. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  115473. * @param samplers defines an array of string used to represent textures
  115474. * @param defines defines the string containing the defines to use to compile the shaders
  115475. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  115476. * @param onCompiled defines a function to call when the effect creation is successful
  115477. * @param onError defines a function to call when the effect creation has failed
  115478. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  115479. * @returns the new Effect
  115480. */
  115481. 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;
  115482. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  115483. private _compileShader;
  115484. private _compileRawShader;
  115485. /** @hidden */
  115486. _getShaderSource(shader: WebGLShader): Nullable<string>;
  115487. /**
  115488. * Directly creates a webGL program
  115489. * @param pipelineContext defines the pipeline context to attach to
  115490. * @param vertexCode defines the vertex shader code to use
  115491. * @param fragmentCode defines the fragment shader code to use
  115492. * @param context defines the webGL context to use (if not set, the current one will be used)
  115493. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115494. * @returns the new webGL program
  115495. */
  115496. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115497. /**
  115498. * Creates a webGL program
  115499. * @param pipelineContext defines the pipeline context to attach to
  115500. * @param vertexCode defines the vertex shader code to use
  115501. * @param fragmentCode defines the fragment shader code to use
  115502. * @param defines defines the string containing the defines to use to compile the shaders
  115503. * @param context defines the webGL context to use (if not set, the current one will be used)
  115504. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115505. * @returns the new webGL program
  115506. */
  115507. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115508. /**
  115509. * Creates a new pipeline context
  115510. * @returns the new pipeline
  115511. */
  115512. createPipelineContext(): IPipelineContext;
  115513. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115514. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  115515. /** @hidden */
  115516. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  115517. /** @hidden */
  115518. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  115519. /** @hidden */
  115520. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  115521. /**
  115522. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  115523. * @param pipelineContext defines the pipeline context to use
  115524. * @param uniformsNames defines the list of uniform names
  115525. * @returns an array of webGL uniform locations
  115526. */
  115527. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  115528. /**
  115529. * Gets the lsit of active attributes for a given webGL program
  115530. * @param pipelineContext defines the pipeline context to use
  115531. * @param attributesNames defines the list of attribute names to get
  115532. * @returns an array of indices indicating the offset of each attribute
  115533. */
  115534. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  115535. /**
  115536. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  115537. * @param effect defines the effect to activate
  115538. */
  115539. enableEffect(effect: Nullable<Effect>): void;
  115540. /**
  115541. * Set the value of an uniform to a number (int)
  115542. * @param uniform defines the webGL uniform location where to store the value
  115543. * @param value defines the int number to store
  115544. */
  115545. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115546. /**
  115547. * Set the value of an uniform to an array of int32
  115548. * @param uniform defines the webGL uniform location where to store the value
  115549. * @param array defines the array of int32 to store
  115550. */
  115551. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115552. /**
  115553. * Set the value of an uniform to an array of int32 (stored as vec2)
  115554. * @param uniform defines the webGL uniform location where to store the value
  115555. * @param array defines the array of int32 to store
  115556. */
  115557. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115558. /**
  115559. * Set the value of an uniform to an array of int32 (stored as vec3)
  115560. * @param uniform defines the webGL uniform location where to store the value
  115561. * @param array defines the array of int32 to store
  115562. */
  115563. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115564. /**
  115565. * Set the value of an uniform to an array of int32 (stored as vec4)
  115566. * @param uniform defines the webGL uniform location where to store the value
  115567. * @param array defines the array of int32 to store
  115568. */
  115569. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115570. /**
  115571. * Set the value of an uniform to an array of number
  115572. * @param uniform defines the webGL uniform location where to store the value
  115573. * @param array defines the array of number to store
  115574. */
  115575. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115576. /**
  115577. * Set the value of an uniform to an array of number (stored as vec2)
  115578. * @param uniform defines the webGL uniform location where to store the value
  115579. * @param array defines the array of number to store
  115580. */
  115581. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115582. /**
  115583. * Set the value of an uniform to an array of number (stored as vec3)
  115584. * @param uniform defines the webGL uniform location where to store the value
  115585. * @param array defines the array of number to store
  115586. */
  115587. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115588. /**
  115589. * Set the value of an uniform to an array of number (stored as vec4)
  115590. * @param uniform defines the webGL uniform location where to store the value
  115591. * @param array defines the array of number to store
  115592. */
  115593. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115594. /**
  115595. * Set the value of an uniform to an array of float32 (stored as matrices)
  115596. * @param uniform defines the webGL uniform location where to store the value
  115597. * @param matrices defines the array of float32 to store
  115598. */
  115599. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  115600. /**
  115601. * Set the value of an uniform to a matrix (3x3)
  115602. * @param uniform defines the webGL uniform location where to store the value
  115603. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  115604. */
  115605. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115606. /**
  115607. * Set the value of an uniform to a matrix (2x2)
  115608. * @param uniform defines the webGL uniform location where to store the value
  115609. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  115610. */
  115611. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115612. /**
  115613. * Set the value of an uniform to a number (float)
  115614. * @param uniform defines the webGL uniform location where to store the value
  115615. * @param value defines the float number to store
  115616. */
  115617. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115618. /**
  115619. * Set the value of an uniform to a vec2
  115620. * @param uniform defines the webGL uniform location where to store the value
  115621. * @param x defines the 1st component of the value
  115622. * @param y defines the 2nd component of the value
  115623. */
  115624. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  115625. /**
  115626. * Set the value of an uniform to a vec3
  115627. * @param uniform defines the webGL uniform location where to store the value
  115628. * @param x defines the 1st component of the value
  115629. * @param y defines the 2nd component of the value
  115630. * @param z defines the 3rd component of the value
  115631. */
  115632. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  115633. /**
  115634. * Set the value of an uniform to a vec4
  115635. * @param uniform defines the webGL uniform location where to store the value
  115636. * @param x defines the 1st component of the value
  115637. * @param y defines the 2nd component of the value
  115638. * @param z defines the 3rd component of the value
  115639. * @param w defines the 4th component of the value
  115640. */
  115641. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  115642. /**
  115643. * Apply all cached states (depth, culling, stencil and alpha)
  115644. */
  115645. applyStates(): void;
  115646. /**
  115647. * Enable or disable color writing
  115648. * @param enable defines the state to set
  115649. */
  115650. setColorWrite(enable: boolean): void;
  115651. /**
  115652. * Gets a boolean indicating if color writing is enabled
  115653. * @returns the current color writing state
  115654. */
  115655. getColorWrite(): boolean;
  115656. /**
  115657. * Gets the depth culling state manager
  115658. */
  115659. get depthCullingState(): DepthCullingState;
  115660. /**
  115661. * Gets the alpha state manager
  115662. */
  115663. get alphaState(): AlphaState;
  115664. /**
  115665. * Gets the stencil state manager
  115666. */
  115667. get stencilState(): StencilState;
  115668. /**
  115669. * Clears the list of texture accessible through engine.
  115670. * This can help preventing texture load conflict due to name collision.
  115671. */
  115672. clearInternalTexturesCache(): void;
  115673. /**
  115674. * Force the entire cache to be cleared
  115675. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  115676. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  115677. */
  115678. wipeCaches(bruteForce?: boolean): void;
  115679. /** @hidden */
  115680. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  115681. min: number;
  115682. mag: number;
  115683. };
  115684. /** @hidden */
  115685. _createTexture(): WebGLTexture;
  115686. /**
  115687. * Usually called from Texture.ts.
  115688. * Passed information to create a WebGLTexture
  115689. * @param url defines a value which contains one of the following:
  115690. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  115691. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  115692. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  115693. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  115694. * @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)
  115695. * @param scene needed for loading to the correct scene
  115696. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  115697. * @param onLoad optional callback to be called upon successful completion
  115698. * @param onError optional callback to be called upon failure
  115699. * @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
  115700. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  115701. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  115702. * @param forcedExtension defines the extension to use to pick the right loader
  115703. * @param mimeType defines an optional mime type
  115704. * @returns a InternalTexture for assignment back into BABYLON.Texture
  115705. */
  115706. 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;
  115707. /**
  115708. * Loads an image as an HTMLImageElement.
  115709. * @param input url string, ArrayBuffer, or Blob to load
  115710. * @param onLoad callback called when the image successfully loads
  115711. * @param onError callback called when the image fails to load
  115712. * @param offlineProvider offline provider for caching
  115713. * @param mimeType optional mime type
  115714. * @returns the HTMLImageElement of the loaded image
  115715. * @hidden
  115716. */
  115717. 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>;
  115718. /**
  115719. * @hidden
  115720. */
  115721. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  115722. private _unpackFlipYCached;
  115723. /**
  115724. * In case you are sharing the context with other applications, it might
  115725. * be interested to not cache the unpack flip y state to ensure a consistent
  115726. * value would be set.
  115727. */
  115728. enableUnpackFlipYCached: boolean;
  115729. /** @hidden */
  115730. _unpackFlipY(value: boolean): void;
  115731. /** @hidden */
  115732. _getUnpackAlignement(): number;
  115733. private _getTextureTarget;
  115734. /**
  115735. * Update the sampling mode of a given texture
  115736. * @param samplingMode defines the required sampling mode
  115737. * @param texture defines the texture to update
  115738. * @param generateMipMaps defines whether to generate mipmaps for the texture
  115739. */
  115740. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  115741. /**
  115742. * Update the sampling mode of a given texture
  115743. * @param texture defines the texture to update
  115744. * @param wrapU defines the texture wrap mode of the u coordinates
  115745. * @param wrapV defines the texture wrap mode of the v coordinates
  115746. * @param wrapR defines the texture wrap mode of the r coordinates
  115747. */
  115748. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  115749. /** @hidden */
  115750. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  115751. width: number;
  115752. height: number;
  115753. layers?: number;
  115754. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  115755. /** @hidden */
  115756. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115757. /** @hidden */
  115758. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  115759. /**
  115760. * Update a portion of an internal texture
  115761. * @param texture defines the texture to update
  115762. * @param imageData defines the data to store into the texture
  115763. * @param xOffset defines the x coordinates of the update rectangle
  115764. * @param yOffset defines the y coordinates of the update rectangle
  115765. * @param width defines the width of the update rectangle
  115766. * @param height defines the height of the update rectangle
  115767. * @param faceIndex defines the face index if texture is a cube (0 by default)
  115768. * @param lod defines the lod level to update (0 by default)
  115769. */
  115770. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  115771. /** @hidden */
  115772. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115773. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  115774. private _prepareWebGLTexture;
  115775. /** @hidden */
  115776. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  115777. private _getDepthStencilBuffer;
  115778. /** @hidden */
  115779. _releaseFramebufferObjects(texture: InternalTexture): void;
  115780. /** @hidden */
  115781. _releaseTexture(texture: InternalTexture): void;
  115782. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  115783. protected _setProgram(program: WebGLProgram): void;
  115784. protected _boundUniforms: {
  115785. [key: number]: WebGLUniformLocation;
  115786. };
  115787. /**
  115788. * Binds an effect to the webGL context
  115789. * @param effect defines the effect to bind
  115790. */
  115791. bindSamplers(effect: Effect): void;
  115792. private _activateCurrentTexture;
  115793. /** @hidden */
  115794. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  115795. /** @hidden */
  115796. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  115797. /**
  115798. * Unbind all textures from the webGL context
  115799. */
  115800. unbindAllTextures(): void;
  115801. /**
  115802. * Sets a texture to the according uniform.
  115803. * @param channel The texture channel
  115804. * @param uniform The uniform to set
  115805. * @param texture The texture to apply
  115806. */
  115807. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  115808. private _bindSamplerUniformToChannel;
  115809. private _getTextureWrapMode;
  115810. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  115811. /**
  115812. * Sets an array of texture to the webGL context
  115813. * @param channel defines the channel where the texture array must be set
  115814. * @param uniform defines the associated uniform location
  115815. * @param textures defines the array of textures to bind
  115816. */
  115817. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  115818. /** @hidden */
  115819. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  115820. private _setTextureParameterFloat;
  115821. private _setTextureParameterInteger;
  115822. /**
  115823. * Unbind all vertex attributes from the webGL context
  115824. */
  115825. unbindAllAttributes(): void;
  115826. /**
  115827. * 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
  115828. */
  115829. releaseEffects(): void;
  115830. /**
  115831. * Dispose and release all associated resources
  115832. */
  115833. dispose(): void;
  115834. /**
  115835. * Attach a new callback raised when context lost event is fired
  115836. * @param callback defines the callback to call
  115837. */
  115838. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115839. /**
  115840. * Attach a new callback raised when context restored event is fired
  115841. * @param callback defines the callback to call
  115842. */
  115843. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115844. /**
  115845. * Get the current error code of the webGL context
  115846. * @returns the error code
  115847. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  115848. */
  115849. getError(): number;
  115850. private _canRenderToFloatFramebuffer;
  115851. private _canRenderToHalfFloatFramebuffer;
  115852. private _canRenderToFramebuffer;
  115853. /** @hidden */
  115854. _getWebGLTextureType(type: number): number;
  115855. /** @hidden */
  115856. _getInternalFormat(format: number): number;
  115857. /** @hidden */
  115858. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  115859. /** @hidden */
  115860. _getRGBAMultiSampleBufferFormat(type: number): number;
  115861. /** @hidden */
  115862. _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;
  115863. /**
  115864. * Loads a file from a url
  115865. * @param url url to load
  115866. * @param onSuccess callback called when the file successfully loads
  115867. * @param onProgress callback called while file is loading (if the server supports this mode)
  115868. * @param offlineProvider defines the offline provider for caching
  115869. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115870. * @param onError callback called when the file fails to load
  115871. * @returns a file request object
  115872. * @hidden
  115873. */
  115874. 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;
  115875. /**
  115876. * Reads pixels from the current frame buffer. Please note that this function can be slow
  115877. * @param x defines the x coordinate of the rectangle where pixels must be read
  115878. * @param y defines the y coordinate of the rectangle where pixels must be read
  115879. * @param width defines the width of the rectangle where pixels must be read
  115880. * @param height defines the height of the rectangle where pixels must be read
  115881. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  115882. * @returns a Uint8Array containing RGBA colors
  115883. */
  115884. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  115885. private static _isSupported;
  115886. /**
  115887. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  115888. * @returns true if the engine can be created
  115889. * @ignorenaming
  115890. */
  115891. static isSupported(): boolean;
  115892. /**
  115893. * Find the next highest power of two.
  115894. * @param x Number to start search from.
  115895. * @return Next highest power of two.
  115896. */
  115897. static CeilingPOT(x: number): number;
  115898. /**
  115899. * Find the next lowest power of two.
  115900. * @param x Number to start search from.
  115901. * @return Next lowest power of two.
  115902. */
  115903. static FloorPOT(x: number): number;
  115904. /**
  115905. * Find the nearest power of two.
  115906. * @param x Number to start search from.
  115907. * @return Next nearest power of two.
  115908. */
  115909. static NearestPOT(x: number): number;
  115910. /**
  115911. * Get the closest exponent of two
  115912. * @param value defines the value to approximate
  115913. * @param max defines the maximum value to return
  115914. * @param mode defines how to define the closest value
  115915. * @returns closest exponent of two of the given value
  115916. */
  115917. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  115918. /**
  115919. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  115920. * @param func - the function to be called
  115921. * @param requester - the object that will request the next frame. Falls back to window.
  115922. * @returns frame number
  115923. */
  115924. static QueueNewFrame(func: () => void, requester?: any): number;
  115925. /**
  115926. * Gets host document
  115927. * @returns the host document object
  115928. */
  115929. getHostDocument(): Nullable<Document>;
  115930. }
  115931. }
  115932. declare module BABYLON {
  115933. /**
  115934. * Class representing spherical harmonics coefficients to the 3rd degree
  115935. */
  115936. export class SphericalHarmonics {
  115937. /**
  115938. * Defines whether or not the harmonics have been prescaled for rendering.
  115939. */
  115940. preScaled: boolean;
  115941. /**
  115942. * The l0,0 coefficients of the spherical harmonics
  115943. */
  115944. l00: Vector3;
  115945. /**
  115946. * The l1,-1 coefficients of the spherical harmonics
  115947. */
  115948. l1_1: Vector3;
  115949. /**
  115950. * The l1,0 coefficients of the spherical harmonics
  115951. */
  115952. l10: Vector3;
  115953. /**
  115954. * The l1,1 coefficients of the spherical harmonics
  115955. */
  115956. l11: Vector3;
  115957. /**
  115958. * The l2,-2 coefficients of the spherical harmonics
  115959. */
  115960. l2_2: Vector3;
  115961. /**
  115962. * The l2,-1 coefficients of the spherical harmonics
  115963. */
  115964. l2_1: Vector3;
  115965. /**
  115966. * The l2,0 coefficients of the spherical harmonics
  115967. */
  115968. l20: Vector3;
  115969. /**
  115970. * The l2,1 coefficients of the spherical harmonics
  115971. */
  115972. l21: Vector3;
  115973. /**
  115974. * The l2,2 coefficients of the spherical harmonics
  115975. */
  115976. l22: Vector3;
  115977. /**
  115978. * Adds a light to the spherical harmonics
  115979. * @param direction the direction of the light
  115980. * @param color the color of the light
  115981. * @param deltaSolidAngle the delta solid angle of the light
  115982. */
  115983. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  115984. /**
  115985. * Scales the spherical harmonics by the given amount
  115986. * @param scale the amount to scale
  115987. */
  115988. scaleInPlace(scale: number): void;
  115989. /**
  115990. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  115991. *
  115992. * ```
  115993. * E_lm = A_l * L_lm
  115994. * ```
  115995. *
  115996. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  115997. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  115998. * the scaling factors are given in equation 9.
  115999. */
  116000. convertIncidentRadianceToIrradiance(): void;
  116001. /**
  116002. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  116003. *
  116004. * ```
  116005. * L = (1/pi) * E * rho
  116006. * ```
  116007. *
  116008. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  116009. */
  116010. convertIrradianceToLambertianRadiance(): void;
  116011. /**
  116012. * Integrates the reconstruction coefficients directly in to the SH preventing further
  116013. * required operations at run time.
  116014. *
  116015. * This is simply done by scaling back the SH with Ylm constants parameter.
  116016. * The trigonometric part being applied by the shader at run time.
  116017. */
  116018. preScaleForRendering(): void;
  116019. /**
  116020. * Constructs a spherical harmonics from an array.
  116021. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  116022. * @returns the spherical harmonics
  116023. */
  116024. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  116025. /**
  116026. * Gets the spherical harmonics from polynomial
  116027. * @param polynomial the spherical polynomial
  116028. * @returns the spherical harmonics
  116029. */
  116030. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  116031. }
  116032. /**
  116033. * Class representing spherical polynomial coefficients to the 3rd degree
  116034. */
  116035. export class SphericalPolynomial {
  116036. private _harmonics;
  116037. /**
  116038. * The spherical harmonics used to create the polynomials.
  116039. */
  116040. get preScaledHarmonics(): SphericalHarmonics;
  116041. /**
  116042. * The x coefficients of the spherical polynomial
  116043. */
  116044. x: Vector3;
  116045. /**
  116046. * The y coefficients of the spherical polynomial
  116047. */
  116048. y: Vector3;
  116049. /**
  116050. * The z coefficients of the spherical polynomial
  116051. */
  116052. z: Vector3;
  116053. /**
  116054. * The xx coefficients of the spherical polynomial
  116055. */
  116056. xx: Vector3;
  116057. /**
  116058. * The yy coefficients of the spherical polynomial
  116059. */
  116060. yy: Vector3;
  116061. /**
  116062. * The zz coefficients of the spherical polynomial
  116063. */
  116064. zz: Vector3;
  116065. /**
  116066. * The xy coefficients of the spherical polynomial
  116067. */
  116068. xy: Vector3;
  116069. /**
  116070. * The yz coefficients of the spherical polynomial
  116071. */
  116072. yz: Vector3;
  116073. /**
  116074. * The zx coefficients of the spherical polynomial
  116075. */
  116076. zx: Vector3;
  116077. /**
  116078. * Adds an ambient color to the spherical polynomial
  116079. * @param color the color to add
  116080. */
  116081. addAmbient(color: Color3): void;
  116082. /**
  116083. * Scales the spherical polynomial by the given amount
  116084. * @param scale the amount to scale
  116085. */
  116086. scaleInPlace(scale: number): void;
  116087. /**
  116088. * Gets the spherical polynomial from harmonics
  116089. * @param harmonics the spherical harmonics
  116090. * @returns the spherical polynomial
  116091. */
  116092. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  116093. /**
  116094. * Constructs a spherical polynomial from an array.
  116095. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  116096. * @returns the spherical polynomial
  116097. */
  116098. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  116099. }
  116100. }
  116101. declare module BABYLON {
  116102. /**
  116103. * Defines the source of the internal texture
  116104. */
  116105. export enum InternalTextureSource {
  116106. /**
  116107. * The source of the texture data is unknown
  116108. */
  116109. Unknown = 0,
  116110. /**
  116111. * Texture data comes from an URL
  116112. */
  116113. Url = 1,
  116114. /**
  116115. * Texture data is only used for temporary storage
  116116. */
  116117. Temp = 2,
  116118. /**
  116119. * Texture data comes from raw data (ArrayBuffer)
  116120. */
  116121. Raw = 3,
  116122. /**
  116123. * Texture content is dynamic (video or dynamic texture)
  116124. */
  116125. Dynamic = 4,
  116126. /**
  116127. * Texture content is generated by rendering to it
  116128. */
  116129. RenderTarget = 5,
  116130. /**
  116131. * Texture content is part of a multi render target process
  116132. */
  116133. MultiRenderTarget = 6,
  116134. /**
  116135. * Texture data comes from a cube data file
  116136. */
  116137. Cube = 7,
  116138. /**
  116139. * Texture data comes from a raw cube data
  116140. */
  116141. CubeRaw = 8,
  116142. /**
  116143. * Texture data come from a prefiltered cube data file
  116144. */
  116145. CubePrefiltered = 9,
  116146. /**
  116147. * Texture content is raw 3D data
  116148. */
  116149. Raw3D = 10,
  116150. /**
  116151. * Texture content is raw 2D array data
  116152. */
  116153. Raw2DArray = 11,
  116154. /**
  116155. * Texture content is a depth texture
  116156. */
  116157. Depth = 12,
  116158. /**
  116159. * Texture data comes from a raw cube data encoded with RGBD
  116160. */
  116161. CubeRawRGBD = 13
  116162. }
  116163. /**
  116164. * Class used to store data associated with WebGL texture data for the engine
  116165. * This class should not be used directly
  116166. */
  116167. export class InternalTexture {
  116168. /** @hidden */
  116169. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  116170. /**
  116171. * Defines if the texture is ready
  116172. */
  116173. isReady: boolean;
  116174. /**
  116175. * Defines if the texture is a cube texture
  116176. */
  116177. isCube: boolean;
  116178. /**
  116179. * Defines if the texture contains 3D data
  116180. */
  116181. is3D: boolean;
  116182. /**
  116183. * Defines if the texture contains 2D array data
  116184. */
  116185. is2DArray: boolean;
  116186. /**
  116187. * Defines if the texture contains multiview data
  116188. */
  116189. isMultiview: boolean;
  116190. /**
  116191. * Gets the URL used to load this texture
  116192. */
  116193. url: string;
  116194. /**
  116195. * Gets the sampling mode of the texture
  116196. */
  116197. samplingMode: number;
  116198. /**
  116199. * Gets a boolean indicating if the texture needs mipmaps generation
  116200. */
  116201. generateMipMaps: boolean;
  116202. /**
  116203. * Gets the number of samples used by the texture (WebGL2+ only)
  116204. */
  116205. samples: number;
  116206. /**
  116207. * Gets the type of the texture (int, float...)
  116208. */
  116209. type: number;
  116210. /**
  116211. * Gets the format of the texture (RGB, RGBA...)
  116212. */
  116213. format: number;
  116214. /**
  116215. * Observable called when the texture is loaded
  116216. */
  116217. onLoadedObservable: Observable<InternalTexture>;
  116218. /**
  116219. * Gets the width of the texture
  116220. */
  116221. width: number;
  116222. /**
  116223. * Gets the height of the texture
  116224. */
  116225. height: number;
  116226. /**
  116227. * Gets the depth of the texture
  116228. */
  116229. depth: number;
  116230. /**
  116231. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  116232. */
  116233. baseWidth: number;
  116234. /**
  116235. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  116236. */
  116237. baseHeight: number;
  116238. /**
  116239. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  116240. */
  116241. baseDepth: number;
  116242. /**
  116243. * Gets a boolean indicating if the texture is inverted on Y axis
  116244. */
  116245. invertY: boolean;
  116246. /** @hidden */
  116247. _invertVScale: boolean;
  116248. /** @hidden */
  116249. _associatedChannel: number;
  116250. /** @hidden */
  116251. _source: InternalTextureSource;
  116252. /** @hidden */
  116253. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  116254. /** @hidden */
  116255. _bufferView: Nullable<ArrayBufferView>;
  116256. /** @hidden */
  116257. _bufferViewArray: Nullable<ArrayBufferView[]>;
  116258. /** @hidden */
  116259. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  116260. /** @hidden */
  116261. _size: number;
  116262. /** @hidden */
  116263. _extension: string;
  116264. /** @hidden */
  116265. _files: Nullable<string[]>;
  116266. /** @hidden */
  116267. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  116268. /** @hidden */
  116269. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  116270. /** @hidden */
  116271. _framebuffer: Nullable<WebGLFramebuffer>;
  116272. /** @hidden */
  116273. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  116274. /** @hidden */
  116275. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  116276. /** @hidden */
  116277. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  116278. /** @hidden */
  116279. _attachments: Nullable<number[]>;
  116280. /** @hidden */
  116281. _textureArray: Nullable<InternalTexture[]>;
  116282. /** @hidden */
  116283. _cachedCoordinatesMode: Nullable<number>;
  116284. /** @hidden */
  116285. _cachedWrapU: Nullable<number>;
  116286. /** @hidden */
  116287. _cachedWrapV: Nullable<number>;
  116288. /** @hidden */
  116289. _cachedWrapR: Nullable<number>;
  116290. /** @hidden */
  116291. _cachedAnisotropicFilteringLevel: Nullable<number>;
  116292. /** @hidden */
  116293. _isDisabled: boolean;
  116294. /** @hidden */
  116295. _compression: Nullable<string>;
  116296. /** @hidden */
  116297. _generateStencilBuffer: boolean;
  116298. /** @hidden */
  116299. _generateDepthBuffer: boolean;
  116300. /** @hidden */
  116301. _comparisonFunction: number;
  116302. /** @hidden */
  116303. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  116304. /** @hidden */
  116305. _lodGenerationScale: number;
  116306. /** @hidden */
  116307. _lodGenerationOffset: number;
  116308. /** @hidden */
  116309. _depthStencilTexture: Nullable<InternalTexture>;
  116310. /** @hidden */
  116311. _colorTextureArray: Nullable<WebGLTexture>;
  116312. /** @hidden */
  116313. _depthStencilTextureArray: Nullable<WebGLTexture>;
  116314. /** @hidden */
  116315. _lodTextureHigh: Nullable<BaseTexture>;
  116316. /** @hidden */
  116317. _lodTextureMid: Nullable<BaseTexture>;
  116318. /** @hidden */
  116319. _lodTextureLow: Nullable<BaseTexture>;
  116320. /** @hidden */
  116321. _isRGBD: boolean;
  116322. /** @hidden */
  116323. _linearSpecularLOD: boolean;
  116324. /** @hidden */
  116325. _irradianceTexture: Nullable<BaseTexture>;
  116326. /** @hidden */
  116327. _webGLTexture: Nullable<WebGLTexture>;
  116328. /** @hidden */
  116329. _references: number;
  116330. private _engine;
  116331. /**
  116332. * Gets the Engine the texture belongs to.
  116333. * @returns The babylon engine
  116334. */
  116335. getEngine(): ThinEngine;
  116336. /**
  116337. * Gets the data source type of the texture
  116338. */
  116339. get source(): InternalTextureSource;
  116340. /**
  116341. * Creates a new InternalTexture
  116342. * @param engine defines the engine to use
  116343. * @param source defines the type of data that will be used
  116344. * @param delayAllocation if the texture allocation should be delayed (default: false)
  116345. */
  116346. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  116347. /**
  116348. * Increments the number of references (ie. the number of Texture that point to it)
  116349. */
  116350. incrementReferences(): void;
  116351. /**
  116352. * Change the size of the texture (not the size of the content)
  116353. * @param width defines the new width
  116354. * @param height defines the new height
  116355. * @param depth defines the new depth (1 by default)
  116356. */
  116357. updateSize(width: int, height: int, depth?: int): void;
  116358. /** @hidden */
  116359. _rebuild(): void;
  116360. /** @hidden */
  116361. _swapAndDie(target: InternalTexture): void;
  116362. /**
  116363. * Dispose the current allocated resources
  116364. */
  116365. dispose(): void;
  116366. }
  116367. }
  116368. declare module BABYLON {
  116369. /**
  116370. * Class used to work with sound analyzer using fast fourier transform (FFT)
  116371. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116372. */
  116373. export class Analyser {
  116374. /**
  116375. * Gets or sets the smoothing
  116376. * @ignorenaming
  116377. */
  116378. SMOOTHING: number;
  116379. /**
  116380. * Gets or sets the FFT table size
  116381. * @ignorenaming
  116382. */
  116383. FFT_SIZE: number;
  116384. /**
  116385. * Gets or sets the bar graph amplitude
  116386. * @ignorenaming
  116387. */
  116388. BARGRAPHAMPLITUDE: number;
  116389. /**
  116390. * Gets or sets the position of the debug canvas
  116391. * @ignorenaming
  116392. */
  116393. DEBUGCANVASPOS: {
  116394. x: number;
  116395. y: number;
  116396. };
  116397. /**
  116398. * Gets or sets the debug canvas size
  116399. * @ignorenaming
  116400. */
  116401. DEBUGCANVASSIZE: {
  116402. width: number;
  116403. height: number;
  116404. };
  116405. private _byteFreqs;
  116406. private _byteTime;
  116407. private _floatFreqs;
  116408. private _webAudioAnalyser;
  116409. private _debugCanvas;
  116410. private _debugCanvasContext;
  116411. private _scene;
  116412. private _registerFunc;
  116413. private _audioEngine;
  116414. /**
  116415. * Creates a new analyser
  116416. * @param scene defines hosting scene
  116417. */
  116418. constructor(scene: Scene);
  116419. /**
  116420. * Get the number of data values you will have to play with for the visualization
  116421. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  116422. * @returns a number
  116423. */
  116424. getFrequencyBinCount(): number;
  116425. /**
  116426. * Gets the current frequency data as a byte array
  116427. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116428. * @returns a Uint8Array
  116429. */
  116430. getByteFrequencyData(): Uint8Array;
  116431. /**
  116432. * Gets the current waveform as a byte array
  116433. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  116434. * @returns a Uint8Array
  116435. */
  116436. getByteTimeDomainData(): Uint8Array;
  116437. /**
  116438. * Gets the current frequency data as a float array
  116439. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116440. * @returns a Float32Array
  116441. */
  116442. getFloatFrequencyData(): Float32Array;
  116443. /**
  116444. * Renders the debug canvas
  116445. */
  116446. drawDebugCanvas(): void;
  116447. /**
  116448. * Stops rendering the debug canvas and removes it
  116449. */
  116450. stopDebugCanvas(): void;
  116451. /**
  116452. * Connects two audio nodes
  116453. * @param inputAudioNode defines first node to connect
  116454. * @param outputAudioNode defines second node to connect
  116455. */
  116456. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  116457. /**
  116458. * Releases all associated resources
  116459. */
  116460. dispose(): void;
  116461. }
  116462. }
  116463. declare module BABYLON {
  116464. /**
  116465. * This represents an audio engine and it is responsible
  116466. * to play, synchronize and analyse sounds throughout the application.
  116467. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116468. */
  116469. export interface IAudioEngine extends IDisposable {
  116470. /**
  116471. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116472. */
  116473. readonly canUseWebAudio: boolean;
  116474. /**
  116475. * Gets the current AudioContext if available.
  116476. */
  116477. readonly audioContext: Nullable<AudioContext>;
  116478. /**
  116479. * The master gain node defines the global audio volume of your audio engine.
  116480. */
  116481. readonly masterGain: GainNode;
  116482. /**
  116483. * Gets whether or not mp3 are supported by your browser.
  116484. */
  116485. readonly isMP3supported: boolean;
  116486. /**
  116487. * Gets whether or not ogg are supported by your browser.
  116488. */
  116489. readonly isOGGsupported: boolean;
  116490. /**
  116491. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116492. * @ignoreNaming
  116493. */
  116494. WarnedWebAudioUnsupported: boolean;
  116495. /**
  116496. * Defines if the audio engine relies on a custom unlocked button.
  116497. * In this case, the embedded button will not be displayed.
  116498. */
  116499. useCustomUnlockedButton: boolean;
  116500. /**
  116501. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  116502. */
  116503. readonly unlocked: boolean;
  116504. /**
  116505. * Event raised when audio has been unlocked on the browser.
  116506. */
  116507. onAudioUnlockedObservable: Observable<AudioEngine>;
  116508. /**
  116509. * Event raised when audio has been locked on the browser.
  116510. */
  116511. onAudioLockedObservable: Observable<AudioEngine>;
  116512. /**
  116513. * Flags the audio engine in Locked state.
  116514. * This happens due to new browser policies preventing audio to autoplay.
  116515. */
  116516. lock(): void;
  116517. /**
  116518. * Unlocks the audio engine once a user action has been done on the dom.
  116519. * This is helpful to resume play once browser policies have been satisfied.
  116520. */
  116521. unlock(): void;
  116522. /**
  116523. * Gets the global volume sets on the master gain.
  116524. * @returns the global volume if set or -1 otherwise
  116525. */
  116526. getGlobalVolume(): number;
  116527. /**
  116528. * Sets the global volume of your experience (sets on the master gain).
  116529. * @param newVolume Defines the new global volume of the application
  116530. */
  116531. setGlobalVolume(newVolume: number): void;
  116532. /**
  116533. * Connect the audio engine to an audio analyser allowing some amazing
  116534. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116535. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116536. * @param analyser The analyser to connect to the engine
  116537. */
  116538. connectToAnalyser(analyser: Analyser): void;
  116539. }
  116540. /**
  116541. * This represents the default audio engine used in babylon.
  116542. * It is responsible to play, synchronize and analyse sounds throughout the application.
  116543. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116544. */
  116545. export class AudioEngine implements IAudioEngine {
  116546. private _audioContext;
  116547. private _audioContextInitialized;
  116548. private _muteButton;
  116549. private _hostElement;
  116550. /**
  116551. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116552. */
  116553. canUseWebAudio: boolean;
  116554. /**
  116555. * The master gain node defines the global audio volume of your audio engine.
  116556. */
  116557. masterGain: GainNode;
  116558. /**
  116559. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116560. * @ignoreNaming
  116561. */
  116562. WarnedWebAudioUnsupported: boolean;
  116563. /**
  116564. * Gets whether or not mp3 are supported by your browser.
  116565. */
  116566. isMP3supported: boolean;
  116567. /**
  116568. * Gets whether or not ogg are supported by your browser.
  116569. */
  116570. isOGGsupported: boolean;
  116571. /**
  116572. * Gets whether audio has been unlocked on the device.
  116573. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  116574. * a user interaction has happened.
  116575. */
  116576. unlocked: boolean;
  116577. /**
  116578. * Defines if the audio engine relies on a custom unlocked button.
  116579. * In this case, the embedded button will not be displayed.
  116580. */
  116581. useCustomUnlockedButton: boolean;
  116582. /**
  116583. * Event raised when audio has been unlocked on the browser.
  116584. */
  116585. onAudioUnlockedObservable: Observable<AudioEngine>;
  116586. /**
  116587. * Event raised when audio has been locked on the browser.
  116588. */
  116589. onAudioLockedObservable: Observable<AudioEngine>;
  116590. /**
  116591. * Gets the current AudioContext if available.
  116592. */
  116593. get audioContext(): Nullable<AudioContext>;
  116594. private _connectedAnalyser;
  116595. /**
  116596. * Instantiates a new audio engine.
  116597. *
  116598. * There should be only one per page as some browsers restrict the number
  116599. * of audio contexts you can create.
  116600. * @param hostElement defines the host element where to display the mute icon if necessary
  116601. */
  116602. constructor(hostElement?: Nullable<HTMLElement>);
  116603. /**
  116604. * Flags the audio engine in Locked state.
  116605. * This happens due to new browser policies preventing audio to autoplay.
  116606. */
  116607. lock(): void;
  116608. /**
  116609. * Unlocks the audio engine once a user action has been done on the dom.
  116610. * This is helpful to resume play once browser policies have been satisfied.
  116611. */
  116612. unlock(): void;
  116613. private _resumeAudioContext;
  116614. private _initializeAudioContext;
  116615. private _tryToRun;
  116616. private _triggerRunningState;
  116617. private _triggerSuspendedState;
  116618. private _displayMuteButton;
  116619. private _moveButtonToTopLeft;
  116620. private _onResize;
  116621. private _hideMuteButton;
  116622. /**
  116623. * Destroy and release the resources associated with the audio ccontext.
  116624. */
  116625. dispose(): void;
  116626. /**
  116627. * Gets the global volume sets on the master gain.
  116628. * @returns the global volume if set or -1 otherwise
  116629. */
  116630. getGlobalVolume(): number;
  116631. /**
  116632. * Sets the global volume of your experience (sets on the master gain).
  116633. * @param newVolume Defines the new global volume of the application
  116634. */
  116635. setGlobalVolume(newVolume: number): void;
  116636. /**
  116637. * Connect the audio engine to an audio analyser allowing some amazing
  116638. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116639. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116640. * @param analyser The analyser to connect to the engine
  116641. */
  116642. connectToAnalyser(analyser: Analyser): void;
  116643. }
  116644. }
  116645. declare module BABYLON {
  116646. /**
  116647. * Interface used to present a loading screen while loading a scene
  116648. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116649. */
  116650. export interface ILoadingScreen {
  116651. /**
  116652. * Function called to display the loading screen
  116653. */
  116654. displayLoadingUI: () => void;
  116655. /**
  116656. * Function called to hide the loading screen
  116657. */
  116658. hideLoadingUI: () => void;
  116659. /**
  116660. * Gets or sets the color to use for the background
  116661. */
  116662. loadingUIBackgroundColor: string;
  116663. /**
  116664. * Gets or sets the text to display while loading
  116665. */
  116666. loadingUIText: string;
  116667. }
  116668. /**
  116669. * Class used for the default loading screen
  116670. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116671. */
  116672. export class DefaultLoadingScreen implements ILoadingScreen {
  116673. private _renderingCanvas;
  116674. private _loadingText;
  116675. private _loadingDivBackgroundColor;
  116676. private _loadingDiv;
  116677. private _loadingTextDiv;
  116678. /** Gets or sets the logo url to use for the default loading screen */
  116679. static DefaultLogoUrl: string;
  116680. /** Gets or sets the spinner url to use for the default loading screen */
  116681. static DefaultSpinnerUrl: string;
  116682. /**
  116683. * Creates a new default loading screen
  116684. * @param _renderingCanvas defines the canvas used to render the scene
  116685. * @param _loadingText defines the default text to display
  116686. * @param _loadingDivBackgroundColor defines the default background color
  116687. */
  116688. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  116689. /**
  116690. * Function called to display the loading screen
  116691. */
  116692. displayLoadingUI(): void;
  116693. /**
  116694. * Function called to hide the loading screen
  116695. */
  116696. hideLoadingUI(): void;
  116697. /**
  116698. * Gets or sets the text to display while loading
  116699. */
  116700. set loadingUIText(text: string);
  116701. get loadingUIText(): string;
  116702. /**
  116703. * Gets or sets the color to use for the background
  116704. */
  116705. get loadingUIBackgroundColor(): string;
  116706. set loadingUIBackgroundColor(color: string);
  116707. private _resizeLoadingUI;
  116708. }
  116709. }
  116710. declare module BABYLON {
  116711. /**
  116712. * Interface for any object that can request an animation frame
  116713. */
  116714. export interface ICustomAnimationFrameRequester {
  116715. /**
  116716. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  116717. */
  116718. renderFunction?: Function;
  116719. /**
  116720. * Called to request the next frame to render to
  116721. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  116722. */
  116723. requestAnimationFrame: Function;
  116724. /**
  116725. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  116726. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  116727. */
  116728. requestID?: number;
  116729. }
  116730. }
  116731. declare module BABYLON {
  116732. /**
  116733. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  116734. */
  116735. export class PerformanceMonitor {
  116736. private _enabled;
  116737. private _rollingFrameTime;
  116738. private _lastFrameTimeMs;
  116739. /**
  116740. * constructor
  116741. * @param frameSampleSize The number of samples required to saturate the sliding window
  116742. */
  116743. constructor(frameSampleSize?: number);
  116744. /**
  116745. * Samples current frame
  116746. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  116747. */
  116748. sampleFrame(timeMs?: number): void;
  116749. /**
  116750. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116751. */
  116752. get averageFrameTime(): number;
  116753. /**
  116754. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116755. */
  116756. get averageFrameTimeVariance(): number;
  116757. /**
  116758. * Returns the frame time of the most recent frame
  116759. */
  116760. get instantaneousFrameTime(): number;
  116761. /**
  116762. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  116763. */
  116764. get averageFPS(): number;
  116765. /**
  116766. * Returns the average framerate in frames per second using the most recent frame time
  116767. */
  116768. get instantaneousFPS(): number;
  116769. /**
  116770. * Returns true if enough samples have been taken to completely fill the sliding window
  116771. */
  116772. get isSaturated(): boolean;
  116773. /**
  116774. * Enables contributions to the sliding window sample set
  116775. */
  116776. enable(): void;
  116777. /**
  116778. * Disables contributions to the sliding window sample set
  116779. * Samples will not be interpolated over the disabled period
  116780. */
  116781. disable(): void;
  116782. /**
  116783. * Returns true if sampling is enabled
  116784. */
  116785. get isEnabled(): boolean;
  116786. /**
  116787. * Resets performance monitor
  116788. */
  116789. reset(): void;
  116790. }
  116791. /**
  116792. * RollingAverage
  116793. *
  116794. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  116795. */
  116796. export class RollingAverage {
  116797. /**
  116798. * Current average
  116799. */
  116800. average: number;
  116801. /**
  116802. * Current variance
  116803. */
  116804. variance: number;
  116805. protected _samples: Array<number>;
  116806. protected _sampleCount: number;
  116807. protected _pos: number;
  116808. protected _m2: number;
  116809. /**
  116810. * constructor
  116811. * @param length The number of samples required to saturate the sliding window
  116812. */
  116813. constructor(length: number);
  116814. /**
  116815. * Adds a sample to the sample set
  116816. * @param v The sample value
  116817. */
  116818. add(v: number): void;
  116819. /**
  116820. * Returns previously added values or null if outside of history or outside the sliding window domain
  116821. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  116822. * @return Value previously recorded with add() or null if outside of range
  116823. */
  116824. history(i: number): number;
  116825. /**
  116826. * Returns true if enough samples have been taken to completely fill the sliding window
  116827. * @return true if sample-set saturated
  116828. */
  116829. isSaturated(): boolean;
  116830. /**
  116831. * Resets the rolling average (equivalent to 0 samples taken so far)
  116832. */
  116833. reset(): void;
  116834. /**
  116835. * Wraps a value around the sample range boundaries
  116836. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  116837. * @return Wrapped position in sample range
  116838. */
  116839. protected _wrapPosition(i: number): number;
  116840. }
  116841. }
  116842. declare module BABYLON {
  116843. /**
  116844. * This class is used to track a performance counter which is number based.
  116845. * The user has access to many properties which give statistics of different nature.
  116846. *
  116847. * The implementer can track two kinds of Performance Counter: time and count.
  116848. * 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.
  116849. * 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.
  116850. */
  116851. export class PerfCounter {
  116852. /**
  116853. * Gets or sets a global boolean to turn on and off all the counters
  116854. */
  116855. static Enabled: boolean;
  116856. /**
  116857. * Returns the smallest value ever
  116858. */
  116859. get min(): number;
  116860. /**
  116861. * Returns the biggest value ever
  116862. */
  116863. get max(): number;
  116864. /**
  116865. * Returns the average value since the performance counter is running
  116866. */
  116867. get average(): number;
  116868. /**
  116869. * Returns the average value of the last second the counter was monitored
  116870. */
  116871. get lastSecAverage(): number;
  116872. /**
  116873. * Returns the current value
  116874. */
  116875. get current(): number;
  116876. /**
  116877. * Gets the accumulated total
  116878. */
  116879. get total(): number;
  116880. /**
  116881. * Gets the total value count
  116882. */
  116883. get count(): number;
  116884. /**
  116885. * Creates a new counter
  116886. */
  116887. constructor();
  116888. /**
  116889. * Call this method to start monitoring a new frame.
  116890. * 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.
  116891. */
  116892. fetchNewFrame(): void;
  116893. /**
  116894. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  116895. * @param newCount the count value to add to the monitored count
  116896. * @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.
  116897. */
  116898. addCount(newCount: number, fetchResult: boolean): void;
  116899. /**
  116900. * Start monitoring this performance counter
  116901. */
  116902. beginMonitoring(): void;
  116903. /**
  116904. * Compute the time lapsed since the previous beginMonitoring() call.
  116905. * @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
  116906. */
  116907. endMonitoring(newFrame?: boolean): void;
  116908. private _fetchResult;
  116909. private _startMonitoringTime;
  116910. private _min;
  116911. private _max;
  116912. private _average;
  116913. private _current;
  116914. private _totalValueCount;
  116915. private _totalAccumulated;
  116916. private _lastSecAverage;
  116917. private _lastSecAccumulated;
  116918. private _lastSecTime;
  116919. private _lastSecValueCount;
  116920. }
  116921. }
  116922. declare module BABYLON {
  116923. interface ThinEngine {
  116924. /** @hidden */
  116925. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  116926. }
  116927. }
  116928. declare module BABYLON {
  116929. /**
  116930. * Defines the interface used by display changed events
  116931. */
  116932. export interface IDisplayChangedEventArgs {
  116933. /** Gets the vrDisplay object (if any) */
  116934. vrDisplay: Nullable<any>;
  116935. /** Gets a boolean indicating if webVR is supported */
  116936. vrSupported: boolean;
  116937. }
  116938. /**
  116939. * Defines the interface used by objects containing a viewport (like a camera)
  116940. */
  116941. interface IViewportOwnerLike {
  116942. /**
  116943. * Gets or sets the viewport
  116944. */
  116945. viewport: IViewportLike;
  116946. }
  116947. /**
  116948. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  116949. */
  116950. export class Engine extends ThinEngine {
  116951. /** Defines that alpha blending is disabled */
  116952. static readonly ALPHA_DISABLE: number;
  116953. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  116954. static readonly ALPHA_ADD: number;
  116955. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  116956. static readonly ALPHA_COMBINE: number;
  116957. /** Defines that alpha blending to DEST - SRC * DEST */
  116958. static readonly ALPHA_SUBTRACT: number;
  116959. /** Defines that alpha blending to SRC * DEST */
  116960. static readonly ALPHA_MULTIPLY: number;
  116961. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  116962. static readonly ALPHA_MAXIMIZED: number;
  116963. /** Defines that alpha blending to SRC + DEST */
  116964. static readonly ALPHA_ONEONE: number;
  116965. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  116966. static readonly ALPHA_PREMULTIPLIED: number;
  116967. /**
  116968. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  116969. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  116970. */
  116971. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  116972. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  116973. static readonly ALPHA_INTERPOLATE: number;
  116974. /**
  116975. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  116976. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  116977. */
  116978. static readonly ALPHA_SCREENMODE: number;
  116979. /** Defines that the ressource is not delayed*/
  116980. static readonly DELAYLOADSTATE_NONE: number;
  116981. /** Defines that the ressource was successfully delay loaded */
  116982. static readonly DELAYLOADSTATE_LOADED: number;
  116983. /** Defines that the ressource is currently delay loading */
  116984. static readonly DELAYLOADSTATE_LOADING: number;
  116985. /** Defines that the ressource is delayed and has not started loading */
  116986. static readonly DELAYLOADSTATE_NOTLOADED: number;
  116987. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  116988. static readonly NEVER: number;
  116989. /** 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 */
  116990. static readonly ALWAYS: number;
  116991. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  116992. static readonly LESS: number;
  116993. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  116994. static readonly EQUAL: number;
  116995. /** 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 */
  116996. static readonly LEQUAL: number;
  116997. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  116998. static readonly GREATER: number;
  116999. /** 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 */
  117000. static readonly GEQUAL: number;
  117001. /** 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 */
  117002. static readonly NOTEQUAL: number;
  117003. /** Passed to stencilOperation to specify that stencil value must be kept */
  117004. static readonly KEEP: number;
  117005. /** Passed to stencilOperation to specify that stencil value must be replaced */
  117006. static readonly REPLACE: number;
  117007. /** Passed to stencilOperation to specify that stencil value must be incremented */
  117008. static readonly INCR: number;
  117009. /** Passed to stencilOperation to specify that stencil value must be decremented */
  117010. static readonly DECR: number;
  117011. /** Passed to stencilOperation to specify that stencil value must be inverted */
  117012. static readonly INVERT: number;
  117013. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  117014. static readonly INCR_WRAP: number;
  117015. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  117016. static readonly DECR_WRAP: number;
  117017. /** Texture is not repeating outside of 0..1 UVs */
  117018. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  117019. /** Texture is repeating outside of 0..1 UVs */
  117020. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  117021. /** Texture is repeating and mirrored */
  117022. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  117023. /** ALPHA */
  117024. static readonly TEXTUREFORMAT_ALPHA: number;
  117025. /** LUMINANCE */
  117026. static readonly TEXTUREFORMAT_LUMINANCE: number;
  117027. /** LUMINANCE_ALPHA */
  117028. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  117029. /** RGB */
  117030. static readonly TEXTUREFORMAT_RGB: number;
  117031. /** RGBA */
  117032. static readonly TEXTUREFORMAT_RGBA: number;
  117033. /** RED */
  117034. static readonly TEXTUREFORMAT_RED: number;
  117035. /** RED (2nd reference) */
  117036. static readonly TEXTUREFORMAT_R: number;
  117037. /** RG */
  117038. static readonly TEXTUREFORMAT_RG: number;
  117039. /** RED_INTEGER */
  117040. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  117041. /** RED_INTEGER (2nd reference) */
  117042. static readonly TEXTUREFORMAT_R_INTEGER: number;
  117043. /** RG_INTEGER */
  117044. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  117045. /** RGB_INTEGER */
  117046. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  117047. /** RGBA_INTEGER */
  117048. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  117049. /** UNSIGNED_BYTE */
  117050. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  117051. /** UNSIGNED_BYTE (2nd reference) */
  117052. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  117053. /** FLOAT */
  117054. static readonly TEXTURETYPE_FLOAT: number;
  117055. /** HALF_FLOAT */
  117056. static readonly TEXTURETYPE_HALF_FLOAT: number;
  117057. /** BYTE */
  117058. static readonly TEXTURETYPE_BYTE: number;
  117059. /** SHORT */
  117060. static readonly TEXTURETYPE_SHORT: number;
  117061. /** UNSIGNED_SHORT */
  117062. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  117063. /** INT */
  117064. static readonly TEXTURETYPE_INT: number;
  117065. /** UNSIGNED_INT */
  117066. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  117067. /** UNSIGNED_SHORT_4_4_4_4 */
  117068. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  117069. /** UNSIGNED_SHORT_5_5_5_1 */
  117070. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  117071. /** UNSIGNED_SHORT_5_6_5 */
  117072. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  117073. /** UNSIGNED_INT_2_10_10_10_REV */
  117074. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  117075. /** UNSIGNED_INT_24_8 */
  117076. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  117077. /** UNSIGNED_INT_10F_11F_11F_REV */
  117078. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  117079. /** UNSIGNED_INT_5_9_9_9_REV */
  117080. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  117081. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  117082. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  117083. /** nearest is mag = nearest and min = nearest and mip = linear */
  117084. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  117085. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117086. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  117087. /** Trilinear is mag = linear and min = linear and mip = linear */
  117088. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  117089. /** nearest is mag = nearest and min = nearest and mip = linear */
  117090. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  117091. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117092. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  117093. /** Trilinear is mag = linear and min = linear and mip = linear */
  117094. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  117095. /** mag = nearest and min = nearest and mip = nearest */
  117096. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  117097. /** mag = nearest and min = linear and mip = nearest */
  117098. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  117099. /** mag = nearest and min = linear and mip = linear */
  117100. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  117101. /** mag = nearest and min = linear and mip = none */
  117102. static readonly TEXTURE_NEAREST_LINEAR: number;
  117103. /** mag = nearest and min = nearest and mip = none */
  117104. static readonly TEXTURE_NEAREST_NEAREST: number;
  117105. /** mag = linear and min = nearest and mip = nearest */
  117106. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  117107. /** mag = linear and min = nearest and mip = linear */
  117108. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  117109. /** mag = linear and min = linear and mip = none */
  117110. static readonly TEXTURE_LINEAR_LINEAR: number;
  117111. /** mag = linear and min = nearest and mip = none */
  117112. static readonly TEXTURE_LINEAR_NEAREST: number;
  117113. /** Explicit coordinates mode */
  117114. static readonly TEXTURE_EXPLICIT_MODE: number;
  117115. /** Spherical coordinates mode */
  117116. static readonly TEXTURE_SPHERICAL_MODE: number;
  117117. /** Planar coordinates mode */
  117118. static readonly TEXTURE_PLANAR_MODE: number;
  117119. /** Cubic coordinates mode */
  117120. static readonly TEXTURE_CUBIC_MODE: number;
  117121. /** Projection coordinates mode */
  117122. static readonly TEXTURE_PROJECTION_MODE: number;
  117123. /** Skybox coordinates mode */
  117124. static readonly TEXTURE_SKYBOX_MODE: number;
  117125. /** Inverse Cubic coordinates mode */
  117126. static readonly TEXTURE_INVCUBIC_MODE: number;
  117127. /** Equirectangular coordinates mode */
  117128. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  117129. /** Equirectangular Fixed coordinates mode */
  117130. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  117131. /** Equirectangular Fixed Mirrored coordinates mode */
  117132. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  117133. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  117134. static readonly SCALEMODE_FLOOR: number;
  117135. /** Defines that texture rescaling will look for the nearest power of 2 size */
  117136. static readonly SCALEMODE_NEAREST: number;
  117137. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  117138. static readonly SCALEMODE_CEILING: number;
  117139. /**
  117140. * Returns the current npm package of the sdk
  117141. */
  117142. static get NpmPackage(): string;
  117143. /**
  117144. * Returns the current version of the framework
  117145. */
  117146. static get Version(): string;
  117147. /** Gets the list of created engines */
  117148. static get Instances(): Engine[];
  117149. /**
  117150. * Gets the latest created engine
  117151. */
  117152. static get LastCreatedEngine(): Nullable<Engine>;
  117153. /**
  117154. * Gets the latest created scene
  117155. */
  117156. static get LastCreatedScene(): Nullable<Scene>;
  117157. /**
  117158. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  117159. * @param flag defines which part of the materials must be marked as dirty
  117160. * @param predicate defines a predicate used to filter which materials should be affected
  117161. */
  117162. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  117163. /**
  117164. * Method called to create the default loading screen.
  117165. * This can be overriden in your own app.
  117166. * @param canvas The rendering canvas element
  117167. * @returns The loading screen
  117168. */
  117169. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  117170. /**
  117171. * Method called to create the default rescale post process on each engine.
  117172. */
  117173. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  117174. /**
  117175. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  117176. **/
  117177. enableOfflineSupport: boolean;
  117178. /**
  117179. * 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)
  117180. **/
  117181. disableManifestCheck: boolean;
  117182. /**
  117183. * Gets the list of created scenes
  117184. */
  117185. scenes: Scene[];
  117186. /**
  117187. * Event raised when a new scene is created
  117188. */
  117189. onNewSceneAddedObservable: Observable<Scene>;
  117190. /**
  117191. * Gets the list of created postprocesses
  117192. */
  117193. postProcesses: PostProcess[];
  117194. /**
  117195. * Gets a boolean indicating if the pointer is currently locked
  117196. */
  117197. isPointerLock: boolean;
  117198. /**
  117199. * Observable event triggered each time the rendering canvas is resized
  117200. */
  117201. onResizeObservable: Observable<Engine>;
  117202. /**
  117203. * Observable event triggered each time the canvas loses focus
  117204. */
  117205. onCanvasBlurObservable: Observable<Engine>;
  117206. /**
  117207. * Observable event triggered each time the canvas gains focus
  117208. */
  117209. onCanvasFocusObservable: Observable<Engine>;
  117210. /**
  117211. * Observable event triggered each time the canvas receives pointerout event
  117212. */
  117213. onCanvasPointerOutObservable: Observable<PointerEvent>;
  117214. /**
  117215. * Observable raised when the engine begins a new frame
  117216. */
  117217. onBeginFrameObservable: Observable<Engine>;
  117218. /**
  117219. * If set, will be used to request the next animation frame for the render loop
  117220. */
  117221. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  117222. /**
  117223. * Observable raised when the engine ends the current frame
  117224. */
  117225. onEndFrameObservable: Observable<Engine>;
  117226. /**
  117227. * Observable raised when the engine is about to compile a shader
  117228. */
  117229. onBeforeShaderCompilationObservable: Observable<Engine>;
  117230. /**
  117231. * Observable raised when the engine has jsut compiled a shader
  117232. */
  117233. onAfterShaderCompilationObservable: Observable<Engine>;
  117234. /**
  117235. * Gets the audio engine
  117236. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117237. * @ignorenaming
  117238. */
  117239. static audioEngine: IAudioEngine;
  117240. /**
  117241. * Default AudioEngine factory responsible of creating the Audio Engine.
  117242. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  117243. */
  117244. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  117245. /**
  117246. * Default offline support factory responsible of creating a tool used to store data locally.
  117247. * By default, this will create a Database object if the workload has been embedded.
  117248. */
  117249. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  117250. private _loadingScreen;
  117251. private _pointerLockRequested;
  117252. private _rescalePostProcess;
  117253. private _deterministicLockstep;
  117254. private _lockstepMaxSteps;
  117255. private _timeStep;
  117256. protected get _supportsHardwareTextureRescaling(): boolean;
  117257. private _fps;
  117258. private _deltaTime;
  117259. /** @hidden */
  117260. _drawCalls: PerfCounter;
  117261. /** 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 */
  117262. canvasTabIndex: number;
  117263. /**
  117264. * Turn this value on if you want to pause FPS computation when in background
  117265. */
  117266. disablePerformanceMonitorInBackground: boolean;
  117267. private _performanceMonitor;
  117268. /**
  117269. * Gets the performance monitor attached to this engine
  117270. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117271. */
  117272. get performanceMonitor(): PerformanceMonitor;
  117273. private _onFocus;
  117274. private _onBlur;
  117275. private _onCanvasPointerOut;
  117276. private _onCanvasBlur;
  117277. private _onCanvasFocus;
  117278. private _onFullscreenChange;
  117279. private _onPointerLockChange;
  117280. /**
  117281. * Gets the HTML element used to attach event listeners
  117282. * @returns a HTML element
  117283. */
  117284. getInputElement(): Nullable<HTMLElement>;
  117285. /**
  117286. * Creates a new engine
  117287. * @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
  117288. * @param antialias defines enable antialiasing (default: false)
  117289. * @param options defines further options to be sent to the getContext() function
  117290. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  117291. */
  117292. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  117293. /**
  117294. * Gets current aspect ratio
  117295. * @param viewportOwner defines the camera to use to get the aspect ratio
  117296. * @param useScreen defines if screen size must be used (or the current render target if any)
  117297. * @returns a number defining the aspect ratio
  117298. */
  117299. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  117300. /**
  117301. * Gets current screen aspect ratio
  117302. * @returns a number defining the aspect ratio
  117303. */
  117304. getScreenAspectRatio(): number;
  117305. /**
  117306. * Gets the client rect of the HTML canvas attached with the current webGL context
  117307. * @returns a client rectanglee
  117308. */
  117309. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  117310. /**
  117311. * Gets the client rect of the HTML element used for events
  117312. * @returns a client rectanglee
  117313. */
  117314. getInputElementClientRect(): Nullable<ClientRect>;
  117315. /**
  117316. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  117317. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117318. * @returns true if engine is in deterministic lock step mode
  117319. */
  117320. isDeterministicLockStep(): boolean;
  117321. /**
  117322. * Gets the max steps when engine is running in deterministic lock step
  117323. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117324. * @returns the max steps
  117325. */
  117326. getLockstepMaxSteps(): number;
  117327. /**
  117328. * Returns the time in ms between steps when using deterministic lock step.
  117329. * @returns time step in (ms)
  117330. */
  117331. getTimeStep(): number;
  117332. /**
  117333. * Force the mipmap generation for the given render target texture
  117334. * @param texture defines the render target texture to use
  117335. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  117336. */
  117337. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  117338. /** States */
  117339. /**
  117340. * Set various states to the webGL context
  117341. * @param culling defines backface culling state
  117342. * @param zOffset defines the value to apply to zOffset (0 by default)
  117343. * @param force defines if states must be applied even if cache is up to date
  117344. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  117345. */
  117346. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  117347. /**
  117348. * Set the z offset to apply to current rendering
  117349. * @param value defines the offset to apply
  117350. */
  117351. setZOffset(value: number): void;
  117352. /**
  117353. * Gets the current value of the zOffset
  117354. * @returns the current zOffset state
  117355. */
  117356. getZOffset(): number;
  117357. /**
  117358. * Enable or disable depth buffering
  117359. * @param enable defines the state to set
  117360. */
  117361. setDepthBuffer(enable: boolean): void;
  117362. /**
  117363. * Gets a boolean indicating if depth writing is enabled
  117364. * @returns the current depth writing state
  117365. */
  117366. getDepthWrite(): boolean;
  117367. /**
  117368. * Enable or disable depth writing
  117369. * @param enable defines the state to set
  117370. */
  117371. setDepthWrite(enable: boolean): void;
  117372. /**
  117373. * Gets a boolean indicating if stencil buffer is enabled
  117374. * @returns the current stencil buffer state
  117375. */
  117376. getStencilBuffer(): boolean;
  117377. /**
  117378. * Enable or disable the stencil buffer
  117379. * @param enable defines if the stencil buffer must be enabled or disabled
  117380. */
  117381. setStencilBuffer(enable: boolean): void;
  117382. /**
  117383. * Gets the current stencil mask
  117384. * @returns a number defining the new stencil mask to use
  117385. */
  117386. getStencilMask(): number;
  117387. /**
  117388. * Sets the current stencil mask
  117389. * @param mask defines the new stencil mask to use
  117390. */
  117391. setStencilMask(mask: number): void;
  117392. /**
  117393. * Gets the current stencil function
  117394. * @returns a number defining the stencil function to use
  117395. */
  117396. getStencilFunction(): number;
  117397. /**
  117398. * Gets the current stencil reference value
  117399. * @returns a number defining the stencil reference value to use
  117400. */
  117401. getStencilFunctionReference(): number;
  117402. /**
  117403. * Gets the current stencil mask
  117404. * @returns a number defining the stencil mask to use
  117405. */
  117406. getStencilFunctionMask(): number;
  117407. /**
  117408. * Sets the current stencil function
  117409. * @param stencilFunc defines the new stencil function to use
  117410. */
  117411. setStencilFunction(stencilFunc: number): void;
  117412. /**
  117413. * Sets the current stencil reference
  117414. * @param reference defines the new stencil reference to use
  117415. */
  117416. setStencilFunctionReference(reference: number): void;
  117417. /**
  117418. * Sets the current stencil mask
  117419. * @param mask defines the new stencil mask to use
  117420. */
  117421. setStencilFunctionMask(mask: number): void;
  117422. /**
  117423. * Gets the current stencil operation when stencil fails
  117424. * @returns a number defining stencil operation to use when stencil fails
  117425. */
  117426. getStencilOperationFail(): number;
  117427. /**
  117428. * Gets the current stencil operation when depth fails
  117429. * @returns a number defining stencil operation to use when depth fails
  117430. */
  117431. getStencilOperationDepthFail(): number;
  117432. /**
  117433. * Gets the current stencil operation when stencil passes
  117434. * @returns a number defining stencil operation to use when stencil passes
  117435. */
  117436. getStencilOperationPass(): number;
  117437. /**
  117438. * Sets the stencil operation to use when stencil fails
  117439. * @param operation defines the stencil operation to use when stencil fails
  117440. */
  117441. setStencilOperationFail(operation: number): void;
  117442. /**
  117443. * Sets the stencil operation to use when depth fails
  117444. * @param operation defines the stencil operation to use when depth fails
  117445. */
  117446. setStencilOperationDepthFail(operation: number): void;
  117447. /**
  117448. * Sets the stencil operation to use when stencil passes
  117449. * @param operation defines the stencil operation to use when stencil passes
  117450. */
  117451. setStencilOperationPass(operation: number): void;
  117452. /**
  117453. * Sets a boolean indicating if the dithering state is enabled or disabled
  117454. * @param value defines the dithering state
  117455. */
  117456. setDitheringState(value: boolean): void;
  117457. /**
  117458. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  117459. * @param value defines the rasterizer state
  117460. */
  117461. setRasterizerState(value: boolean): void;
  117462. /**
  117463. * Gets the current depth function
  117464. * @returns a number defining the depth function
  117465. */
  117466. getDepthFunction(): Nullable<number>;
  117467. /**
  117468. * Sets the current depth function
  117469. * @param depthFunc defines the function to use
  117470. */
  117471. setDepthFunction(depthFunc: number): void;
  117472. /**
  117473. * Sets the current depth function to GREATER
  117474. */
  117475. setDepthFunctionToGreater(): void;
  117476. /**
  117477. * Sets the current depth function to GEQUAL
  117478. */
  117479. setDepthFunctionToGreaterOrEqual(): void;
  117480. /**
  117481. * Sets the current depth function to LESS
  117482. */
  117483. setDepthFunctionToLess(): void;
  117484. /**
  117485. * Sets the current depth function to LEQUAL
  117486. */
  117487. setDepthFunctionToLessOrEqual(): void;
  117488. private _cachedStencilBuffer;
  117489. private _cachedStencilFunction;
  117490. private _cachedStencilMask;
  117491. private _cachedStencilOperationPass;
  117492. private _cachedStencilOperationFail;
  117493. private _cachedStencilOperationDepthFail;
  117494. private _cachedStencilReference;
  117495. /**
  117496. * Caches the the state of the stencil buffer
  117497. */
  117498. cacheStencilState(): void;
  117499. /**
  117500. * Restores the state of the stencil buffer
  117501. */
  117502. restoreStencilState(): void;
  117503. /**
  117504. * Directly set the WebGL Viewport
  117505. * @param x defines the x coordinate of the viewport (in screen space)
  117506. * @param y defines the y coordinate of the viewport (in screen space)
  117507. * @param width defines the width of the viewport (in screen space)
  117508. * @param height defines the height of the viewport (in screen space)
  117509. * @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
  117510. */
  117511. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  117512. /**
  117513. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  117514. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117515. * @param y defines the y-coordinate of the corner of the clear rectangle
  117516. * @param width defines the width of the clear rectangle
  117517. * @param height defines the height of the clear rectangle
  117518. * @param clearColor defines the clear color
  117519. */
  117520. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  117521. /**
  117522. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  117523. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117524. * @param y defines the y-coordinate of the corner of the clear rectangle
  117525. * @param width defines the width of the clear rectangle
  117526. * @param height defines the height of the clear rectangle
  117527. */
  117528. enableScissor(x: number, y: number, width: number, height: number): void;
  117529. /**
  117530. * Disable previously set scissor test rectangle
  117531. */
  117532. disableScissor(): void;
  117533. protected _reportDrawCall(): void;
  117534. /**
  117535. * Initializes a webVR display and starts listening to display change events
  117536. * The onVRDisplayChangedObservable will be notified upon these changes
  117537. * @returns The onVRDisplayChangedObservable
  117538. */
  117539. initWebVR(): Observable<IDisplayChangedEventArgs>;
  117540. /** @hidden */
  117541. _prepareVRComponent(): void;
  117542. /** @hidden */
  117543. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  117544. /** @hidden */
  117545. _submitVRFrame(): void;
  117546. /**
  117547. * Call this function to leave webVR mode
  117548. * Will do nothing if webVR is not supported or if there is no webVR device
  117549. * @see https://doc.babylonjs.com/how_to/webvr_camera
  117550. */
  117551. disableVR(): void;
  117552. /**
  117553. * Gets a boolean indicating that the system is in VR mode and is presenting
  117554. * @returns true if VR mode is engaged
  117555. */
  117556. isVRPresenting(): boolean;
  117557. /** @hidden */
  117558. _requestVRFrame(): void;
  117559. /** @hidden */
  117560. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  117561. /**
  117562. * Gets the source code of the vertex shader associated with a specific webGL program
  117563. * @param program defines the program to use
  117564. * @returns a string containing the source code of the vertex shader associated with the program
  117565. */
  117566. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  117567. /**
  117568. * Gets the source code of the fragment shader associated with a specific webGL program
  117569. * @param program defines the program to use
  117570. * @returns a string containing the source code of the fragment shader associated with the program
  117571. */
  117572. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  117573. /**
  117574. * Sets a depth stencil texture from a render target to the according uniform.
  117575. * @param channel The texture channel
  117576. * @param uniform The uniform to set
  117577. * @param texture The render target texture containing the depth stencil texture to apply
  117578. */
  117579. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  117580. /**
  117581. * Sets a texture to the webGL context from a postprocess
  117582. * @param channel defines the channel to use
  117583. * @param postProcess defines the source postprocess
  117584. */
  117585. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  117586. /**
  117587. * Binds the output of the passed in post process to the texture channel specified
  117588. * @param channel The channel the texture should be bound to
  117589. * @param postProcess The post process which's output should be bound
  117590. */
  117591. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  117592. protected _rebuildBuffers(): void;
  117593. /** @hidden */
  117594. _renderFrame(): void;
  117595. _renderLoop(): void;
  117596. /** @hidden */
  117597. _renderViews(): boolean;
  117598. /**
  117599. * Toggle full screen mode
  117600. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117601. */
  117602. switchFullscreen(requestPointerLock: boolean): void;
  117603. /**
  117604. * Enters full screen mode
  117605. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117606. */
  117607. enterFullscreen(requestPointerLock: boolean): void;
  117608. /**
  117609. * Exits full screen mode
  117610. */
  117611. exitFullscreen(): void;
  117612. /**
  117613. * Enters Pointerlock mode
  117614. */
  117615. enterPointerlock(): void;
  117616. /**
  117617. * Exits Pointerlock mode
  117618. */
  117619. exitPointerlock(): void;
  117620. /**
  117621. * Begin a new frame
  117622. */
  117623. beginFrame(): void;
  117624. /**
  117625. * Enf the current frame
  117626. */
  117627. endFrame(): void;
  117628. resize(): void;
  117629. /**
  117630. * Force a specific size of the canvas
  117631. * @param width defines the new canvas' width
  117632. * @param height defines the new canvas' height
  117633. * @returns true if the size was changed
  117634. */
  117635. setSize(width: number, height: number): boolean;
  117636. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  117637. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117638. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117639. _releaseTexture(texture: InternalTexture): void;
  117640. /**
  117641. * @hidden
  117642. * Rescales a texture
  117643. * @param source input texutre
  117644. * @param destination destination texture
  117645. * @param scene scene to use to render the resize
  117646. * @param internalFormat format to use when resizing
  117647. * @param onComplete callback to be called when resize has completed
  117648. */
  117649. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  117650. /**
  117651. * Gets the current framerate
  117652. * @returns a number representing the framerate
  117653. */
  117654. getFps(): number;
  117655. /**
  117656. * Gets the time spent between current and previous frame
  117657. * @returns a number representing the delta time in ms
  117658. */
  117659. getDeltaTime(): number;
  117660. private _measureFps;
  117661. /** @hidden */
  117662. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  117663. /**
  117664. * Updates the sample count of a render target texture
  117665. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  117666. * @param texture defines the texture to update
  117667. * @param samples defines the sample count to set
  117668. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  117669. */
  117670. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  117671. /**
  117672. * Updates a depth texture Comparison Mode and Function.
  117673. * If the comparison Function is equal to 0, the mode will be set to none.
  117674. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  117675. * @param texture The texture to set the comparison function for
  117676. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  117677. */
  117678. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  117679. /**
  117680. * Creates a webGL buffer to use with instanciation
  117681. * @param capacity defines the size of the buffer
  117682. * @returns the webGL buffer
  117683. */
  117684. createInstancesBuffer(capacity: number): DataBuffer;
  117685. /**
  117686. * Delete a webGL buffer used with instanciation
  117687. * @param buffer defines the webGL buffer to delete
  117688. */
  117689. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  117690. private _clientWaitAsync;
  117691. /** @hidden */
  117692. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  117693. dispose(): void;
  117694. private _disableTouchAction;
  117695. /**
  117696. * Display the loading screen
  117697. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117698. */
  117699. displayLoadingUI(): void;
  117700. /**
  117701. * Hide the loading screen
  117702. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117703. */
  117704. hideLoadingUI(): void;
  117705. /**
  117706. * Gets the current loading screen object
  117707. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117708. */
  117709. get loadingScreen(): ILoadingScreen;
  117710. /**
  117711. * Sets the current loading screen object
  117712. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117713. */
  117714. set loadingScreen(loadingScreen: ILoadingScreen);
  117715. /**
  117716. * Sets the current loading screen text
  117717. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117718. */
  117719. set loadingUIText(text: string);
  117720. /**
  117721. * Sets the current loading screen background color
  117722. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117723. */
  117724. set loadingUIBackgroundColor(color: string);
  117725. /** Pointerlock and fullscreen */
  117726. /**
  117727. * Ask the browser to promote the current element to pointerlock mode
  117728. * @param element defines the DOM element to promote
  117729. */
  117730. static _RequestPointerlock(element: HTMLElement): void;
  117731. /**
  117732. * Asks the browser to exit pointerlock mode
  117733. */
  117734. static _ExitPointerlock(): void;
  117735. /**
  117736. * Ask the browser to promote the current element to fullscreen rendering mode
  117737. * @param element defines the DOM element to promote
  117738. */
  117739. static _RequestFullscreen(element: HTMLElement): void;
  117740. /**
  117741. * Asks the browser to exit fullscreen mode
  117742. */
  117743. static _ExitFullscreen(): void;
  117744. }
  117745. }
  117746. declare module BABYLON {
  117747. /**
  117748. * The engine store class is responsible to hold all the instances of Engine and Scene created
  117749. * during the life time of the application.
  117750. */
  117751. export class EngineStore {
  117752. /** Gets the list of created engines */
  117753. static Instances: Engine[];
  117754. /** @hidden */
  117755. static _LastCreatedScene: Nullable<Scene>;
  117756. /**
  117757. * Gets the latest created engine
  117758. */
  117759. static get LastCreatedEngine(): Nullable<Engine>;
  117760. /**
  117761. * Gets the latest created scene
  117762. */
  117763. static get LastCreatedScene(): Nullable<Scene>;
  117764. /**
  117765. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117766. * @ignorenaming
  117767. */
  117768. static UseFallbackTexture: boolean;
  117769. /**
  117770. * Texture content used if a texture cannot loaded
  117771. * @ignorenaming
  117772. */
  117773. static FallbackTexture: string;
  117774. }
  117775. }
  117776. declare module BABYLON {
  117777. /**
  117778. * Helper class that provides a small promise polyfill
  117779. */
  117780. export class PromisePolyfill {
  117781. /**
  117782. * Static function used to check if the polyfill is required
  117783. * If this is the case then the function will inject the polyfill to window.Promise
  117784. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  117785. */
  117786. static Apply(force?: boolean): void;
  117787. }
  117788. }
  117789. declare module BABYLON {
  117790. /**
  117791. * Interface for screenshot methods with describe argument called `size` as object with options
  117792. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  117793. */
  117794. export interface IScreenshotSize {
  117795. /**
  117796. * number in pixels for canvas height
  117797. */
  117798. height?: number;
  117799. /**
  117800. * multiplier allowing render at a higher or lower resolution
  117801. * If value is defined then height and width will be ignored and taken from camera
  117802. */
  117803. precision?: number;
  117804. /**
  117805. * number in pixels for canvas width
  117806. */
  117807. width?: number;
  117808. }
  117809. }
  117810. declare module BABYLON {
  117811. interface IColor4Like {
  117812. r: float;
  117813. g: float;
  117814. b: float;
  117815. a: float;
  117816. }
  117817. /**
  117818. * Class containing a set of static utilities functions
  117819. */
  117820. export class Tools {
  117821. /**
  117822. * Gets or sets the base URL to use to load assets
  117823. */
  117824. static get BaseUrl(): string;
  117825. static set BaseUrl(value: string);
  117826. /**
  117827. * Enable/Disable Custom HTTP Request Headers globally.
  117828. * default = false
  117829. * @see CustomRequestHeaders
  117830. */
  117831. static UseCustomRequestHeaders: boolean;
  117832. /**
  117833. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  117834. * i.e. when loading files, where the server/service expects an Authorization header
  117835. */
  117836. static CustomRequestHeaders: {
  117837. [key: string]: string;
  117838. };
  117839. /**
  117840. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  117841. */
  117842. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  117843. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  117844. /**
  117845. * Default behaviour for cors in the application.
  117846. * It can be a string if the expected behavior is identical in the entire app.
  117847. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  117848. */
  117849. static get CorsBehavior(): string | ((url: string | string[]) => string);
  117850. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  117851. /**
  117852. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117853. * @ignorenaming
  117854. */
  117855. static get UseFallbackTexture(): boolean;
  117856. static set UseFallbackTexture(value: boolean);
  117857. /**
  117858. * Use this object to register external classes like custom textures or material
  117859. * to allow the laoders to instantiate them
  117860. */
  117861. static get RegisteredExternalClasses(): {
  117862. [key: string]: Object;
  117863. };
  117864. static set RegisteredExternalClasses(classes: {
  117865. [key: string]: Object;
  117866. });
  117867. /**
  117868. * Texture content used if a texture cannot loaded
  117869. * @ignorenaming
  117870. */
  117871. static get fallbackTexture(): string;
  117872. static set fallbackTexture(value: string);
  117873. /**
  117874. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  117875. * @param u defines the coordinate on X axis
  117876. * @param v defines the coordinate on Y axis
  117877. * @param width defines the width of the source data
  117878. * @param height defines the height of the source data
  117879. * @param pixels defines the source byte array
  117880. * @param color defines the output color
  117881. */
  117882. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  117883. /**
  117884. * Interpolates between a and b via alpha
  117885. * @param a The lower value (returned when alpha = 0)
  117886. * @param b The upper value (returned when alpha = 1)
  117887. * @param alpha The interpolation-factor
  117888. * @return The mixed value
  117889. */
  117890. static Mix(a: number, b: number, alpha: number): number;
  117891. /**
  117892. * Tries to instantiate a new object from a given class name
  117893. * @param className defines the class name to instantiate
  117894. * @returns the new object or null if the system was not able to do the instantiation
  117895. */
  117896. static Instantiate(className: string): any;
  117897. /**
  117898. * Provides a slice function that will work even on IE
  117899. * @param data defines the array to slice
  117900. * @param start defines the start of the data (optional)
  117901. * @param end defines the end of the data (optional)
  117902. * @returns the new sliced array
  117903. */
  117904. static Slice<T>(data: T, start?: number, end?: number): T;
  117905. /**
  117906. * Polyfill for setImmediate
  117907. * @param action defines the action to execute after the current execution block
  117908. */
  117909. static SetImmediate(action: () => void): void;
  117910. /**
  117911. * Function indicating if a number is an exponent of 2
  117912. * @param value defines the value to test
  117913. * @returns true if the value is an exponent of 2
  117914. */
  117915. static IsExponentOfTwo(value: number): boolean;
  117916. private static _tmpFloatArray;
  117917. /**
  117918. * Returns the nearest 32-bit single precision float representation of a Number
  117919. * @param value A Number. If the parameter is of a different type, it will get converted
  117920. * to a number or to NaN if it cannot be converted
  117921. * @returns number
  117922. */
  117923. static FloatRound(value: number): number;
  117924. /**
  117925. * Extracts the filename from a path
  117926. * @param path defines the path to use
  117927. * @returns the filename
  117928. */
  117929. static GetFilename(path: string): string;
  117930. /**
  117931. * Extracts the "folder" part of a path (everything before the filename).
  117932. * @param uri The URI to extract the info from
  117933. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  117934. * @returns The "folder" part of the path
  117935. */
  117936. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  117937. /**
  117938. * Extracts text content from a DOM element hierarchy
  117939. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  117940. */
  117941. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  117942. /**
  117943. * Convert an angle in radians to degrees
  117944. * @param angle defines the angle to convert
  117945. * @returns the angle in degrees
  117946. */
  117947. static ToDegrees(angle: number): number;
  117948. /**
  117949. * Convert an angle in degrees to radians
  117950. * @param angle defines the angle to convert
  117951. * @returns the angle in radians
  117952. */
  117953. static ToRadians(angle: number): number;
  117954. /**
  117955. * Returns an array if obj is not an array
  117956. * @param obj defines the object to evaluate as an array
  117957. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  117958. * @returns either obj directly if obj is an array or a new array containing obj
  117959. */
  117960. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  117961. /**
  117962. * Gets the pointer prefix to use
  117963. * @param engine defines the engine we are finding the prefix for
  117964. * @returns "pointer" if touch is enabled. Else returns "mouse"
  117965. */
  117966. static GetPointerPrefix(engine: Engine): string;
  117967. /**
  117968. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  117969. * @param url define the url we are trying
  117970. * @param element define the dom element where to configure the cors policy
  117971. */
  117972. static SetCorsBehavior(url: string | string[], element: {
  117973. crossOrigin: string | null;
  117974. }): void;
  117975. /**
  117976. * Removes unwanted characters from an url
  117977. * @param url defines the url to clean
  117978. * @returns the cleaned url
  117979. */
  117980. static CleanUrl(url: string): string;
  117981. /**
  117982. * Gets or sets a function used to pre-process url before using them to load assets
  117983. */
  117984. static get PreprocessUrl(): (url: string) => string;
  117985. static set PreprocessUrl(processor: (url: string) => string);
  117986. /**
  117987. * Loads an image as an HTMLImageElement.
  117988. * @param input url string, ArrayBuffer, or Blob to load
  117989. * @param onLoad callback called when the image successfully loads
  117990. * @param onError callback called when the image fails to load
  117991. * @param offlineProvider offline provider for caching
  117992. * @param mimeType optional mime type
  117993. * @returns the HTMLImageElement of the loaded image
  117994. */
  117995. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  117996. /**
  117997. * Loads a file from a url
  117998. * @param url url string, ArrayBuffer, or Blob to load
  117999. * @param onSuccess callback called when the file successfully loads
  118000. * @param onProgress callback called while file is loading (if the server supports this mode)
  118001. * @param offlineProvider defines the offline provider for caching
  118002. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118003. * @param onError callback called when the file fails to load
  118004. * @returns a file request object
  118005. */
  118006. 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;
  118007. /**
  118008. * Loads a file from a url
  118009. * @param url the file url to load
  118010. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118011. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  118012. */
  118013. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  118014. /**
  118015. * Load a script (identified by an url). When the url returns, the
  118016. * content of this file is added into a new script element, attached to the DOM (body element)
  118017. * @param scriptUrl defines the url of the script to laod
  118018. * @param onSuccess defines the callback called when the script is loaded
  118019. * @param onError defines the callback to call if an error occurs
  118020. * @param scriptId defines the id of the script element
  118021. */
  118022. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  118023. /**
  118024. * Load an asynchronous script (identified by an url). When the url returns, the
  118025. * content of this file is added into a new script element, attached to the DOM (body element)
  118026. * @param scriptUrl defines the url of the script to laod
  118027. * @param scriptId defines the id of the script element
  118028. * @returns a promise request object
  118029. */
  118030. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  118031. /**
  118032. * Loads a file from a blob
  118033. * @param fileToLoad defines the blob to use
  118034. * @param callback defines the callback to call when data is loaded
  118035. * @param progressCallback defines the callback to call during loading process
  118036. * @returns a file request object
  118037. */
  118038. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  118039. /**
  118040. * Reads a file from a File object
  118041. * @param file defines the file to load
  118042. * @param onSuccess defines the callback to call when data is loaded
  118043. * @param onProgress defines the callback to call during loading process
  118044. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  118045. * @param onError defines the callback to call when an error occurs
  118046. * @returns a file request object
  118047. */
  118048. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118049. /**
  118050. * Creates a data url from a given string content
  118051. * @param content defines the content to convert
  118052. * @returns the new data url link
  118053. */
  118054. static FileAsURL(content: string): string;
  118055. /**
  118056. * Format the given number to a specific decimal format
  118057. * @param value defines the number to format
  118058. * @param decimals defines the number of decimals to use
  118059. * @returns the formatted string
  118060. */
  118061. static Format(value: number, decimals?: number): string;
  118062. /**
  118063. * Tries to copy an object by duplicating every property
  118064. * @param source defines the source object
  118065. * @param destination defines the target object
  118066. * @param doNotCopyList defines a list of properties to avoid
  118067. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  118068. */
  118069. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  118070. /**
  118071. * Gets a boolean indicating if the given object has no own property
  118072. * @param obj defines the object to test
  118073. * @returns true if object has no own property
  118074. */
  118075. static IsEmpty(obj: any): boolean;
  118076. /**
  118077. * Function used to register events at window level
  118078. * @param windowElement defines the Window object to use
  118079. * @param events defines the events to register
  118080. */
  118081. static RegisterTopRootEvents(windowElement: Window, events: {
  118082. name: string;
  118083. handler: Nullable<(e: FocusEvent) => any>;
  118084. }[]): void;
  118085. /**
  118086. * Function used to unregister events from window level
  118087. * @param windowElement defines the Window object to use
  118088. * @param events defines the events to unregister
  118089. */
  118090. static UnregisterTopRootEvents(windowElement: Window, events: {
  118091. name: string;
  118092. handler: Nullable<(e: FocusEvent) => any>;
  118093. }[]): void;
  118094. /**
  118095. * @ignore
  118096. */
  118097. static _ScreenshotCanvas: HTMLCanvasElement;
  118098. /**
  118099. * Dumps the current bound framebuffer
  118100. * @param width defines the rendering width
  118101. * @param height defines the rendering height
  118102. * @param engine defines the hosting engine
  118103. * @param successCallback defines the callback triggered once the data are available
  118104. * @param mimeType defines the mime type of the result
  118105. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  118106. */
  118107. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118108. /**
  118109. * Converts the canvas data to blob.
  118110. * This acts as a polyfill for browsers not supporting the to blob function.
  118111. * @param canvas Defines the canvas to extract the data from
  118112. * @param successCallback Defines the callback triggered once the data are available
  118113. * @param mimeType Defines the mime type of the result
  118114. */
  118115. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  118116. /**
  118117. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  118118. * @param successCallback defines the callback triggered once the data are available
  118119. * @param mimeType defines the mime type of the result
  118120. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  118121. */
  118122. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118123. /**
  118124. * Downloads a blob in the browser
  118125. * @param blob defines the blob to download
  118126. * @param fileName defines the name of the downloaded file
  118127. */
  118128. static Download(blob: Blob, fileName: string): void;
  118129. /**
  118130. * Captures a screenshot of the current rendering
  118131. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118132. * @param engine defines the rendering engine
  118133. * @param camera defines the source camera
  118134. * @param size This parameter can be set to a single number or to an object with the
  118135. * following (optional) properties: precision, width, height. If a single number is passed,
  118136. * it will be used for both width and height. If an object is passed, the screenshot size
  118137. * will be derived from the parameters. The precision property is a multiplier allowing
  118138. * rendering at a higher or lower resolution
  118139. * @param successCallback defines the callback receives a single parameter which contains the
  118140. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118141. * src parameter of an <img> to display it
  118142. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118143. * Check your browser for supported MIME types
  118144. */
  118145. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  118146. /**
  118147. * Captures a screenshot of the current rendering
  118148. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118149. * @param engine defines the rendering engine
  118150. * @param camera defines the source camera
  118151. * @param size This parameter can be set to a single number or to an object with the
  118152. * following (optional) properties: precision, width, height. If a single number is passed,
  118153. * it will be used for both width and height. If an object is passed, the screenshot size
  118154. * will be derived from the parameters. The precision property is a multiplier allowing
  118155. * rendering at a higher or lower resolution
  118156. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118157. * Check your browser for supported MIME types
  118158. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118159. * to the src parameter of an <img> to display it
  118160. */
  118161. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  118162. /**
  118163. * Generates an image screenshot from the specified camera.
  118164. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118165. * @param engine The engine to use for rendering
  118166. * @param camera The camera to use for rendering
  118167. * @param size This parameter can be set to a single number or to an object with the
  118168. * following (optional) properties: precision, width, height. If a single number is passed,
  118169. * it will be used for both width and height. If an object is passed, the screenshot size
  118170. * will be derived from the parameters. The precision property is a multiplier allowing
  118171. * rendering at a higher or lower resolution
  118172. * @param successCallback The callback receives a single parameter which contains the
  118173. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118174. * src parameter of an <img> to display it
  118175. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118176. * Check your browser for supported MIME types
  118177. * @param samples Texture samples (default: 1)
  118178. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118179. * @param fileName A name for for the downloaded file.
  118180. */
  118181. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  118182. /**
  118183. * Generates an image screenshot from the specified camera.
  118184. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118185. * @param engine The engine to use for rendering
  118186. * @param camera The camera to use for rendering
  118187. * @param size This parameter can be set to a single number or to an object with the
  118188. * following (optional) properties: precision, width, height. If a single number is passed,
  118189. * it will be used for both width and height. If an object is passed, the screenshot size
  118190. * will be derived from the parameters. The precision property is a multiplier allowing
  118191. * rendering at a higher or lower resolution
  118192. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118193. * Check your browser for supported MIME types
  118194. * @param samples Texture samples (default: 1)
  118195. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118196. * @param fileName A name for for the downloaded file.
  118197. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118198. * to the src parameter of an <img> to display it
  118199. */
  118200. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  118201. /**
  118202. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  118203. * Be aware Math.random() could cause collisions, but:
  118204. * "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"
  118205. * @returns a pseudo random id
  118206. */
  118207. static RandomId(): string;
  118208. /**
  118209. * Test if the given uri is a base64 string
  118210. * @param uri The uri to test
  118211. * @return True if the uri is a base64 string or false otherwise
  118212. */
  118213. static IsBase64(uri: string): boolean;
  118214. /**
  118215. * Decode the given base64 uri.
  118216. * @param uri The uri to decode
  118217. * @return The decoded base64 data.
  118218. */
  118219. static DecodeBase64(uri: string): ArrayBuffer;
  118220. /**
  118221. * Gets the absolute url.
  118222. * @param url the input url
  118223. * @return the absolute url
  118224. */
  118225. static GetAbsoluteUrl(url: string): string;
  118226. /**
  118227. * No log
  118228. */
  118229. static readonly NoneLogLevel: number;
  118230. /**
  118231. * Only message logs
  118232. */
  118233. static readonly MessageLogLevel: number;
  118234. /**
  118235. * Only warning logs
  118236. */
  118237. static readonly WarningLogLevel: number;
  118238. /**
  118239. * Only error logs
  118240. */
  118241. static readonly ErrorLogLevel: number;
  118242. /**
  118243. * All logs
  118244. */
  118245. static readonly AllLogLevel: number;
  118246. /**
  118247. * Gets a value indicating the number of loading errors
  118248. * @ignorenaming
  118249. */
  118250. static get errorsCount(): number;
  118251. /**
  118252. * Callback called when a new log is added
  118253. */
  118254. static OnNewCacheEntry: (entry: string) => void;
  118255. /**
  118256. * Log a message to the console
  118257. * @param message defines the message to log
  118258. */
  118259. static Log(message: string): void;
  118260. /**
  118261. * Write a warning message to the console
  118262. * @param message defines the message to log
  118263. */
  118264. static Warn(message: string): void;
  118265. /**
  118266. * Write an error message to the console
  118267. * @param message defines the message to log
  118268. */
  118269. static Error(message: string): void;
  118270. /**
  118271. * Gets current log cache (list of logs)
  118272. */
  118273. static get LogCache(): string;
  118274. /**
  118275. * Clears the log cache
  118276. */
  118277. static ClearLogCache(): void;
  118278. /**
  118279. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  118280. */
  118281. static set LogLevels(level: number);
  118282. /**
  118283. * Checks if the window object exists
  118284. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  118285. */
  118286. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  118287. /**
  118288. * No performance log
  118289. */
  118290. static readonly PerformanceNoneLogLevel: number;
  118291. /**
  118292. * Use user marks to log performance
  118293. */
  118294. static readonly PerformanceUserMarkLogLevel: number;
  118295. /**
  118296. * Log performance to the console
  118297. */
  118298. static readonly PerformanceConsoleLogLevel: number;
  118299. private static _performance;
  118300. /**
  118301. * Sets the current performance log level
  118302. */
  118303. static set PerformanceLogLevel(level: number);
  118304. private static _StartPerformanceCounterDisabled;
  118305. private static _EndPerformanceCounterDisabled;
  118306. private static _StartUserMark;
  118307. private static _EndUserMark;
  118308. private static _StartPerformanceConsole;
  118309. private static _EndPerformanceConsole;
  118310. /**
  118311. * Starts a performance counter
  118312. */
  118313. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118314. /**
  118315. * Ends a specific performance coutner
  118316. */
  118317. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118318. /**
  118319. * Gets either window.performance.now() if supported or Date.now() else
  118320. */
  118321. static get Now(): number;
  118322. /**
  118323. * This method will return the name of the class used to create the instance of the given object.
  118324. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  118325. * @param object the object to get the class name from
  118326. * @param isType defines if the object is actually a type
  118327. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  118328. */
  118329. static GetClassName(object: any, isType?: boolean): string;
  118330. /**
  118331. * Gets the first element of an array satisfying a given predicate
  118332. * @param array defines the array to browse
  118333. * @param predicate defines the predicate to use
  118334. * @returns null if not found or the element
  118335. */
  118336. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  118337. /**
  118338. * This method will return the name of the full name of the class, including its owning module (if any).
  118339. * 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).
  118340. * @param object the object to get the class name from
  118341. * @param isType defines if the object is actually a type
  118342. * @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.
  118343. * @ignorenaming
  118344. */
  118345. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  118346. /**
  118347. * Returns a promise that resolves after the given amount of time.
  118348. * @param delay Number of milliseconds to delay
  118349. * @returns Promise that resolves after the given amount of time
  118350. */
  118351. static DelayAsync(delay: number): Promise<void>;
  118352. /**
  118353. * Utility function to detect if the current user agent is Safari
  118354. * @returns whether or not the current user agent is safari
  118355. */
  118356. static IsSafari(): boolean;
  118357. }
  118358. /**
  118359. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  118360. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  118361. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  118362. * @param name The name of the class, case should be preserved
  118363. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  118364. */
  118365. export function className(name: string, module?: string): (target: Object) => void;
  118366. /**
  118367. * An implementation of a loop for asynchronous functions.
  118368. */
  118369. export class AsyncLoop {
  118370. /**
  118371. * Defines the number of iterations for the loop
  118372. */
  118373. iterations: number;
  118374. /**
  118375. * Defines the current index of the loop.
  118376. */
  118377. index: number;
  118378. private _done;
  118379. private _fn;
  118380. private _successCallback;
  118381. /**
  118382. * Constructor.
  118383. * @param iterations the number of iterations.
  118384. * @param func the function to run each iteration
  118385. * @param successCallback the callback that will be called upon succesful execution
  118386. * @param offset starting offset.
  118387. */
  118388. constructor(
  118389. /**
  118390. * Defines the number of iterations for the loop
  118391. */
  118392. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  118393. /**
  118394. * Execute the next iteration. Must be called after the last iteration was finished.
  118395. */
  118396. executeNext(): void;
  118397. /**
  118398. * Break the loop and run the success callback.
  118399. */
  118400. breakLoop(): void;
  118401. /**
  118402. * Create and run an async loop.
  118403. * @param iterations the number of iterations.
  118404. * @param fn the function to run each iteration
  118405. * @param successCallback the callback that will be called upon succesful execution
  118406. * @param offset starting offset.
  118407. * @returns the created async loop object
  118408. */
  118409. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  118410. /**
  118411. * A for-loop that will run a given number of iterations synchronous and the rest async.
  118412. * @param iterations total number of iterations
  118413. * @param syncedIterations number of synchronous iterations in each async iteration.
  118414. * @param fn the function to call each iteration.
  118415. * @param callback a success call back that will be called when iterating stops.
  118416. * @param breakFunction a break condition (optional)
  118417. * @param timeout timeout settings for the setTimeout function. default - 0.
  118418. * @returns the created async loop object
  118419. */
  118420. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  118421. }
  118422. }
  118423. declare module BABYLON {
  118424. /**
  118425. * This class implement a typical dictionary using a string as key and the generic type T as value.
  118426. * The underlying implementation relies on an associative array to ensure the best performances.
  118427. * The value can be anything including 'null' but except 'undefined'
  118428. */
  118429. export class StringDictionary<T> {
  118430. /**
  118431. * This will clear this dictionary and copy the content from the 'source' one.
  118432. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  118433. * @param source the dictionary to take the content from and copy to this dictionary
  118434. */
  118435. copyFrom(source: StringDictionary<T>): void;
  118436. /**
  118437. * Get a value based from its key
  118438. * @param key the given key to get the matching value from
  118439. * @return the value if found, otherwise undefined is returned
  118440. */
  118441. get(key: string): T | undefined;
  118442. /**
  118443. * Get a value from its key or add it if it doesn't exist.
  118444. * This method will ensure you that a given key/data will be present in the dictionary.
  118445. * @param key the given key to get the matching value from
  118446. * @param factory the factory that will create the value if the key is not present in the dictionary.
  118447. * The factory will only be invoked if there's no data for the given key.
  118448. * @return the value corresponding to the key.
  118449. */
  118450. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  118451. /**
  118452. * Get a value from its key if present in the dictionary otherwise add it
  118453. * @param key the key to get the value from
  118454. * @param val if there's no such key/value pair in the dictionary add it with this value
  118455. * @return the value corresponding to the key
  118456. */
  118457. getOrAdd(key: string, val: T): T;
  118458. /**
  118459. * Check if there's a given key in the dictionary
  118460. * @param key the key to check for
  118461. * @return true if the key is present, false otherwise
  118462. */
  118463. contains(key: string): boolean;
  118464. /**
  118465. * Add a new key and its corresponding value
  118466. * @param key the key to add
  118467. * @param value the value corresponding to the key
  118468. * @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
  118469. */
  118470. add(key: string, value: T): boolean;
  118471. /**
  118472. * Update a specific value associated to a key
  118473. * @param key defines the key to use
  118474. * @param value defines the value to store
  118475. * @returns true if the value was updated (or false if the key was not found)
  118476. */
  118477. set(key: string, value: T): boolean;
  118478. /**
  118479. * Get the element of the given key and remove it from the dictionary
  118480. * @param key defines the key to search
  118481. * @returns the value associated with the key or null if not found
  118482. */
  118483. getAndRemove(key: string): Nullable<T>;
  118484. /**
  118485. * Remove a key/value from the dictionary.
  118486. * @param key the key to remove
  118487. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  118488. */
  118489. remove(key: string): boolean;
  118490. /**
  118491. * Clear the whole content of the dictionary
  118492. */
  118493. clear(): void;
  118494. /**
  118495. * Gets the current count
  118496. */
  118497. get count(): number;
  118498. /**
  118499. * Execute a callback on each key/val of the dictionary.
  118500. * Note that you can remove any element in this dictionary in the callback implementation
  118501. * @param callback the callback to execute on a given key/value pair
  118502. */
  118503. forEach(callback: (key: string, val: T) => void): void;
  118504. /**
  118505. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  118506. * If the callback returns null or undefined the method will iterate to the next key/value pair
  118507. * Note that you can remove any element in this dictionary in the callback implementation
  118508. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  118509. * @returns the first item
  118510. */
  118511. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  118512. private _count;
  118513. private _data;
  118514. }
  118515. }
  118516. declare module BABYLON {
  118517. /** @hidden */
  118518. export interface ICollisionCoordinator {
  118519. createCollider(): Collider;
  118520. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118521. init(scene: Scene): void;
  118522. }
  118523. /** @hidden */
  118524. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  118525. private _scene;
  118526. private _scaledPosition;
  118527. private _scaledVelocity;
  118528. private _finalPosition;
  118529. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118530. createCollider(): Collider;
  118531. init(scene: Scene): void;
  118532. private _collideWithWorld;
  118533. }
  118534. }
  118535. declare module BABYLON {
  118536. /**
  118537. * Class used to manage all inputs for the scene.
  118538. */
  118539. export class InputManager {
  118540. /** The distance in pixel that you have to move to prevent some events */
  118541. static DragMovementThreshold: number;
  118542. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  118543. static LongPressDelay: number;
  118544. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  118545. static DoubleClickDelay: number;
  118546. /** If you need to check double click without raising a single click at first click, enable this flag */
  118547. static ExclusiveDoubleClickMode: boolean;
  118548. /** 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. */
  118549. private _alreadyAttached;
  118550. private _wheelEventName;
  118551. private _onPointerMove;
  118552. private _onPointerDown;
  118553. private _onPointerUp;
  118554. private _initClickEvent;
  118555. private _initActionManager;
  118556. private _delayedSimpleClick;
  118557. private _delayedSimpleClickTimeout;
  118558. private _previousDelayedSimpleClickTimeout;
  118559. private _meshPickProceed;
  118560. private _previousButtonPressed;
  118561. private _currentPickResult;
  118562. private _previousPickResult;
  118563. private _totalPointersPressed;
  118564. private _doubleClickOccured;
  118565. private _pointerOverMesh;
  118566. private _pickedDownMesh;
  118567. private _pickedUpMesh;
  118568. private _pointerX;
  118569. private _pointerY;
  118570. private _unTranslatedPointerX;
  118571. private _unTranslatedPointerY;
  118572. private _startingPointerPosition;
  118573. private _previousStartingPointerPosition;
  118574. private _startingPointerTime;
  118575. private _previousStartingPointerTime;
  118576. private _pointerCaptures;
  118577. private _onKeyDown;
  118578. private _onKeyUp;
  118579. private _onCanvasFocusObserver;
  118580. private _onCanvasBlurObserver;
  118581. private _scene;
  118582. /**
  118583. * Creates a new InputManager
  118584. * @param scene defines the hosting scene
  118585. */
  118586. constructor(scene: Scene);
  118587. /**
  118588. * Gets the mesh that is currently under the pointer
  118589. */
  118590. get meshUnderPointer(): Nullable<AbstractMesh>;
  118591. /**
  118592. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  118593. */
  118594. get unTranslatedPointer(): Vector2;
  118595. /**
  118596. * Gets or sets the current on-screen X position of the pointer
  118597. */
  118598. get pointerX(): number;
  118599. set pointerX(value: number);
  118600. /**
  118601. * Gets or sets the current on-screen Y position of the pointer
  118602. */
  118603. get pointerY(): number;
  118604. set pointerY(value: number);
  118605. private _updatePointerPosition;
  118606. private _processPointerMove;
  118607. private _setRayOnPointerInfo;
  118608. private _checkPrePointerObservable;
  118609. /**
  118610. * Use this method to simulate a pointer move on a mesh
  118611. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118612. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118613. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118614. */
  118615. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118616. /**
  118617. * Use this method to simulate a pointer down on a mesh
  118618. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118619. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118620. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118621. */
  118622. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118623. private _processPointerDown;
  118624. /** @hidden */
  118625. _isPointerSwiping(): boolean;
  118626. /**
  118627. * Use this method to simulate a pointer up on a mesh
  118628. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118629. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118630. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118631. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118632. */
  118633. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  118634. private _processPointerUp;
  118635. /**
  118636. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118637. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118638. * @returns true if the pointer was captured
  118639. */
  118640. isPointerCaptured(pointerId?: number): boolean;
  118641. /**
  118642. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118643. * @param attachUp defines if you want to attach events to pointerup
  118644. * @param attachDown defines if you want to attach events to pointerdown
  118645. * @param attachMove defines if you want to attach events to pointermove
  118646. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  118647. */
  118648. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  118649. /**
  118650. * Detaches all event handlers
  118651. */
  118652. detachControl(): void;
  118653. /**
  118654. * Force the value of meshUnderPointer
  118655. * @param mesh defines the mesh to use
  118656. */
  118657. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  118658. /**
  118659. * Gets the mesh under the pointer
  118660. * @returns a Mesh or null if no mesh is under the pointer
  118661. */
  118662. getPointerOverMesh(): Nullable<AbstractMesh>;
  118663. }
  118664. }
  118665. declare module BABYLON {
  118666. /**
  118667. * This class defines the direct association between an animation and a target
  118668. */
  118669. export class TargetedAnimation {
  118670. /**
  118671. * Animation to perform
  118672. */
  118673. animation: Animation;
  118674. /**
  118675. * Target to animate
  118676. */
  118677. target: any;
  118678. /**
  118679. * Returns the string "TargetedAnimation"
  118680. * @returns "TargetedAnimation"
  118681. */
  118682. getClassName(): string;
  118683. /**
  118684. * Serialize the object
  118685. * @returns the JSON object representing the current entity
  118686. */
  118687. serialize(): any;
  118688. }
  118689. /**
  118690. * Use this class to create coordinated animations on multiple targets
  118691. */
  118692. export class AnimationGroup implements IDisposable {
  118693. /** The name of the animation group */
  118694. name: string;
  118695. private _scene;
  118696. private _targetedAnimations;
  118697. private _animatables;
  118698. private _from;
  118699. private _to;
  118700. private _isStarted;
  118701. private _isPaused;
  118702. private _speedRatio;
  118703. private _loopAnimation;
  118704. private _isAdditive;
  118705. /**
  118706. * Gets or sets the unique id of the node
  118707. */
  118708. uniqueId: number;
  118709. /**
  118710. * This observable will notify when one animation have ended
  118711. */
  118712. onAnimationEndObservable: Observable<TargetedAnimation>;
  118713. /**
  118714. * Observer raised when one animation loops
  118715. */
  118716. onAnimationLoopObservable: Observable<TargetedAnimation>;
  118717. /**
  118718. * Observer raised when all animations have looped
  118719. */
  118720. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  118721. /**
  118722. * This observable will notify when all animations have ended.
  118723. */
  118724. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  118725. /**
  118726. * This observable will notify when all animations have paused.
  118727. */
  118728. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  118729. /**
  118730. * This observable will notify when all animations are playing.
  118731. */
  118732. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  118733. /**
  118734. * Gets the first frame
  118735. */
  118736. get from(): number;
  118737. /**
  118738. * Gets the last frame
  118739. */
  118740. get to(): number;
  118741. /**
  118742. * Define if the animations are started
  118743. */
  118744. get isStarted(): boolean;
  118745. /**
  118746. * Gets a value indicating that the current group is playing
  118747. */
  118748. get isPlaying(): boolean;
  118749. /**
  118750. * Gets or sets the speed ratio to use for all animations
  118751. */
  118752. get speedRatio(): number;
  118753. /**
  118754. * Gets or sets the speed ratio to use for all animations
  118755. */
  118756. set speedRatio(value: number);
  118757. /**
  118758. * Gets or sets if all animations should loop or not
  118759. */
  118760. get loopAnimation(): boolean;
  118761. set loopAnimation(value: boolean);
  118762. /**
  118763. * Gets or sets if all animations should be evaluated additively
  118764. */
  118765. get isAdditive(): boolean;
  118766. set isAdditive(value: boolean);
  118767. /**
  118768. * Gets the targeted animations for this animation group
  118769. */
  118770. get targetedAnimations(): Array<TargetedAnimation>;
  118771. /**
  118772. * returning the list of animatables controlled by this animation group.
  118773. */
  118774. get animatables(): Array<Animatable>;
  118775. /**
  118776. * Gets the list of target animations
  118777. */
  118778. get children(): TargetedAnimation[];
  118779. /**
  118780. * Instantiates a new Animation Group.
  118781. * This helps managing several animations at once.
  118782. * @see https://doc.babylonjs.com/how_to/group
  118783. * @param name Defines the name of the group
  118784. * @param scene Defines the scene the group belongs to
  118785. */
  118786. constructor(
  118787. /** The name of the animation group */
  118788. name: string, scene?: Nullable<Scene>);
  118789. /**
  118790. * Add an animation (with its target) in the group
  118791. * @param animation defines the animation we want to add
  118792. * @param target defines the target of the animation
  118793. * @returns the TargetedAnimation object
  118794. */
  118795. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  118796. /**
  118797. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  118798. * It can add constant keys at begin or end
  118799. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  118800. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  118801. * @returns the animation group
  118802. */
  118803. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  118804. private _animationLoopCount;
  118805. private _animationLoopFlags;
  118806. private _processLoop;
  118807. /**
  118808. * Start all animations on given targets
  118809. * @param loop defines if animations must loop
  118810. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  118811. * @param from defines the from key (optional)
  118812. * @param to defines the to key (optional)
  118813. * @param isAdditive defines the additive state for the resulting animatables (optional)
  118814. * @returns the current animation group
  118815. */
  118816. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  118817. /**
  118818. * Pause all animations
  118819. * @returns the animation group
  118820. */
  118821. pause(): AnimationGroup;
  118822. /**
  118823. * Play all animations to initial state
  118824. * This function will start() the animations if they were not started or will restart() them if they were paused
  118825. * @param loop defines if animations must loop
  118826. * @returns the animation group
  118827. */
  118828. play(loop?: boolean): AnimationGroup;
  118829. /**
  118830. * Reset all animations to initial state
  118831. * @returns the animation group
  118832. */
  118833. reset(): AnimationGroup;
  118834. /**
  118835. * Restart animations from key 0
  118836. * @returns the animation group
  118837. */
  118838. restart(): AnimationGroup;
  118839. /**
  118840. * Stop all animations
  118841. * @returns the animation group
  118842. */
  118843. stop(): AnimationGroup;
  118844. /**
  118845. * Set animation weight for all animatables
  118846. * @param weight defines the weight to use
  118847. * @return the animationGroup
  118848. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118849. */
  118850. setWeightForAllAnimatables(weight: number): AnimationGroup;
  118851. /**
  118852. * Synchronize and normalize all animatables with a source animatable
  118853. * @param root defines the root animatable to synchronize with
  118854. * @return the animationGroup
  118855. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118856. */
  118857. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  118858. /**
  118859. * Goes to a specific frame in this animation group
  118860. * @param frame the frame number to go to
  118861. * @return the animationGroup
  118862. */
  118863. goToFrame(frame: number): AnimationGroup;
  118864. /**
  118865. * Dispose all associated resources
  118866. */
  118867. dispose(): void;
  118868. private _checkAnimationGroupEnded;
  118869. /**
  118870. * Clone the current animation group and returns a copy
  118871. * @param newName defines the name of the new group
  118872. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  118873. * @returns the new aniamtion group
  118874. */
  118875. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  118876. /**
  118877. * Serializes the animationGroup to an object
  118878. * @returns Serialized object
  118879. */
  118880. serialize(): any;
  118881. /**
  118882. * Returns a new AnimationGroup object parsed from the source provided.
  118883. * @param parsedAnimationGroup defines the source
  118884. * @param scene defines the scene that will receive the animationGroup
  118885. * @returns a new AnimationGroup
  118886. */
  118887. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  118888. /**
  118889. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  118890. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  118891. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  118892. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  118893. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  118894. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  118895. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  118896. */
  118897. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  118898. /**
  118899. * Returns the string "AnimationGroup"
  118900. * @returns "AnimationGroup"
  118901. */
  118902. getClassName(): string;
  118903. /**
  118904. * Creates a detailled string about the object
  118905. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  118906. * @returns a string representing the object
  118907. */
  118908. toString(fullDetails?: boolean): string;
  118909. }
  118910. }
  118911. declare module BABYLON {
  118912. /**
  118913. * Define an interface for all classes that will hold resources
  118914. */
  118915. export interface IDisposable {
  118916. /**
  118917. * Releases all held resources
  118918. */
  118919. dispose(): void;
  118920. }
  118921. /** Interface defining initialization parameters for Scene class */
  118922. export interface SceneOptions {
  118923. /**
  118924. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  118925. * It will improve performance when the number of geometries becomes important.
  118926. */
  118927. useGeometryUniqueIdsMap?: boolean;
  118928. /**
  118929. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  118930. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118931. */
  118932. useMaterialMeshMap?: boolean;
  118933. /**
  118934. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  118935. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118936. */
  118937. useClonedMeshMap?: boolean;
  118938. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  118939. virtual?: boolean;
  118940. }
  118941. /**
  118942. * Represents a scene to be rendered by the engine.
  118943. * @see https://doc.babylonjs.com/features/scene
  118944. */
  118945. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  118946. /** The fog is deactivated */
  118947. static readonly FOGMODE_NONE: number;
  118948. /** The fog density is following an exponential function */
  118949. static readonly FOGMODE_EXP: number;
  118950. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  118951. static readonly FOGMODE_EXP2: number;
  118952. /** The fog density is following a linear function. */
  118953. static readonly FOGMODE_LINEAR: number;
  118954. /**
  118955. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  118956. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118957. */
  118958. static MinDeltaTime: number;
  118959. /**
  118960. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  118961. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118962. */
  118963. static MaxDeltaTime: number;
  118964. /**
  118965. * Factory used to create the default material.
  118966. * @param name The name of the material to create
  118967. * @param scene The scene to create the material for
  118968. * @returns The default material
  118969. */
  118970. static DefaultMaterialFactory(scene: Scene): Material;
  118971. /**
  118972. * Factory used to create the a collision coordinator.
  118973. * @returns The collision coordinator
  118974. */
  118975. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  118976. /** @hidden */
  118977. _inputManager: InputManager;
  118978. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  118979. cameraToUseForPointers: Nullable<Camera>;
  118980. /** @hidden */
  118981. readonly _isScene: boolean;
  118982. /** @hidden */
  118983. _blockEntityCollection: boolean;
  118984. /**
  118985. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  118986. */
  118987. autoClear: boolean;
  118988. /**
  118989. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  118990. */
  118991. autoClearDepthAndStencil: boolean;
  118992. /**
  118993. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  118994. */
  118995. clearColor: Color4;
  118996. /**
  118997. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  118998. */
  118999. ambientColor: Color3;
  119000. /**
  119001. * This is use to store the default BRDF lookup for PBR materials in your scene.
  119002. * It should only be one of the following (if not the default embedded one):
  119003. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  119004. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  119005. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  119006. * The material properties need to be setup according to the type of texture in use.
  119007. */
  119008. environmentBRDFTexture: BaseTexture;
  119009. /**
  119010. * Texture used in all pbr material as the reflection texture.
  119011. * As in the majority of the scene they are the same (exception for multi room and so on),
  119012. * this is easier to reference from here than from all the materials.
  119013. */
  119014. get environmentTexture(): Nullable<BaseTexture>;
  119015. /**
  119016. * Texture used in all pbr material as the reflection texture.
  119017. * As in the majority of the scene they are the same (exception for multi room and so on),
  119018. * this is easier to set here than in all the materials.
  119019. */
  119020. set environmentTexture(value: Nullable<BaseTexture>);
  119021. /** @hidden */
  119022. protected _environmentIntensity: number;
  119023. /**
  119024. * Intensity of the environment in all pbr material.
  119025. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119026. * As in the majority of the scene they are the same (exception for multi room and so on),
  119027. * this is easier to reference from here than from all the materials.
  119028. */
  119029. get environmentIntensity(): number;
  119030. /**
  119031. * Intensity of the environment in all pbr material.
  119032. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119033. * As in the majority of the scene they are the same (exception for multi room and so on),
  119034. * this is easier to set here than in all the materials.
  119035. */
  119036. set environmentIntensity(value: number);
  119037. /** @hidden */
  119038. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  119039. /**
  119040. * Default image processing configuration used either in the rendering
  119041. * Forward main pass or through the imageProcessingPostProcess if present.
  119042. * As in the majority of the scene they are the same (exception for multi camera),
  119043. * this is easier to reference from here than from all the materials and post process.
  119044. *
  119045. * No setter as we it is a shared configuration, you can set the values instead.
  119046. */
  119047. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  119048. private _forceWireframe;
  119049. /**
  119050. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  119051. */
  119052. set forceWireframe(value: boolean);
  119053. get forceWireframe(): boolean;
  119054. private _skipFrustumClipping;
  119055. /**
  119056. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  119057. */
  119058. set skipFrustumClipping(value: boolean);
  119059. get skipFrustumClipping(): boolean;
  119060. private _forcePointsCloud;
  119061. /**
  119062. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  119063. */
  119064. set forcePointsCloud(value: boolean);
  119065. get forcePointsCloud(): boolean;
  119066. /**
  119067. * Gets or sets the active clipplane 1
  119068. */
  119069. clipPlane: Nullable<Plane>;
  119070. /**
  119071. * Gets or sets the active clipplane 2
  119072. */
  119073. clipPlane2: Nullable<Plane>;
  119074. /**
  119075. * Gets or sets the active clipplane 3
  119076. */
  119077. clipPlane3: Nullable<Plane>;
  119078. /**
  119079. * Gets or sets the active clipplane 4
  119080. */
  119081. clipPlane4: Nullable<Plane>;
  119082. /**
  119083. * Gets or sets the active clipplane 5
  119084. */
  119085. clipPlane5: Nullable<Plane>;
  119086. /**
  119087. * Gets or sets the active clipplane 6
  119088. */
  119089. clipPlane6: Nullable<Plane>;
  119090. /**
  119091. * Gets or sets a boolean indicating if animations are enabled
  119092. */
  119093. animationsEnabled: boolean;
  119094. private _animationPropertiesOverride;
  119095. /**
  119096. * Gets or sets the animation properties override
  119097. */
  119098. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  119099. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  119100. /**
  119101. * Gets or sets a boolean indicating if a constant deltatime has to be used
  119102. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  119103. */
  119104. useConstantAnimationDeltaTime: boolean;
  119105. /**
  119106. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  119107. * Please note that it requires to run a ray cast through the scene on every frame
  119108. */
  119109. constantlyUpdateMeshUnderPointer: boolean;
  119110. /**
  119111. * Defines the HTML cursor to use when hovering over interactive elements
  119112. */
  119113. hoverCursor: string;
  119114. /**
  119115. * Defines the HTML default cursor to use (empty by default)
  119116. */
  119117. defaultCursor: string;
  119118. /**
  119119. * Defines whether cursors are handled by the scene.
  119120. */
  119121. doNotHandleCursors: boolean;
  119122. /**
  119123. * This is used to call preventDefault() on pointer down
  119124. * in order to block unwanted artifacts like system double clicks
  119125. */
  119126. preventDefaultOnPointerDown: boolean;
  119127. /**
  119128. * This is used to call preventDefault() on pointer up
  119129. * in order to block unwanted artifacts like system double clicks
  119130. */
  119131. preventDefaultOnPointerUp: boolean;
  119132. /**
  119133. * Gets or sets user defined metadata
  119134. */
  119135. metadata: any;
  119136. /**
  119137. * For internal use only. Please do not use.
  119138. */
  119139. reservedDataStore: any;
  119140. /**
  119141. * Gets the name of the plugin used to load this scene (null by default)
  119142. */
  119143. loadingPluginName: string;
  119144. /**
  119145. * Use this array to add regular expressions used to disable offline support for specific urls
  119146. */
  119147. disableOfflineSupportExceptionRules: RegExp[];
  119148. /**
  119149. * An event triggered when the scene is disposed.
  119150. */
  119151. onDisposeObservable: Observable<Scene>;
  119152. private _onDisposeObserver;
  119153. /** Sets a function to be executed when this scene is disposed. */
  119154. set onDispose(callback: () => void);
  119155. /**
  119156. * An event triggered before rendering the scene (right after animations and physics)
  119157. */
  119158. onBeforeRenderObservable: Observable<Scene>;
  119159. private _onBeforeRenderObserver;
  119160. /** Sets a function to be executed before rendering this scene */
  119161. set beforeRender(callback: Nullable<() => void>);
  119162. /**
  119163. * An event triggered after rendering the scene
  119164. */
  119165. onAfterRenderObservable: Observable<Scene>;
  119166. /**
  119167. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  119168. */
  119169. onAfterRenderCameraObservable: Observable<Camera>;
  119170. private _onAfterRenderObserver;
  119171. /** Sets a function to be executed after rendering this scene */
  119172. set afterRender(callback: Nullable<() => void>);
  119173. /**
  119174. * An event triggered before animating the scene
  119175. */
  119176. onBeforeAnimationsObservable: Observable<Scene>;
  119177. /**
  119178. * An event triggered after animations processing
  119179. */
  119180. onAfterAnimationsObservable: Observable<Scene>;
  119181. /**
  119182. * An event triggered before draw calls are ready to be sent
  119183. */
  119184. onBeforeDrawPhaseObservable: Observable<Scene>;
  119185. /**
  119186. * An event triggered after draw calls have been sent
  119187. */
  119188. onAfterDrawPhaseObservable: Observable<Scene>;
  119189. /**
  119190. * An event triggered when the scene is ready
  119191. */
  119192. onReadyObservable: Observable<Scene>;
  119193. /**
  119194. * An event triggered before rendering a camera
  119195. */
  119196. onBeforeCameraRenderObservable: Observable<Camera>;
  119197. private _onBeforeCameraRenderObserver;
  119198. /** Sets a function to be executed before rendering a camera*/
  119199. set beforeCameraRender(callback: () => void);
  119200. /**
  119201. * An event triggered after rendering a camera
  119202. */
  119203. onAfterCameraRenderObservable: Observable<Camera>;
  119204. private _onAfterCameraRenderObserver;
  119205. /** Sets a function to be executed after rendering a camera*/
  119206. set afterCameraRender(callback: () => void);
  119207. /**
  119208. * An event triggered when active meshes evaluation is about to start
  119209. */
  119210. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  119211. /**
  119212. * An event triggered when active meshes evaluation is done
  119213. */
  119214. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  119215. /**
  119216. * An event triggered when particles rendering is about to start
  119217. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119218. */
  119219. onBeforeParticlesRenderingObservable: Observable<Scene>;
  119220. /**
  119221. * An event triggered when particles rendering is done
  119222. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119223. */
  119224. onAfterParticlesRenderingObservable: Observable<Scene>;
  119225. /**
  119226. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  119227. */
  119228. onDataLoadedObservable: Observable<Scene>;
  119229. /**
  119230. * An event triggered when a camera is created
  119231. */
  119232. onNewCameraAddedObservable: Observable<Camera>;
  119233. /**
  119234. * An event triggered when a camera is removed
  119235. */
  119236. onCameraRemovedObservable: Observable<Camera>;
  119237. /**
  119238. * An event triggered when a light is created
  119239. */
  119240. onNewLightAddedObservable: Observable<Light>;
  119241. /**
  119242. * An event triggered when a light is removed
  119243. */
  119244. onLightRemovedObservable: Observable<Light>;
  119245. /**
  119246. * An event triggered when a geometry is created
  119247. */
  119248. onNewGeometryAddedObservable: Observable<Geometry>;
  119249. /**
  119250. * An event triggered when a geometry is removed
  119251. */
  119252. onGeometryRemovedObservable: Observable<Geometry>;
  119253. /**
  119254. * An event triggered when a transform node is created
  119255. */
  119256. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  119257. /**
  119258. * An event triggered when a transform node is removed
  119259. */
  119260. onTransformNodeRemovedObservable: Observable<TransformNode>;
  119261. /**
  119262. * An event triggered when a mesh is created
  119263. */
  119264. onNewMeshAddedObservable: Observable<AbstractMesh>;
  119265. /**
  119266. * An event triggered when a mesh is removed
  119267. */
  119268. onMeshRemovedObservable: Observable<AbstractMesh>;
  119269. /**
  119270. * An event triggered when a skeleton is created
  119271. */
  119272. onNewSkeletonAddedObservable: Observable<Skeleton>;
  119273. /**
  119274. * An event triggered when a skeleton is removed
  119275. */
  119276. onSkeletonRemovedObservable: Observable<Skeleton>;
  119277. /**
  119278. * An event triggered when a material is created
  119279. */
  119280. onNewMaterialAddedObservable: Observable<Material>;
  119281. /**
  119282. * An event triggered when a material is removed
  119283. */
  119284. onMaterialRemovedObservable: Observable<Material>;
  119285. /**
  119286. * An event triggered when a texture is created
  119287. */
  119288. onNewTextureAddedObservable: Observable<BaseTexture>;
  119289. /**
  119290. * An event triggered when a texture is removed
  119291. */
  119292. onTextureRemovedObservable: Observable<BaseTexture>;
  119293. /**
  119294. * An event triggered when render targets are about to be rendered
  119295. * Can happen multiple times per frame.
  119296. */
  119297. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  119298. /**
  119299. * An event triggered when render targets were rendered.
  119300. * Can happen multiple times per frame.
  119301. */
  119302. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  119303. /**
  119304. * An event triggered before calculating deterministic simulation step
  119305. */
  119306. onBeforeStepObservable: Observable<Scene>;
  119307. /**
  119308. * An event triggered after calculating deterministic simulation step
  119309. */
  119310. onAfterStepObservable: Observable<Scene>;
  119311. /**
  119312. * An event triggered when the activeCamera property is updated
  119313. */
  119314. onActiveCameraChanged: Observable<Scene>;
  119315. /**
  119316. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  119317. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119318. * 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)
  119319. */
  119320. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119321. /**
  119322. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  119323. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119324. * 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)
  119325. */
  119326. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119327. /**
  119328. * This Observable will when a mesh has been imported into the scene.
  119329. */
  119330. onMeshImportedObservable: Observable<AbstractMesh>;
  119331. /**
  119332. * This Observable will when an animation file has been imported into the scene.
  119333. */
  119334. onAnimationFileImportedObservable: Observable<Scene>;
  119335. /**
  119336. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  119337. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  119338. */
  119339. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  119340. /** @hidden */
  119341. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  119342. /**
  119343. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  119344. */
  119345. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  119346. /**
  119347. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  119348. */
  119349. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  119350. /**
  119351. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  119352. */
  119353. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  119354. /** Callback called when a pointer move is detected */
  119355. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119356. /** Callback called when a pointer down is detected */
  119357. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119358. /** Callback called when a pointer up is detected */
  119359. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  119360. /** Callback called when a pointer pick is detected */
  119361. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  119362. /**
  119363. * 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).
  119364. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  119365. */
  119366. onPrePointerObservable: Observable<PointerInfoPre>;
  119367. /**
  119368. * Observable event triggered each time an input event is received from the rendering canvas
  119369. */
  119370. onPointerObservable: Observable<PointerInfo>;
  119371. /**
  119372. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  119373. */
  119374. get unTranslatedPointer(): Vector2;
  119375. /**
  119376. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  119377. */
  119378. static get DragMovementThreshold(): number;
  119379. static set DragMovementThreshold(value: number);
  119380. /**
  119381. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  119382. */
  119383. static get LongPressDelay(): number;
  119384. static set LongPressDelay(value: number);
  119385. /**
  119386. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  119387. */
  119388. static get DoubleClickDelay(): number;
  119389. static set DoubleClickDelay(value: number);
  119390. /** If you need to check double click without raising a single click at first click, enable this flag */
  119391. static get ExclusiveDoubleClickMode(): boolean;
  119392. static set ExclusiveDoubleClickMode(value: boolean);
  119393. /** @hidden */
  119394. _mirroredCameraPosition: Nullable<Vector3>;
  119395. /**
  119396. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  119397. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  119398. */
  119399. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  119400. /**
  119401. * Observable event triggered each time an keyboard event is received from the hosting window
  119402. */
  119403. onKeyboardObservable: Observable<KeyboardInfo>;
  119404. private _useRightHandedSystem;
  119405. /**
  119406. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  119407. */
  119408. set useRightHandedSystem(value: boolean);
  119409. get useRightHandedSystem(): boolean;
  119410. private _timeAccumulator;
  119411. private _currentStepId;
  119412. private _currentInternalStep;
  119413. /**
  119414. * Sets the step Id used by deterministic lock step
  119415. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119416. * @param newStepId defines the step Id
  119417. */
  119418. setStepId(newStepId: number): void;
  119419. /**
  119420. * Gets the step Id used by deterministic lock step
  119421. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119422. * @returns the step Id
  119423. */
  119424. getStepId(): number;
  119425. /**
  119426. * Gets the internal step used by deterministic lock step
  119427. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119428. * @returns the internal step
  119429. */
  119430. getInternalStep(): number;
  119431. private _fogEnabled;
  119432. /**
  119433. * Gets or sets a boolean indicating if fog is enabled on this scene
  119434. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119435. * (Default is true)
  119436. */
  119437. set fogEnabled(value: boolean);
  119438. get fogEnabled(): boolean;
  119439. private _fogMode;
  119440. /**
  119441. * Gets or sets the fog mode to use
  119442. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119443. * | mode | value |
  119444. * | --- | --- |
  119445. * | FOGMODE_NONE | 0 |
  119446. * | FOGMODE_EXP | 1 |
  119447. * | FOGMODE_EXP2 | 2 |
  119448. * | FOGMODE_LINEAR | 3 |
  119449. */
  119450. set fogMode(value: number);
  119451. get fogMode(): number;
  119452. /**
  119453. * Gets or sets the fog color to use
  119454. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119455. * (Default is Color3(0.2, 0.2, 0.3))
  119456. */
  119457. fogColor: Color3;
  119458. /**
  119459. * Gets or sets the fog density to use
  119460. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119461. * (Default is 0.1)
  119462. */
  119463. fogDensity: number;
  119464. /**
  119465. * Gets or sets the fog start distance to use
  119466. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119467. * (Default is 0)
  119468. */
  119469. fogStart: number;
  119470. /**
  119471. * Gets or sets the fog end distance to use
  119472. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119473. * (Default is 1000)
  119474. */
  119475. fogEnd: number;
  119476. /**
  119477. * Flag indicating that the frame buffer binding is handled by another component
  119478. */
  119479. prePass: boolean;
  119480. private _shadowsEnabled;
  119481. /**
  119482. * Gets or sets a boolean indicating if shadows are enabled on this scene
  119483. */
  119484. set shadowsEnabled(value: boolean);
  119485. get shadowsEnabled(): boolean;
  119486. private _lightsEnabled;
  119487. /**
  119488. * Gets or sets a boolean indicating if lights are enabled on this scene
  119489. */
  119490. set lightsEnabled(value: boolean);
  119491. get lightsEnabled(): boolean;
  119492. /** All of the active cameras added to this scene. */
  119493. activeCameras: Camera[];
  119494. /** @hidden */
  119495. _activeCamera: Nullable<Camera>;
  119496. /** Gets or sets the current active camera */
  119497. get activeCamera(): Nullable<Camera>;
  119498. set activeCamera(value: Nullable<Camera>);
  119499. private _defaultMaterial;
  119500. /** The default material used on meshes when no material is affected */
  119501. get defaultMaterial(): Material;
  119502. /** The default material used on meshes when no material is affected */
  119503. set defaultMaterial(value: Material);
  119504. private _texturesEnabled;
  119505. /**
  119506. * Gets or sets a boolean indicating if textures are enabled on this scene
  119507. */
  119508. set texturesEnabled(value: boolean);
  119509. get texturesEnabled(): boolean;
  119510. /**
  119511. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  119512. */
  119513. physicsEnabled: boolean;
  119514. /**
  119515. * Gets or sets a boolean indicating if particles are enabled on this scene
  119516. */
  119517. particlesEnabled: boolean;
  119518. /**
  119519. * Gets or sets a boolean indicating if sprites are enabled on this scene
  119520. */
  119521. spritesEnabled: boolean;
  119522. private _skeletonsEnabled;
  119523. /**
  119524. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  119525. */
  119526. set skeletonsEnabled(value: boolean);
  119527. get skeletonsEnabled(): boolean;
  119528. /**
  119529. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  119530. */
  119531. lensFlaresEnabled: boolean;
  119532. /**
  119533. * Gets or sets a boolean indicating if collisions are enabled on this scene
  119534. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119535. */
  119536. collisionsEnabled: boolean;
  119537. private _collisionCoordinator;
  119538. /** @hidden */
  119539. get collisionCoordinator(): ICollisionCoordinator;
  119540. /**
  119541. * Defines the gravity applied to this scene (used only for collisions)
  119542. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119543. */
  119544. gravity: Vector3;
  119545. /**
  119546. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  119547. */
  119548. postProcessesEnabled: boolean;
  119549. /**
  119550. * Gets the current postprocess manager
  119551. */
  119552. postProcessManager: PostProcessManager;
  119553. /**
  119554. * Gets or sets a boolean indicating if render targets are enabled on this scene
  119555. */
  119556. renderTargetsEnabled: boolean;
  119557. /**
  119558. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  119559. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  119560. */
  119561. dumpNextRenderTargets: boolean;
  119562. /**
  119563. * The list of user defined render targets added to the scene
  119564. */
  119565. customRenderTargets: RenderTargetTexture[];
  119566. /**
  119567. * Defines if texture loading must be delayed
  119568. * If true, textures will only be loaded when they need to be rendered
  119569. */
  119570. useDelayedTextureLoading: boolean;
  119571. /**
  119572. * Gets the list of meshes imported to the scene through SceneLoader
  119573. */
  119574. importedMeshesFiles: String[];
  119575. /**
  119576. * Gets or sets a boolean indicating if probes are enabled on this scene
  119577. */
  119578. probesEnabled: boolean;
  119579. /**
  119580. * Gets or sets the current offline provider to use to store scene data
  119581. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119582. */
  119583. offlineProvider: IOfflineProvider;
  119584. /**
  119585. * Gets or sets the action manager associated with the scene
  119586. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  119587. */
  119588. actionManager: AbstractActionManager;
  119589. private _meshesForIntersections;
  119590. /**
  119591. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  119592. */
  119593. proceduralTexturesEnabled: boolean;
  119594. private _engine;
  119595. private _totalVertices;
  119596. /** @hidden */
  119597. _activeIndices: PerfCounter;
  119598. /** @hidden */
  119599. _activeParticles: PerfCounter;
  119600. /** @hidden */
  119601. _activeBones: PerfCounter;
  119602. private _animationRatio;
  119603. /** @hidden */
  119604. _animationTimeLast: number;
  119605. /** @hidden */
  119606. _animationTime: number;
  119607. /**
  119608. * Gets or sets a general scale for animation speed
  119609. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  119610. */
  119611. animationTimeScale: number;
  119612. /** @hidden */
  119613. _cachedMaterial: Nullable<Material>;
  119614. /** @hidden */
  119615. _cachedEffect: Nullable<Effect>;
  119616. /** @hidden */
  119617. _cachedVisibility: Nullable<number>;
  119618. private _renderId;
  119619. private _frameId;
  119620. private _executeWhenReadyTimeoutId;
  119621. private _intermediateRendering;
  119622. private _viewUpdateFlag;
  119623. private _projectionUpdateFlag;
  119624. /** @hidden */
  119625. _toBeDisposed: Nullable<IDisposable>[];
  119626. private _activeRequests;
  119627. /** @hidden */
  119628. _pendingData: any[];
  119629. private _isDisposed;
  119630. /**
  119631. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  119632. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  119633. */
  119634. dispatchAllSubMeshesOfActiveMeshes: boolean;
  119635. private _activeMeshes;
  119636. private _processedMaterials;
  119637. private _renderTargets;
  119638. /** @hidden */
  119639. _activeParticleSystems: SmartArray<IParticleSystem>;
  119640. private _activeSkeletons;
  119641. private _softwareSkinnedMeshes;
  119642. private _renderingManager;
  119643. /** @hidden */
  119644. _activeAnimatables: Animatable[];
  119645. private _transformMatrix;
  119646. private _sceneUbo;
  119647. /** @hidden */
  119648. _viewMatrix: Matrix;
  119649. private _projectionMatrix;
  119650. /** @hidden */
  119651. _forcedViewPosition: Nullable<Vector3>;
  119652. /** @hidden */
  119653. _frustumPlanes: Plane[];
  119654. /**
  119655. * Gets the list of frustum planes (built from the active camera)
  119656. */
  119657. get frustumPlanes(): Plane[];
  119658. /**
  119659. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  119660. * This is useful if there are more lights that the maximum simulteanous authorized
  119661. */
  119662. requireLightSorting: boolean;
  119663. /** @hidden */
  119664. readonly useMaterialMeshMap: boolean;
  119665. /** @hidden */
  119666. readonly useClonedMeshMap: boolean;
  119667. private _externalData;
  119668. private _uid;
  119669. /**
  119670. * @hidden
  119671. * Backing store of defined scene components.
  119672. */
  119673. _components: ISceneComponent[];
  119674. /**
  119675. * @hidden
  119676. * Backing store of defined scene components.
  119677. */
  119678. _serializableComponents: ISceneSerializableComponent[];
  119679. /**
  119680. * List of components to register on the next registration step.
  119681. */
  119682. private _transientComponents;
  119683. /**
  119684. * Registers the transient components if needed.
  119685. */
  119686. private _registerTransientComponents;
  119687. /**
  119688. * @hidden
  119689. * Add a component to the scene.
  119690. * Note that the ccomponent could be registered on th next frame if this is called after
  119691. * the register component stage.
  119692. * @param component Defines the component to add to the scene
  119693. */
  119694. _addComponent(component: ISceneComponent): void;
  119695. /**
  119696. * @hidden
  119697. * Gets a component from the scene.
  119698. * @param name defines the name of the component to retrieve
  119699. * @returns the component or null if not present
  119700. */
  119701. _getComponent(name: string): Nullable<ISceneComponent>;
  119702. /**
  119703. * @hidden
  119704. * Defines the actions happening before camera updates.
  119705. */
  119706. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  119707. /**
  119708. * @hidden
  119709. * Defines the actions happening before clear the canvas.
  119710. */
  119711. _beforeClearStage: Stage<SimpleStageAction>;
  119712. /**
  119713. * @hidden
  119714. * Defines the actions when collecting render targets for the frame.
  119715. */
  119716. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119717. /**
  119718. * @hidden
  119719. * Defines the actions happening for one camera in the frame.
  119720. */
  119721. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119722. /**
  119723. * @hidden
  119724. * Defines the actions happening during the per mesh ready checks.
  119725. */
  119726. _isReadyForMeshStage: Stage<MeshStageAction>;
  119727. /**
  119728. * @hidden
  119729. * Defines the actions happening before evaluate active mesh checks.
  119730. */
  119731. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  119732. /**
  119733. * @hidden
  119734. * Defines the actions happening during the evaluate sub mesh checks.
  119735. */
  119736. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  119737. /**
  119738. * @hidden
  119739. * Defines the actions happening during the active mesh stage.
  119740. */
  119741. _activeMeshStage: Stage<ActiveMeshStageAction>;
  119742. /**
  119743. * @hidden
  119744. * Defines the actions happening during the per camera render target step.
  119745. */
  119746. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  119747. /**
  119748. * @hidden
  119749. * Defines the actions happening just before the active camera is drawing.
  119750. */
  119751. _beforeCameraDrawStage: Stage<CameraStageAction>;
  119752. /**
  119753. * @hidden
  119754. * Defines the actions happening just before a render target is drawing.
  119755. */
  119756. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119757. /**
  119758. * @hidden
  119759. * Defines the actions happening just before a rendering group is drawing.
  119760. */
  119761. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119762. /**
  119763. * @hidden
  119764. * Defines the actions happening just before a mesh is drawing.
  119765. */
  119766. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119767. /**
  119768. * @hidden
  119769. * Defines the actions happening just after a mesh has been drawn.
  119770. */
  119771. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119772. /**
  119773. * @hidden
  119774. * Defines the actions happening just after a rendering group has been drawn.
  119775. */
  119776. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119777. /**
  119778. * @hidden
  119779. * Defines the actions happening just after the active camera has been drawn.
  119780. */
  119781. _afterCameraDrawStage: Stage<CameraStageAction>;
  119782. /**
  119783. * @hidden
  119784. * Defines the actions happening just after a render target has been drawn.
  119785. */
  119786. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119787. /**
  119788. * @hidden
  119789. * Defines the actions happening just after rendering all cameras and computing intersections.
  119790. */
  119791. _afterRenderStage: Stage<SimpleStageAction>;
  119792. /**
  119793. * @hidden
  119794. * Defines the actions happening when a pointer move event happens.
  119795. */
  119796. _pointerMoveStage: Stage<PointerMoveStageAction>;
  119797. /**
  119798. * @hidden
  119799. * Defines the actions happening when a pointer down event happens.
  119800. */
  119801. _pointerDownStage: Stage<PointerUpDownStageAction>;
  119802. /**
  119803. * @hidden
  119804. * Defines the actions happening when a pointer up event happens.
  119805. */
  119806. _pointerUpStage: Stage<PointerUpDownStageAction>;
  119807. /**
  119808. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  119809. */
  119810. private geometriesByUniqueId;
  119811. /**
  119812. * Creates a new Scene
  119813. * @param engine defines the engine to use to render this scene
  119814. * @param options defines the scene options
  119815. */
  119816. constructor(engine: Engine, options?: SceneOptions);
  119817. /**
  119818. * Gets a string identifying the name of the class
  119819. * @returns "Scene" string
  119820. */
  119821. getClassName(): string;
  119822. private _defaultMeshCandidates;
  119823. /**
  119824. * @hidden
  119825. */
  119826. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  119827. private _defaultSubMeshCandidates;
  119828. /**
  119829. * @hidden
  119830. */
  119831. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  119832. /**
  119833. * Sets the default candidate providers for the scene.
  119834. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  119835. * and getCollidingSubMeshCandidates to their default function
  119836. */
  119837. setDefaultCandidateProviders(): void;
  119838. /**
  119839. * Gets the mesh that is currently under the pointer
  119840. */
  119841. get meshUnderPointer(): Nullable<AbstractMesh>;
  119842. /**
  119843. * Gets or sets the current on-screen X position of the pointer
  119844. */
  119845. get pointerX(): number;
  119846. set pointerX(value: number);
  119847. /**
  119848. * Gets or sets the current on-screen Y position of the pointer
  119849. */
  119850. get pointerY(): number;
  119851. set pointerY(value: number);
  119852. /**
  119853. * Gets the cached material (ie. the latest rendered one)
  119854. * @returns the cached material
  119855. */
  119856. getCachedMaterial(): Nullable<Material>;
  119857. /**
  119858. * Gets the cached effect (ie. the latest rendered one)
  119859. * @returns the cached effect
  119860. */
  119861. getCachedEffect(): Nullable<Effect>;
  119862. /**
  119863. * Gets the cached visibility state (ie. the latest rendered one)
  119864. * @returns the cached visibility state
  119865. */
  119866. getCachedVisibility(): Nullable<number>;
  119867. /**
  119868. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  119869. * @param material defines the current material
  119870. * @param effect defines the current effect
  119871. * @param visibility defines the current visibility state
  119872. * @returns true if one parameter is not cached
  119873. */
  119874. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  119875. /**
  119876. * Gets the engine associated with the scene
  119877. * @returns an Engine
  119878. */
  119879. getEngine(): Engine;
  119880. /**
  119881. * Gets the total number of vertices rendered per frame
  119882. * @returns the total number of vertices rendered per frame
  119883. */
  119884. getTotalVertices(): number;
  119885. /**
  119886. * Gets the performance counter for total vertices
  119887. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119888. */
  119889. get totalVerticesPerfCounter(): PerfCounter;
  119890. /**
  119891. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  119892. * @returns the total number of active indices rendered per frame
  119893. */
  119894. getActiveIndices(): number;
  119895. /**
  119896. * Gets the performance counter for active indices
  119897. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119898. */
  119899. get totalActiveIndicesPerfCounter(): PerfCounter;
  119900. /**
  119901. * Gets the total number of active particles rendered per frame
  119902. * @returns the total number of active particles rendered per frame
  119903. */
  119904. getActiveParticles(): number;
  119905. /**
  119906. * Gets the performance counter for active particles
  119907. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119908. */
  119909. get activeParticlesPerfCounter(): PerfCounter;
  119910. /**
  119911. * Gets the total number of active bones rendered per frame
  119912. * @returns the total number of active bones rendered per frame
  119913. */
  119914. getActiveBones(): number;
  119915. /**
  119916. * Gets the performance counter for active bones
  119917. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119918. */
  119919. get activeBonesPerfCounter(): PerfCounter;
  119920. /**
  119921. * Gets the array of active meshes
  119922. * @returns an array of AbstractMesh
  119923. */
  119924. getActiveMeshes(): SmartArray<AbstractMesh>;
  119925. /**
  119926. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  119927. * @returns a number
  119928. */
  119929. getAnimationRatio(): number;
  119930. /**
  119931. * Gets an unique Id for the current render phase
  119932. * @returns a number
  119933. */
  119934. getRenderId(): number;
  119935. /**
  119936. * Gets an unique Id for the current frame
  119937. * @returns a number
  119938. */
  119939. getFrameId(): number;
  119940. /** Call this function if you want to manually increment the render Id*/
  119941. incrementRenderId(): void;
  119942. private _createUbo;
  119943. /**
  119944. * Use this method to simulate a pointer move on a mesh
  119945. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119946. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119947. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119948. * @returns the current scene
  119949. */
  119950. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119951. /**
  119952. * Use this method to simulate a pointer down on a mesh
  119953. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119954. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119955. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119956. * @returns the current scene
  119957. */
  119958. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119959. /**
  119960. * Use this method to simulate a pointer up on a mesh
  119961. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119962. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119963. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119964. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  119965. * @returns the current scene
  119966. */
  119967. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  119968. /**
  119969. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  119970. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  119971. * @returns true if the pointer was captured
  119972. */
  119973. isPointerCaptured(pointerId?: number): boolean;
  119974. /**
  119975. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  119976. * @param attachUp defines if you want to attach events to pointerup
  119977. * @param attachDown defines if you want to attach events to pointerdown
  119978. * @param attachMove defines if you want to attach events to pointermove
  119979. */
  119980. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  119981. /** Detaches all event handlers*/
  119982. detachControl(): void;
  119983. /**
  119984. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  119985. * Delay loaded resources are not taking in account
  119986. * @return true if all required resources are ready
  119987. */
  119988. isReady(): boolean;
  119989. /** Resets all cached information relative to material (including effect and visibility) */
  119990. resetCachedMaterial(): void;
  119991. /**
  119992. * Registers a function to be called before every frame render
  119993. * @param func defines the function to register
  119994. */
  119995. registerBeforeRender(func: () => void): void;
  119996. /**
  119997. * Unregisters a function called before every frame render
  119998. * @param func defines the function to unregister
  119999. */
  120000. unregisterBeforeRender(func: () => void): void;
  120001. /**
  120002. * Registers a function to be called after every frame render
  120003. * @param func defines the function to register
  120004. */
  120005. registerAfterRender(func: () => void): void;
  120006. /**
  120007. * Unregisters a function called after every frame render
  120008. * @param func defines the function to unregister
  120009. */
  120010. unregisterAfterRender(func: () => void): void;
  120011. private _executeOnceBeforeRender;
  120012. /**
  120013. * The provided function will run before render once and will be disposed afterwards.
  120014. * A timeout delay can be provided so that the function will be executed in N ms.
  120015. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  120016. * @param func The function to be executed.
  120017. * @param timeout optional delay in ms
  120018. */
  120019. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  120020. /** @hidden */
  120021. _addPendingData(data: any): void;
  120022. /** @hidden */
  120023. _removePendingData(data: any): void;
  120024. /**
  120025. * Returns the number of items waiting to be loaded
  120026. * @returns the number of items waiting to be loaded
  120027. */
  120028. getWaitingItemsCount(): number;
  120029. /**
  120030. * Returns a boolean indicating if the scene is still loading data
  120031. */
  120032. get isLoading(): boolean;
  120033. /**
  120034. * Registers a function to be executed when the scene is ready
  120035. * @param {Function} func - the function to be executed
  120036. */
  120037. executeWhenReady(func: () => void): void;
  120038. /**
  120039. * Returns a promise that resolves when the scene is ready
  120040. * @returns A promise that resolves when the scene is ready
  120041. */
  120042. whenReadyAsync(): Promise<void>;
  120043. /** @hidden */
  120044. _checkIsReady(): void;
  120045. /**
  120046. * Gets all animatable attached to the scene
  120047. */
  120048. get animatables(): Animatable[];
  120049. /**
  120050. * Resets the last animation time frame.
  120051. * Useful to override when animations start running when loading a scene for the first time.
  120052. */
  120053. resetLastAnimationTimeFrame(): void;
  120054. /**
  120055. * Gets the current view matrix
  120056. * @returns a Matrix
  120057. */
  120058. getViewMatrix(): Matrix;
  120059. /**
  120060. * Gets the current projection matrix
  120061. * @returns a Matrix
  120062. */
  120063. getProjectionMatrix(): Matrix;
  120064. /**
  120065. * Gets the current transform matrix
  120066. * @returns a Matrix made of View * Projection
  120067. */
  120068. getTransformMatrix(): Matrix;
  120069. /**
  120070. * Sets the current transform matrix
  120071. * @param viewL defines the View matrix to use
  120072. * @param projectionL defines the Projection matrix to use
  120073. * @param viewR defines the right View matrix to use (if provided)
  120074. * @param projectionR defines the right Projection matrix to use (if provided)
  120075. */
  120076. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  120077. /**
  120078. * Gets the uniform buffer used to store scene data
  120079. * @returns a UniformBuffer
  120080. */
  120081. getSceneUniformBuffer(): UniformBuffer;
  120082. /**
  120083. * Gets an unique (relatively to the current scene) Id
  120084. * @returns an unique number for the scene
  120085. */
  120086. getUniqueId(): number;
  120087. /**
  120088. * Add a mesh to the list of scene's meshes
  120089. * @param newMesh defines the mesh to add
  120090. * @param recursive if all child meshes should also be added to the scene
  120091. */
  120092. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  120093. /**
  120094. * Remove a mesh for the list of scene's meshes
  120095. * @param toRemove defines the mesh to remove
  120096. * @param recursive if all child meshes should also be removed from the scene
  120097. * @returns the index where the mesh was in the mesh list
  120098. */
  120099. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  120100. /**
  120101. * Add a transform node to the list of scene's transform nodes
  120102. * @param newTransformNode defines the transform node to add
  120103. */
  120104. addTransformNode(newTransformNode: TransformNode): void;
  120105. /**
  120106. * Remove a transform node for the list of scene's transform nodes
  120107. * @param toRemove defines the transform node to remove
  120108. * @returns the index where the transform node was in the transform node list
  120109. */
  120110. removeTransformNode(toRemove: TransformNode): number;
  120111. /**
  120112. * Remove a skeleton for the list of scene's skeletons
  120113. * @param toRemove defines the skeleton to remove
  120114. * @returns the index where the skeleton was in the skeleton list
  120115. */
  120116. removeSkeleton(toRemove: Skeleton): number;
  120117. /**
  120118. * Remove a morph target for the list of scene's morph targets
  120119. * @param toRemove defines the morph target to remove
  120120. * @returns the index where the morph target was in the morph target list
  120121. */
  120122. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  120123. /**
  120124. * Remove a light for the list of scene's lights
  120125. * @param toRemove defines the light to remove
  120126. * @returns the index where the light was in the light list
  120127. */
  120128. removeLight(toRemove: Light): number;
  120129. /**
  120130. * Remove a camera for the list of scene's cameras
  120131. * @param toRemove defines the camera to remove
  120132. * @returns the index where the camera was in the camera list
  120133. */
  120134. removeCamera(toRemove: Camera): number;
  120135. /**
  120136. * Remove a particle system for the list of scene's particle systems
  120137. * @param toRemove defines the particle system to remove
  120138. * @returns the index where the particle system was in the particle system list
  120139. */
  120140. removeParticleSystem(toRemove: IParticleSystem): number;
  120141. /**
  120142. * Remove a animation for the list of scene's animations
  120143. * @param toRemove defines the animation to remove
  120144. * @returns the index where the animation was in the animation list
  120145. */
  120146. removeAnimation(toRemove: Animation): number;
  120147. /**
  120148. * Will stop the animation of the given target
  120149. * @param target - the target
  120150. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  120151. * @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)
  120152. */
  120153. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  120154. /**
  120155. * Removes the given animation group from this scene.
  120156. * @param toRemove The animation group to remove
  120157. * @returns The index of the removed animation group
  120158. */
  120159. removeAnimationGroup(toRemove: AnimationGroup): number;
  120160. /**
  120161. * Removes the given multi-material from this scene.
  120162. * @param toRemove The multi-material to remove
  120163. * @returns The index of the removed multi-material
  120164. */
  120165. removeMultiMaterial(toRemove: MultiMaterial): number;
  120166. /**
  120167. * Removes the given material from this scene.
  120168. * @param toRemove The material to remove
  120169. * @returns The index of the removed material
  120170. */
  120171. removeMaterial(toRemove: Material): number;
  120172. /**
  120173. * Removes the given action manager from this scene.
  120174. * @param toRemove The action manager to remove
  120175. * @returns The index of the removed action manager
  120176. */
  120177. removeActionManager(toRemove: AbstractActionManager): number;
  120178. /**
  120179. * Removes the given texture from this scene.
  120180. * @param toRemove The texture to remove
  120181. * @returns The index of the removed texture
  120182. */
  120183. removeTexture(toRemove: BaseTexture): number;
  120184. /**
  120185. * Adds the given light to this scene
  120186. * @param newLight The light to add
  120187. */
  120188. addLight(newLight: Light): void;
  120189. /**
  120190. * Sorts the list list based on light priorities
  120191. */
  120192. sortLightsByPriority(): void;
  120193. /**
  120194. * Adds the given camera to this scene
  120195. * @param newCamera The camera to add
  120196. */
  120197. addCamera(newCamera: Camera): void;
  120198. /**
  120199. * Adds the given skeleton to this scene
  120200. * @param newSkeleton The skeleton to add
  120201. */
  120202. addSkeleton(newSkeleton: Skeleton): void;
  120203. /**
  120204. * Adds the given particle system to this scene
  120205. * @param newParticleSystem The particle system to add
  120206. */
  120207. addParticleSystem(newParticleSystem: IParticleSystem): void;
  120208. /**
  120209. * Adds the given animation to this scene
  120210. * @param newAnimation The animation to add
  120211. */
  120212. addAnimation(newAnimation: Animation): void;
  120213. /**
  120214. * Adds the given animation group to this scene.
  120215. * @param newAnimationGroup The animation group to add
  120216. */
  120217. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  120218. /**
  120219. * Adds the given multi-material to this scene
  120220. * @param newMultiMaterial The multi-material to add
  120221. */
  120222. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  120223. /**
  120224. * Adds the given material to this scene
  120225. * @param newMaterial The material to add
  120226. */
  120227. addMaterial(newMaterial: Material): void;
  120228. /**
  120229. * Adds the given morph target to this scene
  120230. * @param newMorphTargetManager The morph target to add
  120231. */
  120232. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  120233. /**
  120234. * Adds the given geometry to this scene
  120235. * @param newGeometry The geometry to add
  120236. */
  120237. addGeometry(newGeometry: Geometry): void;
  120238. /**
  120239. * Adds the given action manager to this scene
  120240. * @param newActionManager The action manager to add
  120241. */
  120242. addActionManager(newActionManager: AbstractActionManager): void;
  120243. /**
  120244. * Adds the given texture to this scene.
  120245. * @param newTexture The texture to add
  120246. */
  120247. addTexture(newTexture: BaseTexture): void;
  120248. /**
  120249. * Switch active camera
  120250. * @param newCamera defines the new active camera
  120251. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  120252. */
  120253. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  120254. /**
  120255. * sets the active camera of the scene using its ID
  120256. * @param id defines the camera's ID
  120257. * @return the new active camera or null if none found.
  120258. */
  120259. setActiveCameraByID(id: string): Nullable<Camera>;
  120260. /**
  120261. * sets the active camera of the scene using its name
  120262. * @param name defines the camera's name
  120263. * @returns the new active camera or null if none found.
  120264. */
  120265. setActiveCameraByName(name: string): Nullable<Camera>;
  120266. /**
  120267. * get an animation group using its name
  120268. * @param name defines the material's name
  120269. * @return the animation group or null if none found.
  120270. */
  120271. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  120272. /**
  120273. * Get a material using its unique id
  120274. * @param uniqueId defines the material's unique id
  120275. * @return the material or null if none found.
  120276. */
  120277. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  120278. /**
  120279. * get a material using its id
  120280. * @param id defines the material's ID
  120281. * @return the material or null if none found.
  120282. */
  120283. getMaterialByID(id: string): Nullable<Material>;
  120284. /**
  120285. * Gets a the last added material using a given id
  120286. * @param id defines the material's ID
  120287. * @return the last material with the given id or null if none found.
  120288. */
  120289. getLastMaterialByID(id: string): Nullable<Material>;
  120290. /**
  120291. * Gets a material using its name
  120292. * @param name defines the material's name
  120293. * @return the material or null if none found.
  120294. */
  120295. getMaterialByName(name: string): Nullable<Material>;
  120296. /**
  120297. * Get a texture using its unique id
  120298. * @param uniqueId defines the texture's unique id
  120299. * @return the texture or null if none found.
  120300. */
  120301. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  120302. /**
  120303. * Gets a camera using its id
  120304. * @param id defines the id to look for
  120305. * @returns the camera or null if not found
  120306. */
  120307. getCameraByID(id: string): Nullable<Camera>;
  120308. /**
  120309. * Gets a camera using its unique id
  120310. * @param uniqueId defines the unique id to look for
  120311. * @returns the camera or null if not found
  120312. */
  120313. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  120314. /**
  120315. * Gets a camera using its name
  120316. * @param name defines the camera's name
  120317. * @return the camera or null if none found.
  120318. */
  120319. getCameraByName(name: string): Nullable<Camera>;
  120320. /**
  120321. * Gets a bone using its id
  120322. * @param id defines the bone's id
  120323. * @return the bone or null if not found
  120324. */
  120325. getBoneByID(id: string): Nullable<Bone>;
  120326. /**
  120327. * Gets a bone using its id
  120328. * @param name defines the bone's name
  120329. * @return the bone or null if not found
  120330. */
  120331. getBoneByName(name: string): Nullable<Bone>;
  120332. /**
  120333. * Gets a light node using its name
  120334. * @param name defines the the light's name
  120335. * @return the light or null if none found.
  120336. */
  120337. getLightByName(name: string): Nullable<Light>;
  120338. /**
  120339. * Gets a light node using its id
  120340. * @param id defines the light's id
  120341. * @return the light or null if none found.
  120342. */
  120343. getLightByID(id: string): Nullable<Light>;
  120344. /**
  120345. * Gets a light node using its scene-generated unique ID
  120346. * @param uniqueId defines the light's unique id
  120347. * @return the light or null if none found.
  120348. */
  120349. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  120350. /**
  120351. * Gets a particle system by id
  120352. * @param id defines the particle system id
  120353. * @return the corresponding system or null if none found
  120354. */
  120355. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  120356. /**
  120357. * Gets a geometry using its ID
  120358. * @param id defines the geometry's id
  120359. * @return the geometry or null if none found.
  120360. */
  120361. getGeometryByID(id: string): Nullable<Geometry>;
  120362. private _getGeometryByUniqueID;
  120363. /**
  120364. * Add a new geometry to this scene
  120365. * @param geometry defines the geometry to be added to the scene.
  120366. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  120367. * @return a boolean defining if the geometry was added or not
  120368. */
  120369. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  120370. /**
  120371. * Removes an existing geometry
  120372. * @param geometry defines the geometry to be removed from the scene
  120373. * @return a boolean defining if the geometry was removed or not
  120374. */
  120375. removeGeometry(geometry: Geometry): boolean;
  120376. /**
  120377. * Gets the list of geometries attached to the scene
  120378. * @returns an array of Geometry
  120379. */
  120380. getGeometries(): Geometry[];
  120381. /**
  120382. * Gets the first added mesh found of a given ID
  120383. * @param id defines the id to search for
  120384. * @return the mesh found or null if not found at all
  120385. */
  120386. getMeshByID(id: string): Nullable<AbstractMesh>;
  120387. /**
  120388. * Gets a list of meshes using their id
  120389. * @param id defines the id to search for
  120390. * @returns a list of meshes
  120391. */
  120392. getMeshesByID(id: string): Array<AbstractMesh>;
  120393. /**
  120394. * Gets the first added transform node found of a given ID
  120395. * @param id defines the id to search for
  120396. * @return the found transform node or null if not found at all.
  120397. */
  120398. getTransformNodeByID(id: string): Nullable<TransformNode>;
  120399. /**
  120400. * Gets a transform node with its auto-generated unique id
  120401. * @param uniqueId efines the unique id to search for
  120402. * @return the found transform node or null if not found at all.
  120403. */
  120404. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  120405. /**
  120406. * Gets a list of transform nodes using their id
  120407. * @param id defines the id to search for
  120408. * @returns a list of transform nodes
  120409. */
  120410. getTransformNodesByID(id: string): Array<TransformNode>;
  120411. /**
  120412. * Gets a mesh with its auto-generated unique id
  120413. * @param uniqueId defines the unique id to search for
  120414. * @return the found mesh or null if not found at all.
  120415. */
  120416. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  120417. /**
  120418. * Gets a the last added mesh using a given id
  120419. * @param id defines the id to search for
  120420. * @return the found mesh or null if not found at all.
  120421. */
  120422. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  120423. /**
  120424. * Gets a the last added node (Mesh, Camera, Light) using a given id
  120425. * @param id defines the id to search for
  120426. * @return the found node or null if not found at all
  120427. */
  120428. getLastEntryByID(id: string): Nullable<Node>;
  120429. /**
  120430. * Gets a node (Mesh, Camera, Light) using a given id
  120431. * @param id defines the id to search for
  120432. * @return the found node or null if not found at all
  120433. */
  120434. getNodeByID(id: string): Nullable<Node>;
  120435. /**
  120436. * Gets a node (Mesh, Camera, Light) using a given name
  120437. * @param name defines the name to search for
  120438. * @return the found node or null if not found at all.
  120439. */
  120440. getNodeByName(name: string): Nullable<Node>;
  120441. /**
  120442. * Gets a mesh using a given name
  120443. * @param name defines the name to search for
  120444. * @return the found mesh or null if not found at all.
  120445. */
  120446. getMeshByName(name: string): Nullable<AbstractMesh>;
  120447. /**
  120448. * Gets a transform node using a given name
  120449. * @param name defines the name to search for
  120450. * @return the found transform node or null if not found at all.
  120451. */
  120452. getTransformNodeByName(name: string): Nullable<TransformNode>;
  120453. /**
  120454. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  120455. * @param id defines the id to search for
  120456. * @return the found skeleton or null if not found at all.
  120457. */
  120458. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  120459. /**
  120460. * Gets a skeleton using a given auto generated unique id
  120461. * @param uniqueId defines the unique id to search for
  120462. * @return the found skeleton or null if not found at all.
  120463. */
  120464. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  120465. /**
  120466. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  120467. * @param id defines the id to search for
  120468. * @return the found skeleton or null if not found at all.
  120469. */
  120470. getSkeletonById(id: string): Nullable<Skeleton>;
  120471. /**
  120472. * Gets a skeleton using a given name
  120473. * @param name defines the name to search for
  120474. * @return the found skeleton or null if not found at all.
  120475. */
  120476. getSkeletonByName(name: string): Nullable<Skeleton>;
  120477. /**
  120478. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  120479. * @param id defines the id to search for
  120480. * @return the found morph target manager or null if not found at all.
  120481. */
  120482. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  120483. /**
  120484. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  120485. * @param id defines the id to search for
  120486. * @return the found morph target or null if not found at all.
  120487. */
  120488. getMorphTargetById(id: string): Nullable<MorphTarget>;
  120489. /**
  120490. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  120491. * @param name defines the name to search for
  120492. * @return the found morph target or null if not found at all.
  120493. */
  120494. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  120495. /**
  120496. * Gets a post process using a given name (if many are found, this function will pick the first one)
  120497. * @param name defines the name to search for
  120498. * @return the found post process or null if not found at all.
  120499. */
  120500. getPostProcessByName(name: string): Nullable<PostProcess>;
  120501. /**
  120502. * Gets a boolean indicating if the given mesh is active
  120503. * @param mesh defines the mesh to look for
  120504. * @returns true if the mesh is in the active list
  120505. */
  120506. isActiveMesh(mesh: AbstractMesh): boolean;
  120507. /**
  120508. * Return a unique id as a string which can serve as an identifier for the scene
  120509. */
  120510. get uid(): string;
  120511. /**
  120512. * Add an externaly attached data from its key.
  120513. * This method call will fail and return false, if such key already exists.
  120514. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  120515. * @param key the unique key that identifies the data
  120516. * @param data the data object to associate to the key for this Engine instance
  120517. * @return true if no such key were already present and the data was added successfully, false otherwise
  120518. */
  120519. addExternalData<T>(key: string, data: T): boolean;
  120520. /**
  120521. * Get an externaly attached data from its key
  120522. * @param key the unique key that identifies the data
  120523. * @return the associated data, if present (can be null), or undefined if not present
  120524. */
  120525. getExternalData<T>(key: string): Nullable<T>;
  120526. /**
  120527. * Get an externaly attached data from its key, create it using a factory if it's not already present
  120528. * @param key the unique key that identifies the data
  120529. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  120530. * @return the associated data, can be null if the factory returned null.
  120531. */
  120532. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  120533. /**
  120534. * Remove an externaly attached data from the Engine instance
  120535. * @param key the unique key that identifies the data
  120536. * @return true if the data was successfully removed, false if it doesn't exist
  120537. */
  120538. removeExternalData(key: string): boolean;
  120539. private _evaluateSubMesh;
  120540. /**
  120541. * Clear the processed materials smart array preventing retention point in material dispose.
  120542. */
  120543. freeProcessedMaterials(): void;
  120544. private _preventFreeActiveMeshesAndRenderingGroups;
  120545. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  120546. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  120547. * when disposing several meshes in a row or a hierarchy of meshes.
  120548. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  120549. */
  120550. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  120551. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  120552. /**
  120553. * Clear the active meshes smart array preventing retention point in mesh dispose.
  120554. */
  120555. freeActiveMeshes(): void;
  120556. /**
  120557. * Clear the info related to rendering groups preventing retention points during dispose.
  120558. */
  120559. freeRenderingGroups(): void;
  120560. /** @hidden */
  120561. _isInIntermediateRendering(): boolean;
  120562. /**
  120563. * Lambda returning the list of potentially active meshes.
  120564. */
  120565. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  120566. /**
  120567. * Lambda returning the list of potentially active sub meshes.
  120568. */
  120569. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  120570. /**
  120571. * Lambda returning the list of potentially intersecting sub meshes.
  120572. */
  120573. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  120574. /**
  120575. * Lambda returning the list of potentially colliding sub meshes.
  120576. */
  120577. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  120578. private _activeMeshesFrozen;
  120579. private _skipEvaluateActiveMeshesCompletely;
  120580. /**
  120581. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  120582. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  120583. * @returns the current scene
  120584. */
  120585. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  120586. /**
  120587. * Use this function to restart evaluating active meshes on every frame
  120588. * @returns the current scene
  120589. */
  120590. unfreezeActiveMeshes(): Scene;
  120591. private _evaluateActiveMeshes;
  120592. private _activeMesh;
  120593. /**
  120594. * Update the transform matrix to update from the current active camera
  120595. * @param force defines a boolean used to force the update even if cache is up to date
  120596. */
  120597. updateTransformMatrix(force?: boolean): void;
  120598. private _bindFrameBuffer;
  120599. /** @hidden */
  120600. _allowPostProcessClearColor: boolean;
  120601. /** @hidden */
  120602. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  120603. private _processSubCameras;
  120604. private _checkIntersections;
  120605. /** @hidden */
  120606. _advancePhysicsEngineStep(step: number): void;
  120607. /**
  120608. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  120609. */
  120610. getDeterministicFrameTime: () => number;
  120611. /** @hidden */
  120612. _animate(): void;
  120613. /** Execute all animations (for a frame) */
  120614. animate(): void;
  120615. /**
  120616. * Render the scene
  120617. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  120618. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  120619. */
  120620. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  120621. /**
  120622. * Freeze all materials
  120623. * A frozen material will not be updatable but should be faster to render
  120624. */
  120625. freezeMaterials(): void;
  120626. /**
  120627. * Unfreeze all materials
  120628. * A frozen material will not be updatable but should be faster to render
  120629. */
  120630. unfreezeMaterials(): void;
  120631. /**
  120632. * Releases all held ressources
  120633. */
  120634. dispose(): void;
  120635. /**
  120636. * Gets if the scene is already disposed
  120637. */
  120638. get isDisposed(): boolean;
  120639. /**
  120640. * Call this function to reduce memory footprint of the scene.
  120641. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  120642. */
  120643. clearCachedVertexData(): void;
  120644. /**
  120645. * This function will remove the local cached buffer data from texture.
  120646. * It will save memory but will prevent the texture from being rebuilt
  120647. */
  120648. cleanCachedTextureBuffer(): void;
  120649. /**
  120650. * Get the world extend vectors with an optional filter
  120651. *
  120652. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  120653. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  120654. */
  120655. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  120656. min: Vector3;
  120657. max: Vector3;
  120658. };
  120659. /**
  120660. * Creates a ray that can be used to pick in the scene
  120661. * @param x defines the x coordinate of the origin (on-screen)
  120662. * @param y defines the y coordinate of the origin (on-screen)
  120663. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120664. * @param camera defines the camera to use for the picking
  120665. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120666. * @returns a Ray
  120667. */
  120668. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  120669. /**
  120670. * Creates a ray that can be used to pick in the scene
  120671. * @param x defines the x coordinate of the origin (on-screen)
  120672. * @param y defines the y coordinate of the origin (on-screen)
  120673. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120674. * @param result defines the ray where to store the picking ray
  120675. * @param camera defines the camera to use for the picking
  120676. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120677. * @returns the current scene
  120678. */
  120679. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  120680. /**
  120681. * Creates a ray that can be used to pick in the scene
  120682. * @param x defines the x coordinate of the origin (on-screen)
  120683. * @param y defines the y coordinate of the origin (on-screen)
  120684. * @param camera defines the camera to use for the picking
  120685. * @returns a Ray
  120686. */
  120687. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  120688. /**
  120689. * Creates a ray that can be used to pick in the scene
  120690. * @param x defines the x coordinate of the origin (on-screen)
  120691. * @param y defines the y coordinate of the origin (on-screen)
  120692. * @param result defines the ray where to store the picking ray
  120693. * @param camera defines the camera to use for the picking
  120694. * @returns the current scene
  120695. */
  120696. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  120697. /** Launch a ray to try to pick a mesh in the scene
  120698. * @param x position on screen
  120699. * @param y position on screen
  120700. * @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
  120701. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120702. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120703. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120704. * @returns a PickingInfo
  120705. */
  120706. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120707. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  120708. * @param x position on screen
  120709. * @param y position on screen
  120710. * @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
  120711. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120712. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120713. * @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)
  120714. */
  120715. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  120716. /** Use the given ray to pick a mesh in the scene
  120717. * @param ray The ray to use to pick meshes
  120718. * @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
  120719. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120720. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120721. * @returns a PickingInfo
  120722. */
  120723. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120724. /**
  120725. * Launch a ray to try to pick a mesh in the scene
  120726. * @param x X position on screen
  120727. * @param y Y position on screen
  120728. * @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
  120729. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120730. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120731. * @returns an array of PickingInfo
  120732. */
  120733. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120734. /**
  120735. * Launch a ray to try to pick a mesh in the scene
  120736. * @param ray Ray to use
  120737. * @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
  120738. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120739. * @returns an array of PickingInfo
  120740. */
  120741. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120742. /**
  120743. * Force the value of meshUnderPointer
  120744. * @param mesh defines the mesh to use
  120745. */
  120746. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  120747. /**
  120748. * Gets the mesh under the pointer
  120749. * @returns a Mesh or null if no mesh is under the pointer
  120750. */
  120751. getPointerOverMesh(): Nullable<AbstractMesh>;
  120752. /** @hidden */
  120753. _rebuildGeometries(): void;
  120754. /** @hidden */
  120755. _rebuildTextures(): void;
  120756. private _getByTags;
  120757. /**
  120758. * Get a list of meshes by tags
  120759. * @param tagsQuery defines the tags query to use
  120760. * @param forEach defines a predicate used to filter results
  120761. * @returns an array of Mesh
  120762. */
  120763. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  120764. /**
  120765. * Get a list of cameras by tags
  120766. * @param tagsQuery defines the tags query to use
  120767. * @param forEach defines a predicate used to filter results
  120768. * @returns an array of Camera
  120769. */
  120770. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  120771. /**
  120772. * Get a list of lights by tags
  120773. * @param tagsQuery defines the tags query to use
  120774. * @param forEach defines a predicate used to filter results
  120775. * @returns an array of Light
  120776. */
  120777. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  120778. /**
  120779. * Get a list of materials by tags
  120780. * @param tagsQuery defines the tags query to use
  120781. * @param forEach defines a predicate used to filter results
  120782. * @returns an array of Material
  120783. */
  120784. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  120785. /**
  120786. * Get a list of transform nodes by tags
  120787. * @param tagsQuery defines the tags query to use
  120788. * @param forEach defines a predicate used to filter results
  120789. * @returns an array of TransformNode
  120790. */
  120791. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  120792. /**
  120793. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  120794. * This allowed control for front to back rendering or reversly depending of the special needs.
  120795. *
  120796. * @param renderingGroupId The rendering group id corresponding to its index
  120797. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  120798. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  120799. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  120800. */
  120801. 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;
  120802. /**
  120803. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  120804. *
  120805. * @param renderingGroupId The rendering group id corresponding to its index
  120806. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120807. * @param depth Automatically clears depth between groups if true and autoClear is true.
  120808. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  120809. */
  120810. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  120811. /**
  120812. * Gets the current auto clear configuration for one rendering group of the rendering
  120813. * manager.
  120814. * @param index the rendering group index to get the information for
  120815. * @returns The auto clear setup for the requested rendering group
  120816. */
  120817. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  120818. private _blockMaterialDirtyMechanism;
  120819. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  120820. get blockMaterialDirtyMechanism(): boolean;
  120821. set blockMaterialDirtyMechanism(value: boolean);
  120822. /**
  120823. * Will flag all materials as dirty to trigger new shader compilation
  120824. * @param flag defines the flag used to specify which material part must be marked as dirty
  120825. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  120826. */
  120827. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  120828. /** @hidden */
  120829. _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;
  120830. /** @hidden */
  120831. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120832. /** @hidden */
  120833. _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;
  120834. /** @hidden */
  120835. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  120836. /** @hidden */
  120837. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  120838. /** @hidden */
  120839. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120840. }
  120841. }
  120842. declare module BABYLON {
  120843. /**
  120844. * Set of assets to keep when moving a scene into an asset container.
  120845. */
  120846. export class KeepAssets extends AbstractScene {
  120847. }
  120848. /**
  120849. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  120850. */
  120851. export class InstantiatedEntries {
  120852. /**
  120853. * List of new root nodes (eg. nodes with no parent)
  120854. */
  120855. rootNodes: TransformNode[];
  120856. /**
  120857. * List of new skeletons
  120858. */
  120859. skeletons: Skeleton[];
  120860. /**
  120861. * List of new animation groups
  120862. */
  120863. animationGroups: AnimationGroup[];
  120864. }
  120865. /**
  120866. * Container with a set of assets that can be added or removed from a scene.
  120867. */
  120868. export class AssetContainer extends AbstractScene {
  120869. private _wasAddedToScene;
  120870. /**
  120871. * The scene the AssetContainer belongs to.
  120872. */
  120873. scene: Scene;
  120874. /**
  120875. * Instantiates an AssetContainer.
  120876. * @param scene The scene the AssetContainer belongs to.
  120877. */
  120878. constructor(scene: Scene);
  120879. /**
  120880. * Instantiate or clone all meshes and add the new ones to the scene.
  120881. * Skeletons and animation groups will all be cloned
  120882. * @param nameFunction defines an optional function used to get new names for clones
  120883. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  120884. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  120885. */
  120886. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  120887. /**
  120888. * Adds all the assets from the container to the scene.
  120889. */
  120890. addAllToScene(): void;
  120891. /**
  120892. * Removes all the assets in the container from the scene
  120893. */
  120894. removeAllFromScene(): void;
  120895. /**
  120896. * Disposes all the assets in the container
  120897. */
  120898. dispose(): void;
  120899. private _moveAssets;
  120900. /**
  120901. * Removes all the assets contained in the scene and adds them to the container.
  120902. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  120903. */
  120904. moveAllFromScene(keepAssets?: KeepAssets): void;
  120905. /**
  120906. * 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.
  120907. * @returns the root mesh
  120908. */
  120909. createRootMesh(): Mesh;
  120910. /**
  120911. * Merge animations (direct and animation groups) from this asset container into a scene
  120912. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  120913. * @param animatables set of animatables to retarget to a node from the scene
  120914. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  120915. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  120916. */
  120917. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  120918. }
  120919. }
  120920. declare module BABYLON {
  120921. /**
  120922. * Defines how the parser contract is defined.
  120923. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  120924. */
  120925. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  120926. /**
  120927. * Defines how the individual parser contract is defined.
  120928. * These parser can parse an individual asset
  120929. */
  120930. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  120931. /**
  120932. * Base class of the scene acting as a container for the different elements composing a scene.
  120933. * This class is dynamically extended by the different components of the scene increasing
  120934. * flexibility and reducing coupling
  120935. */
  120936. export abstract class AbstractScene {
  120937. /**
  120938. * Stores the list of available parsers in the application.
  120939. */
  120940. private static _BabylonFileParsers;
  120941. /**
  120942. * Stores the list of available individual parsers in the application.
  120943. */
  120944. private static _IndividualBabylonFileParsers;
  120945. /**
  120946. * Adds a parser in the list of available ones
  120947. * @param name Defines the name of the parser
  120948. * @param parser Defines the parser to add
  120949. */
  120950. static AddParser(name: string, parser: BabylonFileParser): void;
  120951. /**
  120952. * Gets a general parser from the list of avaialble ones
  120953. * @param name Defines the name of the parser
  120954. * @returns the requested parser or null
  120955. */
  120956. static GetParser(name: string): Nullable<BabylonFileParser>;
  120957. /**
  120958. * Adds n individual parser in the list of available ones
  120959. * @param name Defines the name of the parser
  120960. * @param parser Defines the parser to add
  120961. */
  120962. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  120963. /**
  120964. * Gets an individual parser from the list of avaialble ones
  120965. * @param name Defines the name of the parser
  120966. * @returns the requested parser or null
  120967. */
  120968. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  120969. /**
  120970. * Parser json data and populate both a scene and its associated container object
  120971. * @param jsonData Defines the data to parse
  120972. * @param scene Defines the scene to parse the data for
  120973. * @param container Defines the container attached to the parsing sequence
  120974. * @param rootUrl Defines the root url of the data
  120975. */
  120976. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  120977. /**
  120978. * Gets the list of root nodes (ie. nodes with no parent)
  120979. */
  120980. rootNodes: Node[];
  120981. /** All of the cameras added to this scene
  120982. * @see https://doc.babylonjs.com/babylon101/cameras
  120983. */
  120984. cameras: Camera[];
  120985. /**
  120986. * All of the lights added to this scene
  120987. * @see https://doc.babylonjs.com/babylon101/lights
  120988. */
  120989. lights: Light[];
  120990. /**
  120991. * All of the (abstract) meshes added to this scene
  120992. */
  120993. meshes: AbstractMesh[];
  120994. /**
  120995. * The list of skeletons added to the scene
  120996. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  120997. */
  120998. skeletons: Skeleton[];
  120999. /**
  121000. * All of the particle systems added to this scene
  121001. * @see https://doc.babylonjs.com/babylon101/particles
  121002. */
  121003. particleSystems: IParticleSystem[];
  121004. /**
  121005. * Gets a list of Animations associated with the scene
  121006. */
  121007. animations: Animation[];
  121008. /**
  121009. * All of the animation groups added to this scene
  121010. * @see https://doc.babylonjs.com/how_to/group
  121011. */
  121012. animationGroups: AnimationGroup[];
  121013. /**
  121014. * All of the multi-materials added to this scene
  121015. * @see https://doc.babylonjs.com/how_to/multi_materials
  121016. */
  121017. multiMaterials: MultiMaterial[];
  121018. /**
  121019. * All of the materials added to this scene
  121020. * In the context of a Scene, it is not supposed to be modified manually.
  121021. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  121022. * Note also that the order of the Material within the array is not significant and might change.
  121023. * @see https://doc.babylonjs.com/babylon101/materials
  121024. */
  121025. materials: Material[];
  121026. /**
  121027. * The list of morph target managers added to the scene
  121028. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  121029. */
  121030. morphTargetManagers: MorphTargetManager[];
  121031. /**
  121032. * The list of geometries used in the scene.
  121033. */
  121034. geometries: Geometry[];
  121035. /**
  121036. * All of the tranform nodes added to this scene
  121037. * In the context of a Scene, it is not supposed to be modified manually.
  121038. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  121039. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  121040. * @see https://doc.babylonjs.com/how_to/transformnode
  121041. */
  121042. transformNodes: TransformNode[];
  121043. /**
  121044. * ActionManagers available on the scene.
  121045. */
  121046. actionManagers: AbstractActionManager[];
  121047. /**
  121048. * Textures to keep.
  121049. */
  121050. textures: BaseTexture[];
  121051. /** @hidden */
  121052. protected _environmentTexture: Nullable<BaseTexture>;
  121053. /**
  121054. * Texture used in all pbr material as the reflection texture.
  121055. * As in the majority of the scene they are the same (exception for multi room and so on),
  121056. * this is easier to reference from here than from all the materials.
  121057. */
  121058. get environmentTexture(): Nullable<BaseTexture>;
  121059. set environmentTexture(value: Nullable<BaseTexture>);
  121060. /**
  121061. * The list of postprocesses added to the scene
  121062. */
  121063. postProcesses: PostProcess[];
  121064. /**
  121065. * @returns all meshes, lights, cameras, transformNodes and bones
  121066. */
  121067. getNodes(): Array<Node>;
  121068. }
  121069. }
  121070. declare module BABYLON {
  121071. /**
  121072. * Interface used to define options for Sound class
  121073. */
  121074. export interface ISoundOptions {
  121075. /**
  121076. * Does the sound autoplay once loaded.
  121077. */
  121078. autoplay?: boolean;
  121079. /**
  121080. * Does the sound loop after it finishes playing once.
  121081. */
  121082. loop?: boolean;
  121083. /**
  121084. * Sound's volume
  121085. */
  121086. volume?: number;
  121087. /**
  121088. * Is it a spatial sound?
  121089. */
  121090. spatialSound?: boolean;
  121091. /**
  121092. * Maximum distance to hear that sound
  121093. */
  121094. maxDistance?: number;
  121095. /**
  121096. * Uses user defined attenuation function
  121097. */
  121098. useCustomAttenuation?: boolean;
  121099. /**
  121100. * Define the roll off factor of spatial sounds.
  121101. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121102. */
  121103. rolloffFactor?: number;
  121104. /**
  121105. * Define the reference distance the sound should be heard perfectly.
  121106. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121107. */
  121108. refDistance?: number;
  121109. /**
  121110. * Define the distance attenuation model the sound will follow.
  121111. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121112. */
  121113. distanceModel?: string;
  121114. /**
  121115. * Defines the playback speed (1 by default)
  121116. */
  121117. playbackRate?: number;
  121118. /**
  121119. * Defines if the sound is from a streaming source
  121120. */
  121121. streaming?: boolean;
  121122. /**
  121123. * Defines an optional length (in seconds) inside the sound file
  121124. */
  121125. length?: number;
  121126. /**
  121127. * Defines an optional offset (in seconds) inside the sound file
  121128. */
  121129. offset?: number;
  121130. /**
  121131. * If true, URLs will not be required to state the audio file codec to use.
  121132. */
  121133. skipCodecCheck?: boolean;
  121134. }
  121135. /**
  121136. * Defines a sound that can be played in the application.
  121137. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  121138. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121139. */
  121140. export class Sound {
  121141. /**
  121142. * The name of the sound in the scene.
  121143. */
  121144. name: string;
  121145. /**
  121146. * Does the sound autoplay once loaded.
  121147. */
  121148. autoplay: boolean;
  121149. /**
  121150. * Does the sound loop after it finishes playing once.
  121151. */
  121152. loop: boolean;
  121153. /**
  121154. * Does the sound use a custom attenuation curve to simulate the falloff
  121155. * happening when the source gets further away from the camera.
  121156. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121157. */
  121158. useCustomAttenuation: boolean;
  121159. /**
  121160. * The sound track id this sound belongs to.
  121161. */
  121162. soundTrackId: number;
  121163. /**
  121164. * Is this sound currently played.
  121165. */
  121166. isPlaying: boolean;
  121167. /**
  121168. * Is this sound currently paused.
  121169. */
  121170. isPaused: boolean;
  121171. /**
  121172. * Does this sound enables spatial sound.
  121173. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121174. */
  121175. spatialSound: boolean;
  121176. /**
  121177. * Define the reference distance the sound should be heard perfectly.
  121178. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121179. */
  121180. refDistance: number;
  121181. /**
  121182. * Define the roll off factor of spatial sounds.
  121183. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121184. */
  121185. rolloffFactor: number;
  121186. /**
  121187. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  121188. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121189. */
  121190. maxDistance: number;
  121191. /**
  121192. * Define the distance attenuation model the sound will follow.
  121193. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121194. */
  121195. distanceModel: string;
  121196. /**
  121197. * @hidden
  121198. * Back Compat
  121199. **/
  121200. onended: () => any;
  121201. /**
  121202. * Gets or sets an object used to store user defined information for the sound.
  121203. */
  121204. metadata: any;
  121205. /**
  121206. * Observable event when the current playing sound finishes.
  121207. */
  121208. onEndedObservable: Observable<Sound>;
  121209. private _panningModel;
  121210. private _playbackRate;
  121211. private _streaming;
  121212. private _startTime;
  121213. private _startOffset;
  121214. private _position;
  121215. /** @hidden */
  121216. _positionInEmitterSpace: boolean;
  121217. private _localDirection;
  121218. private _volume;
  121219. private _isReadyToPlay;
  121220. private _isDirectional;
  121221. private _readyToPlayCallback;
  121222. private _audioBuffer;
  121223. private _soundSource;
  121224. private _streamingSource;
  121225. private _soundPanner;
  121226. private _soundGain;
  121227. private _inputAudioNode;
  121228. private _outputAudioNode;
  121229. private _coneInnerAngle;
  121230. private _coneOuterAngle;
  121231. private _coneOuterGain;
  121232. private _scene;
  121233. private _connectedTransformNode;
  121234. private _customAttenuationFunction;
  121235. private _registerFunc;
  121236. private _isOutputConnected;
  121237. private _htmlAudioElement;
  121238. private _urlType;
  121239. private _length?;
  121240. private _offset?;
  121241. /** @hidden */
  121242. static _SceneComponentInitialization: (scene: Scene) => void;
  121243. /**
  121244. * Create a sound and attach it to a scene
  121245. * @param name Name of your sound
  121246. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  121247. * @param scene defines the scene the sound belongs to
  121248. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  121249. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  121250. */
  121251. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  121252. /**
  121253. * Release the sound and its associated resources
  121254. */
  121255. dispose(): void;
  121256. /**
  121257. * Gets if the sounds is ready to be played or not.
  121258. * @returns true if ready, otherwise false
  121259. */
  121260. isReady(): boolean;
  121261. private _soundLoaded;
  121262. /**
  121263. * Sets the data of the sound from an audiobuffer
  121264. * @param audioBuffer The audioBuffer containing the data
  121265. */
  121266. setAudioBuffer(audioBuffer: AudioBuffer): void;
  121267. /**
  121268. * Updates the current sounds options such as maxdistance, loop...
  121269. * @param options A JSON object containing values named as the object properties
  121270. */
  121271. updateOptions(options: ISoundOptions): void;
  121272. private _createSpatialParameters;
  121273. private _updateSpatialParameters;
  121274. /**
  121275. * Switch the panning model to HRTF:
  121276. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121277. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121278. */
  121279. switchPanningModelToHRTF(): void;
  121280. /**
  121281. * Switch the panning model to Equal Power:
  121282. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121283. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121284. */
  121285. switchPanningModelToEqualPower(): void;
  121286. private _switchPanningModel;
  121287. /**
  121288. * Connect this sound to a sound track audio node like gain...
  121289. * @param soundTrackAudioNode the sound track audio node to connect to
  121290. */
  121291. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  121292. /**
  121293. * Transform this sound into a directional source
  121294. * @param coneInnerAngle Size of the inner cone in degree
  121295. * @param coneOuterAngle Size of the outer cone in degree
  121296. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  121297. */
  121298. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  121299. /**
  121300. * Gets or sets the inner angle for the directional cone.
  121301. */
  121302. get directionalConeInnerAngle(): number;
  121303. /**
  121304. * Gets or sets the inner angle for the directional cone.
  121305. */
  121306. set directionalConeInnerAngle(value: number);
  121307. /**
  121308. * Gets or sets the outer angle for the directional cone.
  121309. */
  121310. get directionalConeOuterAngle(): number;
  121311. /**
  121312. * Gets or sets the outer angle for the directional cone.
  121313. */
  121314. set directionalConeOuterAngle(value: number);
  121315. /**
  121316. * Sets the position of the emitter if spatial sound is enabled
  121317. * @param newPosition Defines the new posisiton
  121318. */
  121319. setPosition(newPosition: Vector3): void;
  121320. /**
  121321. * Sets the local direction of the emitter if spatial sound is enabled
  121322. * @param newLocalDirection Defines the new local direction
  121323. */
  121324. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  121325. private _updateDirection;
  121326. /** @hidden */
  121327. updateDistanceFromListener(): void;
  121328. /**
  121329. * Sets a new custom attenuation function for the sound.
  121330. * @param callback Defines the function used for the attenuation
  121331. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121332. */
  121333. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  121334. /**
  121335. * Play the sound
  121336. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  121337. * @param offset (optional) Start the sound at a specific time in seconds
  121338. * @param length (optional) Sound duration (in seconds)
  121339. */
  121340. play(time?: number, offset?: number, length?: number): void;
  121341. private _onended;
  121342. /**
  121343. * Stop the sound
  121344. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  121345. */
  121346. stop(time?: number): void;
  121347. /**
  121348. * Put the sound in pause
  121349. */
  121350. pause(): void;
  121351. /**
  121352. * Sets a dedicated volume for this sounds
  121353. * @param newVolume Define the new volume of the sound
  121354. * @param time Define time for gradual change to new volume
  121355. */
  121356. setVolume(newVolume: number, time?: number): void;
  121357. /**
  121358. * Set the sound play back rate
  121359. * @param newPlaybackRate Define the playback rate the sound should be played at
  121360. */
  121361. setPlaybackRate(newPlaybackRate: number): void;
  121362. /**
  121363. * Gets the volume of the sound.
  121364. * @returns the volume of the sound
  121365. */
  121366. getVolume(): number;
  121367. /**
  121368. * Attach the sound to a dedicated mesh
  121369. * @param transformNode The transform node to connect the sound with
  121370. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121371. */
  121372. attachToMesh(transformNode: TransformNode): void;
  121373. /**
  121374. * Detach the sound from the previously attached mesh
  121375. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121376. */
  121377. detachFromMesh(): void;
  121378. private _onRegisterAfterWorldMatrixUpdate;
  121379. /**
  121380. * Clone the current sound in the scene.
  121381. * @returns the new sound clone
  121382. */
  121383. clone(): Nullable<Sound>;
  121384. /**
  121385. * Gets the current underlying audio buffer containing the data
  121386. * @returns the audio buffer
  121387. */
  121388. getAudioBuffer(): Nullable<AudioBuffer>;
  121389. /**
  121390. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  121391. * @returns the source node
  121392. */
  121393. getSoundSource(): Nullable<AudioBufferSourceNode>;
  121394. /**
  121395. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  121396. * @returns the gain node
  121397. */
  121398. getSoundGain(): Nullable<GainNode>;
  121399. /**
  121400. * Serializes the Sound in a JSON representation
  121401. * @returns the JSON representation of the sound
  121402. */
  121403. serialize(): any;
  121404. /**
  121405. * Parse a JSON representation of a sound to innstantiate in a given scene
  121406. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  121407. * @param scene Define the scene the new parsed sound should be created in
  121408. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  121409. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  121410. * @returns the newly parsed sound
  121411. */
  121412. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  121413. }
  121414. }
  121415. declare module BABYLON {
  121416. /**
  121417. * This defines an action helpful to play a defined sound on a triggered action.
  121418. */
  121419. export class PlaySoundAction extends Action {
  121420. private _sound;
  121421. /**
  121422. * Instantiate the action
  121423. * @param triggerOptions defines the trigger options
  121424. * @param sound defines the sound to play
  121425. * @param condition defines the trigger related conditions
  121426. */
  121427. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121428. /** @hidden */
  121429. _prepare(): void;
  121430. /**
  121431. * Execute the action and play the sound.
  121432. */
  121433. execute(): void;
  121434. /**
  121435. * Serializes the actions and its related information.
  121436. * @param parent defines the object to serialize in
  121437. * @returns the serialized object
  121438. */
  121439. serialize(parent: any): any;
  121440. }
  121441. /**
  121442. * This defines an action helpful to stop a defined sound on a triggered action.
  121443. */
  121444. export class StopSoundAction extends Action {
  121445. private _sound;
  121446. /**
  121447. * Instantiate the action
  121448. * @param triggerOptions defines the trigger options
  121449. * @param sound defines the sound to stop
  121450. * @param condition defines the trigger related conditions
  121451. */
  121452. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121453. /** @hidden */
  121454. _prepare(): void;
  121455. /**
  121456. * Execute the action and stop the sound.
  121457. */
  121458. execute(): void;
  121459. /**
  121460. * Serializes the actions and its related information.
  121461. * @param parent defines the object to serialize in
  121462. * @returns the serialized object
  121463. */
  121464. serialize(parent: any): any;
  121465. }
  121466. }
  121467. declare module BABYLON {
  121468. /**
  121469. * This defines an action responsible to change the value of a property
  121470. * by interpolating between its current value and the newly set one once triggered.
  121471. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  121472. */
  121473. export class InterpolateValueAction extends Action {
  121474. /**
  121475. * Defines the path of the property where the value should be interpolated
  121476. */
  121477. propertyPath: string;
  121478. /**
  121479. * Defines the target value at the end of the interpolation.
  121480. */
  121481. value: any;
  121482. /**
  121483. * Defines the time it will take for the property to interpolate to the value.
  121484. */
  121485. duration: number;
  121486. /**
  121487. * Defines if the other scene animations should be stopped when the action has been triggered
  121488. */
  121489. stopOtherAnimations?: boolean;
  121490. /**
  121491. * Defines a callback raised once the interpolation animation has been done.
  121492. */
  121493. onInterpolationDone?: () => void;
  121494. /**
  121495. * Observable triggered once the interpolation animation has been done.
  121496. */
  121497. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  121498. private _target;
  121499. private _effectiveTarget;
  121500. private _property;
  121501. /**
  121502. * Instantiate the action
  121503. * @param triggerOptions defines the trigger options
  121504. * @param target defines the object containing the value to interpolate
  121505. * @param propertyPath defines the path to the property in the target object
  121506. * @param value defines the target value at the end of the interpolation
  121507. * @param duration deines the time it will take for the property to interpolate to the value.
  121508. * @param condition defines the trigger related conditions
  121509. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  121510. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  121511. */
  121512. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  121513. /** @hidden */
  121514. _prepare(): void;
  121515. /**
  121516. * Execute the action starts the value interpolation.
  121517. */
  121518. execute(): void;
  121519. /**
  121520. * Serializes the actions and its related information.
  121521. * @param parent defines the object to serialize in
  121522. * @returns the serialized object
  121523. */
  121524. serialize(parent: any): any;
  121525. }
  121526. }
  121527. declare module BABYLON {
  121528. /**
  121529. * Options allowed during the creation of a sound track.
  121530. */
  121531. export interface ISoundTrackOptions {
  121532. /**
  121533. * The volume the sound track should take during creation
  121534. */
  121535. volume?: number;
  121536. /**
  121537. * Define if the sound track is the main sound track of the scene
  121538. */
  121539. mainTrack?: boolean;
  121540. }
  121541. /**
  121542. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  121543. * It will be also used in a future release to apply effects on a specific track.
  121544. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121545. */
  121546. export class SoundTrack {
  121547. /**
  121548. * The unique identifier of the sound track in the scene.
  121549. */
  121550. id: number;
  121551. /**
  121552. * The list of sounds included in the sound track.
  121553. */
  121554. soundCollection: Array<Sound>;
  121555. private _outputAudioNode;
  121556. private _scene;
  121557. private _connectedAnalyser;
  121558. private _options;
  121559. private _isInitialized;
  121560. /**
  121561. * Creates a new sound track.
  121562. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121563. * @param scene Define the scene the sound track belongs to
  121564. * @param options
  121565. */
  121566. constructor(scene: Scene, options?: ISoundTrackOptions);
  121567. private _initializeSoundTrackAudioGraph;
  121568. /**
  121569. * Release the sound track and its associated resources
  121570. */
  121571. dispose(): void;
  121572. /**
  121573. * Adds a sound to this sound track
  121574. * @param sound define the cound to add
  121575. * @ignoreNaming
  121576. */
  121577. AddSound(sound: Sound): void;
  121578. /**
  121579. * Removes a sound to this sound track
  121580. * @param sound define the cound to remove
  121581. * @ignoreNaming
  121582. */
  121583. RemoveSound(sound: Sound): void;
  121584. /**
  121585. * Set a global volume for the full sound track.
  121586. * @param newVolume Define the new volume of the sound track
  121587. */
  121588. setVolume(newVolume: number): void;
  121589. /**
  121590. * Switch the panning model to HRTF:
  121591. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121592. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121593. */
  121594. switchPanningModelToHRTF(): void;
  121595. /**
  121596. * Switch the panning model to Equal Power:
  121597. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121598. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121599. */
  121600. switchPanningModelToEqualPower(): void;
  121601. /**
  121602. * Connect the sound track to an audio analyser allowing some amazing
  121603. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  121604. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  121605. * @param analyser The analyser to connect to the engine
  121606. */
  121607. connectToAnalyser(analyser: Analyser): void;
  121608. }
  121609. }
  121610. declare module BABYLON {
  121611. interface AbstractScene {
  121612. /**
  121613. * The list of sounds used in the scene.
  121614. */
  121615. sounds: Nullable<Array<Sound>>;
  121616. }
  121617. interface Scene {
  121618. /**
  121619. * @hidden
  121620. * Backing field
  121621. */
  121622. _mainSoundTrack: SoundTrack;
  121623. /**
  121624. * The main sound track played by the scene.
  121625. * It cotains your primary collection of sounds.
  121626. */
  121627. mainSoundTrack: SoundTrack;
  121628. /**
  121629. * The list of sound tracks added to the scene
  121630. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121631. */
  121632. soundTracks: Nullable<Array<SoundTrack>>;
  121633. /**
  121634. * Gets a sound using a given name
  121635. * @param name defines the name to search for
  121636. * @return the found sound or null if not found at all.
  121637. */
  121638. getSoundByName(name: string): Nullable<Sound>;
  121639. /**
  121640. * Gets or sets if audio support is enabled
  121641. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121642. */
  121643. audioEnabled: boolean;
  121644. /**
  121645. * Gets or sets if audio will be output to headphones
  121646. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121647. */
  121648. headphone: boolean;
  121649. /**
  121650. * Gets or sets custom audio listener position provider
  121651. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121652. */
  121653. audioListenerPositionProvider: Nullable<() => Vector3>;
  121654. /**
  121655. * Gets or sets a refresh rate when using 3D audio positioning
  121656. */
  121657. audioPositioningRefreshRate: number;
  121658. }
  121659. /**
  121660. * Defines the sound scene component responsible to manage any sounds
  121661. * in a given scene.
  121662. */
  121663. export class AudioSceneComponent implements ISceneSerializableComponent {
  121664. /**
  121665. * The component name helpfull to identify the component in the list of scene components.
  121666. */
  121667. readonly name: string;
  121668. /**
  121669. * The scene the component belongs to.
  121670. */
  121671. scene: Scene;
  121672. private _audioEnabled;
  121673. /**
  121674. * Gets whether audio is enabled or not.
  121675. * Please use related enable/disable method to switch state.
  121676. */
  121677. get audioEnabled(): boolean;
  121678. private _headphone;
  121679. /**
  121680. * Gets whether audio is outputing to headphone or not.
  121681. * Please use the according Switch methods to change output.
  121682. */
  121683. get headphone(): boolean;
  121684. /**
  121685. * Gets or sets a refresh rate when using 3D audio positioning
  121686. */
  121687. audioPositioningRefreshRate: number;
  121688. private _audioListenerPositionProvider;
  121689. /**
  121690. * Gets the current audio listener position provider
  121691. */
  121692. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  121693. /**
  121694. * Sets a custom listener position for all sounds in the scene
  121695. * By default, this is the position of the first active camera
  121696. */
  121697. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  121698. /**
  121699. * Creates a new instance of the component for the given scene
  121700. * @param scene Defines the scene to register the component in
  121701. */
  121702. constructor(scene: Scene);
  121703. /**
  121704. * Registers the component in a given scene
  121705. */
  121706. register(): void;
  121707. /**
  121708. * Rebuilds the elements related to this component in case of
  121709. * context lost for instance.
  121710. */
  121711. rebuild(): void;
  121712. /**
  121713. * Serializes the component data to the specified json object
  121714. * @param serializationObject The object to serialize to
  121715. */
  121716. serialize(serializationObject: any): void;
  121717. /**
  121718. * Adds all the elements from the container to the scene
  121719. * @param container the container holding the elements
  121720. */
  121721. addFromContainer(container: AbstractScene): void;
  121722. /**
  121723. * Removes all the elements in the container from the scene
  121724. * @param container contains the elements to remove
  121725. * @param dispose if the removed element should be disposed (default: false)
  121726. */
  121727. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  121728. /**
  121729. * Disposes the component and the associated ressources.
  121730. */
  121731. dispose(): void;
  121732. /**
  121733. * Disables audio in the associated scene.
  121734. */
  121735. disableAudio(): void;
  121736. /**
  121737. * Enables audio in the associated scene.
  121738. */
  121739. enableAudio(): void;
  121740. /**
  121741. * Switch audio to headphone output.
  121742. */
  121743. switchAudioModeForHeadphones(): void;
  121744. /**
  121745. * Switch audio to normal speakers.
  121746. */
  121747. switchAudioModeForNormalSpeakers(): void;
  121748. private _cachedCameraDirection;
  121749. private _cachedCameraPosition;
  121750. private _lastCheck;
  121751. private _afterRender;
  121752. }
  121753. }
  121754. declare module BABYLON {
  121755. /**
  121756. * Wraps one or more Sound objects and selects one with random weight for playback.
  121757. */
  121758. export class WeightedSound {
  121759. /** When true a Sound will be selected and played when the current playing Sound completes. */
  121760. loop: boolean;
  121761. private _coneInnerAngle;
  121762. private _coneOuterAngle;
  121763. private _volume;
  121764. /** A Sound is currently playing. */
  121765. isPlaying: boolean;
  121766. /** A Sound is currently paused. */
  121767. isPaused: boolean;
  121768. private _sounds;
  121769. private _weights;
  121770. private _currentIndex?;
  121771. /**
  121772. * Creates a new WeightedSound from the list of sounds given.
  121773. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  121774. * @param sounds Array of Sounds that will be selected from.
  121775. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  121776. */
  121777. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  121778. /**
  121779. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  121780. */
  121781. get directionalConeInnerAngle(): number;
  121782. /**
  121783. * The size of cone in degress for a directional sound in which there will be no attenuation.
  121784. */
  121785. set directionalConeInnerAngle(value: number);
  121786. /**
  121787. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121788. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121789. */
  121790. get directionalConeOuterAngle(): number;
  121791. /**
  121792. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121793. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121794. */
  121795. set directionalConeOuterAngle(value: number);
  121796. /**
  121797. * Playback volume.
  121798. */
  121799. get volume(): number;
  121800. /**
  121801. * Playback volume.
  121802. */
  121803. set volume(value: number);
  121804. private _onended;
  121805. /**
  121806. * Suspend playback
  121807. */
  121808. pause(): void;
  121809. /**
  121810. * Stop playback
  121811. */
  121812. stop(): void;
  121813. /**
  121814. * Start playback.
  121815. * @param startOffset Position the clip head at a specific time in seconds.
  121816. */
  121817. play(startOffset?: number): void;
  121818. }
  121819. }
  121820. declare module BABYLON {
  121821. /**
  121822. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  121823. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121824. */
  121825. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  121826. /**
  121827. * Gets the name of the behavior.
  121828. */
  121829. get name(): string;
  121830. /**
  121831. * The easing function used by animations
  121832. */
  121833. static EasingFunction: BackEase;
  121834. /**
  121835. * The easing mode used by animations
  121836. */
  121837. static EasingMode: number;
  121838. /**
  121839. * The duration of the animation, in milliseconds
  121840. */
  121841. transitionDuration: number;
  121842. /**
  121843. * Length of the distance animated by the transition when lower radius is reached
  121844. */
  121845. lowerRadiusTransitionRange: number;
  121846. /**
  121847. * Length of the distance animated by the transition when upper radius is reached
  121848. */
  121849. upperRadiusTransitionRange: number;
  121850. private _autoTransitionRange;
  121851. /**
  121852. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121853. */
  121854. get autoTransitionRange(): boolean;
  121855. /**
  121856. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121857. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  121858. */
  121859. set autoTransitionRange(value: boolean);
  121860. private _attachedCamera;
  121861. private _onAfterCheckInputsObserver;
  121862. private _onMeshTargetChangedObserver;
  121863. /**
  121864. * Initializes the behavior.
  121865. */
  121866. init(): void;
  121867. /**
  121868. * Attaches the behavior to its arc rotate camera.
  121869. * @param camera Defines the camera to attach the behavior to
  121870. */
  121871. attach(camera: ArcRotateCamera): void;
  121872. /**
  121873. * Detaches the behavior from its current arc rotate camera.
  121874. */
  121875. detach(): void;
  121876. private _radiusIsAnimating;
  121877. private _radiusBounceTransition;
  121878. private _animatables;
  121879. private _cachedWheelPrecision;
  121880. /**
  121881. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  121882. * @param radiusLimit The limit to check against.
  121883. * @return Bool to indicate if at limit.
  121884. */
  121885. private _isRadiusAtLimit;
  121886. /**
  121887. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  121888. * @param radiusDelta The delta by which to animate to. Can be negative.
  121889. */
  121890. private _applyBoundRadiusAnimation;
  121891. /**
  121892. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  121893. */
  121894. protected _clearAnimationLocks(): void;
  121895. /**
  121896. * Stops and removes all animations that have been applied to the camera
  121897. */
  121898. stopAllAnimations(): void;
  121899. }
  121900. }
  121901. declare module BABYLON {
  121902. /**
  121903. * 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.
  121904. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121905. */
  121906. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  121907. /**
  121908. * Gets the name of the behavior.
  121909. */
  121910. get name(): string;
  121911. private _mode;
  121912. private _radiusScale;
  121913. private _positionScale;
  121914. private _defaultElevation;
  121915. private _elevationReturnTime;
  121916. private _elevationReturnWaitTime;
  121917. private _zoomStopsAnimation;
  121918. private _framingTime;
  121919. /**
  121920. * The easing function used by animations
  121921. */
  121922. static EasingFunction: ExponentialEase;
  121923. /**
  121924. * The easing mode used by animations
  121925. */
  121926. static EasingMode: number;
  121927. /**
  121928. * Sets the current mode used by the behavior
  121929. */
  121930. set mode(mode: number);
  121931. /**
  121932. * Gets current mode used by the behavior.
  121933. */
  121934. get mode(): number;
  121935. /**
  121936. * Sets the scale applied to the radius (1 by default)
  121937. */
  121938. set radiusScale(radius: number);
  121939. /**
  121940. * Gets the scale applied to the radius
  121941. */
  121942. get radiusScale(): number;
  121943. /**
  121944. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121945. */
  121946. set positionScale(scale: number);
  121947. /**
  121948. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121949. */
  121950. get positionScale(): number;
  121951. /**
  121952. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121953. * behaviour is triggered, in radians.
  121954. */
  121955. set defaultElevation(elevation: number);
  121956. /**
  121957. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121958. * behaviour is triggered, in radians.
  121959. */
  121960. get defaultElevation(): number;
  121961. /**
  121962. * Sets the time (in milliseconds) taken to return to the default beta position.
  121963. * Negative value indicates camera should not return to default.
  121964. */
  121965. set elevationReturnTime(speed: number);
  121966. /**
  121967. * Gets the time (in milliseconds) taken to return to the default beta position.
  121968. * Negative value indicates camera should not return to default.
  121969. */
  121970. get elevationReturnTime(): number;
  121971. /**
  121972. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121973. */
  121974. set elevationReturnWaitTime(time: number);
  121975. /**
  121976. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121977. */
  121978. get elevationReturnWaitTime(): number;
  121979. /**
  121980. * Sets the flag that indicates if user zooming should stop animation.
  121981. */
  121982. set zoomStopsAnimation(flag: boolean);
  121983. /**
  121984. * Gets the flag that indicates if user zooming should stop animation.
  121985. */
  121986. get zoomStopsAnimation(): boolean;
  121987. /**
  121988. * Sets the transition time when framing the mesh, in milliseconds
  121989. */
  121990. set framingTime(time: number);
  121991. /**
  121992. * Gets the transition time when framing the mesh, in milliseconds
  121993. */
  121994. get framingTime(): number;
  121995. /**
  121996. * Define if the behavior should automatically change the configured
  121997. * camera limits and sensibilities.
  121998. */
  121999. autoCorrectCameraLimitsAndSensibility: boolean;
  122000. private _onPrePointerObservableObserver;
  122001. private _onAfterCheckInputsObserver;
  122002. private _onMeshTargetChangedObserver;
  122003. private _attachedCamera;
  122004. private _isPointerDown;
  122005. private _lastInteractionTime;
  122006. /**
  122007. * Initializes the behavior.
  122008. */
  122009. init(): void;
  122010. /**
  122011. * Attaches the behavior to its arc rotate camera.
  122012. * @param camera Defines the camera to attach the behavior to
  122013. */
  122014. attach(camera: ArcRotateCamera): void;
  122015. /**
  122016. * Detaches the behavior from its current arc rotate camera.
  122017. */
  122018. detach(): void;
  122019. private _animatables;
  122020. private _betaIsAnimating;
  122021. private _betaTransition;
  122022. private _radiusTransition;
  122023. private _vectorTransition;
  122024. /**
  122025. * Targets the given mesh and updates zoom level accordingly.
  122026. * @param mesh The mesh to target.
  122027. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122028. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122029. */
  122030. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122031. /**
  122032. * Targets the given mesh with its children and updates zoom level accordingly.
  122033. * @param mesh The mesh to target.
  122034. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122035. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122036. */
  122037. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122038. /**
  122039. * Targets the given meshes with their children and updates zoom level accordingly.
  122040. * @param meshes The mesh to target.
  122041. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122042. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122043. */
  122044. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122045. /**
  122046. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  122047. * @param minimumWorld Determines the smaller position of the bounding box extend
  122048. * @param maximumWorld Determines the bigger position of the bounding box extend
  122049. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122050. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122051. */
  122052. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122053. /**
  122054. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  122055. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  122056. * frustum width.
  122057. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  122058. * to fully enclose the mesh in the viewing frustum.
  122059. */
  122060. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  122061. /**
  122062. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  122063. * is automatically returned to its default position (expected to be above ground plane).
  122064. */
  122065. private _maintainCameraAboveGround;
  122066. /**
  122067. * Returns the frustum slope based on the canvas ratio and camera FOV
  122068. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  122069. */
  122070. private _getFrustumSlope;
  122071. /**
  122072. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  122073. */
  122074. private _clearAnimationLocks;
  122075. /**
  122076. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122077. */
  122078. private _applyUserInteraction;
  122079. /**
  122080. * Stops and removes all animations that have been applied to the camera
  122081. */
  122082. stopAllAnimations(): void;
  122083. /**
  122084. * Gets a value indicating if the user is moving the camera
  122085. */
  122086. get isUserIsMoving(): boolean;
  122087. /**
  122088. * The camera can move all the way towards the mesh.
  122089. */
  122090. static IgnoreBoundsSizeMode: number;
  122091. /**
  122092. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  122093. */
  122094. static FitFrustumSidesMode: number;
  122095. }
  122096. }
  122097. declare module BABYLON {
  122098. /**
  122099. * Base class for Camera Pointer Inputs.
  122100. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  122101. * for example usage.
  122102. */
  122103. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  122104. /**
  122105. * Defines the camera the input is attached to.
  122106. */
  122107. abstract camera: Camera;
  122108. /**
  122109. * Whether keyboard modifier keys are pressed at time of last mouse event.
  122110. */
  122111. protected _altKey: boolean;
  122112. protected _ctrlKey: boolean;
  122113. protected _metaKey: boolean;
  122114. protected _shiftKey: boolean;
  122115. /**
  122116. * Which mouse buttons were pressed at time of last mouse event.
  122117. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  122118. */
  122119. protected _buttonsPressed: number;
  122120. /**
  122121. * Defines the buttons associated with the input to handle camera move.
  122122. */
  122123. buttons: number[];
  122124. /**
  122125. * Attach the input controls to a specific dom element to get the input from.
  122126. * @param element Defines the element the controls should be listened from
  122127. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122128. */
  122129. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122130. /**
  122131. * Detach the current controls from the specified dom element.
  122132. * @param element Defines the element to stop listening the inputs from
  122133. */
  122134. detachControl(element: Nullable<HTMLElement>): void;
  122135. /**
  122136. * Gets the class name of the current input.
  122137. * @returns the class name
  122138. */
  122139. getClassName(): string;
  122140. /**
  122141. * Get the friendly name associated with the input class.
  122142. * @returns the input friendly name
  122143. */
  122144. getSimpleName(): string;
  122145. /**
  122146. * Called on pointer POINTERDOUBLETAP event.
  122147. * Override this method to provide functionality on POINTERDOUBLETAP event.
  122148. */
  122149. protected onDoubleTap(type: string): void;
  122150. /**
  122151. * Called on pointer POINTERMOVE event if only a single touch is active.
  122152. * Override this method to provide functionality.
  122153. */
  122154. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122155. /**
  122156. * Called on pointer POINTERMOVE event if multiple touches are active.
  122157. * Override this method to provide functionality.
  122158. */
  122159. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122160. /**
  122161. * Called on JS contextmenu event.
  122162. * Override this method to provide functionality.
  122163. */
  122164. protected onContextMenu(evt: PointerEvent): void;
  122165. /**
  122166. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122167. * press.
  122168. * Override this method to provide functionality.
  122169. */
  122170. protected onButtonDown(evt: PointerEvent): void;
  122171. /**
  122172. * Called each time a new POINTERUP event occurs. Ie, for each button
  122173. * release.
  122174. * Override this method to provide functionality.
  122175. */
  122176. protected onButtonUp(evt: PointerEvent): void;
  122177. /**
  122178. * Called when window becomes inactive.
  122179. * Override this method to provide functionality.
  122180. */
  122181. protected onLostFocus(): void;
  122182. private _pointerInput;
  122183. private _observer;
  122184. private _onLostFocus;
  122185. private pointA;
  122186. private pointB;
  122187. }
  122188. }
  122189. declare module BABYLON {
  122190. /**
  122191. * Manage the pointers inputs to control an arc rotate camera.
  122192. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122193. */
  122194. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  122195. /**
  122196. * Defines the camera the input is attached to.
  122197. */
  122198. camera: ArcRotateCamera;
  122199. /**
  122200. * Gets the class name of the current input.
  122201. * @returns the class name
  122202. */
  122203. getClassName(): string;
  122204. /**
  122205. * Defines the buttons associated with the input to handle camera move.
  122206. */
  122207. buttons: number[];
  122208. /**
  122209. * Defines the pointer angular sensibility along the X axis or how fast is
  122210. * the camera rotating.
  122211. */
  122212. angularSensibilityX: number;
  122213. /**
  122214. * Defines the pointer angular sensibility along the Y axis or how fast is
  122215. * the camera rotating.
  122216. */
  122217. angularSensibilityY: number;
  122218. /**
  122219. * Defines the pointer pinch precision or how fast is the camera zooming.
  122220. */
  122221. pinchPrecision: number;
  122222. /**
  122223. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122224. * from 0.
  122225. * It defines the percentage of current camera.radius to use as delta when
  122226. * pinch zoom is used.
  122227. */
  122228. pinchDeltaPercentage: number;
  122229. /**
  122230. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122231. * that any object in the plane at the camera's target point will scale
  122232. * perfectly with finger motion.
  122233. * Overrides pinchDeltaPercentage and pinchPrecision.
  122234. */
  122235. useNaturalPinchZoom: boolean;
  122236. /**
  122237. * Defines the pointer panning sensibility or how fast is the camera moving.
  122238. */
  122239. panningSensibility: number;
  122240. /**
  122241. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  122242. */
  122243. multiTouchPanning: boolean;
  122244. /**
  122245. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  122246. * zoom (pinch) through multitouch.
  122247. */
  122248. multiTouchPanAndZoom: boolean;
  122249. /**
  122250. * Revers pinch action direction.
  122251. */
  122252. pinchInwards: boolean;
  122253. private _isPanClick;
  122254. private _twoFingerActivityCount;
  122255. private _isPinching;
  122256. /**
  122257. * Called on pointer POINTERMOVE event if only a single touch is active.
  122258. */
  122259. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122260. /**
  122261. * Called on pointer POINTERDOUBLETAP event.
  122262. */
  122263. protected onDoubleTap(type: string): void;
  122264. /**
  122265. * Called on pointer POINTERMOVE event if multiple touches are active.
  122266. */
  122267. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122268. /**
  122269. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122270. * press.
  122271. */
  122272. protected onButtonDown(evt: PointerEvent): void;
  122273. /**
  122274. * Called each time a new POINTERUP event occurs. Ie, for each button
  122275. * release.
  122276. */
  122277. protected onButtonUp(evt: PointerEvent): void;
  122278. /**
  122279. * Called when window becomes inactive.
  122280. */
  122281. protected onLostFocus(): void;
  122282. }
  122283. }
  122284. declare module BABYLON {
  122285. /**
  122286. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  122287. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122288. */
  122289. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  122290. /**
  122291. * Defines the camera the input is attached to.
  122292. */
  122293. camera: ArcRotateCamera;
  122294. /**
  122295. * Defines the list of key codes associated with the up action (increase alpha)
  122296. */
  122297. keysUp: number[];
  122298. /**
  122299. * Defines the list of key codes associated with the down action (decrease alpha)
  122300. */
  122301. keysDown: number[];
  122302. /**
  122303. * Defines the list of key codes associated with the left action (increase beta)
  122304. */
  122305. keysLeft: number[];
  122306. /**
  122307. * Defines the list of key codes associated with the right action (decrease beta)
  122308. */
  122309. keysRight: number[];
  122310. /**
  122311. * Defines the list of key codes associated with the reset action.
  122312. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  122313. */
  122314. keysReset: number[];
  122315. /**
  122316. * Defines the panning sensibility of the inputs.
  122317. * (How fast is the camera panning)
  122318. */
  122319. panningSensibility: number;
  122320. /**
  122321. * Defines the zooming sensibility of the inputs.
  122322. * (How fast is the camera zooming)
  122323. */
  122324. zoomingSensibility: number;
  122325. /**
  122326. * Defines whether maintaining the alt key down switch the movement mode from
  122327. * orientation to zoom.
  122328. */
  122329. useAltToZoom: boolean;
  122330. /**
  122331. * Rotation speed of the camera
  122332. */
  122333. angularSpeed: number;
  122334. private _keys;
  122335. private _ctrlPressed;
  122336. private _altPressed;
  122337. private _onCanvasBlurObserver;
  122338. private _onKeyboardObserver;
  122339. private _engine;
  122340. private _scene;
  122341. /**
  122342. * Attach the input controls to a specific dom element to get the input from.
  122343. * @param element Defines the element the controls should be listened from
  122344. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122345. */
  122346. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122347. /**
  122348. * Detach the current controls from the specified dom element.
  122349. * @param element Defines the element to stop listening the inputs from
  122350. */
  122351. detachControl(element: Nullable<HTMLElement>): void;
  122352. /**
  122353. * Update the current camera state depending on the inputs that have been used this frame.
  122354. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122355. */
  122356. checkInputs(): void;
  122357. /**
  122358. * Gets the class name of the current intput.
  122359. * @returns the class name
  122360. */
  122361. getClassName(): string;
  122362. /**
  122363. * Get the friendly name associated with the input class.
  122364. * @returns the input friendly name
  122365. */
  122366. getSimpleName(): string;
  122367. }
  122368. }
  122369. declare module BABYLON {
  122370. /**
  122371. * Manage the mouse wheel inputs to control an arc rotate camera.
  122372. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122373. */
  122374. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  122375. /**
  122376. * Defines the camera the input is attached to.
  122377. */
  122378. camera: ArcRotateCamera;
  122379. /**
  122380. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122381. */
  122382. wheelPrecision: number;
  122383. /**
  122384. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122385. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122386. */
  122387. wheelDeltaPercentage: number;
  122388. private _wheel;
  122389. private _observer;
  122390. private computeDeltaFromMouseWheelLegacyEvent;
  122391. /**
  122392. * Attach the input controls to a specific dom element to get the input from.
  122393. * @param element Defines the element the controls should be listened from
  122394. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122395. */
  122396. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122397. /**
  122398. * Detach the current controls from the specified dom element.
  122399. * @param element Defines the element to stop listening the inputs from
  122400. */
  122401. detachControl(element: Nullable<HTMLElement>): void;
  122402. /**
  122403. * Gets the class name of the current intput.
  122404. * @returns the class name
  122405. */
  122406. getClassName(): string;
  122407. /**
  122408. * Get the friendly name associated with the input class.
  122409. * @returns the input friendly name
  122410. */
  122411. getSimpleName(): string;
  122412. }
  122413. }
  122414. declare module BABYLON {
  122415. /**
  122416. * Default Inputs manager for the ArcRotateCamera.
  122417. * It groups all the default supported inputs for ease of use.
  122418. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122419. */
  122420. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  122421. /**
  122422. * Instantiates a new ArcRotateCameraInputsManager.
  122423. * @param camera Defines the camera the inputs belong to
  122424. */
  122425. constructor(camera: ArcRotateCamera);
  122426. /**
  122427. * Add mouse wheel input support to the input manager.
  122428. * @returns the current input manager
  122429. */
  122430. addMouseWheel(): ArcRotateCameraInputsManager;
  122431. /**
  122432. * Add pointers input support to the input manager.
  122433. * @returns the current input manager
  122434. */
  122435. addPointers(): ArcRotateCameraInputsManager;
  122436. /**
  122437. * Add keyboard input support to the input manager.
  122438. * @returns the current input manager
  122439. */
  122440. addKeyboard(): ArcRotateCameraInputsManager;
  122441. }
  122442. }
  122443. declare module BABYLON {
  122444. /**
  122445. * This represents an orbital type of camera.
  122446. *
  122447. * 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.
  122448. * 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.
  122449. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  122450. */
  122451. export class ArcRotateCamera extends TargetCamera {
  122452. /**
  122453. * Defines the rotation angle of the camera along the longitudinal axis.
  122454. */
  122455. alpha: number;
  122456. /**
  122457. * Defines the rotation angle of the camera along the latitudinal axis.
  122458. */
  122459. beta: number;
  122460. /**
  122461. * Defines the radius of the camera from it s target point.
  122462. */
  122463. radius: number;
  122464. protected _target: Vector3;
  122465. protected _targetHost: Nullable<AbstractMesh>;
  122466. /**
  122467. * Defines the target point of the camera.
  122468. * The camera looks towards it form the radius distance.
  122469. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  122470. */
  122471. get target(): Vector3;
  122472. set target(value: Vector3);
  122473. /**
  122474. * Define the current local position of the camera in the scene
  122475. */
  122476. get position(): Vector3;
  122477. set position(newPosition: Vector3);
  122478. protected _upToYMatrix: Matrix;
  122479. protected _YToUpMatrix: Matrix;
  122480. /**
  122481. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  122482. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  122483. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  122484. */
  122485. set upVector(vec: Vector3);
  122486. get upVector(): Vector3;
  122487. /**
  122488. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  122489. */
  122490. setMatUp(): void;
  122491. /**
  122492. * Current inertia value on the longitudinal axis.
  122493. * The bigger this number the longer it will take for the camera to stop.
  122494. */
  122495. inertialAlphaOffset: number;
  122496. /**
  122497. * Current inertia value on the latitudinal axis.
  122498. * The bigger this number the longer it will take for the camera to stop.
  122499. */
  122500. inertialBetaOffset: number;
  122501. /**
  122502. * Current inertia value on the radius axis.
  122503. * The bigger this number the longer it will take for the camera to stop.
  122504. */
  122505. inertialRadiusOffset: number;
  122506. /**
  122507. * Minimum allowed angle on the longitudinal axis.
  122508. * This can help limiting how the Camera is able to move in the scene.
  122509. */
  122510. lowerAlphaLimit: Nullable<number>;
  122511. /**
  122512. * Maximum allowed angle on the longitudinal axis.
  122513. * This can help limiting how the Camera is able to move in the scene.
  122514. */
  122515. upperAlphaLimit: Nullable<number>;
  122516. /**
  122517. * Minimum allowed angle on the latitudinal axis.
  122518. * This can help limiting how the Camera is able to move in the scene.
  122519. */
  122520. lowerBetaLimit: number;
  122521. /**
  122522. * Maximum allowed angle on the latitudinal axis.
  122523. * This can help limiting how the Camera is able to move in the scene.
  122524. */
  122525. upperBetaLimit: number;
  122526. /**
  122527. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  122528. * This can help limiting how the Camera is able to move in the scene.
  122529. */
  122530. lowerRadiusLimit: Nullable<number>;
  122531. /**
  122532. * Maximum allowed distance of the camera to the target (The camera can not get further).
  122533. * This can help limiting how the Camera is able to move in the scene.
  122534. */
  122535. upperRadiusLimit: Nullable<number>;
  122536. /**
  122537. * Defines the current inertia value used during panning of the camera along the X axis.
  122538. */
  122539. inertialPanningX: number;
  122540. /**
  122541. * Defines the current inertia value used during panning of the camera along the Y axis.
  122542. */
  122543. inertialPanningY: number;
  122544. /**
  122545. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  122546. * Basically if your fingers moves away from more than this distance you will be considered
  122547. * in pinch mode.
  122548. */
  122549. pinchToPanMaxDistance: number;
  122550. /**
  122551. * Defines the maximum distance the camera can pan.
  122552. * This could help keeping the cammera always in your scene.
  122553. */
  122554. panningDistanceLimit: Nullable<number>;
  122555. /**
  122556. * Defines the target of the camera before paning.
  122557. */
  122558. panningOriginTarget: Vector3;
  122559. /**
  122560. * Defines the value of the inertia used during panning.
  122561. * 0 would mean stop inertia and one would mean no decelleration at all.
  122562. */
  122563. panningInertia: number;
  122564. /**
  122565. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  122566. */
  122567. get angularSensibilityX(): number;
  122568. set angularSensibilityX(value: number);
  122569. /**
  122570. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  122571. */
  122572. get angularSensibilityY(): number;
  122573. set angularSensibilityY(value: number);
  122574. /**
  122575. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  122576. */
  122577. get pinchPrecision(): number;
  122578. set pinchPrecision(value: number);
  122579. /**
  122580. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  122581. * It will be used instead of pinchDeltaPrecision if different from 0.
  122582. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122583. */
  122584. get pinchDeltaPercentage(): number;
  122585. set pinchDeltaPercentage(value: number);
  122586. /**
  122587. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  122588. * and pinch delta percentage.
  122589. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122590. * that any object in the plane at the camera's target point will scale
  122591. * perfectly with finger motion.
  122592. */
  122593. get useNaturalPinchZoom(): boolean;
  122594. set useNaturalPinchZoom(value: boolean);
  122595. /**
  122596. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  122597. */
  122598. get panningSensibility(): number;
  122599. set panningSensibility(value: number);
  122600. /**
  122601. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  122602. */
  122603. get keysUp(): number[];
  122604. set keysUp(value: number[]);
  122605. /**
  122606. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  122607. */
  122608. get keysDown(): number[];
  122609. set keysDown(value: number[]);
  122610. /**
  122611. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  122612. */
  122613. get keysLeft(): number[];
  122614. set keysLeft(value: number[]);
  122615. /**
  122616. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  122617. */
  122618. get keysRight(): number[];
  122619. set keysRight(value: number[]);
  122620. /**
  122621. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122622. */
  122623. get wheelPrecision(): number;
  122624. set wheelPrecision(value: number);
  122625. /**
  122626. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  122627. * It will be used instead of pinchDeltaPrecision if different from 0.
  122628. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122629. */
  122630. get wheelDeltaPercentage(): number;
  122631. set wheelDeltaPercentage(value: number);
  122632. /**
  122633. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  122634. */
  122635. zoomOnFactor: number;
  122636. /**
  122637. * Defines a screen offset for the camera position.
  122638. */
  122639. targetScreenOffset: Vector2;
  122640. /**
  122641. * Allows the camera to be completely reversed.
  122642. * If false the camera can not arrive upside down.
  122643. */
  122644. allowUpsideDown: boolean;
  122645. /**
  122646. * Define if double tap/click is used to restore the previously saved state of the camera.
  122647. */
  122648. useInputToRestoreState: boolean;
  122649. /** @hidden */
  122650. _viewMatrix: Matrix;
  122651. /** @hidden */
  122652. _useCtrlForPanning: boolean;
  122653. /** @hidden */
  122654. _panningMouseButton: number;
  122655. /**
  122656. * Defines the input associated to the camera.
  122657. */
  122658. inputs: ArcRotateCameraInputsManager;
  122659. /** @hidden */
  122660. _reset: () => void;
  122661. /**
  122662. * Defines the allowed panning axis.
  122663. */
  122664. panningAxis: Vector3;
  122665. protected _localDirection: Vector3;
  122666. protected _transformedDirection: Vector3;
  122667. private _bouncingBehavior;
  122668. /**
  122669. * Gets the bouncing behavior of the camera if it has been enabled.
  122670. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122671. */
  122672. get bouncingBehavior(): Nullable<BouncingBehavior>;
  122673. /**
  122674. * Defines if the bouncing behavior of the camera is enabled on the camera.
  122675. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122676. */
  122677. get useBouncingBehavior(): boolean;
  122678. set useBouncingBehavior(value: boolean);
  122679. private _framingBehavior;
  122680. /**
  122681. * Gets the framing behavior of the camera if it has been enabled.
  122682. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122683. */
  122684. get framingBehavior(): Nullable<FramingBehavior>;
  122685. /**
  122686. * Defines if the framing behavior of the camera is enabled on the camera.
  122687. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122688. */
  122689. get useFramingBehavior(): boolean;
  122690. set useFramingBehavior(value: boolean);
  122691. private _autoRotationBehavior;
  122692. /**
  122693. * Gets the auto rotation behavior of the camera if it has been enabled.
  122694. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122695. */
  122696. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  122697. /**
  122698. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  122699. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122700. */
  122701. get useAutoRotationBehavior(): boolean;
  122702. set useAutoRotationBehavior(value: boolean);
  122703. /**
  122704. * Observable triggered when the mesh target has been changed on the camera.
  122705. */
  122706. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  122707. /**
  122708. * Event raised when the camera is colliding with a mesh.
  122709. */
  122710. onCollide: (collidedMesh: AbstractMesh) => void;
  122711. /**
  122712. * Defines whether the camera should check collision with the objects oh the scene.
  122713. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  122714. */
  122715. checkCollisions: boolean;
  122716. /**
  122717. * Defines the collision radius of the camera.
  122718. * This simulates a sphere around the camera.
  122719. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122720. */
  122721. collisionRadius: Vector3;
  122722. protected _collider: Collider;
  122723. protected _previousPosition: Vector3;
  122724. protected _collisionVelocity: Vector3;
  122725. protected _newPosition: Vector3;
  122726. protected _previousAlpha: number;
  122727. protected _previousBeta: number;
  122728. protected _previousRadius: number;
  122729. protected _collisionTriggered: boolean;
  122730. protected _targetBoundingCenter: Nullable<Vector3>;
  122731. private _computationVector;
  122732. /**
  122733. * Instantiates a new ArcRotateCamera in a given scene
  122734. * @param name Defines the name of the camera
  122735. * @param alpha Defines the camera rotation along the logitudinal axis
  122736. * @param beta Defines the camera rotation along the latitudinal axis
  122737. * @param radius Defines the camera distance from its target
  122738. * @param target Defines the camera target
  122739. * @param scene Defines the scene the camera belongs to
  122740. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  122741. */
  122742. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122743. /** @hidden */
  122744. _initCache(): void;
  122745. /** @hidden */
  122746. _updateCache(ignoreParentClass?: boolean): void;
  122747. protected _getTargetPosition(): Vector3;
  122748. private _storedAlpha;
  122749. private _storedBeta;
  122750. private _storedRadius;
  122751. private _storedTarget;
  122752. private _storedTargetScreenOffset;
  122753. /**
  122754. * Stores the current state of the camera (alpha, beta, radius and target)
  122755. * @returns the camera itself
  122756. */
  122757. storeState(): Camera;
  122758. /**
  122759. * @hidden
  122760. * Restored camera state. You must call storeState() first
  122761. */
  122762. _restoreStateValues(): boolean;
  122763. /** @hidden */
  122764. _isSynchronizedViewMatrix(): boolean;
  122765. /**
  122766. * Attached controls to the current camera.
  122767. * @param element Defines the element the controls should be listened from
  122768. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122769. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  122770. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  122771. */
  122772. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  122773. /**
  122774. * Detach the current controls from the camera.
  122775. * The camera will stop reacting to inputs.
  122776. * @param element Defines the element to stop listening the inputs from
  122777. */
  122778. detachControl(element: HTMLElement): void;
  122779. /** @hidden */
  122780. _checkInputs(): void;
  122781. protected _checkLimits(): void;
  122782. /**
  122783. * Rebuilds angles (alpha, beta) and radius from the give position and target
  122784. */
  122785. rebuildAnglesAndRadius(): void;
  122786. /**
  122787. * Use a position to define the current camera related information like alpha, beta and radius
  122788. * @param position Defines the position to set the camera at
  122789. */
  122790. setPosition(position: Vector3): void;
  122791. /**
  122792. * Defines the target the camera should look at.
  122793. * This will automatically adapt alpha beta and radius to fit within the new target.
  122794. * @param target Defines the new target as a Vector or a mesh
  122795. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  122796. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  122797. */
  122798. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  122799. /** @hidden */
  122800. _getViewMatrix(): Matrix;
  122801. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  122802. /**
  122803. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  122804. * @param meshes Defines the mesh to zoom on
  122805. * @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)
  122806. */
  122807. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  122808. /**
  122809. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  122810. * The target will be changed but the radius
  122811. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  122812. * @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)
  122813. */
  122814. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  122815. min: Vector3;
  122816. max: Vector3;
  122817. distance: number;
  122818. }, doNotUpdateMaxZ?: boolean): void;
  122819. /**
  122820. * @override
  122821. * Override Camera.createRigCamera
  122822. */
  122823. createRigCamera(name: string, cameraIndex: number): Camera;
  122824. /**
  122825. * @hidden
  122826. * @override
  122827. * Override Camera._updateRigCameras
  122828. */
  122829. _updateRigCameras(): void;
  122830. /**
  122831. * Destroy the camera and release the current resources hold by it.
  122832. */
  122833. dispose(): void;
  122834. /**
  122835. * Gets the current object class name.
  122836. * @return the class name
  122837. */
  122838. getClassName(): string;
  122839. }
  122840. }
  122841. declare module BABYLON {
  122842. /**
  122843. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  122844. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122845. */
  122846. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  122847. /**
  122848. * Gets the name of the behavior.
  122849. */
  122850. get name(): string;
  122851. private _zoomStopsAnimation;
  122852. private _idleRotationSpeed;
  122853. private _idleRotationWaitTime;
  122854. private _idleRotationSpinupTime;
  122855. /**
  122856. * Sets the flag that indicates if user zooming should stop animation.
  122857. */
  122858. set zoomStopsAnimation(flag: boolean);
  122859. /**
  122860. * Gets the flag that indicates if user zooming should stop animation.
  122861. */
  122862. get zoomStopsAnimation(): boolean;
  122863. /**
  122864. * Sets the default speed at which the camera rotates around the model.
  122865. */
  122866. set idleRotationSpeed(speed: number);
  122867. /**
  122868. * Gets the default speed at which the camera rotates around the model.
  122869. */
  122870. get idleRotationSpeed(): number;
  122871. /**
  122872. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  122873. */
  122874. set idleRotationWaitTime(time: number);
  122875. /**
  122876. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  122877. */
  122878. get idleRotationWaitTime(): number;
  122879. /**
  122880. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122881. */
  122882. set idleRotationSpinupTime(time: number);
  122883. /**
  122884. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122885. */
  122886. get idleRotationSpinupTime(): number;
  122887. /**
  122888. * Gets a value indicating if the camera is currently rotating because of this behavior
  122889. */
  122890. get rotationInProgress(): boolean;
  122891. private _onPrePointerObservableObserver;
  122892. private _onAfterCheckInputsObserver;
  122893. private _attachedCamera;
  122894. private _isPointerDown;
  122895. private _lastFrameTime;
  122896. private _lastInteractionTime;
  122897. private _cameraRotationSpeed;
  122898. /**
  122899. * Initializes the behavior.
  122900. */
  122901. init(): void;
  122902. /**
  122903. * Attaches the behavior to its arc rotate camera.
  122904. * @param camera Defines the camera to attach the behavior to
  122905. */
  122906. attach(camera: ArcRotateCamera): void;
  122907. /**
  122908. * Detaches the behavior from its current arc rotate camera.
  122909. */
  122910. detach(): void;
  122911. /**
  122912. * Returns true if user is scrolling.
  122913. * @return true if user is scrolling.
  122914. */
  122915. private _userIsZooming;
  122916. private _lastFrameRadius;
  122917. private _shouldAnimationStopForInteraction;
  122918. /**
  122919. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122920. */
  122921. private _applyUserInteraction;
  122922. private _userIsMoving;
  122923. }
  122924. }
  122925. declare module BABYLON {
  122926. /**
  122927. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  122928. */
  122929. export class AttachToBoxBehavior implements Behavior<Mesh> {
  122930. private ui;
  122931. /**
  122932. * The name of the behavior
  122933. */
  122934. name: string;
  122935. /**
  122936. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  122937. */
  122938. distanceAwayFromFace: number;
  122939. /**
  122940. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  122941. */
  122942. distanceAwayFromBottomOfFace: number;
  122943. private _faceVectors;
  122944. private _target;
  122945. private _scene;
  122946. private _onRenderObserver;
  122947. private _tmpMatrix;
  122948. private _tmpVector;
  122949. /**
  122950. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  122951. * @param ui The transform node that should be attched to the mesh
  122952. */
  122953. constructor(ui: TransformNode);
  122954. /**
  122955. * Initializes the behavior
  122956. */
  122957. init(): void;
  122958. private _closestFace;
  122959. private _zeroVector;
  122960. private _lookAtTmpMatrix;
  122961. private _lookAtToRef;
  122962. /**
  122963. * Attaches the AttachToBoxBehavior to the passed in mesh
  122964. * @param target The mesh that the specified node will be attached to
  122965. */
  122966. attach(target: Mesh): void;
  122967. /**
  122968. * Detaches the behavior from the mesh
  122969. */
  122970. detach(): void;
  122971. }
  122972. }
  122973. declare module BABYLON {
  122974. /**
  122975. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  122976. */
  122977. export class FadeInOutBehavior implements Behavior<Mesh> {
  122978. /**
  122979. * Time in milliseconds to delay before fading in (Default: 0)
  122980. */
  122981. delay: number;
  122982. /**
  122983. * Time in milliseconds for the mesh to fade in (Default: 300)
  122984. */
  122985. fadeInTime: number;
  122986. private _millisecondsPerFrame;
  122987. private _hovered;
  122988. private _hoverValue;
  122989. private _ownerNode;
  122990. /**
  122991. * Instatiates the FadeInOutBehavior
  122992. */
  122993. constructor();
  122994. /**
  122995. * The name of the behavior
  122996. */
  122997. get name(): string;
  122998. /**
  122999. * Initializes the behavior
  123000. */
  123001. init(): void;
  123002. /**
  123003. * Attaches the fade behavior on the passed in mesh
  123004. * @param ownerNode The mesh that will be faded in/out once attached
  123005. */
  123006. attach(ownerNode: Mesh): void;
  123007. /**
  123008. * Detaches the behavior from the mesh
  123009. */
  123010. detach(): void;
  123011. /**
  123012. * Triggers the mesh to begin fading in or out
  123013. * @param value if the object should fade in or out (true to fade in)
  123014. */
  123015. fadeIn(value: boolean): void;
  123016. private _update;
  123017. private _setAllVisibility;
  123018. }
  123019. }
  123020. declare module BABYLON {
  123021. /**
  123022. * Class containing a set of static utilities functions for managing Pivots
  123023. * @hidden
  123024. */
  123025. export class PivotTools {
  123026. private static _PivotCached;
  123027. private static _OldPivotPoint;
  123028. private static _PivotTranslation;
  123029. private static _PivotTmpVector;
  123030. /** @hidden */
  123031. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  123032. /** @hidden */
  123033. static _RestorePivotPoint(mesh: AbstractMesh): void;
  123034. }
  123035. }
  123036. declare module BABYLON {
  123037. /**
  123038. * Class containing static functions to help procedurally build meshes
  123039. */
  123040. export class PlaneBuilder {
  123041. /**
  123042. * Creates a plane mesh
  123043. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  123044. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  123045. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  123046. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123047. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  123048. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123049. * @param name defines the name of the mesh
  123050. * @param options defines the options used to create the mesh
  123051. * @param scene defines the hosting scene
  123052. * @returns the plane mesh
  123053. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  123054. */
  123055. static CreatePlane(name: string, options: {
  123056. size?: number;
  123057. width?: number;
  123058. height?: number;
  123059. sideOrientation?: number;
  123060. frontUVs?: Vector4;
  123061. backUVs?: Vector4;
  123062. updatable?: boolean;
  123063. sourcePlane?: Plane;
  123064. }, scene?: Nullable<Scene>): Mesh;
  123065. }
  123066. }
  123067. declare module BABYLON {
  123068. /**
  123069. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  123070. */
  123071. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  123072. private static _AnyMouseID;
  123073. /**
  123074. * Abstract mesh the behavior is set on
  123075. */
  123076. attachedNode: AbstractMesh;
  123077. private _dragPlane;
  123078. private _scene;
  123079. private _pointerObserver;
  123080. private _beforeRenderObserver;
  123081. private static _planeScene;
  123082. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  123083. /**
  123084. * 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)
  123085. */
  123086. maxDragAngle: number;
  123087. /**
  123088. * @hidden
  123089. */
  123090. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  123091. /**
  123092. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123093. */
  123094. currentDraggingPointerID: number;
  123095. /**
  123096. * The last position where the pointer hit the drag plane in world space
  123097. */
  123098. lastDragPosition: Vector3;
  123099. /**
  123100. * If the behavior is currently in a dragging state
  123101. */
  123102. dragging: boolean;
  123103. /**
  123104. * 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)
  123105. */
  123106. dragDeltaRatio: number;
  123107. /**
  123108. * If the drag plane orientation should be updated during the dragging (Default: true)
  123109. */
  123110. updateDragPlane: boolean;
  123111. private _debugMode;
  123112. private _moving;
  123113. /**
  123114. * Fires each time the attached mesh is dragged with the pointer
  123115. * * delta between last drag position and current drag position in world space
  123116. * * dragDistance along the drag axis
  123117. * * dragPlaneNormal normal of the current drag plane used during the drag
  123118. * * dragPlanePoint in world space where the drag intersects the drag plane
  123119. */
  123120. onDragObservable: Observable<{
  123121. delta: Vector3;
  123122. dragPlanePoint: Vector3;
  123123. dragPlaneNormal: Vector3;
  123124. dragDistance: number;
  123125. pointerId: number;
  123126. }>;
  123127. /**
  123128. * Fires each time a drag begins (eg. mouse down on mesh)
  123129. */
  123130. onDragStartObservable: Observable<{
  123131. dragPlanePoint: Vector3;
  123132. pointerId: number;
  123133. }>;
  123134. /**
  123135. * Fires each time a drag ends (eg. mouse release after drag)
  123136. */
  123137. onDragEndObservable: Observable<{
  123138. dragPlanePoint: Vector3;
  123139. pointerId: number;
  123140. }>;
  123141. /**
  123142. * If the attached mesh should be moved when dragged
  123143. */
  123144. moveAttached: boolean;
  123145. /**
  123146. * If the drag behavior will react to drag events (Default: true)
  123147. */
  123148. enabled: boolean;
  123149. /**
  123150. * If pointer events should start and release the drag (Default: true)
  123151. */
  123152. startAndReleaseDragOnPointerEvents: boolean;
  123153. /**
  123154. * If camera controls should be detached during the drag
  123155. */
  123156. detachCameraControls: boolean;
  123157. /**
  123158. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  123159. */
  123160. useObjectOrientationForDragging: boolean;
  123161. private _options;
  123162. /**
  123163. * Gets the options used by the behavior
  123164. */
  123165. get options(): {
  123166. dragAxis?: Vector3;
  123167. dragPlaneNormal?: Vector3;
  123168. };
  123169. /**
  123170. * Sets the options used by the behavior
  123171. */
  123172. set options(options: {
  123173. dragAxis?: Vector3;
  123174. dragPlaneNormal?: Vector3;
  123175. });
  123176. /**
  123177. * Creates a pointer drag behavior that can be attached to a mesh
  123178. * @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)
  123179. */
  123180. constructor(options?: {
  123181. dragAxis?: Vector3;
  123182. dragPlaneNormal?: Vector3;
  123183. });
  123184. /**
  123185. * Predicate to determine if it is valid to move the object to a new position when it is moved
  123186. */
  123187. validateDrag: (targetPosition: Vector3) => boolean;
  123188. /**
  123189. * The name of the behavior
  123190. */
  123191. get name(): string;
  123192. /**
  123193. * Initializes the behavior
  123194. */
  123195. init(): void;
  123196. private _tmpVector;
  123197. private _alternatePickedPoint;
  123198. private _worldDragAxis;
  123199. private _targetPosition;
  123200. private _attachedElement;
  123201. /**
  123202. * Attaches the drag behavior the passed in mesh
  123203. * @param ownerNode The mesh that will be dragged around once attached
  123204. * @param predicate Predicate to use for pick filtering
  123205. */
  123206. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  123207. /**
  123208. * Force relase the drag action by code.
  123209. */
  123210. releaseDrag(): void;
  123211. private _startDragRay;
  123212. private _lastPointerRay;
  123213. /**
  123214. * Simulates the start of a pointer drag event on the behavior
  123215. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  123216. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  123217. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  123218. */
  123219. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  123220. private _startDrag;
  123221. private _dragDelta;
  123222. private _moveDrag;
  123223. private _pickWithRayOnDragPlane;
  123224. private _pointA;
  123225. private _pointC;
  123226. private _localAxis;
  123227. private _lookAt;
  123228. private _updateDragPlanePosition;
  123229. /**
  123230. * Detaches the behavior from the mesh
  123231. */
  123232. detach(): void;
  123233. }
  123234. }
  123235. declare module BABYLON {
  123236. /**
  123237. * A behavior that when attached to a mesh will allow the mesh to be scaled
  123238. */
  123239. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  123240. private _dragBehaviorA;
  123241. private _dragBehaviorB;
  123242. private _startDistance;
  123243. private _initialScale;
  123244. private _targetScale;
  123245. private _ownerNode;
  123246. private _sceneRenderObserver;
  123247. /**
  123248. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  123249. */
  123250. constructor();
  123251. /**
  123252. * The name of the behavior
  123253. */
  123254. get name(): string;
  123255. /**
  123256. * Initializes the behavior
  123257. */
  123258. init(): void;
  123259. private _getCurrentDistance;
  123260. /**
  123261. * Attaches the scale behavior the passed in mesh
  123262. * @param ownerNode The mesh that will be scaled around once attached
  123263. */
  123264. attach(ownerNode: Mesh): void;
  123265. /**
  123266. * Detaches the behavior from the mesh
  123267. */
  123268. detach(): void;
  123269. }
  123270. }
  123271. declare module BABYLON {
  123272. /**
  123273. * 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
  123274. */
  123275. export class SixDofDragBehavior implements Behavior<Mesh> {
  123276. private static _virtualScene;
  123277. private _ownerNode;
  123278. private _sceneRenderObserver;
  123279. private _scene;
  123280. private _targetPosition;
  123281. private _virtualOriginMesh;
  123282. private _virtualDragMesh;
  123283. private _pointerObserver;
  123284. private _moving;
  123285. private _startingOrientation;
  123286. private _attachedElement;
  123287. /**
  123288. * 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)
  123289. */
  123290. private zDragFactor;
  123291. /**
  123292. * If the object should rotate to face the drag origin
  123293. */
  123294. rotateDraggedObject: boolean;
  123295. /**
  123296. * If the behavior is currently in a dragging state
  123297. */
  123298. dragging: boolean;
  123299. /**
  123300. * 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)
  123301. */
  123302. dragDeltaRatio: number;
  123303. /**
  123304. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123305. */
  123306. currentDraggingPointerID: number;
  123307. /**
  123308. * If camera controls should be detached during the drag
  123309. */
  123310. detachCameraControls: boolean;
  123311. /**
  123312. * Fires each time a drag starts
  123313. */
  123314. onDragStartObservable: Observable<{}>;
  123315. /**
  123316. * Fires each time a drag ends (eg. mouse release after drag)
  123317. */
  123318. onDragEndObservable: Observable<{}>;
  123319. /**
  123320. * 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
  123321. */
  123322. constructor();
  123323. /**
  123324. * The name of the behavior
  123325. */
  123326. get name(): string;
  123327. /**
  123328. * Initializes the behavior
  123329. */
  123330. init(): void;
  123331. /**
  123332. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  123333. */
  123334. private get _pointerCamera();
  123335. /**
  123336. * Attaches the scale behavior the passed in mesh
  123337. * @param ownerNode The mesh that will be scaled around once attached
  123338. */
  123339. attach(ownerNode: Mesh): void;
  123340. /**
  123341. * Detaches the behavior from the mesh
  123342. */
  123343. detach(): void;
  123344. }
  123345. }
  123346. declare module BABYLON {
  123347. /**
  123348. * Class used to apply inverse kinematics to bones
  123349. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  123350. */
  123351. export class BoneIKController {
  123352. private static _tmpVecs;
  123353. private static _tmpQuat;
  123354. private static _tmpMats;
  123355. /**
  123356. * Gets or sets the target mesh
  123357. */
  123358. targetMesh: AbstractMesh;
  123359. /** Gets or sets the mesh used as pole */
  123360. poleTargetMesh: AbstractMesh;
  123361. /**
  123362. * Gets or sets the bone used as pole
  123363. */
  123364. poleTargetBone: Nullable<Bone>;
  123365. /**
  123366. * Gets or sets the target position
  123367. */
  123368. targetPosition: Vector3;
  123369. /**
  123370. * Gets or sets the pole target position
  123371. */
  123372. poleTargetPosition: Vector3;
  123373. /**
  123374. * Gets or sets the pole target local offset
  123375. */
  123376. poleTargetLocalOffset: Vector3;
  123377. /**
  123378. * Gets or sets the pole angle
  123379. */
  123380. poleAngle: number;
  123381. /**
  123382. * Gets or sets the mesh associated with the controller
  123383. */
  123384. mesh: AbstractMesh;
  123385. /**
  123386. * 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)
  123387. */
  123388. slerpAmount: number;
  123389. private _bone1Quat;
  123390. private _bone1Mat;
  123391. private _bone2Ang;
  123392. private _bone1;
  123393. private _bone2;
  123394. private _bone1Length;
  123395. private _bone2Length;
  123396. private _maxAngle;
  123397. private _maxReach;
  123398. private _rightHandedSystem;
  123399. private _bendAxis;
  123400. private _slerping;
  123401. private _adjustRoll;
  123402. /**
  123403. * Gets or sets maximum allowed angle
  123404. */
  123405. get maxAngle(): number;
  123406. set maxAngle(value: number);
  123407. /**
  123408. * Creates a new BoneIKController
  123409. * @param mesh defines the mesh to control
  123410. * @param bone defines the bone to control
  123411. * @param options defines options to set up the controller
  123412. */
  123413. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  123414. targetMesh?: AbstractMesh;
  123415. poleTargetMesh?: AbstractMesh;
  123416. poleTargetBone?: Bone;
  123417. poleTargetLocalOffset?: Vector3;
  123418. poleAngle?: number;
  123419. bendAxis?: Vector3;
  123420. maxAngle?: number;
  123421. slerpAmount?: number;
  123422. });
  123423. private _setMaxAngle;
  123424. /**
  123425. * Force the controller to update the bones
  123426. */
  123427. update(): void;
  123428. }
  123429. }
  123430. declare module BABYLON {
  123431. /**
  123432. * Class used to make a bone look toward a point in space
  123433. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  123434. */
  123435. export class BoneLookController {
  123436. private static _tmpVecs;
  123437. private static _tmpQuat;
  123438. private static _tmpMats;
  123439. /**
  123440. * The target Vector3 that the bone will look at
  123441. */
  123442. target: Vector3;
  123443. /**
  123444. * The mesh that the bone is attached to
  123445. */
  123446. mesh: AbstractMesh;
  123447. /**
  123448. * The bone that will be looking to the target
  123449. */
  123450. bone: Bone;
  123451. /**
  123452. * The up axis of the coordinate system that is used when the bone is rotated
  123453. */
  123454. upAxis: Vector3;
  123455. /**
  123456. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  123457. */
  123458. upAxisSpace: Space;
  123459. /**
  123460. * Used to make an adjustment to the yaw of the bone
  123461. */
  123462. adjustYaw: number;
  123463. /**
  123464. * Used to make an adjustment to the pitch of the bone
  123465. */
  123466. adjustPitch: number;
  123467. /**
  123468. * Used to make an adjustment to the roll of the bone
  123469. */
  123470. adjustRoll: number;
  123471. /**
  123472. * 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)
  123473. */
  123474. slerpAmount: number;
  123475. private _minYaw;
  123476. private _maxYaw;
  123477. private _minPitch;
  123478. private _maxPitch;
  123479. private _minYawSin;
  123480. private _minYawCos;
  123481. private _maxYawSin;
  123482. private _maxYawCos;
  123483. private _midYawConstraint;
  123484. private _minPitchTan;
  123485. private _maxPitchTan;
  123486. private _boneQuat;
  123487. private _slerping;
  123488. private _transformYawPitch;
  123489. private _transformYawPitchInv;
  123490. private _firstFrameSkipped;
  123491. private _yawRange;
  123492. private _fowardAxis;
  123493. /**
  123494. * Gets or sets the minimum yaw angle that the bone can look to
  123495. */
  123496. get minYaw(): number;
  123497. set minYaw(value: number);
  123498. /**
  123499. * Gets or sets the maximum yaw angle that the bone can look to
  123500. */
  123501. get maxYaw(): number;
  123502. set maxYaw(value: number);
  123503. /**
  123504. * Gets or sets the minimum pitch angle that the bone can look to
  123505. */
  123506. get minPitch(): number;
  123507. set minPitch(value: number);
  123508. /**
  123509. * Gets or sets the maximum pitch angle that the bone can look to
  123510. */
  123511. get maxPitch(): number;
  123512. set maxPitch(value: number);
  123513. /**
  123514. * Create a BoneLookController
  123515. * @param mesh the mesh that the bone belongs to
  123516. * @param bone the bone that will be looking to the target
  123517. * @param target the target Vector3 to look at
  123518. * @param options optional settings:
  123519. * * maxYaw: the maximum angle the bone will yaw to
  123520. * * minYaw: the minimum angle the bone will yaw to
  123521. * * maxPitch: the maximum angle the bone will pitch to
  123522. * * minPitch: the minimum angle the bone will yaw to
  123523. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  123524. * * upAxis: the up axis of the coordinate system
  123525. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  123526. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  123527. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  123528. * * adjustYaw: used to make an adjustment to the yaw of the bone
  123529. * * adjustPitch: used to make an adjustment to the pitch of the bone
  123530. * * adjustRoll: used to make an adjustment to the roll of the bone
  123531. **/
  123532. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  123533. maxYaw?: number;
  123534. minYaw?: number;
  123535. maxPitch?: number;
  123536. minPitch?: number;
  123537. slerpAmount?: number;
  123538. upAxis?: Vector3;
  123539. upAxisSpace?: Space;
  123540. yawAxis?: Vector3;
  123541. pitchAxis?: Vector3;
  123542. adjustYaw?: number;
  123543. adjustPitch?: number;
  123544. adjustRoll?: number;
  123545. });
  123546. /**
  123547. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  123548. */
  123549. update(): void;
  123550. private _getAngleDiff;
  123551. private _getAngleBetween;
  123552. private _isAngleBetween;
  123553. }
  123554. }
  123555. declare module BABYLON {
  123556. /**
  123557. * Manage the gamepad inputs to control an arc rotate camera.
  123558. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123559. */
  123560. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  123561. /**
  123562. * Defines the camera the input is attached to.
  123563. */
  123564. camera: ArcRotateCamera;
  123565. /**
  123566. * Defines the gamepad the input is gathering event from.
  123567. */
  123568. gamepad: Nullable<Gamepad>;
  123569. /**
  123570. * Defines the gamepad rotation sensiblity.
  123571. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123572. */
  123573. gamepadRotationSensibility: number;
  123574. /**
  123575. * Defines the gamepad move sensiblity.
  123576. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123577. */
  123578. gamepadMoveSensibility: number;
  123579. private _yAxisScale;
  123580. /**
  123581. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123582. */
  123583. get invertYAxis(): boolean;
  123584. set invertYAxis(value: boolean);
  123585. private _onGamepadConnectedObserver;
  123586. private _onGamepadDisconnectedObserver;
  123587. /**
  123588. * Attach the input controls to a specific dom element to get the input from.
  123589. * @param element Defines the element the controls should be listened from
  123590. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123591. */
  123592. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123593. /**
  123594. * Detach the current controls from the specified dom element.
  123595. * @param element Defines the element to stop listening the inputs from
  123596. */
  123597. detachControl(element: Nullable<HTMLElement>): void;
  123598. /**
  123599. * Update the current camera state depending on the inputs that have been used this frame.
  123600. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123601. */
  123602. checkInputs(): void;
  123603. /**
  123604. * Gets the class name of the current intput.
  123605. * @returns the class name
  123606. */
  123607. getClassName(): string;
  123608. /**
  123609. * Get the friendly name associated with the input class.
  123610. * @returns the input friendly name
  123611. */
  123612. getSimpleName(): string;
  123613. }
  123614. }
  123615. declare module BABYLON {
  123616. interface ArcRotateCameraInputsManager {
  123617. /**
  123618. * Add orientation input support to the input manager.
  123619. * @returns the current input manager
  123620. */
  123621. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  123622. }
  123623. /**
  123624. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  123625. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123626. */
  123627. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  123628. /**
  123629. * Defines the camera the input is attached to.
  123630. */
  123631. camera: ArcRotateCamera;
  123632. /**
  123633. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  123634. */
  123635. alphaCorrection: number;
  123636. /**
  123637. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  123638. */
  123639. gammaCorrection: number;
  123640. private _alpha;
  123641. private _gamma;
  123642. private _dirty;
  123643. private _deviceOrientationHandler;
  123644. /**
  123645. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  123646. */
  123647. constructor();
  123648. /**
  123649. * Attach the input controls to a specific dom element to get the input from.
  123650. * @param element Defines the element the controls should be listened from
  123651. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123652. */
  123653. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123654. /** @hidden */
  123655. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  123656. /**
  123657. * Update the current camera state depending on the inputs that have been used this frame.
  123658. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123659. */
  123660. checkInputs(): void;
  123661. /**
  123662. * Detach the current controls from the specified dom element.
  123663. * @param element Defines the element to stop listening the inputs from
  123664. */
  123665. detachControl(element: Nullable<HTMLElement>): void;
  123666. /**
  123667. * Gets the class name of the current intput.
  123668. * @returns the class name
  123669. */
  123670. getClassName(): string;
  123671. /**
  123672. * Get the friendly name associated with the input class.
  123673. * @returns the input friendly name
  123674. */
  123675. getSimpleName(): string;
  123676. }
  123677. }
  123678. declare module BABYLON {
  123679. /**
  123680. * Listen to mouse events to control the camera.
  123681. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123682. */
  123683. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  123684. /**
  123685. * Defines the camera the input is attached to.
  123686. */
  123687. camera: FlyCamera;
  123688. /**
  123689. * Defines if touch is enabled. (Default is true.)
  123690. */
  123691. touchEnabled: boolean;
  123692. /**
  123693. * Defines the buttons associated with the input to handle camera rotation.
  123694. */
  123695. buttons: number[];
  123696. /**
  123697. * Assign buttons for Yaw control.
  123698. */
  123699. buttonsYaw: number[];
  123700. /**
  123701. * Assign buttons for Pitch control.
  123702. */
  123703. buttonsPitch: number[];
  123704. /**
  123705. * Assign buttons for Roll control.
  123706. */
  123707. buttonsRoll: number[];
  123708. /**
  123709. * Detect if any button is being pressed while mouse is moved.
  123710. * -1 = Mouse locked.
  123711. * 0 = Left button.
  123712. * 1 = Middle Button.
  123713. * 2 = Right Button.
  123714. */
  123715. activeButton: number;
  123716. /**
  123717. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  123718. * Higher values reduce its sensitivity.
  123719. */
  123720. angularSensibility: number;
  123721. private _mousemoveCallback;
  123722. private _observer;
  123723. private _rollObserver;
  123724. private previousPosition;
  123725. private noPreventDefault;
  123726. private element;
  123727. /**
  123728. * Listen to mouse events to control the camera.
  123729. * @param touchEnabled Define if touch is enabled. (Default is true.)
  123730. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123731. */
  123732. constructor(touchEnabled?: boolean);
  123733. /**
  123734. * Attach the mouse control to the HTML DOM element.
  123735. * @param element Defines the element that listens to the input events.
  123736. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  123737. */
  123738. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123739. /**
  123740. * Detach the current controls from the specified dom element.
  123741. * @param element Defines the element to stop listening the inputs from
  123742. */
  123743. detachControl(element: Nullable<HTMLElement>): void;
  123744. /**
  123745. * Gets the class name of the current input.
  123746. * @returns the class name.
  123747. */
  123748. getClassName(): string;
  123749. /**
  123750. * Get the friendly name associated with the input class.
  123751. * @returns the input's friendly name.
  123752. */
  123753. getSimpleName(): string;
  123754. private _pointerInput;
  123755. private _onMouseMove;
  123756. /**
  123757. * Rotate camera by mouse offset.
  123758. */
  123759. private rotateCamera;
  123760. }
  123761. }
  123762. declare module BABYLON {
  123763. /**
  123764. * Default Inputs manager for the FlyCamera.
  123765. * It groups all the default supported inputs for ease of use.
  123766. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123767. */
  123768. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  123769. /**
  123770. * Instantiates a new FlyCameraInputsManager.
  123771. * @param camera Defines the camera the inputs belong to.
  123772. */
  123773. constructor(camera: FlyCamera);
  123774. /**
  123775. * Add keyboard input support to the input manager.
  123776. * @returns the new FlyCameraKeyboardMoveInput().
  123777. */
  123778. addKeyboard(): FlyCameraInputsManager;
  123779. /**
  123780. * Add mouse input support to the input manager.
  123781. * @param touchEnabled Enable touch screen support.
  123782. * @returns the new FlyCameraMouseInput().
  123783. */
  123784. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  123785. }
  123786. }
  123787. declare module BABYLON {
  123788. /**
  123789. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123790. * such as in a 3D Space Shooter or a Flight Simulator.
  123791. */
  123792. export class FlyCamera extends TargetCamera {
  123793. /**
  123794. * Define the collision ellipsoid of the camera.
  123795. * This is helpful for simulating a camera body, like a player's body.
  123796. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123797. */
  123798. ellipsoid: Vector3;
  123799. /**
  123800. * Define an offset for the position of the ellipsoid around the camera.
  123801. * This can be helpful if the camera is attached away from the player's body center,
  123802. * such as at its head.
  123803. */
  123804. ellipsoidOffset: Vector3;
  123805. /**
  123806. * Enable or disable collisions of the camera with the rest of the scene objects.
  123807. */
  123808. checkCollisions: boolean;
  123809. /**
  123810. * Enable or disable gravity on the camera.
  123811. */
  123812. applyGravity: boolean;
  123813. /**
  123814. * Define the current direction the camera is moving to.
  123815. */
  123816. cameraDirection: Vector3;
  123817. /**
  123818. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  123819. * This overrides and empties cameraRotation.
  123820. */
  123821. rotationQuaternion: Quaternion;
  123822. /**
  123823. * Track Roll to maintain the wanted Rolling when looking around.
  123824. */
  123825. _trackRoll: number;
  123826. /**
  123827. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  123828. */
  123829. rollCorrect: number;
  123830. /**
  123831. * Mimic a banked turn, Rolling the camera when Yawing.
  123832. * It's recommended to use rollCorrect = 10 for faster banking correction.
  123833. */
  123834. bankedTurn: boolean;
  123835. /**
  123836. * Limit in radians for how much Roll banking will add. (Default: 90°)
  123837. */
  123838. bankedTurnLimit: number;
  123839. /**
  123840. * Value of 0 disables the banked Roll.
  123841. * Value of 1 is equal to the Yaw angle in radians.
  123842. */
  123843. bankedTurnMultiplier: number;
  123844. /**
  123845. * The inputs manager loads all the input sources, such as keyboard and mouse.
  123846. */
  123847. inputs: FlyCameraInputsManager;
  123848. /**
  123849. * Gets the input sensibility for mouse input.
  123850. * Higher values reduce sensitivity.
  123851. */
  123852. get angularSensibility(): number;
  123853. /**
  123854. * Sets the input sensibility for a mouse input.
  123855. * Higher values reduce sensitivity.
  123856. */
  123857. set angularSensibility(value: number);
  123858. /**
  123859. * Get the keys for camera movement forward.
  123860. */
  123861. get keysForward(): number[];
  123862. /**
  123863. * Set the keys for camera movement forward.
  123864. */
  123865. set keysForward(value: number[]);
  123866. /**
  123867. * Get the keys for camera movement backward.
  123868. */
  123869. get keysBackward(): number[];
  123870. set keysBackward(value: number[]);
  123871. /**
  123872. * Get the keys for camera movement up.
  123873. */
  123874. get keysUp(): number[];
  123875. /**
  123876. * Set the keys for camera movement up.
  123877. */
  123878. set keysUp(value: number[]);
  123879. /**
  123880. * Get the keys for camera movement down.
  123881. */
  123882. get keysDown(): number[];
  123883. /**
  123884. * Set the keys for camera movement down.
  123885. */
  123886. set keysDown(value: number[]);
  123887. /**
  123888. * Get the keys for camera movement left.
  123889. */
  123890. get keysLeft(): number[];
  123891. /**
  123892. * Set the keys for camera movement left.
  123893. */
  123894. set keysLeft(value: number[]);
  123895. /**
  123896. * Set the keys for camera movement right.
  123897. */
  123898. get keysRight(): number[];
  123899. /**
  123900. * Set the keys for camera movement right.
  123901. */
  123902. set keysRight(value: number[]);
  123903. /**
  123904. * Event raised when the camera collides with a mesh in the scene.
  123905. */
  123906. onCollide: (collidedMesh: AbstractMesh) => void;
  123907. private _collider;
  123908. private _needMoveForGravity;
  123909. private _oldPosition;
  123910. private _diffPosition;
  123911. private _newPosition;
  123912. /** @hidden */
  123913. _localDirection: Vector3;
  123914. /** @hidden */
  123915. _transformedDirection: Vector3;
  123916. /**
  123917. * Instantiates a FlyCamera.
  123918. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123919. * such as in a 3D Space Shooter or a Flight Simulator.
  123920. * @param name Define the name of the camera in the scene.
  123921. * @param position Define the starting position of the camera in the scene.
  123922. * @param scene Define the scene the camera belongs to.
  123923. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  123924. */
  123925. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  123926. /**
  123927. * Attach a control to the HTML DOM element.
  123928. * @param element Defines the element that listens to the input events.
  123929. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  123930. */
  123931. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123932. /**
  123933. * Detach a control from the HTML DOM element.
  123934. * The camera will stop reacting to that input.
  123935. * @param element Defines the element that listens to the input events.
  123936. */
  123937. detachControl(element: HTMLElement): void;
  123938. private _collisionMask;
  123939. /**
  123940. * Get the mask that the camera ignores in collision events.
  123941. */
  123942. get collisionMask(): number;
  123943. /**
  123944. * Set the mask that the camera ignores in collision events.
  123945. */
  123946. set collisionMask(mask: number);
  123947. /** @hidden */
  123948. _collideWithWorld(displacement: Vector3): void;
  123949. /** @hidden */
  123950. private _onCollisionPositionChange;
  123951. /** @hidden */
  123952. _checkInputs(): void;
  123953. /** @hidden */
  123954. _decideIfNeedsToMove(): boolean;
  123955. /** @hidden */
  123956. _updatePosition(): void;
  123957. /**
  123958. * Restore the Roll to its target value at the rate specified.
  123959. * @param rate - Higher means slower restoring.
  123960. * @hidden
  123961. */
  123962. restoreRoll(rate: number): void;
  123963. /**
  123964. * Destroy the camera and release the current resources held by it.
  123965. */
  123966. dispose(): void;
  123967. /**
  123968. * Get the current object class name.
  123969. * @returns the class name.
  123970. */
  123971. getClassName(): string;
  123972. }
  123973. }
  123974. declare module BABYLON {
  123975. /**
  123976. * Listen to keyboard events to control the camera.
  123977. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123978. */
  123979. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  123980. /**
  123981. * Defines the camera the input is attached to.
  123982. */
  123983. camera: FlyCamera;
  123984. /**
  123985. * The list of keyboard keys used to control the forward move of the camera.
  123986. */
  123987. keysForward: number[];
  123988. /**
  123989. * The list of keyboard keys used to control the backward move of the camera.
  123990. */
  123991. keysBackward: number[];
  123992. /**
  123993. * The list of keyboard keys used to control the forward move of the camera.
  123994. */
  123995. keysUp: number[];
  123996. /**
  123997. * The list of keyboard keys used to control the backward move of the camera.
  123998. */
  123999. keysDown: number[];
  124000. /**
  124001. * The list of keyboard keys used to control the right strafe move of the camera.
  124002. */
  124003. keysRight: number[];
  124004. /**
  124005. * The list of keyboard keys used to control the left strafe move of the camera.
  124006. */
  124007. keysLeft: number[];
  124008. private _keys;
  124009. private _onCanvasBlurObserver;
  124010. private _onKeyboardObserver;
  124011. private _engine;
  124012. private _scene;
  124013. /**
  124014. * Attach the input controls to a specific dom element to get the input from.
  124015. * @param element Defines the element the controls should be listened from
  124016. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124017. */
  124018. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124019. /**
  124020. * Detach the current controls from the specified dom element.
  124021. * @param element Defines the element to stop listening the inputs from
  124022. */
  124023. detachControl(element: Nullable<HTMLElement>): void;
  124024. /**
  124025. * Gets the class name of the current intput.
  124026. * @returns the class name
  124027. */
  124028. getClassName(): string;
  124029. /** @hidden */
  124030. _onLostFocus(e: FocusEvent): void;
  124031. /**
  124032. * Get the friendly name associated with the input class.
  124033. * @returns the input friendly name
  124034. */
  124035. getSimpleName(): string;
  124036. /**
  124037. * Update the current camera state depending on the inputs that have been used this frame.
  124038. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124039. */
  124040. checkInputs(): void;
  124041. }
  124042. }
  124043. declare module BABYLON {
  124044. /**
  124045. * Manage the mouse wheel inputs to control a follow camera.
  124046. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124047. */
  124048. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  124049. /**
  124050. * Defines the camera the input is attached to.
  124051. */
  124052. camera: FollowCamera;
  124053. /**
  124054. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  124055. */
  124056. axisControlRadius: boolean;
  124057. /**
  124058. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  124059. */
  124060. axisControlHeight: boolean;
  124061. /**
  124062. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  124063. */
  124064. axisControlRotation: boolean;
  124065. /**
  124066. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  124067. * relation to mouseWheel events.
  124068. */
  124069. wheelPrecision: number;
  124070. /**
  124071. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  124072. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  124073. */
  124074. wheelDeltaPercentage: number;
  124075. private _wheel;
  124076. private _observer;
  124077. /**
  124078. * Attach the input controls to a specific dom element to get the input from.
  124079. * @param element Defines the element the controls should be listened from
  124080. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124081. */
  124082. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124083. /**
  124084. * Detach the current controls from the specified dom element.
  124085. * @param element Defines the element to stop listening the inputs from
  124086. */
  124087. detachControl(element: Nullable<HTMLElement>): void;
  124088. /**
  124089. * Gets the class name of the current intput.
  124090. * @returns the class name
  124091. */
  124092. getClassName(): string;
  124093. /**
  124094. * Get the friendly name associated with the input class.
  124095. * @returns the input friendly name
  124096. */
  124097. getSimpleName(): string;
  124098. }
  124099. }
  124100. declare module BABYLON {
  124101. /**
  124102. * Manage the pointers inputs to control an follow camera.
  124103. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124104. */
  124105. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  124106. /**
  124107. * Defines the camera the input is attached to.
  124108. */
  124109. camera: FollowCamera;
  124110. /**
  124111. * Gets the class name of the current input.
  124112. * @returns the class name
  124113. */
  124114. getClassName(): string;
  124115. /**
  124116. * Defines the pointer angular sensibility along the X axis or how fast is
  124117. * the camera rotating.
  124118. * A negative number will reverse the axis direction.
  124119. */
  124120. angularSensibilityX: number;
  124121. /**
  124122. * Defines the pointer angular sensibility along the Y axis or how fast is
  124123. * the camera rotating.
  124124. * A negative number will reverse the axis direction.
  124125. */
  124126. angularSensibilityY: number;
  124127. /**
  124128. * Defines the pointer pinch precision or how fast is the camera zooming.
  124129. * A negative number will reverse the axis direction.
  124130. */
  124131. pinchPrecision: number;
  124132. /**
  124133. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  124134. * from 0.
  124135. * It defines the percentage of current camera.radius to use as delta when
  124136. * pinch zoom is used.
  124137. */
  124138. pinchDeltaPercentage: number;
  124139. /**
  124140. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  124141. */
  124142. axisXControlRadius: boolean;
  124143. /**
  124144. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  124145. */
  124146. axisXControlHeight: boolean;
  124147. /**
  124148. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  124149. */
  124150. axisXControlRotation: boolean;
  124151. /**
  124152. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  124153. */
  124154. axisYControlRadius: boolean;
  124155. /**
  124156. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  124157. */
  124158. axisYControlHeight: boolean;
  124159. /**
  124160. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  124161. */
  124162. axisYControlRotation: boolean;
  124163. /**
  124164. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  124165. */
  124166. axisPinchControlRadius: boolean;
  124167. /**
  124168. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  124169. */
  124170. axisPinchControlHeight: boolean;
  124171. /**
  124172. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  124173. */
  124174. axisPinchControlRotation: boolean;
  124175. /**
  124176. * Log error messages if basic misconfiguration has occurred.
  124177. */
  124178. warningEnable: boolean;
  124179. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  124180. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  124181. private _warningCounter;
  124182. private _warning;
  124183. }
  124184. }
  124185. declare module BABYLON {
  124186. /**
  124187. * Default Inputs manager for the FollowCamera.
  124188. * It groups all the default supported inputs for ease of use.
  124189. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124190. */
  124191. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  124192. /**
  124193. * Instantiates a new FollowCameraInputsManager.
  124194. * @param camera Defines the camera the inputs belong to
  124195. */
  124196. constructor(camera: FollowCamera);
  124197. /**
  124198. * Add keyboard input support to the input manager.
  124199. * @returns the current input manager
  124200. */
  124201. addKeyboard(): FollowCameraInputsManager;
  124202. /**
  124203. * Add mouse wheel input support to the input manager.
  124204. * @returns the current input manager
  124205. */
  124206. addMouseWheel(): FollowCameraInputsManager;
  124207. /**
  124208. * Add pointers input support to the input manager.
  124209. * @returns the current input manager
  124210. */
  124211. addPointers(): FollowCameraInputsManager;
  124212. /**
  124213. * Add orientation input support to the input manager.
  124214. * @returns the current input manager
  124215. */
  124216. addVRDeviceOrientation(): FollowCameraInputsManager;
  124217. }
  124218. }
  124219. declare module BABYLON {
  124220. /**
  124221. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  124222. * an arc rotate version arcFollowCamera are available.
  124223. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124224. */
  124225. export class FollowCamera extends TargetCamera {
  124226. /**
  124227. * Distance the follow camera should follow an object at
  124228. */
  124229. radius: number;
  124230. /**
  124231. * Minimum allowed distance of the camera to the axis of rotation
  124232. * (The camera can not get closer).
  124233. * This can help limiting how the Camera is able to move in the scene.
  124234. */
  124235. lowerRadiusLimit: Nullable<number>;
  124236. /**
  124237. * Maximum allowed distance of the camera to the axis of rotation
  124238. * (The camera can not get further).
  124239. * This can help limiting how the Camera is able to move in the scene.
  124240. */
  124241. upperRadiusLimit: Nullable<number>;
  124242. /**
  124243. * Define a rotation offset between the camera and the object it follows
  124244. */
  124245. rotationOffset: number;
  124246. /**
  124247. * Minimum allowed angle to camera position relative to target object.
  124248. * This can help limiting how the Camera is able to move in the scene.
  124249. */
  124250. lowerRotationOffsetLimit: Nullable<number>;
  124251. /**
  124252. * Maximum allowed angle to camera position relative to target object.
  124253. * This can help limiting how the Camera is able to move in the scene.
  124254. */
  124255. upperRotationOffsetLimit: Nullable<number>;
  124256. /**
  124257. * Define a height offset between the camera and the object it follows.
  124258. * It can help following an object from the top (like a car chaing a plane)
  124259. */
  124260. heightOffset: number;
  124261. /**
  124262. * Minimum allowed height of camera position relative to target object.
  124263. * This can help limiting how the Camera is able to move in the scene.
  124264. */
  124265. lowerHeightOffsetLimit: Nullable<number>;
  124266. /**
  124267. * Maximum allowed height of camera position relative to target object.
  124268. * This can help limiting how the Camera is able to move in the scene.
  124269. */
  124270. upperHeightOffsetLimit: Nullable<number>;
  124271. /**
  124272. * Define how fast the camera can accelerate to follow it s target.
  124273. */
  124274. cameraAcceleration: number;
  124275. /**
  124276. * Define the speed limit of the camera following an object.
  124277. */
  124278. maxCameraSpeed: number;
  124279. /**
  124280. * Define the target of the camera.
  124281. */
  124282. lockedTarget: Nullable<AbstractMesh>;
  124283. /**
  124284. * Defines the input associated with the camera.
  124285. */
  124286. inputs: FollowCameraInputsManager;
  124287. /**
  124288. * Instantiates the follow camera.
  124289. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124290. * @param name Define the name of the camera in the scene
  124291. * @param position Define the position of the camera
  124292. * @param scene Define the scene the camera belong to
  124293. * @param lockedTarget Define the target of the camera
  124294. */
  124295. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  124296. private _follow;
  124297. /**
  124298. * Attached controls to the current camera.
  124299. * @param element Defines the element the controls should be listened from
  124300. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124301. */
  124302. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124303. /**
  124304. * Detach the current controls from the camera.
  124305. * The camera will stop reacting to inputs.
  124306. * @param element Defines the element to stop listening the inputs from
  124307. */
  124308. detachControl(element: HTMLElement): void;
  124309. /** @hidden */
  124310. _checkInputs(): void;
  124311. private _checkLimits;
  124312. /**
  124313. * Gets the camera class name.
  124314. * @returns the class name
  124315. */
  124316. getClassName(): string;
  124317. }
  124318. /**
  124319. * Arc Rotate version of the follow camera.
  124320. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  124321. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124322. */
  124323. export class ArcFollowCamera extends TargetCamera {
  124324. /** The longitudinal angle of the camera */
  124325. alpha: number;
  124326. /** The latitudinal angle of the camera */
  124327. beta: number;
  124328. /** The radius of the camera from its target */
  124329. radius: number;
  124330. private _cartesianCoordinates;
  124331. /** Define the camera target (the mesh it should follow) */
  124332. private _meshTarget;
  124333. /**
  124334. * Instantiates a new ArcFollowCamera
  124335. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124336. * @param name Define the name of the camera
  124337. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  124338. * @param beta Define the rotation angle of the camera around the elevation axis
  124339. * @param radius Define the radius of the camera from its target point
  124340. * @param target Define the target of the camera
  124341. * @param scene Define the scene the camera belongs to
  124342. */
  124343. constructor(name: string,
  124344. /** The longitudinal angle of the camera */
  124345. alpha: number,
  124346. /** The latitudinal angle of the camera */
  124347. beta: number,
  124348. /** The radius of the camera from its target */
  124349. radius: number,
  124350. /** Define the camera target (the mesh it should follow) */
  124351. target: Nullable<AbstractMesh>, scene: Scene);
  124352. private _follow;
  124353. /** @hidden */
  124354. _checkInputs(): void;
  124355. /**
  124356. * Returns the class name of the object.
  124357. * It is mostly used internally for serialization purposes.
  124358. */
  124359. getClassName(): string;
  124360. }
  124361. }
  124362. declare module BABYLON {
  124363. /**
  124364. * Manage the keyboard inputs to control the movement of a follow camera.
  124365. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124366. */
  124367. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  124368. /**
  124369. * Defines the camera the input is attached to.
  124370. */
  124371. camera: FollowCamera;
  124372. /**
  124373. * Defines the list of key codes associated with the up action (increase heightOffset)
  124374. */
  124375. keysHeightOffsetIncr: number[];
  124376. /**
  124377. * Defines the list of key codes associated with the down action (decrease heightOffset)
  124378. */
  124379. keysHeightOffsetDecr: number[];
  124380. /**
  124381. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  124382. */
  124383. keysHeightOffsetModifierAlt: boolean;
  124384. /**
  124385. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  124386. */
  124387. keysHeightOffsetModifierCtrl: boolean;
  124388. /**
  124389. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  124390. */
  124391. keysHeightOffsetModifierShift: boolean;
  124392. /**
  124393. * Defines the list of key codes associated with the left action (increase rotationOffset)
  124394. */
  124395. keysRotationOffsetIncr: number[];
  124396. /**
  124397. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  124398. */
  124399. keysRotationOffsetDecr: number[];
  124400. /**
  124401. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  124402. */
  124403. keysRotationOffsetModifierAlt: boolean;
  124404. /**
  124405. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  124406. */
  124407. keysRotationOffsetModifierCtrl: boolean;
  124408. /**
  124409. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  124410. */
  124411. keysRotationOffsetModifierShift: boolean;
  124412. /**
  124413. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  124414. */
  124415. keysRadiusIncr: number[];
  124416. /**
  124417. * Defines the list of key codes associated with the zoom-out action (increase radius)
  124418. */
  124419. keysRadiusDecr: number[];
  124420. /**
  124421. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  124422. */
  124423. keysRadiusModifierAlt: boolean;
  124424. /**
  124425. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  124426. */
  124427. keysRadiusModifierCtrl: boolean;
  124428. /**
  124429. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  124430. */
  124431. keysRadiusModifierShift: boolean;
  124432. /**
  124433. * Defines the rate of change of heightOffset.
  124434. */
  124435. heightSensibility: number;
  124436. /**
  124437. * Defines the rate of change of rotationOffset.
  124438. */
  124439. rotationSensibility: number;
  124440. /**
  124441. * Defines the rate of change of radius.
  124442. */
  124443. radiusSensibility: number;
  124444. private _keys;
  124445. private _ctrlPressed;
  124446. private _altPressed;
  124447. private _shiftPressed;
  124448. private _onCanvasBlurObserver;
  124449. private _onKeyboardObserver;
  124450. private _engine;
  124451. private _scene;
  124452. /**
  124453. * Attach the input controls to a specific dom element to get the input from.
  124454. * @param element Defines the element the controls should be listened from
  124455. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124456. */
  124457. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124458. /**
  124459. * Detach the current controls from the specified dom element.
  124460. * @param element Defines the element to stop listening the inputs from
  124461. */
  124462. detachControl(element: Nullable<HTMLElement>): void;
  124463. /**
  124464. * Update the current camera state depending on the inputs that have been used this frame.
  124465. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124466. */
  124467. checkInputs(): void;
  124468. /**
  124469. * Gets the class name of the current input.
  124470. * @returns the class name
  124471. */
  124472. getClassName(): string;
  124473. /**
  124474. * Get the friendly name associated with the input class.
  124475. * @returns the input friendly name
  124476. */
  124477. getSimpleName(): string;
  124478. /**
  124479. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124480. * allow modification of the heightOffset value.
  124481. */
  124482. private _modifierHeightOffset;
  124483. /**
  124484. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124485. * allow modification of the rotationOffset value.
  124486. */
  124487. private _modifierRotationOffset;
  124488. /**
  124489. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124490. * allow modification of the radius value.
  124491. */
  124492. private _modifierRadius;
  124493. }
  124494. }
  124495. declare module BABYLON {
  124496. interface FreeCameraInputsManager {
  124497. /**
  124498. * @hidden
  124499. */
  124500. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  124501. /**
  124502. * Add orientation input support to the input manager.
  124503. * @returns the current input manager
  124504. */
  124505. addDeviceOrientation(): FreeCameraInputsManager;
  124506. }
  124507. /**
  124508. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  124509. * Screen rotation is taken into account.
  124510. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124511. */
  124512. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  124513. private _camera;
  124514. private _screenOrientationAngle;
  124515. private _constantTranform;
  124516. private _screenQuaternion;
  124517. private _alpha;
  124518. private _beta;
  124519. private _gamma;
  124520. /**
  124521. * Can be used to detect if a device orientation sensor is available on a device
  124522. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  124523. * @returns a promise that will resolve on orientation change
  124524. */
  124525. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  124526. /**
  124527. * @hidden
  124528. */
  124529. _onDeviceOrientationChangedObservable: Observable<void>;
  124530. /**
  124531. * Instantiates a new input
  124532. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124533. */
  124534. constructor();
  124535. /**
  124536. * Define the camera controlled by the input.
  124537. */
  124538. get camera(): FreeCamera;
  124539. set camera(camera: FreeCamera);
  124540. /**
  124541. * Attach the input controls to a specific dom element to get the input from.
  124542. * @param element Defines the element the controls should be listened from
  124543. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124544. */
  124545. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124546. private _orientationChanged;
  124547. private _deviceOrientation;
  124548. /**
  124549. * Detach the current controls from the specified dom element.
  124550. * @param element Defines the element to stop listening the inputs from
  124551. */
  124552. detachControl(element: Nullable<HTMLElement>): void;
  124553. /**
  124554. * Update the current camera state depending on the inputs that have been used this frame.
  124555. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124556. */
  124557. checkInputs(): void;
  124558. /**
  124559. * Gets the class name of the current intput.
  124560. * @returns the class name
  124561. */
  124562. getClassName(): string;
  124563. /**
  124564. * Get the friendly name associated with the input class.
  124565. * @returns the input friendly name
  124566. */
  124567. getSimpleName(): string;
  124568. }
  124569. }
  124570. declare module BABYLON {
  124571. /**
  124572. * Manage the gamepad inputs to control a free camera.
  124573. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124574. */
  124575. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  124576. /**
  124577. * Define the camera the input is attached to.
  124578. */
  124579. camera: FreeCamera;
  124580. /**
  124581. * Define the Gamepad controlling the input
  124582. */
  124583. gamepad: Nullable<Gamepad>;
  124584. /**
  124585. * Defines the gamepad rotation sensiblity.
  124586. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124587. */
  124588. gamepadAngularSensibility: number;
  124589. /**
  124590. * Defines the gamepad move sensiblity.
  124591. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124592. */
  124593. gamepadMoveSensibility: number;
  124594. private _yAxisScale;
  124595. /**
  124596. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124597. */
  124598. get invertYAxis(): boolean;
  124599. set invertYAxis(value: boolean);
  124600. private _onGamepadConnectedObserver;
  124601. private _onGamepadDisconnectedObserver;
  124602. private _cameraTransform;
  124603. private _deltaTransform;
  124604. private _vector3;
  124605. private _vector2;
  124606. /**
  124607. * Attach the input controls to a specific dom element to get the input from.
  124608. * @param element Defines the element the controls should be listened from
  124609. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124610. */
  124611. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124612. /**
  124613. * Detach the current controls from the specified dom element.
  124614. * @param element Defines the element to stop listening the inputs from
  124615. */
  124616. detachControl(element: Nullable<HTMLElement>): void;
  124617. /**
  124618. * Update the current camera state depending on the inputs that have been used this frame.
  124619. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124620. */
  124621. checkInputs(): void;
  124622. /**
  124623. * Gets the class name of the current intput.
  124624. * @returns the class name
  124625. */
  124626. getClassName(): string;
  124627. /**
  124628. * Get the friendly name associated with the input class.
  124629. * @returns the input friendly name
  124630. */
  124631. getSimpleName(): string;
  124632. }
  124633. }
  124634. declare module BABYLON {
  124635. /**
  124636. * Defines the potential axis of a Joystick
  124637. */
  124638. export enum JoystickAxis {
  124639. /** X axis */
  124640. X = 0,
  124641. /** Y axis */
  124642. Y = 1,
  124643. /** Z axis */
  124644. Z = 2
  124645. }
  124646. /**
  124647. * Represents the different customization options available
  124648. * for VirtualJoystick
  124649. */
  124650. interface VirtualJoystickCustomizations {
  124651. /**
  124652. * Size of the joystick's puck
  124653. */
  124654. puckSize: number;
  124655. /**
  124656. * Size of the joystick's container
  124657. */
  124658. containerSize: number;
  124659. /**
  124660. * Color of the joystick && puck
  124661. */
  124662. color: string;
  124663. /**
  124664. * Image URL for the joystick's puck
  124665. */
  124666. puckImage?: string;
  124667. /**
  124668. * Image URL for the joystick's container
  124669. */
  124670. containerImage?: string;
  124671. /**
  124672. * Defines the unmoving position of the joystick container
  124673. */
  124674. position?: {
  124675. x: number;
  124676. y: number;
  124677. };
  124678. /**
  124679. * Defines whether or not the joystick container is always visible
  124680. */
  124681. alwaysVisible: boolean;
  124682. /**
  124683. * Defines whether or not to limit the movement of the puck to the joystick's container
  124684. */
  124685. limitToContainer: boolean;
  124686. }
  124687. /**
  124688. * Class used to define virtual joystick (used in touch mode)
  124689. */
  124690. export class VirtualJoystick {
  124691. /**
  124692. * Gets or sets a boolean indicating that left and right values must be inverted
  124693. */
  124694. reverseLeftRight: boolean;
  124695. /**
  124696. * Gets or sets a boolean indicating that up and down values must be inverted
  124697. */
  124698. reverseUpDown: boolean;
  124699. /**
  124700. * Gets the offset value for the position (ie. the change of the position value)
  124701. */
  124702. deltaPosition: Vector3;
  124703. /**
  124704. * Gets a boolean indicating if the virtual joystick was pressed
  124705. */
  124706. pressed: boolean;
  124707. /**
  124708. * Canvas the virtual joystick will render onto, default z-index of this is 5
  124709. */
  124710. static Canvas: Nullable<HTMLCanvasElement>;
  124711. /**
  124712. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  124713. */
  124714. limitToContainer: boolean;
  124715. private static _globalJoystickIndex;
  124716. private static _alwaysVisibleSticks;
  124717. private static vjCanvasContext;
  124718. private static vjCanvasWidth;
  124719. private static vjCanvasHeight;
  124720. private static halfWidth;
  124721. private static _GetDefaultOptions;
  124722. private _action;
  124723. private _axisTargetedByLeftAndRight;
  124724. private _axisTargetedByUpAndDown;
  124725. private _joystickSensibility;
  124726. private _inversedSensibility;
  124727. private _joystickPointerID;
  124728. private _joystickColor;
  124729. private _joystickPointerPos;
  124730. private _joystickPreviousPointerPos;
  124731. private _joystickPointerStartPos;
  124732. private _deltaJoystickVector;
  124733. private _leftJoystick;
  124734. private _touches;
  124735. private _joystickPosition;
  124736. private _alwaysVisible;
  124737. private _puckImage;
  124738. private _containerImage;
  124739. private _joystickPuckSize;
  124740. private _joystickContainerSize;
  124741. private _clearPuckSize;
  124742. private _clearContainerSize;
  124743. private _clearPuckSizeOffset;
  124744. private _clearContainerSizeOffset;
  124745. private _onPointerDownHandlerRef;
  124746. private _onPointerMoveHandlerRef;
  124747. private _onPointerUpHandlerRef;
  124748. private _onResize;
  124749. /**
  124750. * Creates a new virtual joystick
  124751. * @param leftJoystick defines that the joystick is for left hand (false by default)
  124752. * @param customizations Defines the options we want to customize the VirtualJoystick
  124753. */
  124754. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  124755. /**
  124756. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  124757. * @param newJoystickSensibility defines the new sensibility
  124758. */
  124759. setJoystickSensibility(newJoystickSensibility: number): void;
  124760. private _onPointerDown;
  124761. private _onPointerMove;
  124762. private _onPointerUp;
  124763. /**
  124764. * Change the color of the virtual joystick
  124765. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  124766. */
  124767. setJoystickColor(newColor: string): void;
  124768. /**
  124769. * Size of the joystick's container
  124770. */
  124771. set containerSize(newSize: number);
  124772. get containerSize(): number;
  124773. /**
  124774. * Size of the joystick's puck
  124775. */
  124776. set puckSize(newSize: number);
  124777. get puckSize(): number;
  124778. /**
  124779. * Clears the set position of the joystick
  124780. */
  124781. clearPosition(): void;
  124782. /**
  124783. * Defines whether or not the joystick container is always visible
  124784. */
  124785. set alwaysVisible(value: boolean);
  124786. get alwaysVisible(): boolean;
  124787. /**
  124788. * Sets the constant position of the Joystick container
  124789. * @param x X axis coordinate
  124790. * @param y Y axis coordinate
  124791. */
  124792. setPosition(x: number, y: number): void;
  124793. /**
  124794. * Defines a callback to call when the joystick is touched
  124795. * @param action defines the callback
  124796. */
  124797. setActionOnTouch(action: () => any): void;
  124798. /**
  124799. * Defines which axis you'd like to control for left & right
  124800. * @param axis defines the axis to use
  124801. */
  124802. setAxisForLeftRight(axis: JoystickAxis): void;
  124803. /**
  124804. * Defines which axis you'd like to control for up & down
  124805. * @param axis defines the axis to use
  124806. */
  124807. setAxisForUpDown(axis: JoystickAxis): void;
  124808. /**
  124809. * Clears the canvas from the previous puck / container draw
  124810. */
  124811. private _clearPreviousDraw;
  124812. /**
  124813. * Loads `urlPath` to be used for the container's image
  124814. * @param urlPath defines the urlPath of an image to use
  124815. */
  124816. setContainerImage(urlPath: string): void;
  124817. /**
  124818. * Loads `urlPath` to be used for the puck's image
  124819. * @param urlPath defines the urlPath of an image to use
  124820. */
  124821. setPuckImage(urlPath: string): void;
  124822. /**
  124823. * Draws the Virtual Joystick's container
  124824. */
  124825. private _drawContainer;
  124826. /**
  124827. * Draws the Virtual Joystick's puck
  124828. */
  124829. private _drawPuck;
  124830. private _drawVirtualJoystick;
  124831. /**
  124832. * Release internal HTML canvas
  124833. */
  124834. releaseCanvas(): void;
  124835. }
  124836. }
  124837. declare module BABYLON {
  124838. interface FreeCameraInputsManager {
  124839. /**
  124840. * Add virtual joystick input support to the input manager.
  124841. * @returns the current input manager
  124842. */
  124843. addVirtualJoystick(): FreeCameraInputsManager;
  124844. }
  124845. /**
  124846. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  124847. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124848. */
  124849. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  124850. /**
  124851. * Defines the camera the input is attached to.
  124852. */
  124853. camera: FreeCamera;
  124854. private _leftjoystick;
  124855. private _rightjoystick;
  124856. /**
  124857. * Gets the left stick of the virtual joystick.
  124858. * @returns The virtual Joystick
  124859. */
  124860. getLeftJoystick(): VirtualJoystick;
  124861. /**
  124862. * Gets the right stick of the virtual joystick.
  124863. * @returns The virtual Joystick
  124864. */
  124865. getRightJoystick(): VirtualJoystick;
  124866. /**
  124867. * Update the current camera state depending on the inputs that have been used this frame.
  124868. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124869. */
  124870. checkInputs(): void;
  124871. /**
  124872. * Attach the input controls to a specific dom element to get the input from.
  124873. * @param element Defines the element the controls should be listened from
  124874. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124875. */
  124876. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124877. /**
  124878. * Detach the current controls from the specified dom element.
  124879. * @param element Defines the element to stop listening the inputs from
  124880. */
  124881. detachControl(element: Nullable<HTMLElement>): void;
  124882. /**
  124883. * Gets the class name of the current intput.
  124884. * @returns the class name
  124885. */
  124886. getClassName(): string;
  124887. /**
  124888. * Get the friendly name associated with the input class.
  124889. * @returns the input friendly name
  124890. */
  124891. getSimpleName(): string;
  124892. }
  124893. }
  124894. declare module BABYLON {
  124895. /**
  124896. * This represents a FPS type of camera controlled by touch.
  124897. * This is like a universal camera minus the Gamepad controls.
  124898. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124899. */
  124900. export class TouchCamera extends FreeCamera {
  124901. /**
  124902. * Defines the touch sensibility for rotation.
  124903. * The higher the faster.
  124904. */
  124905. get touchAngularSensibility(): number;
  124906. set touchAngularSensibility(value: number);
  124907. /**
  124908. * Defines the touch sensibility for move.
  124909. * The higher the faster.
  124910. */
  124911. get touchMoveSensibility(): number;
  124912. set touchMoveSensibility(value: number);
  124913. /**
  124914. * Instantiates a new touch camera.
  124915. * This represents a FPS type of camera controlled by touch.
  124916. * This is like a universal camera minus the Gamepad controls.
  124917. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124918. * @param name Define the name of the camera in the scene
  124919. * @param position Define the start position of the camera in the scene
  124920. * @param scene Define the scene the camera belongs to
  124921. */
  124922. constructor(name: string, position: Vector3, scene: Scene);
  124923. /**
  124924. * Gets the current object class name.
  124925. * @return the class name
  124926. */
  124927. getClassName(): string;
  124928. /** @hidden */
  124929. _setupInputs(): void;
  124930. }
  124931. }
  124932. declare module BABYLON {
  124933. /**
  124934. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  124935. * being tilted forward or back and left or right.
  124936. */
  124937. export class DeviceOrientationCamera extends FreeCamera {
  124938. private _initialQuaternion;
  124939. private _quaternionCache;
  124940. private _tmpDragQuaternion;
  124941. private _disablePointerInputWhenUsingDeviceOrientation;
  124942. /**
  124943. * Creates a new device orientation camera
  124944. * @param name The name of the camera
  124945. * @param position The start position camera
  124946. * @param scene The scene the camera belongs to
  124947. */
  124948. constructor(name: string, position: Vector3, scene: Scene);
  124949. /**
  124950. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  124951. */
  124952. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  124953. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  124954. private _dragFactor;
  124955. /**
  124956. * Enabled turning on the y axis when the orientation sensor is active
  124957. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  124958. */
  124959. enableHorizontalDragging(dragFactor?: number): void;
  124960. /**
  124961. * Gets the current instance class name ("DeviceOrientationCamera").
  124962. * This helps avoiding instanceof at run time.
  124963. * @returns the class name
  124964. */
  124965. getClassName(): string;
  124966. /**
  124967. * @hidden
  124968. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  124969. */
  124970. _checkInputs(): void;
  124971. /**
  124972. * Reset the camera to its default orientation on the specified axis only.
  124973. * @param axis The axis to reset
  124974. */
  124975. resetToCurrentRotation(axis?: Axis): void;
  124976. }
  124977. }
  124978. declare module BABYLON {
  124979. /**
  124980. * Defines supported buttons for XBox360 compatible gamepads
  124981. */
  124982. export enum Xbox360Button {
  124983. /** A */
  124984. A = 0,
  124985. /** B */
  124986. B = 1,
  124987. /** X */
  124988. X = 2,
  124989. /** Y */
  124990. Y = 3,
  124991. /** Left button */
  124992. LB = 4,
  124993. /** Right button */
  124994. RB = 5,
  124995. /** Back */
  124996. Back = 8,
  124997. /** Start */
  124998. Start = 9,
  124999. /** Left stick */
  125000. LeftStick = 10,
  125001. /** Right stick */
  125002. RightStick = 11
  125003. }
  125004. /** Defines values for XBox360 DPad */
  125005. export enum Xbox360Dpad {
  125006. /** Up */
  125007. Up = 12,
  125008. /** Down */
  125009. Down = 13,
  125010. /** Left */
  125011. Left = 14,
  125012. /** Right */
  125013. Right = 15
  125014. }
  125015. /**
  125016. * Defines a XBox360 gamepad
  125017. */
  125018. export class Xbox360Pad extends Gamepad {
  125019. private _leftTrigger;
  125020. private _rightTrigger;
  125021. private _onlefttriggerchanged;
  125022. private _onrighttriggerchanged;
  125023. private _onbuttondown;
  125024. private _onbuttonup;
  125025. private _ondpaddown;
  125026. private _ondpadup;
  125027. /** Observable raised when a button is pressed */
  125028. onButtonDownObservable: Observable<Xbox360Button>;
  125029. /** Observable raised when a button is released */
  125030. onButtonUpObservable: Observable<Xbox360Button>;
  125031. /** Observable raised when a pad is pressed */
  125032. onPadDownObservable: Observable<Xbox360Dpad>;
  125033. /** Observable raised when a pad is released */
  125034. onPadUpObservable: Observable<Xbox360Dpad>;
  125035. private _buttonA;
  125036. private _buttonB;
  125037. private _buttonX;
  125038. private _buttonY;
  125039. private _buttonBack;
  125040. private _buttonStart;
  125041. private _buttonLB;
  125042. private _buttonRB;
  125043. private _buttonLeftStick;
  125044. private _buttonRightStick;
  125045. private _dPadUp;
  125046. private _dPadDown;
  125047. private _dPadLeft;
  125048. private _dPadRight;
  125049. private _isXboxOnePad;
  125050. /**
  125051. * Creates a new XBox360 gamepad object
  125052. * @param id defines the id of this gamepad
  125053. * @param index defines its index
  125054. * @param gamepad defines the internal HTML gamepad object
  125055. * @param xboxOne defines if it is a XBox One gamepad
  125056. */
  125057. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  125058. /**
  125059. * Defines the callback to call when left trigger is pressed
  125060. * @param callback defines the callback to use
  125061. */
  125062. onlefttriggerchanged(callback: (value: number) => void): void;
  125063. /**
  125064. * Defines the callback to call when right trigger is pressed
  125065. * @param callback defines the callback to use
  125066. */
  125067. onrighttriggerchanged(callback: (value: number) => void): void;
  125068. /**
  125069. * Gets the left trigger value
  125070. */
  125071. get leftTrigger(): number;
  125072. /**
  125073. * Sets the left trigger value
  125074. */
  125075. set leftTrigger(newValue: number);
  125076. /**
  125077. * Gets the right trigger value
  125078. */
  125079. get rightTrigger(): number;
  125080. /**
  125081. * Sets the right trigger value
  125082. */
  125083. set rightTrigger(newValue: number);
  125084. /**
  125085. * Defines the callback to call when a button is pressed
  125086. * @param callback defines the callback to use
  125087. */
  125088. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  125089. /**
  125090. * Defines the callback to call when a button is released
  125091. * @param callback defines the callback to use
  125092. */
  125093. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  125094. /**
  125095. * Defines the callback to call when a pad is pressed
  125096. * @param callback defines the callback to use
  125097. */
  125098. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  125099. /**
  125100. * Defines the callback to call when a pad is released
  125101. * @param callback defines the callback to use
  125102. */
  125103. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  125104. private _setButtonValue;
  125105. private _setDPadValue;
  125106. /**
  125107. * Gets the value of the `A` button
  125108. */
  125109. get buttonA(): number;
  125110. /**
  125111. * Sets the value of the `A` button
  125112. */
  125113. set buttonA(value: number);
  125114. /**
  125115. * Gets the value of the `B` button
  125116. */
  125117. get buttonB(): number;
  125118. /**
  125119. * Sets the value of the `B` button
  125120. */
  125121. set buttonB(value: number);
  125122. /**
  125123. * Gets the value of the `X` button
  125124. */
  125125. get buttonX(): number;
  125126. /**
  125127. * Sets the value of the `X` button
  125128. */
  125129. set buttonX(value: number);
  125130. /**
  125131. * Gets the value of the `Y` button
  125132. */
  125133. get buttonY(): number;
  125134. /**
  125135. * Sets the value of the `Y` button
  125136. */
  125137. set buttonY(value: number);
  125138. /**
  125139. * Gets the value of the `Start` button
  125140. */
  125141. get buttonStart(): number;
  125142. /**
  125143. * Sets the value of the `Start` button
  125144. */
  125145. set buttonStart(value: number);
  125146. /**
  125147. * Gets the value of the `Back` button
  125148. */
  125149. get buttonBack(): number;
  125150. /**
  125151. * Sets the value of the `Back` button
  125152. */
  125153. set buttonBack(value: number);
  125154. /**
  125155. * Gets the value of the `Left` button
  125156. */
  125157. get buttonLB(): number;
  125158. /**
  125159. * Sets the value of the `Left` button
  125160. */
  125161. set buttonLB(value: number);
  125162. /**
  125163. * Gets the value of the `Right` button
  125164. */
  125165. get buttonRB(): number;
  125166. /**
  125167. * Sets the value of the `Right` button
  125168. */
  125169. set buttonRB(value: number);
  125170. /**
  125171. * Gets the value of the Left joystick
  125172. */
  125173. get buttonLeftStick(): number;
  125174. /**
  125175. * Sets the value of the Left joystick
  125176. */
  125177. set buttonLeftStick(value: number);
  125178. /**
  125179. * Gets the value of the Right joystick
  125180. */
  125181. get buttonRightStick(): number;
  125182. /**
  125183. * Sets the value of the Right joystick
  125184. */
  125185. set buttonRightStick(value: number);
  125186. /**
  125187. * Gets the value of D-pad up
  125188. */
  125189. get dPadUp(): number;
  125190. /**
  125191. * Sets the value of D-pad up
  125192. */
  125193. set dPadUp(value: number);
  125194. /**
  125195. * Gets the value of D-pad down
  125196. */
  125197. get dPadDown(): number;
  125198. /**
  125199. * Sets the value of D-pad down
  125200. */
  125201. set dPadDown(value: number);
  125202. /**
  125203. * Gets the value of D-pad left
  125204. */
  125205. get dPadLeft(): number;
  125206. /**
  125207. * Sets the value of D-pad left
  125208. */
  125209. set dPadLeft(value: number);
  125210. /**
  125211. * Gets the value of D-pad right
  125212. */
  125213. get dPadRight(): number;
  125214. /**
  125215. * Sets the value of D-pad right
  125216. */
  125217. set dPadRight(value: number);
  125218. /**
  125219. * Force the gamepad to synchronize with device values
  125220. */
  125221. update(): void;
  125222. /**
  125223. * Disposes the gamepad
  125224. */
  125225. dispose(): void;
  125226. }
  125227. }
  125228. declare module BABYLON {
  125229. /**
  125230. * Defines supported buttons for DualShock compatible gamepads
  125231. */
  125232. export enum DualShockButton {
  125233. /** Cross */
  125234. Cross = 0,
  125235. /** Circle */
  125236. Circle = 1,
  125237. /** Square */
  125238. Square = 2,
  125239. /** Triangle */
  125240. Triangle = 3,
  125241. /** L1 */
  125242. L1 = 4,
  125243. /** R1 */
  125244. R1 = 5,
  125245. /** Share */
  125246. Share = 8,
  125247. /** Options */
  125248. Options = 9,
  125249. /** Left stick */
  125250. LeftStick = 10,
  125251. /** Right stick */
  125252. RightStick = 11
  125253. }
  125254. /** Defines values for DualShock DPad */
  125255. export enum DualShockDpad {
  125256. /** Up */
  125257. Up = 12,
  125258. /** Down */
  125259. Down = 13,
  125260. /** Left */
  125261. Left = 14,
  125262. /** Right */
  125263. Right = 15
  125264. }
  125265. /**
  125266. * Defines a DualShock gamepad
  125267. */
  125268. export class DualShockPad extends Gamepad {
  125269. private _leftTrigger;
  125270. private _rightTrigger;
  125271. private _onlefttriggerchanged;
  125272. private _onrighttriggerchanged;
  125273. private _onbuttondown;
  125274. private _onbuttonup;
  125275. private _ondpaddown;
  125276. private _ondpadup;
  125277. /** Observable raised when a button is pressed */
  125278. onButtonDownObservable: Observable<DualShockButton>;
  125279. /** Observable raised when a button is released */
  125280. onButtonUpObservable: Observable<DualShockButton>;
  125281. /** Observable raised when a pad is pressed */
  125282. onPadDownObservable: Observable<DualShockDpad>;
  125283. /** Observable raised when a pad is released */
  125284. onPadUpObservable: Observable<DualShockDpad>;
  125285. private _buttonCross;
  125286. private _buttonCircle;
  125287. private _buttonSquare;
  125288. private _buttonTriangle;
  125289. private _buttonShare;
  125290. private _buttonOptions;
  125291. private _buttonL1;
  125292. private _buttonR1;
  125293. private _buttonLeftStick;
  125294. private _buttonRightStick;
  125295. private _dPadUp;
  125296. private _dPadDown;
  125297. private _dPadLeft;
  125298. private _dPadRight;
  125299. /**
  125300. * Creates a new DualShock gamepad object
  125301. * @param id defines the id of this gamepad
  125302. * @param index defines its index
  125303. * @param gamepad defines the internal HTML gamepad object
  125304. */
  125305. constructor(id: string, index: number, gamepad: any);
  125306. /**
  125307. * Defines the callback to call when left trigger is pressed
  125308. * @param callback defines the callback to use
  125309. */
  125310. onlefttriggerchanged(callback: (value: number) => void): void;
  125311. /**
  125312. * Defines the callback to call when right trigger is pressed
  125313. * @param callback defines the callback to use
  125314. */
  125315. onrighttriggerchanged(callback: (value: number) => void): void;
  125316. /**
  125317. * Gets the left trigger value
  125318. */
  125319. get leftTrigger(): number;
  125320. /**
  125321. * Sets the left trigger value
  125322. */
  125323. set leftTrigger(newValue: number);
  125324. /**
  125325. * Gets the right trigger value
  125326. */
  125327. get rightTrigger(): number;
  125328. /**
  125329. * Sets the right trigger value
  125330. */
  125331. set rightTrigger(newValue: number);
  125332. /**
  125333. * Defines the callback to call when a button is pressed
  125334. * @param callback defines the callback to use
  125335. */
  125336. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  125337. /**
  125338. * Defines the callback to call when a button is released
  125339. * @param callback defines the callback to use
  125340. */
  125341. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  125342. /**
  125343. * Defines the callback to call when a pad is pressed
  125344. * @param callback defines the callback to use
  125345. */
  125346. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  125347. /**
  125348. * Defines the callback to call when a pad is released
  125349. * @param callback defines the callback to use
  125350. */
  125351. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  125352. private _setButtonValue;
  125353. private _setDPadValue;
  125354. /**
  125355. * Gets the value of the `Cross` button
  125356. */
  125357. get buttonCross(): number;
  125358. /**
  125359. * Sets the value of the `Cross` button
  125360. */
  125361. set buttonCross(value: number);
  125362. /**
  125363. * Gets the value of the `Circle` button
  125364. */
  125365. get buttonCircle(): number;
  125366. /**
  125367. * Sets the value of the `Circle` button
  125368. */
  125369. set buttonCircle(value: number);
  125370. /**
  125371. * Gets the value of the `Square` button
  125372. */
  125373. get buttonSquare(): number;
  125374. /**
  125375. * Sets the value of the `Square` button
  125376. */
  125377. set buttonSquare(value: number);
  125378. /**
  125379. * Gets the value of the `Triangle` button
  125380. */
  125381. get buttonTriangle(): number;
  125382. /**
  125383. * Sets the value of the `Triangle` button
  125384. */
  125385. set buttonTriangle(value: number);
  125386. /**
  125387. * Gets the value of the `Options` button
  125388. */
  125389. get buttonOptions(): number;
  125390. /**
  125391. * Sets the value of the `Options` button
  125392. */
  125393. set buttonOptions(value: number);
  125394. /**
  125395. * Gets the value of the `Share` button
  125396. */
  125397. get buttonShare(): number;
  125398. /**
  125399. * Sets the value of the `Share` button
  125400. */
  125401. set buttonShare(value: number);
  125402. /**
  125403. * Gets the value of the `L1` button
  125404. */
  125405. get buttonL1(): number;
  125406. /**
  125407. * Sets the value of the `L1` button
  125408. */
  125409. set buttonL1(value: number);
  125410. /**
  125411. * Gets the value of the `R1` button
  125412. */
  125413. get buttonR1(): number;
  125414. /**
  125415. * Sets the value of the `R1` button
  125416. */
  125417. set buttonR1(value: number);
  125418. /**
  125419. * Gets the value of the Left joystick
  125420. */
  125421. get buttonLeftStick(): number;
  125422. /**
  125423. * Sets the value of the Left joystick
  125424. */
  125425. set buttonLeftStick(value: number);
  125426. /**
  125427. * Gets the value of the Right joystick
  125428. */
  125429. get buttonRightStick(): number;
  125430. /**
  125431. * Sets the value of the Right joystick
  125432. */
  125433. set buttonRightStick(value: number);
  125434. /**
  125435. * Gets the value of D-pad up
  125436. */
  125437. get dPadUp(): number;
  125438. /**
  125439. * Sets the value of D-pad up
  125440. */
  125441. set dPadUp(value: number);
  125442. /**
  125443. * Gets the value of D-pad down
  125444. */
  125445. get dPadDown(): number;
  125446. /**
  125447. * Sets the value of D-pad down
  125448. */
  125449. set dPadDown(value: number);
  125450. /**
  125451. * Gets the value of D-pad left
  125452. */
  125453. get dPadLeft(): number;
  125454. /**
  125455. * Sets the value of D-pad left
  125456. */
  125457. set dPadLeft(value: number);
  125458. /**
  125459. * Gets the value of D-pad right
  125460. */
  125461. get dPadRight(): number;
  125462. /**
  125463. * Sets the value of D-pad right
  125464. */
  125465. set dPadRight(value: number);
  125466. /**
  125467. * Force the gamepad to synchronize with device values
  125468. */
  125469. update(): void;
  125470. /**
  125471. * Disposes the gamepad
  125472. */
  125473. dispose(): void;
  125474. }
  125475. }
  125476. declare module BABYLON {
  125477. /**
  125478. * Manager for handling gamepads
  125479. */
  125480. export class GamepadManager {
  125481. private _scene?;
  125482. private _babylonGamepads;
  125483. private _oneGamepadConnected;
  125484. /** @hidden */
  125485. _isMonitoring: boolean;
  125486. private _gamepadEventSupported;
  125487. private _gamepadSupport?;
  125488. /**
  125489. * observable to be triggered when the gamepad controller has been connected
  125490. */
  125491. onGamepadConnectedObservable: Observable<Gamepad>;
  125492. /**
  125493. * observable to be triggered when the gamepad controller has been disconnected
  125494. */
  125495. onGamepadDisconnectedObservable: Observable<Gamepad>;
  125496. private _onGamepadConnectedEvent;
  125497. private _onGamepadDisconnectedEvent;
  125498. /**
  125499. * Initializes the gamepad manager
  125500. * @param _scene BabylonJS scene
  125501. */
  125502. constructor(_scene?: Scene | undefined);
  125503. /**
  125504. * The gamepads in the game pad manager
  125505. */
  125506. get gamepads(): Gamepad[];
  125507. /**
  125508. * Get the gamepad controllers based on type
  125509. * @param type The type of gamepad controller
  125510. * @returns Nullable gamepad
  125511. */
  125512. getGamepadByType(type?: number): Nullable<Gamepad>;
  125513. /**
  125514. * Disposes the gamepad manager
  125515. */
  125516. dispose(): void;
  125517. private _addNewGamepad;
  125518. private _startMonitoringGamepads;
  125519. private _stopMonitoringGamepads;
  125520. /** @hidden */
  125521. _checkGamepadsStatus(): void;
  125522. private _updateGamepadObjects;
  125523. }
  125524. }
  125525. declare module BABYLON {
  125526. interface Scene {
  125527. /** @hidden */
  125528. _gamepadManager: Nullable<GamepadManager>;
  125529. /**
  125530. * Gets the gamepad manager associated with the scene
  125531. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  125532. */
  125533. gamepadManager: GamepadManager;
  125534. }
  125535. /**
  125536. * Interface representing a free camera inputs manager
  125537. */
  125538. interface FreeCameraInputsManager {
  125539. /**
  125540. * Adds gamepad input support to the FreeCameraInputsManager.
  125541. * @returns the FreeCameraInputsManager
  125542. */
  125543. addGamepad(): FreeCameraInputsManager;
  125544. }
  125545. /**
  125546. * Interface representing an arc rotate camera inputs manager
  125547. */
  125548. interface ArcRotateCameraInputsManager {
  125549. /**
  125550. * Adds gamepad input support to the ArcRotateCamera InputManager.
  125551. * @returns the camera inputs manager
  125552. */
  125553. addGamepad(): ArcRotateCameraInputsManager;
  125554. }
  125555. /**
  125556. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  125557. */
  125558. export class GamepadSystemSceneComponent implements ISceneComponent {
  125559. /**
  125560. * The component name helpfull to identify the component in the list of scene components.
  125561. */
  125562. readonly name: string;
  125563. /**
  125564. * The scene the component belongs to.
  125565. */
  125566. scene: Scene;
  125567. /**
  125568. * Creates a new instance of the component for the given scene
  125569. * @param scene Defines the scene to register the component in
  125570. */
  125571. constructor(scene: Scene);
  125572. /**
  125573. * Registers the component in a given scene
  125574. */
  125575. register(): void;
  125576. /**
  125577. * Rebuilds the elements related to this component in case of
  125578. * context lost for instance.
  125579. */
  125580. rebuild(): void;
  125581. /**
  125582. * Disposes the component and the associated ressources
  125583. */
  125584. dispose(): void;
  125585. private _beforeCameraUpdate;
  125586. }
  125587. }
  125588. declare module BABYLON {
  125589. /**
  125590. * 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,
  125591. * which still works and will still be found in many Playgrounds.
  125592. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125593. */
  125594. export class UniversalCamera extends TouchCamera {
  125595. /**
  125596. * Defines the gamepad rotation sensiblity.
  125597. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125598. */
  125599. get gamepadAngularSensibility(): number;
  125600. set gamepadAngularSensibility(value: number);
  125601. /**
  125602. * Defines the gamepad move sensiblity.
  125603. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125604. */
  125605. get gamepadMoveSensibility(): number;
  125606. set gamepadMoveSensibility(value: number);
  125607. /**
  125608. * The Universal Camera is the one to choose for first person shooter type games, and works with all the keyboard, mouse, touch and gamepads. This replaces the earlier Free Camera,
  125609. * which still works and will still be found in many Playgrounds.
  125610. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125611. * @param name Define the name of the camera in the scene
  125612. * @param position Define the start position of the camera in the scene
  125613. * @param scene Define the scene the camera belongs to
  125614. */
  125615. constructor(name: string, position: Vector3, scene: Scene);
  125616. /**
  125617. * Gets the current object class name.
  125618. * @return the class name
  125619. */
  125620. getClassName(): string;
  125621. }
  125622. }
  125623. declare module BABYLON {
  125624. /**
  125625. * This represents a FPS type of camera. This is only here for back compat purpose.
  125626. * Please use the UniversalCamera instead as both are identical.
  125627. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125628. */
  125629. export class GamepadCamera extends UniversalCamera {
  125630. /**
  125631. * Instantiates a new Gamepad Camera
  125632. * This represents a FPS type of camera. This is only here for back compat purpose.
  125633. * Please use the UniversalCamera instead as both are identical.
  125634. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125635. * @param name Define the name of the camera in the scene
  125636. * @param position Define the start position of the camera in the scene
  125637. * @param scene Define the scene the camera belongs to
  125638. */
  125639. constructor(name: string, position: Vector3, scene: Scene);
  125640. /**
  125641. * Gets the current object class name.
  125642. * @return the class name
  125643. */
  125644. getClassName(): string;
  125645. }
  125646. }
  125647. declare module BABYLON {
  125648. /** @hidden */
  125649. export var passPixelShader: {
  125650. name: string;
  125651. shader: string;
  125652. };
  125653. }
  125654. declare module BABYLON {
  125655. /** @hidden */
  125656. export var passCubePixelShader: {
  125657. name: string;
  125658. shader: string;
  125659. };
  125660. }
  125661. declare module BABYLON {
  125662. /**
  125663. * PassPostProcess which produces an output the same as it's input
  125664. */
  125665. export class PassPostProcess extends PostProcess {
  125666. /**
  125667. * Gets a string identifying the name of the class
  125668. * @returns "PassPostProcess" string
  125669. */
  125670. getClassName(): string;
  125671. /**
  125672. * Creates the PassPostProcess
  125673. * @param name The name of the effect.
  125674. * @param options The required width/height ratio to downsize to before computing the render pass.
  125675. * @param camera The camera to apply the render pass to.
  125676. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125677. * @param engine The engine which the post process will be applied. (default: current engine)
  125678. * @param reusable If the post process can be reused on the same frame. (default: false)
  125679. * @param textureType The type of texture to be used when performing the post processing.
  125680. * @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)
  125681. */
  125682. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125683. /** @hidden */
  125684. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  125685. }
  125686. /**
  125687. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  125688. */
  125689. export class PassCubePostProcess extends PostProcess {
  125690. private _face;
  125691. /**
  125692. * Gets or sets the cube face to display.
  125693. * * 0 is +X
  125694. * * 1 is -X
  125695. * * 2 is +Y
  125696. * * 3 is -Y
  125697. * * 4 is +Z
  125698. * * 5 is -Z
  125699. */
  125700. get face(): number;
  125701. set face(value: number);
  125702. /**
  125703. * Gets a string identifying the name of the class
  125704. * @returns "PassCubePostProcess" string
  125705. */
  125706. getClassName(): string;
  125707. /**
  125708. * Creates the PassCubePostProcess
  125709. * @param name The name of the effect.
  125710. * @param options The required width/height ratio to downsize to before computing the render pass.
  125711. * @param camera The camera to apply the render pass to.
  125712. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125713. * @param engine The engine which the post process will be applied. (default: current engine)
  125714. * @param reusable If the post process can be reused on the same frame. (default: false)
  125715. * @param textureType The type of texture to be used when performing the post processing.
  125716. * @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)
  125717. */
  125718. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125719. /** @hidden */
  125720. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  125721. }
  125722. }
  125723. declare module BABYLON {
  125724. /** @hidden */
  125725. export var anaglyphPixelShader: {
  125726. name: string;
  125727. shader: string;
  125728. };
  125729. }
  125730. declare module BABYLON {
  125731. /**
  125732. * Postprocess used to generate anaglyphic rendering
  125733. */
  125734. export class AnaglyphPostProcess extends PostProcess {
  125735. private _passedProcess;
  125736. /**
  125737. * Gets a string identifying the name of the class
  125738. * @returns "AnaglyphPostProcess" string
  125739. */
  125740. getClassName(): string;
  125741. /**
  125742. * Creates a new AnaglyphPostProcess
  125743. * @param name defines postprocess name
  125744. * @param options defines creation options or target ratio scale
  125745. * @param rigCameras defines cameras using this postprocess
  125746. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  125747. * @param engine defines hosting engine
  125748. * @param reusable defines if the postprocess will be reused multiple times per frame
  125749. */
  125750. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  125751. }
  125752. }
  125753. declare module BABYLON {
  125754. /**
  125755. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  125756. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125757. */
  125758. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  125759. /**
  125760. * Creates a new AnaglyphArcRotateCamera
  125761. * @param name defines camera name
  125762. * @param alpha defines alpha angle (in radians)
  125763. * @param beta defines beta angle (in radians)
  125764. * @param radius defines radius
  125765. * @param target defines camera target
  125766. * @param interaxialDistance defines distance between each color axis
  125767. * @param scene defines the hosting scene
  125768. */
  125769. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  125770. /**
  125771. * Gets camera class name
  125772. * @returns AnaglyphArcRotateCamera
  125773. */
  125774. getClassName(): string;
  125775. }
  125776. }
  125777. declare module BABYLON {
  125778. /**
  125779. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  125780. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125781. */
  125782. export class AnaglyphFreeCamera extends FreeCamera {
  125783. /**
  125784. * Creates a new AnaglyphFreeCamera
  125785. * @param name defines camera name
  125786. * @param position defines initial position
  125787. * @param interaxialDistance defines distance between each color axis
  125788. * @param scene defines the hosting scene
  125789. */
  125790. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125791. /**
  125792. * Gets camera class name
  125793. * @returns AnaglyphFreeCamera
  125794. */
  125795. getClassName(): string;
  125796. }
  125797. }
  125798. declare module BABYLON {
  125799. /**
  125800. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  125801. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125802. */
  125803. export class AnaglyphGamepadCamera extends GamepadCamera {
  125804. /**
  125805. * Creates a new AnaglyphGamepadCamera
  125806. * @param name defines camera name
  125807. * @param position defines initial position
  125808. * @param interaxialDistance defines distance between each color axis
  125809. * @param scene defines the hosting scene
  125810. */
  125811. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125812. /**
  125813. * Gets camera class name
  125814. * @returns AnaglyphGamepadCamera
  125815. */
  125816. getClassName(): string;
  125817. }
  125818. }
  125819. declare module BABYLON {
  125820. /**
  125821. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  125822. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125823. */
  125824. export class AnaglyphUniversalCamera extends UniversalCamera {
  125825. /**
  125826. * Creates a new AnaglyphUniversalCamera
  125827. * @param name defines camera name
  125828. * @param position defines initial position
  125829. * @param interaxialDistance defines distance between each color axis
  125830. * @param scene defines the hosting scene
  125831. */
  125832. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125833. /**
  125834. * Gets camera class name
  125835. * @returns AnaglyphUniversalCamera
  125836. */
  125837. getClassName(): string;
  125838. }
  125839. }
  125840. declare module BABYLON {
  125841. /**
  125842. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  125843. * @see https://doc.babylonjs.com/features/cameras
  125844. */
  125845. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  125846. /**
  125847. * Creates a new StereoscopicArcRotateCamera
  125848. * @param name defines camera name
  125849. * @param alpha defines alpha angle (in radians)
  125850. * @param beta defines beta angle (in radians)
  125851. * @param radius defines radius
  125852. * @param target defines camera target
  125853. * @param interaxialDistance defines distance between each color axis
  125854. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125855. * @param scene defines the hosting scene
  125856. */
  125857. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125858. /**
  125859. * Gets camera class name
  125860. * @returns StereoscopicArcRotateCamera
  125861. */
  125862. getClassName(): string;
  125863. }
  125864. }
  125865. declare module BABYLON {
  125866. /**
  125867. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  125868. * @see https://doc.babylonjs.com/features/cameras
  125869. */
  125870. export class StereoscopicFreeCamera extends FreeCamera {
  125871. /**
  125872. * Creates a new StereoscopicFreeCamera
  125873. * @param name defines camera name
  125874. * @param position defines initial position
  125875. * @param interaxialDistance defines distance between each color axis
  125876. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125877. * @param scene defines the hosting scene
  125878. */
  125879. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125880. /**
  125881. * Gets camera class name
  125882. * @returns StereoscopicFreeCamera
  125883. */
  125884. getClassName(): string;
  125885. }
  125886. }
  125887. declare module BABYLON {
  125888. /**
  125889. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  125890. * @see https://doc.babylonjs.com/features/cameras
  125891. */
  125892. export class StereoscopicGamepadCamera extends GamepadCamera {
  125893. /**
  125894. * Creates a new StereoscopicGamepadCamera
  125895. * @param name defines camera name
  125896. * @param position defines initial position
  125897. * @param interaxialDistance defines distance between each color axis
  125898. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125899. * @param scene defines the hosting scene
  125900. */
  125901. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125902. /**
  125903. * Gets camera class name
  125904. * @returns StereoscopicGamepadCamera
  125905. */
  125906. getClassName(): string;
  125907. }
  125908. }
  125909. declare module BABYLON {
  125910. /**
  125911. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  125912. * @see https://doc.babylonjs.com/features/cameras
  125913. */
  125914. export class StereoscopicUniversalCamera extends UniversalCamera {
  125915. /**
  125916. * Creates a new StereoscopicUniversalCamera
  125917. * @param name defines camera name
  125918. * @param position defines initial position
  125919. * @param interaxialDistance defines distance between each color axis
  125920. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125921. * @param scene defines the hosting scene
  125922. */
  125923. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125924. /**
  125925. * Gets camera class name
  125926. * @returns StereoscopicUniversalCamera
  125927. */
  125928. getClassName(): string;
  125929. }
  125930. }
  125931. declare module BABYLON {
  125932. /**
  125933. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  125934. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125935. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125936. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125937. */
  125938. export class VirtualJoysticksCamera extends FreeCamera {
  125939. /**
  125940. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  125941. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125942. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125943. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125944. * @param name Define the name of the camera in the scene
  125945. * @param position Define the start position of the camera in the scene
  125946. * @param scene Define the scene the camera belongs to
  125947. */
  125948. constructor(name: string, position: Vector3, scene: Scene);
  125949. /**
  125950. * Gets the current object class name.
  125951. * @return the class name
  125952. */
  125953. getClassName(): string;
  125954. }
  125955. }
  125956. declare module BABYLON {
  125957. /**
  125958. * This represents all the required metrics to create a VR camera.
  125959. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  125960. */
  125961. export class VRCameraMetrics {
  125962. /**
  125963. * Define the horizontal resolution off the screen.
  125964. */
  125965. hResolution: number;
  125966. /**
  125967. * Define the vertical resolution off the screen.
  125968. */
  125969. vResolution: number;
  125970. /**
  125971. * Define the horizontal screen size.
  125972. */
  125973. hScreenSize: number;
  125974. /**
  125975. * Define the vertical screen size.
  125976. */
  125977. vScreenSize: number;
  125978. /**
  125979. * Define the vertical screen center position.
  125980. */
  125981. vScreenCenter: number;
  125982. /**
  125983. * Define the distance of the eyes to the screen.
  125984. */
  125985. eyeToScreenDistance: number;
  125986. /**
  125987. * Define the distance between both lenses
  125988. */
  125989. lensSeparationDistance: number;
  125990. /**
  125991. * Define the distance between both viewer's eyes.
  125992. */
  125993. interpupillaryDistance: number;
  125994. /**
  125995. * Define the distortion factor of the VR postprocess.
  125996. * Please, touch with care.
  125997. */
  125998. distortionK: number[];
  125999. /**
  126000. * Define the chromatic aberration correction factors for the VR post process.
  126001. */
  126002. chromaAbCorrection: number[];
  126003. /**
  126004. * Define the scale factor of the post process.
  126005. * The smaller the better but the slower.
  126006. */
  126007. postProcessScaleFactor: number;
  126008. /**
  126009. * Define an offset for the lens center.
  126010. */
  126011. lensCenterOffset: number;
  126012. /**
  126013. * Define if the current vr camera should compensate the distortion of the lense or not.
  126014. */
  126015. compensateDistortion: boolean;
  126016. /**
  126017. * Defines if multiview should be enabled when rendering (Default: false)
  126018. */
  126019. multiviewEnabled: boolean;
  126020. /**
  126021. * Gets the rendering aspect ratio based on the provided resolutions.
  126022. */
  126023. get aspectRatio(): number;
  126024. /**
  126025. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  126026. */
  126027. get aspectRatioFov(): number;
  126028. /**
  126029. * @hidden
  126030. */
  126031. get leftHMatrix(): Matrix;
  126032. /**
  126033. * @hidden
  126034. */
  126035. get rightHMatrix(): Matrix;
  126036. /**
  126037. * @hidden
  126038. */
  126039. get leftPreViewMatrix(): Matrix;
  126040. /**
  126041. * @hidden
  126042. */
  126043. get rightPreViewMatrix(): Matrix;
  126044. /**
  126045. * Get the default VRMetrics based on the most generic setup.
  126046. * @returns the default vr metrics
  126047. */
  126048. static GetDefault(): VRCameraMetrics;
  126049. }
  126050. }
  126051. declare module BABYLON {
  126052. /** @hidden */
  126053. export var vrDistortionCorrectionPixelShader: {
  126054. name: string;
  126055. shader: string;
  126056. };
  126057. }
  126058. declare module BABYLON {
  126059. /**
  126060. * VRDistortionCorrectionPostProcess used for mobile VR
  126061. */
  126062. export class VRDistortionCorrectionPostProcess extends PostProcess {
  126063. private _isRightEye;
  126064. private _distortionFactors;
  126065. private _postProcessScaleFactor;
  126066. private _lensCenterOffset;
  126067. private _scaleIn;
  126068. private _scaleFactor;
  126069. private _lensCenter;
  126070. /**
  126071. * Gets a string identifying the name of the class
  126072. * @returns "VRDistortionCorrectionPostProcess" string
  126073. */
  126074. getClassName(): string;
  126075. /**
  126076. * Initializes the VRDistortionCorrectionPostProcess
  126077. * @param name The name of the effect.
  126078. * @param camera The camera to apply the render pass to.
  126079. * @param isRightEye If this is for the right eye distortion
  126080. * @param vrMetrics All the required metrics for the VR camera
  126081. */
  126082. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  126083. }
  126084. }
  126085. declare module BABYLON {
  126086. /**
  126087. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  126088. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126089. */
  126090. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  126091. /**
  126092. * Creates a new VRDeviceOrientationArcRotateCamera
  126093. * @param name defines camera name
  126094. * @param alpha defines the camera rotation along the logitudinal axis
  126095. * @param beta defines the camera rotation along the latitudinal axis
  126096. * @param radius defines the camera distance from its target
  126097. * @param target defines the camera target
  126098. * @param scene defines the scene the camera belongs to
  126099. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126100. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126101. */
  126102. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126103. /**
  126104. * Gets camera class name
  126105. * @returns VRDeviceOrientationArcRotateCamera
  126106. */
  126107. getClassName(): string;
  126108. }
  126109. }
  126110. declare module BABYLON {
  126111. /**
  126112. * Camera used to simulate VR rendering (based on FreeCamera)
  126113. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126114. */
  126115. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  126116. /**
  126117. * Creates a new VRDeviceOrientationFreeCamera
  126118. * @param name defines camera name
  126119. * @param position defines the start position of the camera
  126120. * @param scene defines the scene the camera belongs to
  126121. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126122. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126123. */
  126124. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126125. /**
  126126. * Gets camera class name
  126127. * @returns VRDeviceOrientationFreeCamera
  126128. */
  126129. getClassName(): string;
  126130. }
  126131. }
  126132. declare module BABYLON {
  126133. /**
  126134. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  126135. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126136. */
  126137. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  126138. /**
  126139. * Creates a new VRDeviceOrientationGamepadCamera
  126140. * @param name defines camera name
  126141. * @param position defines the start position of the camera
  126142. * @param scene defines the scene the camera belongs to
  126143. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126144. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126145. */
  126146. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126147. /**
  126148. * Gets camera class name
  126149. * @returns VRDeviceOrientationGamepadCamera
  126150. */
  126151. getClassName(): string;
  126152. }
  126153. }
  126154. declare module BABYLON {
  126155. /**
  126156. * A class extending Texture allowing drawing on a texture
  126157. * @see https://doc.babylonjs.com/how_to/dynamictexture
  126158. */
  126159. export class DynamicTexture extends Texture {
  126160. private _generateMipMaps;
  126161. private _canvas;
  126162. private _context;
  126163. /**
  126164. * Creates a DynamicTexture
  126165. * @param name defines the name of the texture
  126166. * @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
  126167. * @param scene defines the scene where you want the texture
  126168. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  126169. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126170. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  126171. */
  126172. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  126173. /**
  126174. * Get the current class name of the texture useful for serialization or dynamic coding.
  126175. * @returns "DynamicTexture"
  126176. */
  126177. getClassName(): string;
  126178. /**
  126179. * Gets the current state of canRescale
  126180. */
  126181. get canRescale(): boolean;
  126182. private _recreate;
  126183. /**
  126184. * Scales the texture
  126185. * @param ratio the scale factor to apply to both width and height
  126186. */
  126187. scale(ratio: number): void;
  126188. /**
  126189. * Resizes the texture
  126190. * @param width the new width
  126191. * @param height the new height
  126192. */
  126193. scaleTo(width: number, height: number): void;
  126194. /**
  126195. * Gets the context of the canvas used by the texture
  126196. * @returns the canvas context of the dynamic texture
  126197. */
  126198. getContext(): CanvasRenderingContext2D;
  126199. /**
  126200. * Clears the texture
  126201. */
  126202. clear(): void;
  126203. /**
  126204. * Updates the texture
  126205. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126206. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  126207. */
  126208. update(invertY?: boolean, premulAlpha?: boolean): void;
  126209. /**
  126210. * Draws text onto the texture
  126211. * @param text defines the text to be drawn
  126212. * @param x defines the placement of the text from the left
  126213. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  126214. * @param font defines the font to be used with font-style, font-size, font-name
  126215. * @param color defines the color used for the text
  126216. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  126217. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126218. * @param update defines whether texture is immediately update (default is true)
  126219. */
  126220. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  126221. /**
  126222. * Clones the texture
  126223. * @returns the clone of the texture.
  126224. */
  126225. clone(): DynamicTexture;
  126226. /**
  126227. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  126228. * @returns a serialized dynamic texture object
  126229. */
  126230. serialize(): any;
  126231. private _IsCanvasElement;
  126232. /** @hidden */
  126233. _rebuild(): void;
  126234. }
  126235. }
  126236. declare module BABYLON {
  126237. /**
  126238. * Class containing static functions to help procedurally build meshes
  126239. */
  126240. export class GroundBuilder {
  126241. /**
  126242. * Creates a ground mesh
  126243. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  126244. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  126245. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126246. * @param name defines the name of the mesh
  126247. * @param options defines the options used to create the mesh
  126248. * @param scene defines the hosting scene
  126249. * @returns the ground mesh
  126250. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  126251. */
  126252. static CreateGround(name: string, options: {
  126253. width?: number;
  126254. height?: number;
  126255. subdivisions?: number;
  126256. subdivisionsX?: number;
  126257. subdivisionsY?: number;
  126258. updatable?: boolean;
  126259. }, scene: any): Mesh;
  126260. /**
  126261. * Creates a tiled ground mesh
  126262. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  126263. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  126264. * * 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
  126265. * * 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
  126266. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126267. * @param name defines the name of the mesh
  126268. * @param options defines the options used to create the mesh
  126269. * @param scene defines the hosting scene
  126270. * @returns the tiled ground mesh
  126271. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  126272. */
  126273. static CreateTiledGround(name: string, options: {
  126274. xmin: number;
  126275. zmin: number;
  126276. xmax: number;
  126277. zmax: number;
  126278. subdivisions?: {
  126279. w: number;
  126280. h: number;
  126281. };
  126282. precision?: {
  126283. w: number;
  126284. h: number;
  126285. };
  126286. updatable?: boolean;
  126287. }, scene?: Nullable<Scene>): Mesh;
  126288. /**
  126289. * Creates a ground mesh from a height map
  126290. * * The parameter `url` sets the URL of the height map image resource.
  126291. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126292. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126293. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126294. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126295. * * 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.
  126296. * * 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).
  126297. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126298. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126299. * @param name defines the name of the mesh
  126300. * @param url defines the url to the height map
  126301. * @param options defines the options used to create the mesh
  126302. * @param scene defines the hosting scene
  126303. * @returns the ground mesh
  126304. * @see https://doc.babylonjs.com/babylon101/height_map
  126305. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126306. */
  126307. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126308. width?: number;
  126309. height?: number;
  126310. subdivisions?: number;
  126311. minHeight?: number;
  126312. maxHeight?: number;
  126313. colorFilter?: Color3;
  126314. alphaFilter?: number;
  126315. updatable?: boolean;
  126316. onReady?: (mesh: GroundMesh) => void;
  126317. }, scene?: Nullable<Scene>): GroundMesh;
  126318. }
  126319. }
  126320. declare module BABYLON {
  126321. /**
  126322. * Class containing static functions to help procedurally build meshes
  126323. */
  126324. export class TorusBuilder {
  126325. /**
  126326. * Creates a torus mesh
  126327. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  126328. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  126329. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  126330. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126331. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126332. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126333. * @param name defines the name of the mesh
  126334. * @param options defines the options used to create the mesh
  126335. * @param scene defines the hosting scene
  126336. * @returns the torus mesh
  126337. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  126338. */
  126339. static CreateTorus(name: string, options: {
  126340. diameter?: number;
  126341. thickness?: number;
  126342. tessellation?: number;
  126343. updatable?: boolean;
  126344. sideOrientation?: number;
  126345. frontUVs?: Vector4;
  126346. backUVs?: Vector4;
  126347. }, scene: any): Mesh;
  126348. }
  126349. }
  126350. declare module BABYLON {
  126351. /**
  126352. * Class containing static functions to help procedurally build meshes
  126353. */
  126354. export class CylinderBuilder {
  126355. /**
  126356. * Creates a cylinder or a cone mesh
  126357. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  126358. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  126359. * * 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.
  126360. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  126361. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  126362. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  126363. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  126364. * * 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).
  126365. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  126366. * * 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).
  126367. * * 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
  126368. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  126369. * * 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
  126370. * * 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.
  126371. * * If `enclose` is false, a ring surface is one element.
  126372. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  126373. * * 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
  126374. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126375. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126376. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126377. * @param name defines the name of the mesh
  126378. * @param options defines the options used to create the mesh
  126379. * @param scene defines the hosting scene
  126380. * @returns the cylinder mesh
  126381. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  126382. */
  126383. static CreateCylinder(name: string, options: {
  126384. height?: number;
  126385. diameterTop?: number;
  126386. diameterBottom?: number;
  126387. diameter?: number;
  126388. tessellation?: number;
  126389. subdivisions?: number;
  126390. arc?: number;
  126391. faceColors?: Color4[];
  126392. faceUV?: Vector4[];
  126393. updatable?: boolean;
  126394. hasRings?: boolean;
  126395. enclose?: boolean;
  126396. cap?: number;
  126397. sideOrientation?: number;
  126398. frontUVs?: Vector4;
  126399. backUVs?: Vector4;
  126400. }, scene: any): Mesh;
  126401. }
  126402. }
  126403. declare module BABYLON {
  126404. /**
  126405. * States of the webXR experience
  126406. */
  126407. export enum WebXRState {
  126408. /**
  126409. * Transitioning to being in XR mode
  126410. */
  126411. ENTERING_XR = 0,
  126412. /**
  126413. * Transitioning to non XR mode
  126414. */
  126415. EXITING_XR = 1,
  126416. /**
  126417. * In XR mode and presenting
  126418. */
  126419. IN_XR = 2,
  126420. /**
  126421. * Not entered XR mode
  126422. */
  126423. NOT_IN_XR = 3
  126424. }
  126425. /**
  126426. * Abstraction of the XR render target
  126427. */
  126428. export interface WebXRRenderTarget extends IDisposable {
  126429. /**
  126430. * xrpresent context of the canvas which can be used to display/mirror xr content
  126431. */
  126432. canvasContext: WebGLRenderingContext;
  126433. /**
  126434. * xr layer for the canvas
  126435. */
  126436. xrLayer: Nullable<XRWebGLLayer>;
  126437. /**
  126438. * Initializes the xr layer for the session
  126439. * @param xrSession xr session
  126440. * @returns a promise that will resolve once the XR Layer has been created
  126441. */
  126442. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126443. }
  126444. }
  126445. declare module BABYLON {
  126446. /**
  126447. * COnfiguration object for WebXR output canvas
  126448. */
  126449. export class WebXRManagedOutputCanvasOptions {
  126450. /**
  126451. * An optional canvas in case you wish to create it yourself and provide it here.
  126452. * If not provided, a new canvas will be created
  126453. */
  126454. canvasElement?: HTMLCanvasElement;
  126455. /**
  126456. * Options for this XR Layer output
  126457. */
  126458. canvasOptions?: XRWebGLLayerOptions;
  126459. /**
  126460. * CSS styling for a newly created canvas (if not provided)
  126461. */
  126462. newCanvasCssStyle?: string;
  126463. /**
  126464. * Get the default values of the configuration object
  126465. * @param engine defines the engine to use (can be null)
  126466. * @returns default values of this configuration object
  126467. */
  126468. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  126469. }
  126470. /**
  126471. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  126472. */
  126473. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  126474. private _options;
  126475. private _canvas;
  126476. private _engine;
  126477. private _originalCanvasSize;
  126478. /**
  126479. * Rendering context of the canvas which can be used to display/mirror xr content
  126480. */
  126481. canvasContext: WebGLRenderingContext;
  126482. /**
  126483. * xr layer for the canvas
  126484. */
  126485. xrLayer: Nullable<XRWebGLLayer>;
  126486. /**
  126487. * Obseervers registered here will be triggered when the xr layer was initialized
  126488. */
  126489. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  126490. /**
  126491. * Initializes the canvas to be added/removed upon entering/exiting xr
  126492. * @param _xrSessionManager The XR Session manager
  126493. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  126494. */
  126495. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  126496. /**
  126497. * Disposes of the object
  126498. */
  126499. dispose(): void;
  126500. /**
  126501. * Initializes the xr layer for the session
  126502. * @param xrSession xr session
  126503. * @returns a promise that will resolve once the XR Layer has been created
  126504. */
  126505. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126506. private _addCanvas;
  126507. private _removeCanvas;
  126508. private _setCanvasSize;
  126509. private _setManagedOutputCanvas;
  126510. }
  126511. }
  126512. declare module BABYLON {
  126513. /**
  126514. * Manages an XRSession to work with Babylon's engine
  126515. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  126516. */
  126517. export class WebXRSessionManager implements IDisposable {
  126518. /** The scene which the session should be created for */
  126519. scene: Scene;
  126520. private _referenceSpace;
  126521. private _rttProvider;
  126522. private _sessionEnded;
  126523. private _xrNavigator;
  126524. private baseLayer;
  126525. /**
  126526. * The base reference space from which the session started. good if you want to reset your
  126527. * reference space
  126528. */
  126529. baseReferenceSpace: XRReferenceSpace;
  126530. /**
  126531. * Current XR frame
  126532. */
  126533. currentFrame: Nullable<XRFrame>;
  126534. /** WebXR timestamp updated every frame */
  126535. currentTimestamp: number;
  126536. /**
  126537. * Used just in case of a failure to initialize an immersive session.
  126538. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  126539. */
  126540. defaultHeightCompensation: number;
  126541. /**
  126542. * Fires every time a new xrFrame arrives which can be used to update the camera
  126543. */
  126544. onXRFrameObservable: Observable<XRFrame>;
  126545. /**
  126546. * Fires when the reference space changed
  126547. */
  126548. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  126549. /**
  126550. * Fires when the xr session is ended either by the device or manually done
  126551. */
  126552. onXRSessionEnded: Observable<any>;
  126553. /**
  126554. * Fires when the xr session is ended either by the device or manually done
  126555. */
  126556. onXRSessionInit: Observable<XRSession>;
  126557. /**
  126558. * Underlying xr session
  126559. */
  126560. session: XRSession;
  126561. /**
  126562. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  126563. * or get the offset the player is currently at.
  126564. */
  126565. viewerReferenceSpace: XRReferenceSpace;
  126566. /**
  126567. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  126568. * @param scene The scene which the session should be created for
  126569. */
  126570. constructor(
  126571. /** The scene which the session should be created for */
  126572. scene: Scene);
  126573. /**
  126574. * The current reference space used in this session. This reference space can constantly change!
  126575. * It is mainly used to offset the camera's position.
  126576. */
  126577. get referenceSpace(): XRReferenceSpace;
  126578. /**
  126579. * Set a new reference space and triggers the observable
  126580. */
  126581. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  126582. /**
  126583. * Disposes of the session manager
  126584. */
  126585. dispose(): void;
  126586. /**
  126587. * Stops the xrSession and restores the render loop
  126588. * @returns Promise which resolves after it exits XR
  126589. */
  126590. exitXRAsync(): Promise<void>;
  126591. /**
  126592. * Gets the correct render target texture to be rendered this frame for this eye
  126593. * @param eye the eye for which to get the render target
  126594. * @returns the render target for the specified eye
  126595. */
  126596. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  126597. /**
  126598. * Creates a WebXRRenderTarget object for the XR session
  126599. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  126600. * @param options optional options to provide when creating a new render target
  126601. * @returns a WebXR render target to which the session can render
  126602. */
  126603. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  126604. /**
  126605. * Initializes the manager
  126606. * After initialization enterXR can be called to start an XR session
  126607. * @returns Promise which resolves after it is initialized
  126608. */
  126609. initializeAsync(): Promise<void>;
  126610. /**
  126611. * Initializes an xr session
  126612. * @param xrSessionMode mode to initialize
  126613. * @param xrSessionInit defines optional and required values to pass to the session builder
  126614. * @returns a promise which will resolve once the session has been initialized
  126615. */
  126616. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  126617. /**
  126618. * Checks if a session would be supported for the creation options specified
  126619. * @param sessionMode session mode to check if supported eg. immersive-vr
  126620. * @returns A Promise that resolves to true if supported and false if not
  126621. */
  126622. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126623. /**
  126624. * Resets the reference space to the one started the session
  126625. */
  126626. resetReferenceSpace(): void;
  126627. /**
  126628. * Starts rendering to the xr layer
  126629. */
  126630. runXRRenderLoop(): void;
  126631. /**
  126632. * Sets the reference space on the xr session
  126633. * @param referenceSpaceType space to set
  126634. * @returns a promise that will resolve once the reference space has been set
  126635. */
  126636. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  126637. /**
  126638. * Updates the render state of the session
  126639. * @param state state to set
  126640. * @returns a promise that resolves once the render state has been updated
  126641. */
  126642. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  126643. /**
  126644. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  126645. * @param sessionMode defines the session to test
  126646. * @returns a promise with boolean as final value
  126647. */
  126648. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126649. private _createRenderTargetTexture;
  126650. }
  126651. }
  126652. declare module BABYLON {
  126653. /**
  126654. * WebXR Camera which holds the views for the xrSession
  126655. * @see https://doc.babylonjs.com/how_to/webxr_camera
  126656. */
  126657. export class WebXRCamera extends FreeCamera {
  126658. private _xrSessionManager;
  126659. private _firstFrame;
  126660. private _referenceQuaternion;
  126661. private _referencedPosition;
  126662. private _xrInvPositionCache;
  126663. private _xrInvQuaternionCache;
  126664. /**
  126665. * Observable raised before camera teleportation
  126666. */
  126667. onBeforeCameraTeleport: Observable<Vector3>;
  126668. /**
  126669. * Observable raised after camera teleportation
  126670. */
  126671. onAfterCameraTeleport: Observable<Vector3>;
  126672. /**
  126673. * Should position compensation execute on first frame.
  126674. * This is used when copying the position from a native (non XR) camera
  126675. */
  126676. compensateOnFirstFrame: boolean;
  126677. /**
  126678. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  126679. * @param name the name of the camera
  126680. * @param scene the scene to add the camera to
  126681. * @param _xrSessionManager a constructed xr session manager
  126682. */
  126683. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  126684. /**
  126685. * Return the user's height, unrelated to the current ground.
  126686. * This will be the y position of this camera, when ground level is 0.
  126687. */
  126688. get realWorldHeight(): number;
  126689. /** @hidden */
  126690. _updateForDualEyeDebugging(): void;
  126691. /**
  126692. * Sets this camera's transformation based on a non-vr camera
  126693. * @param otherCamera the non-vr camera to copy the transformation from
  126694. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  126695. */
  126696. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  126697. /**
  126698. * Gets the current instance class name ("WebXRCamera").
  126699. * @returns the class name
  126700. */
  126701. getClassName(): string;
  126702. private _rotate180;
  126703. private _updateFromXRSession;
  126704. private _updateNumberOfRigCameras;
  126705. private _updateReferenceSpace;
  126706. private _updateReferenceSpaceOffset;
  126707. }
  126708. }
  126709. declare module BABYLON {
  126710. /**
  126711. * Defining the interface required for a (webxr) feature
  126712. */
  126713. export interface IWebXRFeature extends IDisposable {
  126714. /**
  126715. * Is this feature attached
  126716. */
  126717. attached: boolean;
  126718. /**
  126719. * Should auto-attach be disabled?
  126720. */
  126721. disableAutoAttach: boolean;
  126722. /**
  126723. * Attach the feature to the session
  126724. * Will usually be called by the features manager
  126725. *
  126726. * @param force should attachment be forced (even when already attached)
  126727. * @returns true if successful.
  126728. */
  126729. attach(force?: boolean): boolean;
  126730. /**
  126731. * Detach the feature from the session
  126732. * Will usually be called by the features manager
  126733. *
  126734. * @returns true if successful.
  126735. */
  126736. detach(): boolean;
  126737. /**
  126738. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  126739. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  126740. *
  126741. * @returns whether or not the feature is compatible in this environment
  126742. */
  126743. isCompatible(): boolean;
  126744. /**
  126745. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  126746. */
  126747. xrNativeFeatureName?: string;
  126748. /**
  126749. * A list of (Babylon WebXR) features this feature depends on
  126750. */
  126751. dependsOn?: string[];
  126752. }
  126753. /**
  126754. * A list of the currently available features without referencing them
  126755. */
  126756. export class WebXRFeatureName {
  126757. /**
  126758. * The name of the anchor system feature
  126759. */
  126760. static readonly ANCHOR_SYSTEM: string;
  126761. /**
  126762. * The name of the background remover feature
  126763. */
  126764. static readonly BACKGROUND_REMOVER: string;
  126765. /**
  126766. * The name of the hit test feature
  126767. */
  126768. static readonly HIT_TEST: string;
  126769. /**
  126770. * physics impostors for xr controllers feature
  126771. */
  126772. static readonly PHYSICS_CONTROLLERS: string;
  126773. /**
  126774. * The name of the plane detection feature
  126775. */
  126776. static readonly PLANE_DETECTION: string;
  126777. /**
  126778. * The name of the pointer selection feature
  126779. */
  126780. static readonly POINTER_SELECTION: string;
  126781. /**
  126782. * The name of the teleportation feature
  126783. */
  126784. static readonly TELEPORTATION: string;
  126785. /**
  126786. * The name of the feature points feature.
  126787. */
  126788. static readonly FEATURE_POINTS: string;
  126789. /**
  126790. * The name of the hand tracking feature.
  126791. */
  126792. static readonly HAND_TRACKING: string;
  126793. }
  126794. /**
  126795. * Defining the constructor of a feature. Used to register the modules.
  126796. */
  126797. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  126798. /**
  126799. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  126800. * It is mainly used in AR sessions.
  126801. *
  126802. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  126803. */
  126804. export class WebXRFeaturesManager implements IDisposable {
  126805. private _xrSessionManager;
  126806. private static readonly _AvailableFeatures;
  126807. private _features;
  126808. /**
  126809. * constructs a new features manages.
  126810. *
  126811. * @param _xrSessionManager an instance of WebXRSessionManager
  126812. */
  126813. constructor(_xrSessionManager: WebXRSessionManager);
  126814. /**
  126815. * Used to register a module. After calling this function a developer can use this feature in the scene.
  126816. * Mainly used internally.
  126817. *
  126818. * @param featureName the name of the feature to register
  126819. * @param constructorFunction the function used to construct the module
  126820. * @param version the (babylon) version of the module
  126821. * @param stable is that a stable version of this module
  126822. */
  126823. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  126824. /**
  126825. * Returns a constructor of a specific feature.
  126826. *
  126827. * @param featureName the name of the feature to construct
  126828. * @param version the version of the feature to load
  126829. * @param xrSessionManager the xrSessionManager. Used to construct the module
  126830. * @param options optional options provided to the module.
  126831. * @returns a function that, when called, will return a new instance of this feature
  126832. */
  126833. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  126834. /**
  126835. * Can be used to return the list of features currently registered
  126836. *
  126837. * @returns an Array of available features
  126838. */
  126839. static GetAvailableFeatures(): string[];
  126840. /**
  126841. * Gets the versions available for a specific feature
  126842. * @param featureName the name of the feature
  126843. * @returns an array with the available versions
  126844. */
  126845. static GetAvailableVersions(featureName: string): string[];
  126846. /**
  126847. * Return the latest unstable version of this feature
  126848. * @param featureName the name of the feature to search
  126849. * @returns the version number. if not found will return -1
  126850. */
  126851. static GetLatestVersionOfFeature(featureName: string): number;
  126852. /**
  126853. * Return the latest stable version of this feature
  126854. * @param featureName the name of the feature to search
  126855. * @returns the version number. if not found will return -1
  126856. */
  126857. static GetStableVersionOfFeature(featureName: string): number;
  126858. /**
  126859. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  126860. * Can be used during a session to start a feature
  126861. * @param featureName the name of feature to attach
  126862. */
  126863. attachFeature(featureName: string): void;
  126864. /**
  126865. * Can be used inside a session or when the session ends to detach a specific feature
  126866. * @param featureName the name of the feature to detach
  126867. */
  126868. detachFeature(featureName: string): void;
  126869. /**
  126870. * Used to disable an already-enabled feature
  126871. * The feature will be disposed and will be recreated once enabled.
  126872. * @param featureName the feature to disable
  126873. * @returns true if disable was successful
  126874. */
  126875. disableFeature(featureName: string | {
  126876. Name: string;
  126877. }): boolean;
  126878. /**
  126879. * dispose this features manager
  126880. */
  126881. dispose(): void;
  126882. /**
  126883. * 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.
  126884. * 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.
  126885. *
  126886. * @param featureName the name of the feature to load or the class of the feature
  126887. * @param version optional version to load. if not provided the latest version will be enabled
  126888. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  126889. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  126890. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  126891. * @returns a new constructed feature or throws an error if feature not found.
  126892. */
  126893. enableFeature(featureName: string | {
  126894. Name: string;
  126895. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  126896. /**
  126897. * get the implementation of an enabled feature.
  126898. * @param featureName the name of the feature to load
  126899. * @returns the feature class, if found
  126900. */
  126901. getEnabledFeature(featureName: string): IWebXRFeature;
  126902. /**
  126903. * Get the list of enabled features
  126904. * @returns an array of enabled features
  126905. */
  126906. getEnabledFeatures(): string[];
  126907. /**
  126908. * This function will exten the session creation configuration object with enabled features.
  126909. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  126910. * according to the defined "required" variable, provided during enableFeature call
  126911. * @param xrSessionInit the xr Session init object to extend
  126912. *
  126913. * @returns an extended XRSessionInit object
  126914. */
  126915. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  126916. }
  126917. }
  126918. declare module BABYLON {
  126919. /**
  126920. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  126921. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  126922. */
  126923. export class WebXRExperienceHelper implements IDisposable {
  126924. private scene;
  126925. private _nonVRCamera;
  126926. private _originalSceneAutoClear;
  126927. private _supported;
  126928. /**
  126929. * Camera used to render xr content
  126930. */
  126931. camera: WebXRCamera;
  126932. /** A features manager for this xr session */
  126933. featuresManager: WebXRFeaturesManager;
  126934. /**
  126935. * Observers registered here will be triggered after the camera's initial transformation is set
  126936. * This can be used to set a different ground level or an extra rotation.
  126937. *
  126938. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  126939. * to the position set after this observable is done executing.
  126940. */
  126941. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  126942. /**
  126943. * Fires when the state of the experience helper has changed
  126944. */
  126945. onStateChangedObservable: Observable<WebXRState>;
  126946. /** Session manager used to keep track of xr session */
  126947. sessionManager: WebXRSessionManager;
  126948. /**
  126949. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  126950. */
  126951. state: WebXRState;
  126952. /**
  126953. * Creates a WebXRExperienceHelper
  126954. * @param scene The scene the helper should be created in
  126955. */
  126956. private constructor();
  126957. /**
  126958. * Creates the experience helper
  126959. * @param scene the scene to attach the experience helper to
  126960. * @returns a promise for the experience helper
  126961. */
  126962. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  126963. /**
  126964. * Disposes of the experience helper
  126965. */
  126966. dispose(): void;
  126967. /**
  126968. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  126969. * @param sessionMode options for the XR session
  126970. * @param referenceSpaceType frame of reference of the XR session
  126971. * @param renderTarget the output canvas that will be used to enter XR mode
  126972. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  126973. * @returns promise that resolves after xr mode has entered
  126974. */
  126975. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  126976. /**
  126977. * Exits XR mode and returns the scene to its original state
  126978. * @returns promise that resolves after xr mode has exited
  126979. */
  126980. exitXRAsync(): Promise<void>;
  126981. private _nonXRToXRCamera;
  126982. private _setState;
  126983. }
  126984. }
  126985. declare module BABYLON {
  126986. /**
  126987. * X-Y values for axes in WebXR
  126988. */
  126989. export interface IWebXRMotionControllerAxesValue {
  126990. /**
  126991. * The value of the x axis
  126992. */
  126993. x: number;
  126994. /**
  126995. * The value of the y-axis
  126996. */
  126997. y: number;
  126998. }
  126999. /**
  127000. * changed / previous values for the values of this component
  127001. */
  127002. export interface IWebXRMotionControllerComponentChangesValues<T> {
  127003. /**
  127004. * current (this frame) value
  127005. */
  127006. current: T;
  127007. /**
  127008. * previous (last change) value
  127009. */
  127010. previous: T;
  127011. }
  127012. /**
  127013. * Represents changes in the component between current frame and last values recorded
  127014. */
  127015. export interface IWebXRMotionControllerComponentChanges {
  127016. /**
  127017. * will be populated with previous and current values if axes changed
  127018. */
  127019. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  127020. /**
  127021. * will be populated with previous and current values if pressed changed
  127022. */
  127023. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127024. /**
  127025. * will be populated with previous and current values if touched changed
  127026. */
  127027. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127028. /**
  127029. * will be populated with previous and current values if value changed
  127030. */
  127031. value?: IWebXRMotionControllerComponentChangesValues<number>;
  127032. }
  127033. /**
  127034. * This class represents a single component (for example button or thumbstick) of a motion controller
  127035. */
  127036. export class WebXRControllerComponent implements IDisposable {
  127037. /**
  127038. * the id of this component
  127039. */
  127040. id: string;
  127041. /**
  127042. * the type of the component
  127043. */
  127044. type: MotionControllerComponentType;
  127045. private _buttonIndex;
  127046. private _axesIndices;
  127047. private _axes;
  127048. private _changes;
  127049. private _currentValue;
  127050. private _hasChanges;
  127051. private _pressed;
  127052. private _touched;
  127053. /**
  127054. * button component type
  127055. */
  127056. static BUTTON_TYPE: MotionControllerComponentType;
  127057. /**
  127058. * squeeze component type
  127059. */
  127060. static SQUEEZE_TYPE: MotionControllerComponentType;
  127061. /**
  127062. * Thumbstick component type
  127063. */
  127064. static THUMBSTICK_TYPE: MotionControllerComponentType;
  127065. /**
  127066. * Touchpad component type
  127067. */
  127068. static TOUCHPAD_TYPE: MotionControllerComponentType;
  127069. /**
  127070. * trigger component type
  127071. */
  127072. static TRIGGER_TYPE: MotionControllerComponentType;
  127073. /**
  127074. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  127075. * the axes data changes
  127076. */
  127077. onAxisValueChangedObservable: Observable<{
  127078. x: number;
  127079. y: number;
  127080. }>;
  127081. /**
  127082. * Observers registered here will be triggered when the state of a button changes
  127083. * State change is either pressed / touched / value
  127084. */
  127085. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  127086. /**
  127087. * Creates a new component for a motion controller.
  127088. * It is created by the motion controller itself
  127089. *
  127090. * @param id the id of this component
  127091. * @param type the type of the component
  127092. * @param _buttonIndex index in the buttons array of the gamepad
  127093. * @param _axesIndices indices of the values in the axes array of the gamepad
  127094. */
  127095. constructor(
  127096. /**
  127097. * the id of this component
  127098. */
  127099. id: string,
  127100. /**
  127101. * the type of the component
  127102. */
  127103. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  127104. /**
  127105. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  127106. */
  127107. get axes(): IWebXRMotionControllerAxesValue;
  127108. /**
  127109. * Get the changes. Elements will be populated only if they changed with their previous and current value
  127110. */
  127111. get changes(): IWebXRMotionControllerComponentChanges;
  127112. /**
  127113. * Return whether or not the component changed the last frame
  127114. */
  127115. get hasChanges(): boolean;
  127116. /**
  127117. * is the button currently pressed
  127118. */
  127119. get pressed(): boolean;
  127120. /**
  127121. * is the button currently touched
  127122. */
  127123. get touched(): boolean;
  127124. /**
  127125. * Get the current value of this component
  127126. */
  127127. get value(): number;
  127128. /**
  127129. * Dispose this component
  127130. */
  127131. dispose(): void;
  127132. /**
  127133. * Are there axes correlating to this component
  127134. * @return true is axes data is available
  127135. */
  127136. isAxes(): boolean;
  127137. /**
  127138. * Is this component a button (hence - pressable)
  127139. * @returns true if can be pressed
  127140. */
  127141. isButton(): boolean;
  127142. /**
  127143. * update this component using the gamepad object it is in. Called on every frame
  127144. * @param nativeController the native gamepad controller object
  127145. */
  127146. update(nativeController: IMinimalMotionControllerObject): void;
  127147. }
  127148. }
  127149. declare module BABYLON {
  127150. /**
  127151. * Interface used to represent data loading progression
  127152. */
  127153. export interface ISceneLoaderProgressEvent {
  127154. /**
  127155. * Defines if data length to load can be evaluated
  127156. */
  127157. readonly lengthComputable: boolean;
  127158. /**
  127159. * Defines the loaded data length
  127160. */
  127161. readonly loaded: number;
  127162. /**
  127163. * Defines the data length to load
  127164. */
  127165. readonly total: number;
  127166. }
  127167. /**
  127168. * Interface used by SceneLoader plugins to define supported file extensions
  127169. */
  127170. export interface ISceneLoaderPluginExtensions {
  127171. /**
  127172. * Defines the list of supported extensions
  127173. */
  127174. [extension: string]: {
  127175. isBinary: boolean;
  127176. };
  127177. }
  127178. /**
  127179. * Interface used by SceneLoader plugin factory
  127180. */
  127181. export interface ISceneLoaderPluginFactory {
  127182. /**
  127183. * Defines the name of the factory
  127184. */
  127185. name: string;
  127186. /**
  127187. * Function called to create a new plugin
  127188. * @return the new plugin
  127189. */
  127190. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  127191. /**
  127192. * The callback that returns true if the data can be directly loaded.
  127193. * @param data string containing the file data
  127194. * @returns if the data can be loaded directly
  127195. */
  127196. canDirectLoad?(data: string): boolean;
  127197. }
  127198. /**
  127199. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  127200. */
  127201. export interface ISceneLoaderPluginBase {
  127202. /**
  127203. * The friendly name of this plugin.
  127204. */
  127205. name: string;
  127206. /**
  127207. * The file extensions supported by this plugin.
  127208. */
  127209. extensions: string | ISceneLoaderPluginExtensions;
  127210. /**
  127211. * The callback called when loading from a url.
  127212. * @param scene scene loading this url
  127213. * @param url url to load
  127214. * @param onSuccess callback called when the file successfully loads
  127215. * @param onProgress callback called while file is loading (if the server supports this mode)
  127216. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  127217. * @param onError callback called when the file fails to load
  127218. * @returns a file request object
  127219. */
  127220. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127221. /**
  127222. * The callback called when loading from a file object.
  127223. * @param scene scene loading this file
  127224. * @param file defines the file to load
  127225. * @param onSuccess defines the callback to call when data is loaded
  127226. * @param onProgress defines the callback to call during loading process
  127227. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  127228. * @param onError defines the callback to call when an error occurs
  127229. * @returns a file request object
  127230. */
  127231. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127232. /**
  127233. * The callback that returns true if the data can be directly loaded.
  127234. * @param data string containing the file data
  127235. * @returns if the data can be loaded directly
  127236. */
  127237. canDirectLoad?(data: string): boolean;
  127238. /**
  127239. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  127240. * @param scene scene loading this data
  127241. * @param data string containing the data
  127242. * @returns data to pass to the plugin
  127243. */
  127244. directLoad?(scene: Scene, data: string): any;
  127245. /**
  127246. * The callback that allows custom handling of the root url based on the response url.
  127247. * @param rootUrl the original root url
  127248. * @param responseURL the response url if available
  127249. * @returns the new root url
  127250. */
  127251. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  127252. }
  127253. /**
  127254. * Interface used to define a SceneLoader plugin
  127255. */
  127256. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  127257. /**
  127258. * Import meshes into a scene.
  127259. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127260. * @param scene The scene to import into
  127261. * @param data The data to import
  127262. * @param rootUrl The root url for scene and resources
  127263. * @param meshes The meshes array to import into
  127264. * @param particleSystems The particle systems array to import into
  127265. * @param skeletons The skeletons array to import into
  127266. * @param onError The callback when import fails
  127267. * @returns True if successful or false otherwise
  127268. */
  127269. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  127270. /**
  127271. * Load into a scene.
  127272. * @param scene The scene to load into
  127273. * @param data The data to import
  127274. * @param rootUrl The root url for scene and resources
  127275. * @param onError The callback when import fails
  127276. * @returns True if successful or false otherwise
  127277. */
  127278. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  127279. /**
  127280. * Load into an asset container.
  127281. * @param scene The scene to load into
  127282. * @param data The data to import
  127283. * @param rootUrl The root url for scene and resources
  127284. * @param onError The callback when import fails
  127285. * @returns The loaded asset container
  127286. */
  127287. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  127288. }
  127289. /**
  127290. * Interface used to define an async SceneLoader plugin
  127291. */
  127292. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  127293. /**
  127294. * Import meshes into a scene.
  127295. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127296. * @param scene The scene to import into
  127297. * @param data The data to import
  127298. * @param rootUrl The root url for scene and resources
  127299. * @param onProgress The callback when the load progresses
  127300. * @param fileName Defines the name of the file to load
  127301. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  127302. */
  127303. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  127304. meshes: AbstractMesh[];
  127305. particleSystems: IParticleSystem[];
  127306. skeletons: Skeleton[];
  127307. animationGroups: AnimationGroup[];
  127308. }>;
  127309. /**
  127310. * Load into a scene.
  127311. * @param scene The scene to load into
  127312. * @param data The data to import
  127313. * @param rootUrl The root url for scene and resources
  127314. * @param onProgress The callback when the load progresses
  127315. * @param fileName Defines the name of the file to load
  127316. * @returns Nothing
  127317. */
  127318. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  127319. /**
  127320. * Load into an asset container.
  127321. * @param scene The scene to load into
  127322. * @param data The data to import
  127323. * @param rootUrl The root url for scene and resources
  127324. * @param onProgress The callback when the load progresses
  127325. * @param fileName Defines the name of the file to load
  127326. * @returns The loaded asset container
  127327. */
  127328. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  127329. }
  127330. /**
  127331. * Mode that determines how to handle old animation groups before loading new ones.
  127332. */
  127333. export enum SceneLoaderAnimationGroupLoadingMode {
  127334. /**
  127335. * Reset all old animations to initial state then dispose them.
  127336. */
  127337. Clean = 0,
  127338. /**
  127339. * Stop all old animations.
  127340. */
  127341. Stop = 1,
  127342. /**
  127343. * Restart old animations from first frame.
  127344. */
  127345. Sync = 2,
  127346. /**
  127347. * Old animations remains untouched.
  127348. */
  127349. NoSync = 3
  127350. }
  127351. /**
  127352. * Defines a plugin registered by the SceneLoader
  127353. */
  127354. interface IRegisteredPlugin {
  127355. /**
  127356. * Defines the plugin to use
  127357. */
  127358. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127359. /**
  127360. * Defines if the plugin supports binary data
  127361. */
  127362. isBinary: boolean;
  127363. }
  127364. /**
  127365. * Class used to load scene from various file formats using registered plugins
  127366. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  127367. */
  127368. export class SceneLoader {
  127369. /**
  127370. * No logging while loading
  127371. */
  127372. static readonly NO_LOGGING: number;
  127373. /**
  127374. * Minimal logging while loading
  127375. */
  127376. static readonly MINIMAL_LOGGING: number;
  127377. /**
  127378. * Summary logging while loading
  127379. */
  127380. static readonly SUMMARY_LOGGING: number;
  127381. /**
  127382. * Detailled logging while loading
  127383. */
  127384. static readonly DETAILED_LOGGING: number;
  127385. /**
  127386. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  127387. */
  127388. static get ForceFullSceneLoadingForIncremental(): boolean;
  127389. static set ForceFullSceneLoadingForIncremental(value: boolean);
  127390. /**
  127391. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  127392. */
  127393. static get ShowLoadingScreen(): boolean;
  127394. static set ShowLoadingScreen(value: boolean);
  127395. /**
  127396. * Defines the current logging level (while loading the scene)
  127397. * @ignorenaming
  127398. */
  127399. static get loggingLevel(): number;
  127400. static set loggingLevel(value: number);
  127401. /**
  127402. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  127403. */
  127404. static get CleanBoneMatrixWeights(): boolean;
  127405. static set CleanBoneMatrixWeights(value: boolean);
  127406. /**
  127407. * Event raised when a plugin is used to load a scene
  127408. */
  127409. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127410. private static _registeredPlugins;
  127411. private static _showingLoadingScreen;
  127412. /**
  127413. * Gets the default plugin (used to load Babylon files)
  127414. * @returns the .babylon plugin
  127415. */
  127416. static GetDefaultPlugin(): IRegisteredPlugin;
  127417. private static _GetPluginForExtension;
  127418. private static _GetPluginForDirectLoad;
  127419. private static _GetPluginForFilename;
  127420. private static _GetDirectLoad;
  127421. private static _LoadData;
  127422. private static _GetFileInfo;
  127423. /**
  127424. * Gets a plugin that can load the given extension
  127425. * @param extension defines the extension to load
  127426. * @returns a plugin or null if none works
  127427. */
  127428. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127429. /**
  127430. * Gets a boolean indicating that the given extension can be loaded
  127431. * @param extension defines the extension to load
  127432. * @returns true if the extension is supported
  127433. */
  127434. static IsPluginForExtensionAvailable(extension: string): boolean;
  127435. /**
  127436. * Adds a new plugin to the list of registered plugins
  127437. * @param plugin defines the plugin to add
  127438. */
  127439. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  127440. /**
  127441. * Import meshes into a scene
  127442. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127443. * @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)
  127444. * @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)
  127445. * @param scene the instance of BABYLON.Scene to append to
  127446. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  127447. * @param onProgress a callback with a progress event for each file being loaded
  127448. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127449. * @param pluginExtension the extension used to determine the plugin
  127450. * @returns The loaded plugin
  127451. */
  127452. 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>;
  127453. /**
  127454. * Import meshes into a scene
  127455. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127456. * @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)
  127457. * @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)
  127458. * @param scene the instance of BABYLON.Scene to append to
  127459. * @param onProgress a callback with a progress event for each file being loaded
  127460. * @param pluginExtension the extension used to determine the plugin
  127461. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  127462. */
  127463. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  127464. meshes: AbstractMesh[];
  127465. particleSystems: IParticleSystem[];
  127466. skeletons: Skeleton[];
  127467. animationGroups: AnimationGroup[];
  127468. }>;
  127469. /**
  127470. * Load a scene
  127471. * @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)
  127472. * @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)
  127473. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127474. * @param onSuccess a callback with the scene when import succeeds
  127475. * @param onProgress a callback with a progress event for each file being loaded
  127476. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127477. * @param pluginExtension the extension used to determine the plugin
  127478. * @returns The loaded plugin
  127479. */
  127480. 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>;
  127481. /**
  127482. * Load a scene
  127483. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  127484. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  127485. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127486. * @param onProgress a callback with a progress event for each file being loaded
  127487. * @param pluginExtension the extension used to determine the plugin
  127488. * @returns The loaded scene
  127489. */
  127490. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127491. /**
  127492. * Append a scene
  127493. * @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)
  127494. * @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)
  127495. * @param scene is the instance of BABYLON.Scene to append to
  127496. * @param onSuccess a callback with the scene when import succeeds
  127497. * @param onProgress a callback with a progress event for each file being loaded
  127498. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127499. * @param pluginExtension the extension used to determine the plugin
  127500. * @returns The loaded plugin
  127501. */
  127502. 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>;
  127503. /**
  127504. * Append a scene
  127505. * @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)
  127506. * @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)
  127507. * @param scene is the instance of BABYLON.Scene to append to
  127508. * @param onProgress a callback with a progress event for each file being loaded
  127509. * @param pluginExtension the extension used to determine the plugin
  127510. * @returns The given scene
  127511. */
  127512. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127513. /**
  127514. * Load a scene into an asset container
  127515. * @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)
  127516. * @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)
  127517. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127518. * @param onSuccess a callback with the scene when import succeeds
  127519. * @param onProgress a callback with a progress event for each file being loaded
  127520. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127521. * @param pluginExtension the extension used to determine the plugin
  127522. * @returns The loaded plugin
  127523. */
  127524. 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>;
  127525. /**
  127526. * Load a scene into an asset container
  127527. * @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)
  127528. * @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)
  127529. * @param scene is the instance of Scene to append to
  127530. * @param onProgress a callback with a progress event for each file being loaded
  127531. * @param pluginExtension the extension used to determine the plugin
  127532. * @returns The loaded asset container
  127533. */
  127534. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  127535. /**
  127536. * Import animations from a file into a scene
  127537. * @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)
  127538. * @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)
  127539. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127540. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127541. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127542. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127543. * @param onSuccess a callback with the scene when import succeeds
  127544. * @param onProgress a callback with a progress event for each file being loaded
  127545. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127546. * @param pluginExtension the extension used to determine the plugin
  127547. */
  127548. 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;
  127549. /**
  127550. * Import animations from a file into a scene
  127551. * @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)
  127552. * @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)
  127553. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127554. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127555. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127556. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127557. * @param onSuccess a callback with the scene when import succeeds
  127558. * @param onProgress a callback with a progress event for each file being loaded
  127559. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127560. * @param pluginExtension the extension used to determine the plugin
  127561. * @returns the updated scene with imported animations
  127562. */
  127563. 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>;
  127564. }
  127565. }
  127566. declare module BABYLON {
  127567. /**
  127568. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  127569. */
  127570. export type MotionControllerHandedness = "none" | "left" | "right";
  127571. /**
  127572. * The type of components available in motion controllers.
  127573. * This is not the name of the component.
  127574. */
  127575. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  127576. /**
  127577. * The state of a controller component
  127578. */
  127579. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  127580. /**
  127581. * The schema of motion controller layout.
  127582. * No object will be initialized using this interface
  127583. * This is used just to define the profile.
  127584. */
  127585. export interface IMotionControllerLayout {
  127586. /**
  127587. * Path to load the assets. Usually relative to the base path
  127588. */
  127589. assetPath: string;
  127590. /**
  127591. * Available components (unsorted)
  127592. */
  127593. components: {
  127594. /**
  127595. * A map of component Ids
  127596. */
  127597. [componentId: string]: {
  127598. /**
  127599. * The type of input the component outputs
  127600. */
  127601. type: MotionControllerComponentType;
  127602. /**
  127603. * The indices of this component in the gamepad object
  127604. */
  127605. gamepadIndices: {
  127606. /**
  127607. * Index of button
  127608. */
  127609. button?: number;
  127610. /**
  127611. * If available, index of x-axis
  127612. */
  127613. xAxis?: number;
  127614. /**
  127615. * If available, index of y-axis
  127616. */
  127617. yAxis?: number;
  127618. };
  127619. /**
  127620. * The mesh's root node name
  127621. */
  127622. rootNodeName: string;
  127623. /**
  127624. * Animation definitions for this model
  127625. */
  127626. visualResponses: {
  127627. [stateKey: string]: {
  127628. /**
  127629. * What property will be animated
  127630. */
  127631. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  127632. /**
  127633. * What states influence this visual response
  127634. */
  127635. states: MotionControllerComponentStateType[];
  127636. /**
  127637. * Type of animation - movement or visibility
  127638. */
  127639. valueNodeProperty: "transform" | "visibility";
  127640. /**
  127641. * Base node name to move. Its position will be calculated according to the min and max nodes
  127642. */
  127643. valueNodeName?: string;
  127644. /**
  127645. * Minimum movement node
  127646. */
  127647. minNodeName?: string;
  127648. /**
  127649. * Max movement node
  127650. */
  127651. maxNodeName?: string;
  127652. };
  127653. };
  127654. /**
  127655. * If touch enabled, what is the name of node to display user feedback
  127656. */
  127657. touchPointNodeName?: string;
  127658. };
  127659. };
  127660. /**
  127661. * Is it xr standard mapping or not
  127662. */
  127663. gamepadMapping: "" | "xr-standard";
  127664. /**
  127665. * Base root node of this entire model
  127666. */
  127667. rootNodeName: string;
  127668. /**
  127669. * Defines the main button component id
  127670. */
  127671. selectComponentId: string;
  127672. }
  127673. /**
  127674. * A definition for the layout map in the input profile
  127675. */
  127676. export interface IMotionControllerLayoutMap {
  127677. /**
  127678. * Layouts with handedness type as a key
  127679. */
  127680. [handedness: string]: IMotionControllerLayout;
  127681. }
  127682. /**
  127683. * The XR Input profile schema
  127684. * Profiles can be found here:
  127685. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  127686. */
  127687. export interface IMotionControllerProfile {
  127688. /**
  127689. * fallback profiles for this profileId
  127690. */
  127691. fallbackProfileIds: string[];
  127692. /**
  127693. * The layout map, with handedness as key
  127694. */
  127695. layouts: IMotionControllerLayoutMap;
  127696. /**
  127697. * The id of this profile
  127698. * correlates to the profile(s) in the xrInput.profiles array
  127699. */
  127700. profileId: string;
  127701. }
  127702. /**
  127703. * A helper-interface for the 3 meshes needed for controller button animation
  127704. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  127705. */
  127706. export interface IMotionControllerButtonMeshMap {
  127707. /**
  127708. * the mesh that defines the pressed value mesh position.
  127709. * This is used to find the max-position of this button
  127710. */
  127711. pressedMesh: AbstractMesh;
  127712. /**
  127713. * the mesh that defines the unpressed value mesh position.
  127714. * This is used to find the min (or initial) position of this button
  127715. */
  127716. unpressedMesh: AbstractMesh;
  127717. /**
  127718. * The mesh that will be changed when value changes
  127719. */
  127720. valueMesh: AbstractMesh;
  127721. }
  127722. /**
  127723. * A helper-interface for the 3 meshes needed for controller axis animation.
  127724. * This will be expanded when touchpad animations are fully supported
  127725. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  127726. */
  127727. export interface IMotionControllerMeshMap {
  127728. /**
  127729. * the mesh that defines the maximum value mesh position.
  127730. */
  127731. maxMesh?: AbstractMesh;
  127732. /**
  127733. * the mesh that defines the minimum value mesh position.
  127734. */
  127735. minMesh?: AbstractMesh;
  127736. /**
  127737. * The mesh that will be changed when axis value changes
  127738. */
  127739. valueMesh?: AbstractMesh;
  127740. }
  127741. /**
  127742. * The elements needed for change-detection of the gamepad objects in motion controllers
  127743. */
  127744. export interface IMinimalMotionControllerObject {
  127745. /**
  127746. * Available axes of this controller
  127747. */
  127748. axes: number[];
  127749. /**
  127750. * An array of available buttons
  127751. */
  127752. buttons: Array<{
  127753. /**
  127754. * Value of the button/trigger
  127755. */
  127756. value: number;
  127757. /**
  127758. * If the button/trigger is currently touched
  127759. */
  127760. touched: boolean;
  127761. /**
  127762. * If the button/trigger is currently pressed
  127763. */
  127764. pressed: boolean;
  127765. }>;
  127766. /**
  127767. * EXPERIMENTAL haptic support.
  127768. */
  127769. hapticActuators?: Array<{
  127770. pulse: (value: number, duration: number) => Promise<boolean>;
  127771. }>;
  127772. }
  127773. /**
  127774. * An Abstract Motion controller
  127775. * This class receives an xrInput and a profile layout and uses those to initialize the components
  127776. * Each component has an observable to check for changes in value and state
  127777. */
  127778. export abstract class WebXRAbstractMotionController implements IDisposable {
  127779. protected scene: Scene;
  127780. protected layout: IMotionControllerLayout;
  127781. /**
  127782. * The gamepad object correlating to this controller
  127783. */
  127784. gamepadObject: IMinimalMotionControllerObject;
  127785. /**
  127786. * handedness (left/right/none) of this controller
  127787. */
  127788. handedness: MotionControllerHandedness;
  127789. private _initComponent;
  127790. private _modelReady;
  127791. /**
  127792. * A map of components (WebXRControllerComponent) in this motion controller
  127793. * Components have a ComponentType and can also have both button and axis definitions
  127794. */
  127795. readonly components: {
  127796. [id: string]: WebXRControllerComponent;
  127797. };
  127798. /**
  127799. * Disable the model's animation. Can be set at any time.
  127800. */
  127801. disableAnimation: boolean;
  127802. /**
  127803. * Observers registered here will be triggered when the model of this controller is done loading
  127804. */
  127805. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  127806. /**
  127807. * The profile id of this motion controller
  127808. */
  127809. abstract profileId: string;
  127810. /**
  127811. * The root mesh of the model. It is null if the model was not yet initialized
  127812. */
  127813. rootMesh: Nullable<AbstractMesh>;
  127814. /**
  127815. * constructs a new abstract motion controller
  127816. * @param scene the scene to which the model of the controller will be added
  127817. * @param layout The profile layout to load
  127818. * @param gamepadObject The gamepad object correlating to this controller
  127819. * @param handedness handedness (left/right/none) of this controller
  127820. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  127821. */
  127822. constructor(scene: Scene, layout: IMotionControllerLayout,
  127823. /**
  127824. * The gamepad object correlating to this controller
  127825. */
  127826. gamepadObject: IMinimalMotionControllerObject,
  127827. /**
  127828. * handedness (left/right/none) of this controller
  127829. */
  127830. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  127831. /**
  127832. * Dispose this controller, the model mesh and all its components
  127833. */
  127834. dispose(): void;
  127835. /**
  127836. * Returns all components of specific type
  127837. * @param type the type to search for
  127838. * @return an array of components with this type
  127839. */
  127840. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  127841. /**
  127842. * get a component based an its component id as defined in layout.components
  127843. * @param id the id of the component
  127844. * @returns the component correlates to the id or undefined if not found
  127845. */
  127846. getComponent(id: string): WebXRControllerComponent;
  127847. /**
  127848. * Get the list of components available in this motion controller
  127849. * @returns an array of strings correlating to available components
  127850. */
  127851. getComponentIds(): string[];
  127852. /**
  127853. * Get the first component of specific type
  127854. * @param type type of component to find
  127855. * @return a controller component or null if not found
  127856. */
  127857. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  127858. /**
  127859. * Get the main (Select) component of this controller as defined in the layout
  127860. * @returns the main component of this controller
  127861. */
  127862. getMainComponent(): WebXRControllerComponent;
  127863. /**
  127864. * Loads the model correlating to this controller
  127865. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  127866. * @returns A promise fulfilled with the result of the model loading
  127867. */
  127868. loadModel(): Promise<boolean>;
  127869. /**
  127870. * Update this model using the current XRFrame
  127871. * @param xrFrame the current xr frame to use and update the model
  127872. */
  127873. updateFromXRFrame(xrFrame: XRFrame): void;
  127874. /**
  127875. * Backwards compatibility due to a deeply-integrated typo
  127876. */
  127877. get handness(): XREye;
  127878. /**
  127879. * Pulse (vibrate) this controller
  127880. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  127881. * Consecutive calls to this function will cancel the last pulse call
  127882. *
  127883. * @param value the strength of the pulse in 0.0...1.0 range
  127884. * @param duration Duration of the pulse in milliseconds
  127885. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  127886. * @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
  127887. */
  127888. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  127889. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127890. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127891. /**
  127892. * Moves the axis on the controller mesh based on its current state
  127893. * @param axis the index of the axis
  127894. * @param axisValue the value of the axis which determines the meshes new position
  127895. * @hidden
  127896. */
  127897. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  127898. /**
  127899. * Update the model itself with the current frame data
  127900. * @param xrFrame the frame to use for updating the model mesh
  127901. */
  127902. protected updateModel(xrFrame: XRFrame): void;
  127903. /**
  127904. * Get the filename and path for this controller's model
  127905. * @returns a map of filename and path
  127906. */
  127907. protected abstract _getFilenameAndPath(): {
  127908. filename: string;
  127909. path: string;
  127910. };
  127911. /**
  127912. * This function is called before the mesh is loaded. It checks for loading constraints.
  127913. * For example, this function can check if the GLB loader is available
  127914. * If this function returns false, the generic controller will be loaded instead
  127915. * @returns Is the client ready to load the mesh
  127916. */
  127917. protected abstract _getModelLoadingConstraints(): boolean;
  127918. /**
  127919. * This function will be called after the model was successfully loaded and can be used
  127920. * for mesh transformations before it is available for the user
  127921. * @param meshes the loaded meshes
  127922. */
  127923. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  127924. /**
  127925. * Set the root mesh for this controller. Important for the WebXR controller class
  127926. * @param meshes the loaded meshes
  127927. */
  127928. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  127929. /**
  127930. * A function executed each frame that updates the mesh (if needed)
  127931. * @param xrFrame the current xrFrame
  127932. */
  127933. protected abstract _updateModel(xrFrame: XRFrame): void;
  127934. private _getGenericFilenameAndPath;
  127935. private _getGenericParentMesh;
  127936. }
  127937. }
  127938. declare module BABYLON {
  127939. /**
  127940. * A generic trigger-only motion controller for WebXR
  127941. */
  127942. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  127943. /**
  127944. * Static version of the profile id of this controller
  127945. */
  127946. static ProfileId: string;
  127947. profileId: string;
  127948. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  127949. protected _getFilenameAndPath(): {
  127950. filename: string;
  127951. path: string;
  127952. };
  127953. protected _getModelLoadingConstraints(): boolean;
  127954. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  127955. protected _setRootMesh(meshes: AbstractMesh[]): void;
  127956. protected _updateModel(): void;
  127957. }
  127958. }
  127959. declare module BABYLON {
  127960. /**
  127961. * Class containing static functions to help procedurally build meshes
  127962. */
  127963. export class SphereBuilder {
  127964. /**
  127965. * Creates a sphere mesh
  127966. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  127967. * * 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`)
  127968. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  127969. * * 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
  127970. * * 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)
  127971. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127972. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127973. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127974. * @param name defines the name of the mesh
  127975. * @param options defines the options used to create the mesh
  127976. * @param scene defines the hosting scene
  127977. * @returns the sphere mesh
  127978. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  127979. */
  127980. static CreateSphere(name: string, options: {
  127981. segments?: number;
  127982. diameter?: number;
  127983. diameterX?: number;
  127984. diameterY?: number;
  127985. diameterZ?: number;
  127986. arc?: number;
  127987. slice?: number;
  127988. sideOrientation?: number;
  127989. frontUVs?: Vector4;
  127990. backUVs?: Vector4;
  127991. updatable?: boolean;
  127992. }, scene?: Nullable<Scene>): Mesh;
  127993. }
  127994. }
  127995. declare module BABYLON {
  127996. /**
  127997. * A profiled motion controller has its profile loaded from an online repository.
  127998. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  127999. */
  128000. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  128001. private _repositoryUrl;
  128002. private _buttonMeshMapping;
  128003. private _touchDots;
  128004. /**
  128005. * The profile ID of this controller. Will be populated when the controller initializes.
  128006. */
  128007. profileId: string;
  128008. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  128009. dispose(): void;
  128010. protected _getFilenameAndPath(): {
  128011. filename: string;
  128012. path: string;
  128013. };
  128014. protected _getModelLoadingConstraints(): boolean;
  128015. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  128016. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128017. protected _updateModel(_xrFrame: XRFrame): void;
  128018. }
  128019. }
  128020. declare module BABYLON {
  128021. /**
  128022. * A construction function type to create a new controller based on an xrInput object
  128023. */
  128024. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  128025. /**
  128026. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  128027. *
  128028. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  128029. * it should be replaced with auto-loaded controllers.
  128030. *
  128031. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  128032. */
  128033. export class WebXRMotionControllerManager {
  128034. private static _AvailableControllers;
  128035. private static _Fallbacks;
  128036. private static _ProfileLoadingPromises;
  128037. private static _ProfilesList;
  128038. /**
  128039. * The base URL of the online controller repository. Can be changed at any time.
  128040. */
  128041. static BaseRepositoryUrl: string;
  128042. /**
  128043. * Which repository gets priority - local or online
  128044. */
  128045. static PrioritizeOnlineRepository: boolean;
  128046. /**
  128047. * Use the online repository, or use only locally-defined controllers
  128048. */
  128049. static UseOnlineRepository: boolean;
  128050. /**
  128051. * Clear the cache used for profile loading and reload when requested again
  128052. */
  128053. static ClearProfilesCache(): void;
  128054. /**
  128055. * Register the default fallbacks.
  128056. * This function is called automatically when this file is imported.
  128057. */
  128058. static DefaultFallbacks(): void;
  128059. /**
  128060. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  128061. * @param profileId the profile to which a fallback needs to be found
  128062. * @return an array with corresponding fallback profiles
  128063. */
  128064. static FindFallbackWithProfileId(profileId: string): string[];
  128065. /**
  128066. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  128067. * The order of search:
  128068. *
  128069. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  128070. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  128071. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  128072. * 4) return the generic trigger controller if none were found
  128073. *
  128074. * @param xrInput the xrInput to which a new controller is initialized
  128075. * @param scene the scene to which the model will be added
  128076. * @param forceProfile force a certain profile for this controller
  128077. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  128078. */
  128079. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  128080. /**
  128081. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  128082. *
  128083. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  128084. *
  128085. * @param type the profile type to register
  128086. * @param constructFunction the function to be called when loading this profile
  128087. */
  128088. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  128089. /**
  128090. * Register a fallback to a specific profile.
  128091. * @param profileId the profileId that will receive the fallbacks
  128092. * @param fallbacks A list of fallback profiles
  128093. */
  128094. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  128095. /**
  128096. * Will update the list of profiles available in the repository
  128097. * @return a promise that resolves to a map of profiles available online
  128098. */
  128099. static UpdateProfilesList(): Promise<{
  128100. [profile: string]: string;
  128101. }>;
  128102. private static _LoadProfileFromRepository;
  128103. private static _LoadProfilesFromAvailableControllers;
  128104. }
  128105. }
  128106. declare module BABYLON {
  128107. /**
  128108. * Configuration options for the WebXR controller creation
  128109. */
  128110. export interface IWebXRControllerOptions {
  128111. /**
  128112. * Should the controller mesh be animated when a user interacts with it
  128113. * The pressed buttons / thumbstick and touchpad animations will be disabled
  128114. */
  128115. disableMotionControllerAnimation?: boolean;
  128116. /**
  128117. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  128118. */
  128119. doNotLoadControllerMesh?: boolean;
  128120. /**
  128121. * Force a specific controller type for this controller.
  128122. * This can be used when creating your own profile or when testing different controllers
  128123. */
  128124. forceControllerProfile?: string;
  128125. /**
  128126. * Defines a rendering group ID for meshes that will be loaded.
  128127. * This is for the default controllers only.
  128128. */
  128129. renderingGroupId?: number;
  128130. }
  128131. /**
  128132. * Represents an XR controller
  128133. */
  128134. export class WebXRInputSource {
  128135. private _scene;
  128136. /** The underlying input source for the controller */
  128137. inputSource: XRInputSource;
  128138. private _options;
  128139. private _tmpVector;
  128140. private _uniqueId;
  128141. private _disposed;
  128142. /**
  128143. * 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
  128144. */
  128145. grip?: AbstractMesh;
  128146. /**
  128147. * If available, this is the gamepad object related to this controller.
  128148. * Using this object it is possible to get click events and trackpad changes of the
  128149. * webxr controller that is currently being used.
  128150. */
  128151. motionController?: WebXRAbstractMotionController;
  128152. /**
  128153. * Event that fires when the controller is removed/disposed.
  128154. * The object provided as event data is this controller, after associated assets were disposed.
  128155. * uniqueId is still available.
  128156. */
  128157. onDisposeObservable: Observable<WebXRInputSource>;
  128158. /**
  128159. * Will be triggered when the mesh associated with the motion controller is done loading.
  128160. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  128161. * A shortened version of controller -> motion controller -> on mesh loaded.
  128162. */
  128163. onMeshLoadedObservable: Observable<AbstractMesh>;
  128164. /**
  128165. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  128166. */
  128167. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  128168. /**
  128169. * Pointer which can be used to select objects or attach a visible laser to
  128170. */
  128171. pointer: AbstractMesh;
  128172. /**
  128173. * Creates the input source object
  128174. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  128175. * @param _scene the scene which the controller should be associated to
  128176. * @param inputSource the underlying input source for the controller
  128177. * @param _options options for this controller creation
  128178. */
  128179. constructor(_scene: Scene,
  128180. /** The underlying input source for the controller */
  128181. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  128182. /**
  128183. * Get this controllers unique id
  128184. */
  128185. get uniqueId(): string;
  128186. /**
  128187. * Disposes of the object
  128188. */
  128189. dispose(): void;
  128190. /**
  128191. * Gets a world space ray coming from the pointer or grip
  128192. * @param result the resulting ray
  128193. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  128194. */
  128195. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  128196. /**
  128197. * Updates the controller pose based on the given XRFrame
  128198. * @param xrFrame xr frame to update the pose with
  128199. * @param referenceSpace reference space to use
  128200. */
  128201. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  128202. }
  128203. }
  128204. declare module BABYLON {
  128205. /**
  128206. * The schema for initialization options of the XR Input class
  128207. */
  128208. export interface IWebXRInputOptions {
  128209. /**
  128210. * If set to true no model will be automatically loaded
  128211. */
  128212. doNotLoadControllerMeshes?: boolean;
  128213. /**
  128214. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  128215. * If not found, the xr input profile data will be used.
  128216. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  128217. */
  128218. forceInputProfile?: string;
  128219. /**
  128220. * Do not send a request to the controller repository to load the profile.
  128221. *
  128222. * Instead, use the controllers available in babylon itself.
  128223. */
  128224. disableOnlineControllerRepository?: boolean;
  128225. /**
  128226. * A custom URL for the controllers repository
  128227. */
  128228. customControllersRepositoryURL?: string;
  128229. /**
  128230. * Should the controller model's components not move according to the user input
  128231. */
  128232. disableControllerAnimation?: boolean;
  128233. /**
  128234. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  128235. */
  128236. controllerOptions?: IWebXRControllerOptions;
  128237. }
  128238. /**
  128239. * XR input used to track XR inputs such as controllers/rays
  128240. */
  128241. export class WebXRInput implements IDisposable {
  128242. /**
  128243. * the xr session manager for this session
  128244. */
  128245. xrSessionManager: WebXRSessionManager;
  128246. /**
  128247. * the WebXR camera for this session. Mainly used for teleportation
  128248. */
  128249. xrCamera: WebXRCamera;
  128250. private readonly options;
  128251. /**
  128252. * XR controllers being tracked
  128253. */
  128254. controllers: Array<WebXRInputSource>;
  128255. private _frameObserver;
  128256. private _sessionEndedObserver;
  128257. private _sessionInitObserver;
  128258. /**
  128259. * Event when a controller has been connected/added
  128260. */
  128261. onControllerAddedObservable: Observable<WebXRInputSource>;
  128262. /**
  128263. * Event when a controller has been removed/disconnected
  128264. */
  128265. onControllerRemovedObservable: Observable<WebXRInputSource>;
  128266. /**
  128267. * Initializes the WebXRInput
  128268. * @param xrSessionManager the xr session manager for this session
  128269. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  128270. * @param options = initialization options for this xr input
  128271. */
  128272. constructor(
  128273. /**
  128274. * the xr session manager for this session
  128275. */
  128276. xrSessionManager: WebXRSessionManager,
  128277. /**
  128278. * the WebXR camera for this session. Mainly used for teleportation
  128279. */
  128280. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  128281. private _onInputSourcesChange;
  128282. private _addAndRemoveControllers;
  128283. /**
  128284. * Disposes of the object
  128285. */
  128286. dispose(): void;
  128287. }
  128288. }
  128289. declare module BABYLON {
  128290. /**
  128291. * This is the base class for all WebXR features.
  128292. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  128293. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  128294. */
  128295. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  128296. protected _xrSessionManager: WebXRSessionManager;
  128297. private _attached;
  128298. private _removeOnDetach;
  128299. /**
  128300. * Should auto-attach be disabled?
  128301. */
  128302. disableAutoAttach: boolean;
  128303. /**
  128304. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  128305. */
  128306. xrNativeFeatureName: string;
  128307. /**
  128308. * Construct a new (abstract) WebXR feature
  128309. * @param _xrSessionManager the xr session manager for this feature
  128310. */
  128311. constructor(_xrSessionManager: WebXRSessionManager);
  128312. /**
  128313. * Is this feature attached
  128314. */
  128315. get attached(): boolean;
  128316. /**
  128317. * attach this feature
  128318. *
  128319. * @param force should attachment be forced (even when already attached)
  128320. * @returns true if successful, false is failed or already attached
  128321. */
  128322. attach(force?: boolean): boolean;
  128323. /**
  128324. * detach this feature.
  128325. *
  128326. * @returns true if successful, false if failed or already detached
  128327. */
  128328. detach(): boolean;
  128329. /**
  128330. * Dispose this feature and all of the resources attached
  128331. */
  128332. dispose(): void;
  128333. /**
  128334. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  128335. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  128336. *
  128337. * @returns whether or not the feature is compatible in this environment
  128338. */
  128339. isCompatible(): boolean;
  128340. /**
  128341. * This is used to register callbacks that will automatically be removed when detach is called.
  128342. * @param observable the observable to which the observer will be attached
  128343. * @param callback the callback to register
  128344. */
  128345. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  128346. /**
  128347. * Code in this function will be executed on each xrFrame received from the browser.
  128348. * This function will not execute after the feature is detached.
  128349. * @param _xrFrame the current frame
  128350. */
  128351. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  128352. }
  128353. }
  128354. declare module BABYLON {
  128355. /**
  128356. * Renders a layer on top of an existing scene
  128357. */
  128358. export class UtilityLayerRenderer implements IDisposable {
  128359. /** the original scene that will be rendered on top of */
  128360. originalScene: Scene;
  128361. private _pointerCaptures;
  128362. private _lastPointerEvents;
  128363. private static _DefaultUtilityLayer;
  128364. private static _DefaultKeepDepthUtilityLayer;
  128365. private _sharedGizmoLight;
  128366. private _renderCamera;
  128367. /**
  128368. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  128369. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  128370. * @returns the camera that is used when rendering the utility layer
  128371. */
  128372. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  128373. /**
  128374. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  128375. * @param cam the camera that should be used when rendering the utility layer
  128376. */
  128377. setRenderCamera(cam: Nullable<Camera>): void;
  128378. /**
  128379. * @hidden
  128380. * Light which used by gizmos to get light shading
  128381. */
  128382. _getSharedGizmoLight(): HemisphericLight;
  128383. /**
  128384. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  128385. */
  128386. pickUtilitySceneFirst: boolean;
  128387. /**
  128388. * 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)
  128389. */
  128390. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  128391. /**
  128392. * 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)
  128393. */
  128394. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  128395. /**
  128396. * The scene that is rendered on top of the original scene
  128397. */
  128398. utilityLayerScene: Scene;
  128399. /**
  128400. * If the utility layer should automatically be rendered on top of existing scene
  128401. */
  128402. shouldRender: boolean;
  128403. /**
  128404. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  128405. */
  128406. onlyCheckPointerDownEvents: boolean;
  128407. /**
  128408. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  128409. */
  128410. processAllEvents: boolean;
  128411. /**
  128412. * Observable raised when the pointer move from the utility layer scene to the main scene
  128413. */
  128414. onPointerOutObservable: Observable<number>;
  128415. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  128416. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  128417. private _afterRenderObserver;
  128418. private _sceneDisposeObserver;
  128419. private _originalPointerObserver;
  128420. /**
  128421. * Instantiates a UtilityLayerRenderer
  128422. * @param originalScene the original scene that will be rendered on top of
  128423. * @param handleEvents boolean indicating if the utility layer should handle events
  128424. */
  128425. constructor(
  128426. /** the original scene that will be rendered on top of */
  128427. originalScene: Scene, handleEvents?: boolean);
  128428. private _notifyObservers;
  128429. /**
  128430. * Renders the utility layers scene on top of the original scene
  128431. */
  128432. render(): void;
  128433. /**
  128434. * Disposes of the renderer
  128435. */
  128436. dispose(): void;
  128437. private _updateCamera;
  128438. }
  128439. }
  128440. declare module BABYLON {
  128441. /**
  128442. * Options interface for the pointer selection module
  128443. */
  128444. export interface IWebXRControllerPointerSelectionOptions {
  128445. /**
  128446. * if provided, this scene will be used to render meshes.
  128447. */
  128448. customUtilityLayerScene?: Scene;
  128449. /**
  128450. * 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)
  128451. * If not disabled, the last picked point will be used to execute a pointer up event
  128452. * If disabled, pointer up event will be triggered right after the pointer down event.
  128453. * Used in screen and gaze target ray mode only
  128454. */
  128455. disablePointerUpOnTouchOut: boolean;
  128456. /**
  128457. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  128458. */
  128459. forceGazeMode: boolean;
  128460. /**
  128461. * 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
  128462. * to start a new countdown to the pointer down event.
  128463. * Defaults to 1.
  128464. */
  128465. gazeModePointerMovedFactor?: number;
  128466. /**
  128467. * Different button type to use instead of the main component
  128468. */
  128469. overrideButtonId?: string;
  128470. /**
  128471. * use this rendering group id for the meshes (optional)
  128472. */
  128473. renderingGroupId?: number;
  128474. /**
  128475. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  128476. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  128477. * 3000 means 3 seconds between pointing at something and selecting it
  128478. */
  128479. timeToSelect?: number;
  128480. /**
  128481. * Should meshes created here be added to a utility layer or the main scene
  128482. */
  128483. useUtilityLayer?: boolean;
  128484. /**
  128485. * Optional WebXR camera to be used for gaze selection
  128486. */
  128487. gazeCamera?: WebXRCamera;
  128488. /**
  128489. * the xr input to use with this pointer selection
  128490. */
  128491. xrInput: WebXRInput;
  128492. }
  128493. /**
  128494. * A module that will enable pointer selection for motion controllers of XR Input Sources
  128495. */
  128496. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  128497. private readonly _options;
  128498. private static _idCounter;
  128499. private _attachController;
  128500. private _controllers;
  128501. private _scene;
  128502. private _tmpVectorForPickCompare;
  128503. /**
  128504. * The module's name
  128505. */
  128506. static readonly Name: string;
  128507. /**
  128508. * The (Babylon) version of this module.
  128509. * This is an integer representing the implementation version.
  128510. * This number does not correspond to the WebXR specs version
  128511. */
  128512. static readonly Version: number;
  128513. /**
  128514. * Disable lighting on the laser pointer (so it will always be visible)
  128515. */
  128516. disablePointerLighting: boolean;
  128517. /**
  128518. * Disable lighting on the selection mesh (so it will always be visible)
  128519. */
  128520. disableSelectionMeshLighting: boolean;
  128521. /**
  128522. * Should the laser pointer be displayed
  128523. */
  128524. displayLaserPointer: boolean;
  128525. /**
  128526. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  128527. */
  128528. displaySelectionMesh: boolean;
  128529. /**
  128530. * This color will be set to the laser pointer when selection is triggered
  128531. */
  128532. laserPointerPickedColor: Color3;
  128533. /**
  128534. * Default color of the laser pointer
  128535. */
  128536. laserPointerDefaultColor: Color3;
  128537. /**
  128538. * default color of the selection ring
  128539. */
  128540. selectionMeshDefaultColor: Color3;
  128541. /**
  128542. * This color will be applied to the selection ring when selection is triggered
  128543. */
  128544. selectionMeshPickedColor: Color3;
  128545. /**
  128546. * Optional filter to be used for ray selection. This predicate shares behavior with
  128547. * scene.pointerMovePredicate which takes priority if it is also assigned.
  128548. */
  128549. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128550. /**
  128551. * constructs a new background remover module
  128552. * @param _xrSessionManager the session manager for this module
  128553. * @param _options read-only options to be used in this module
  128554. */
  128555. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  128556. /**
  128557. * attach this feature
  128558. * Will usually be called by the features manager
  128559. *
  128560. * @returns true if successful.
  128561. */
  128562. attach(): boolean;
  128563. /**
  128564. * detach this feature.
  128565. * Will usually be called by the features manager
  128566. *
  128567. * @returns true if successful.
  128568. */
  128569. detach(): boolean;
  128570. /**
  128571. * Will get the mesh under a specific pointer.
  128572. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  128573. * @param controllerId the controllerId to check
  128574. * @returns The mesh under pointer or null if no mesh is under the pointer
  128575. */
  128576. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  128577. /**
  128578. * Get the xr controller that correlates to the pointer id in the pointer event
  128579. *
  128580. * @param id the pointer id to search for
  128581. * @returns the controller that correlates to this id or null if not found
  128582. */
  128583. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  128584. protected _onXRFrame(_xrFrame: XRFrame): void;
  128585. private _attachGazeMode;
  128586. private _attachScreenRayMode;
  128587. private _attachTrackedPointerRayMode;
  128588. private _convertNormalToDirectionOfRay;
  128589. private _detachController;
  128590. private _generateNewMeshPair;
  128591. private _pickingMoved;
  128592. private _updatePointerDistance;
  128593. /** @hidden */
  128594. get lasterPointerDefaultColor(): Color3;
  128595. }
  128596. }
  128597. declare module BABYLON {
  128598. /**
  128599. * Button which can be used to enter a different mode of XR
  128600. */
  128601. export class WebXREnterExitUIButton {
  128602. /** button element */
  128603. element: HTMLElement;
  128604. /** XR initialization options for the button */
  128605. sessionMode: XRSessionMode;
  128606. /** Reference space type */
  128607. referenceSpaceType: XRReferenceSpaceType;
  128608. /**
  128609. * Creates a WebXREnterExitUIButton
  128610. * @param element button element
  128611. * @param sessionMode XR initialization session mode
  128612. * @param referenceSpaceType the type of reference space to be used
  128613. */
  128614. constructor(
  128615. /** button element */
  128616. element: HTMLElement,
  128617. /** XR initialization options for the button */
  128618. sessionMode: XRSessionMode,
  128619. /** Reference space type */
  128620. referenceSpaceType: XRReferenceSpaceType);
  128621. /**
  128622. * Extendable function which can be used to update the button's visuals when the state changes
  128623. * @param activeButton the current active button in the UI
  128624. */
  128625. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  128626. }
  128627. /**
  128628. * Options to create the webXR UI
  128629. */
  128630. export class WebXREnterExitUIOptions {
  128631. /**
  128632. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  128633. */
  128634. customButtons?: Array<WebXREnterExitUIButton>;
  128635. /**
  128636. * A reference space type to use when creating the default button.
  128637. * Default is local-floor
  128638. */
  128639. referenceSpaceType?: XRReferenceSpaceType;
  128640. /**
  128641. * Context to enter xr with
  128642. */
  128643. renderTarget?: Nullable<WebXRRenderTarget>;
  128644. /**
  128645. * A session mode to use when creating the default button.
  128646. * Default is immersive-vr
  128647. */
  128648. sessionMode?: XRSessionMode;
  128649. /**
  128650. * A list of optional features to init the session with
  128651. */
  128652. optionalFeatures?: string[];
  128653. /**
  128654. * A list of optional features to init the session with
  128655. */
  128656. requiredFeatures?: string[];
  128657. }
  128658. /**
  128659. * UI to allow the user to enter/exit XR mode
  128660. */
  128661. export class WebXREnterExitUI implements IDisposable {
  128662. private scene;
  128663. /** version of the options passed to this UI */
  128664. options: WebXREnterExitUIOptions;
  128665. private _activeButton;
  128666. private _buttons;
  128667. /**
  128668. * The HTML Div Element to which buttons are added.
  128669. */
  128670. readonly overlay: HTMLDivElement;
  128671. /**
  128672. * Fired every time the active button is changed.
  128673. *
  128674. * When xr is entered via a button that launches xr that button will be the callback parameter
  128675. *
  128676. * When exiting xr the callback parameter will be null)
  128677. */
  128678. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  128679. /**
  128680. *
  128681. * @param scene babylon scene object to use
  128682. * @param options (read-only) version of the options passed to this UI
  128683. */
  128684. private constructor();
  128685. /**
  128686. * Creates UI to allow the user to enter/exit XR mode
  128687. * @param scene the scene to add the ui to
  128688. * @param helper the xr experience helper to enter/exit xr with
  128689. * @param options options to configure the UI
  128690. * @returns the created ui
  128691. */
  128692. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  128693. /**
  128694. * Disposes of the XR UI component
  128695. */
  128696. dispose(): void;
  128697. private _updateButtons;
  128698. }
  128699. }
  128700. declare module BABYLON {
  128701. /**
  128702. * Class containing static functions to help procedurally build meshes
  128703. */
  128704. export class LinesBuilder {
  128705. /**
  128706. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  128707. * * 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
  128708. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  128709. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  128710. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  128711. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  128712. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128713. * * 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
  128714. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  128715. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128716. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  128717. * @param name defines the name of the new line system
  128718. * @param options defines the options used to create the line system
  128719. * @param scene defines the hosting scene
  128720. * @returns a new line system mesh
  128721. */
  128722. static CreateLineSystem(name: string, options: {
  128723. lines: Vector3[][];
  128724. updatable?: boolean;
  128725. instance?: Nullable<LinesMesh>;
  128726. colors?: Nullable<Color4[][]>;
  128727. useVertexAlpha?: boolean;
  128728. }, scene: Nullable<Scene>): LinesMesh;
  128729. /**
  128730. * Creates a line mesh
  128731. * 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
  128732. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128733. * * The parameter `points` is an array successive Vector3
  128734. * * 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
  128735. * * The optional parameter `colors` is an array of successive Color4, one per line point
  128736. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  128737. * * When updating an instance, remember that only point positions can change, not the number of points
  128738. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128739. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  128740. * @param name defines the name of the new line system
  128741. * @param options defines the options used to create the line system
  128742. * @param scene defines the hosting scene
  128743. * @returns a new line mesh
  128744. */
  128745. static CreateLines(name: string, options: {
  128746. points: Vector3[];
  128747. updatable?: boolean;
  128748. instance?: Nullable<LinesMesh>;
  128749. colors?: Color4[];
  128750. useVertexAlpha?: boolean;
  128751. }, scene?: Nullable<Scene>): LinesMesh;
  128752. /**
  128753. * Creates a dashed line mesh
  128754. * * 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
  128755. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128756. * * The parameter `points` is an array successive Vector3
  128757. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  128758. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  128759. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  128760. * * 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
  128761. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128762. * * When updating an instance, remember that only point positions can change, not the number of points
  128763. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128764. * @param name defines the name of the mesh
  128765. * @param options defines the options used to create the mesh
  128766. * @param scene defines the hosting scene
  128767. * @returns the dashed line mesh
  128768. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  128769. */
  128770. static CreateDashedLines(name: string, options: {
  128771. points: Vector3[];
  128772. dashSize?: number;
  128773. gapSize?: number;
  128774. dashNb?: number;
  128775. updatable?: boolean;
  128776. instance?: LinesMesh;
  128777. useVertexAlpha?: boolean;
  128778. }, scene?: Nullable<Scene>): LinesMesh;
  128779. }
  128780. }
  128781. declare module BABYLON {
  128782. /**
  128783. * Construction options for a timer
  128784. */
  128785. export interface ITimerOptions<T> {
  128786. /**
  128787. * Time-to-end
  128788. */
  128789. timeout: number;
  128790. /**
  128791. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  128792. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  128793. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  128794. */
  128795. contextObservable: Observable<T>;
  128796. /**
  128797. * Optional parameters when adding an observer to the observable
  128798. */
  128799. observableParameters?: {
  128800. mask?: number;
  128801. insertFirst?: boolean;
  128802. scope?: any;
  128803. };
  128804. /**
  128805. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  128806. */
  128807. breakCondition?: (data?: ITimerData<T>) => boolean;
  128808. /**
  128809. * Will be triggered when the time condition has met
  128810. */
  128811. onEnded?: (data: ITimerData<any>) => void;
  128812. /**
  128813. * Will be triggered when the break condition has met (prematurely ended)
  128814. */
  128815. onAborted?: (data: ITimerData<any>) => void;
  128816. /**
  128817. * Optional function to execute on each tick (or count)
  128818. */
  128819. onTick?: (data: ITimerData<any>) => void;
  128820. }
  128821. /**
  128822. * An interface defining the data sent by the timer
  128823. */
  128824. export interface ITimerData<T> {
  128825. /**
  128826. * When did it start
  128827. */
  128828. startTime: number;
  128829. /**
  128830. * Time now
  128831. */
  128832. currentTime: number;
  128833. /**
  128834. * Time passed since started
  128835. */
  128836. deltaTime: number;
  128837. /**
  128838. * How much is completed, in [0.0...1.0].
  128839. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  128840. */
  128841. completeRate: number;
  128842. /**
  128843. * What the registered observable sent in the last count
  128844. */
  128845. payload: T;
  128846. }
  128847. /**
  128848. * The current state of the timer
  128849. */
  128850. export enum TimerState {
  128851. /**
  128852. * Timer initialized, not yet started
  128853. */
  128854. INIT = 0,
  128855. /**
  128856. * Timer started and counting
  128857. */
  128858. STARTED = 1,
  128859. /**
  128860. * Timer ended (whether aborted or time reached)
  128861. */
  128862. ENDED = 2
  128863. }
  128864. /**
  128865. * A simple version of the timer. Will take options and start the timer immediately after calling it
  128866. *
  128867. * @param options options with which to initialize this timer
  128868. */
  128869. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  128870. /**
  128871. * An advanced implementation of a timer class
  128872. */
  128873. export class AdvancedTimer<T = any> implements IDisposable {
  128874. /**
  128875. * Will notify each time the timer calculates the remaining time
  128876. */
  128877. onEachCountObservable: Observable<ITimerData<T>>;
  128878. /**
  128879. * Will trigger when the timer was aborted due to the break condition
  128880. */
  128881. onTimerAbortedObservable: Observable<ITimerData<T>>;
  128882. /**
  128883. * Will trigger when the timer ended successfully
  128884. */
  128885. onTimerEndedObservable: Observable<ITimerData<T>>;
  128886. /**
  128887. * Will trigger when the timer state has changed
  128888. */
  128889. onStateChangedObservable: Observable<TimerState>;
  128890. private _observer;
  128891. private _contextObservable;
  128892. private _observableParameters;
  128893. private _startTime;
  128894. private _timer;
  128895. private _state;
  128896. private _breakCondition;
  128897. private _timeToEnd;
  128898. private _breakOnNextTick;
  128899. /**
  128900. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  128901. * @param options construction options for this advanced timer
  128902. */
  128903. constructor(options: ITimerOptions<T>);
  128904. /**
  128905. * set a breaking condition for this timer. Default is to never break during count
  128906. * @param predicate the new break condition. Returns true to break, false otherwise
  128907. */
  128908. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  128909. /**
  128910. * Reset ALL associated observables in this advanced timer
  128911. */
  128912. clearObservables(): void;
  128913. /**
  128914. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  128915. *
  128916. * @param timeToEnd how much time to measure until timer ended
  128917. */
  128918. start(timeToEnd?: number): void;
  128919. /**
  128920. * Will force a stop on the next tick.
  128921. */
  128922. stop(): void;
  128923. /**
  128924. * Dispose this timer, clearing all resources
  128925. */
  128926. dispose(): void;
  128927. private _setState;
  128928. private _tick;
  128929. private _stop;
  128930. }
  128931. }
  128932. declare module BABYLON {
  128933. /**
  128934. * The options container for the teleportation module
  128935. */
  128936. export interface IWebXRTeleportationOptions {
  128937. /**
  128938. * if provided, this scene will be used to render meshes.
  128939. */
  128940. customUtilityLayerScene?: Scene;
  128941. /**
  128942. * Values to configure the default target mesh
  128943. */
  128944. defaultTargetMeshOptions?: {
  128945. /**
  128946. * Fill color of the teleportation area
  128947. */
  128948. teleportationFillColor?: string;
  128949. /**
  128950. * Border color for the teleportation area
  128951. */
  128952. teleportationBorderColor?: string;
  128953. /**
  128954. * Disable the mesh's animation sequence
  128955. */
  128956. disableAnimation?: boolean;
  128957. /**
  128958. * Disable lighting on the material or the ring and arrow
  128959. */
  128960. disableLighting?: boolean;
  128961. /**
  128962. * Override the default material of the torus and arrow
  128963. */
  128964. torusArrowMaterial?: Material;
  128965. };
  128966. /**
  128967. * A list of meshes to use as floor meshes.
  128968. * Meshes can be added and removed after initializing the feature using the
  128969. * addFloorMesh and removeFloorMesh functions
  128970. * If empty, rotation will still work
  128971. */
  128972. floorMeshes?: AbstractMesh[];
  128973. /**
  128974. * use this rendering group id for the meshes (optional)
  128975. */
  128976. renderingGroupId?: number;
  128977. /**
  128978. * Should teleportation move only to snap points
  128979. */
  128980. snapPointsOnly?: boolean;
  128981. /**
  128982. * An array of points to which the teleportation will snap to.
  128983. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  128984. */
  128985. snapPositions?: Vector3[];
  128986. /**
  128987. * How close should the teleportation ray be in order to snap to position.
  128988. * Default to 0.8 units (meters)
  128989. */
  128990. snapToPositionRadius?: number;
  128991. /**
  128992. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  128993. * If you want to support rotation, make sure your mesh has a direction indicator.
  128994. *
  128995. * When left untouched, the default mesh will be initialized.
  128996. */
  128997. teleportationTargetMesh?: AbstractMesh;
  128998. /**
  128999. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  129000. */
  129001. timeToTeleport?: number;
  129002. /**
  129003. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  129004. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  129005. */
  129006. useMainComponentOnly?: boolean;
  129007. /**
  129008. * Should meshes created here be added to a utility layer or the main scene
  129009. */
  129010. useUtilityLayer?: boolean;
  129011. /**
  129012. * Babylon XR Input class for controller
  129013. */
  129014. xrInput: WebXRInput;
  129015. }
  129016. /**
  129017. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  129018. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  129019. * the input of the attached controllers.
  129020. */
  129021. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  129022. private _options;
  129023. private _controllers;
  129024. private _currentTeleportationControllerId;
  129025. private _floorMeshes;
  129026. private _quadraticBezierCurve;
  129027. private _selectionFeature;
  129028. private _snapToPositions;
  129029. private _snappedToPoint;
  129030. private _teleportationRingMaterial?;
  129031. private _tmpRay;
  129032. private _tmpVector;
  129033. /**
  129034. * The module's name
  129035. */
  129036. static readonly Name: string;
  129037. /**
  129038. * The (Babylon) version of this module.
  129039. * This is an integer representing the implementation version.
  129040. * This number does not correspond to the webxr specs version
  129041. */
  129042. static readonly Version: number;
  129043. /**
  129044. * Is movement backwards enabled
  129045. */
  129046. backwardsMovementEnabled: boolean;
  129047. /**
  129048. * Distance to travel when moving backwards
  129049. */
  129050. backwardsTeleportationDistance: number;
  129051. /**
  129052. * The distance from the user to the inspection point in the direction of the controller
  129053. * A higher number will allow the user to move further
  129054. * defaults to 5 (meters, in xr units)
  129055. */
  129056. parabolicCheckRadius: number;
  129057. /**
  129058. * Should the module support parabolic ray on top of direct ray
  129059. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  129060. * Very helpful when moving between floors / different heights
  129061. */
  129062. parabolicRayEnabled: boolean;
  129063. /**
  129064. * How much rotation should be applied when rotating right and left
  129065. */
  129066. rotationAngle: number;
  129067. /**
  129068. * Is rotation enabled when moving forward?
  129069. * Disabling this feature will prevent the user from deciding the direction when teleporting
  129070. */
  129071. rotationEnabled: boolean;
  129072. /**
  129073. * constructs a new anchor system
  129074. * @param _xrSessionManager an instance of WebXRSessionManager
  129075. * @param _options configuration object for this feature
  129076. */
  129077. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  129078. /**
  129079. * Get the snapPointsOnly flag
  129080. */
  129081. get snapPointsOnly(): boolean;
  129082. /**
  129083. * Sets the snapPointsOnly flag
  129084. * @param snapToPoints should teleportation be exclusively to snap points
  129085. */
  129086. set snapPointsOnly(snapToPoints: boolean);
  129087. /**
  129088. * Add a new mesh to the floor meshes array
  129089. * @param mesh the mesh to use as floor mesh
  129090. */
  129091. addFloorMesh(mesh: AbstractMesh): void;
  129092. /**
  129093. * Add a new snap-to point to fix teleportation to this position
  129094. * @param newSnapPoint The new Snap-To point
  129095. */
  129096. addSnapPoint(newSnapPoint: Vector3): void;
  129097. attach(): boolean;
  129098. detach(): boolean;
  129099. dispose(): void;
  129100. /**
  129101. * Remove a mesh from the floor meshes array
  129102. * @param mesh the mesh to remove
  129103. */
  129104. removeFloorMesh(mesh: AbstractMesh): void;
  129105. /**
  129106. * Remove a mesh from the floor meshes array using its name
  129107. * @param name the mesh name to remove
  129108. */
  129109. removeFloorMeshByName(name: string): void;
  129110. /**
  129111. * 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
  129112. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  129113. * @returns was the point found and removed or not
  129114. */
  129115. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  129116. /**
  129117. * This function sets a selection feature that will be disabled when
  129118. * the forward ray is shown and will be reattached when hidden.
  129119. * This is used to remove the selection rays when moving.
  129120. * @param selectionFeature the feature to disable when forward movement is enabled
  129121. */
  129122. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  129123. protected _onXRFrame(_xrFrame: XRFrame): void;
  129124. private _attachController;
  129125. private _createDefaultTargetMesh;
  129126. private _detachController;
  129127. private _findClosestSnapPointWithRadius;
  129128. private _setTargetMeshPosition;
  129129. private _setTargetMeshVisibility;
  129130. private _showParabolicPath;
  129131. private _teleportForward;
  129132. }
  129133. }
  129134. declare module BABYLON {
  129135. /**
  129136. * Options for the default xr helper
  129137. */
  129138. export class WebXRDefaultExperienceOptions {
  129139. /**
  129140. * Enable or disable default UI to enter XR
  129141. */
  129142. disableDefaultUI?: boolean;
  129143. /**
  129144. * Should teleportation not initialize. defaults to false.
  129145. */
  129146. disableTeleportation?: boolean;
  129147. /**
  129148. * Floor meshes that will be used for teleport
  129149. */
  129150. floorMeshes?: Array<AbstractMesh>;
  129151. /**
  129152. * If set to true, the first frame will not be used to reset position
  129153. * The first frame is mainly used when copying transformation from the old camera
  129154. * Mainly used in AR
  129155. */
  129156. ignoreNativeCameraTransformation?: boolean;
  129157. /**
  129158. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  129159. */
  129160. inputOptions?: IWebXRInputOptions;
  129161. /**
  129162. * optional configuration for the output canvas
  129163. */
  129164. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  129165. /**
  129166. * optional UI options. This can be used among other to change session mode and reference space type
  129167. */
  129168. uiOptions?: WebXREnterExitUIOptions;
  129169. /**
  129170. * When loading teleportation and pointer select, use stable versions instead of latest.
  129171. */
  129172. useStablePlugins?: boolean;
  129173. /**
  129174. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  129175. */
  129176. renderingGroupId?: number;
  129177. /**
  129178. * A list of optional features to init the session with
  129179. * If set to true, all features we support will be added
  129180. */
  129181. optionalFeatures?: boolean | string[];
  129182. }
  129183. /**
  129184. * Default experience which provides a similar setup to the previous webVRExperience
  129185. */
  129186. export class WebXRDefaultExperience {
  129187. /**
  129188. * Base experience
  129189. */
  129190. baseExperience: WebXRExperienceHelper;
  129191. /**
  129192. * Enables ui for entering/exiting xr
  129193. */
  129194. enterExitUI: WebXREnterExitUI;
  129195. /**
  129196. * Input experience extension
  129197. */
  129198. input: WebXRInput;
  129199. /**
  129200. * Enables laser pointer and selection
  129201. */
  129202. pointerSelection: WebXRControllerPointerSelection;
  129203. /**
  129204. * Default target xr should render to
  129205. */
  129206. renderTarget: WebXRRenderTarget;
  129207. /**
  129208. * Enables teleportation
  129209. */
  129210. teleportation: WebXRMotionControllerTeleportation;
  129211. private constructor();
  129212. /**
  129213. * Creates the default xr experience
  129214. * @param scene scene
  129215. * @param options options for basic configuration
  129216. * @returns resulting WebXRDefaultExperience
  129217. */
  129218. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  129219. /**
  129220. * DIsposes of the experience helper
  129221. */
  129222. dispose(): void;
  129223. }
  129224. }
  129225. declare module BABYLON {
  129226. /**
  129227. * Options to modify the vr teleportation behavior.
  129228. */
  129229. export interface VRTeleportationOptions {
  129230. /**
  129231. * The name of the mesh which should be used as the teleportation floor. (default: null)
  129232. */
  129233. floorMeshName?: string;
  129234. /**
  129235. * A list of meshes to be used as the teleportation floor. (default: empty)
  129236. */
  129237. floorMeshes?: Mesh[];
  129238. /**
  129239. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  129240. */
  129241. teleportationMode?: number;
  129242. /**
  129243. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  129244. */
  129245. teleportationTime?: number;
  129246. /**
  129247. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  129248. */
  129249. teleportationSpeed?: number;
  129250. /**
  129251. * The easing function used in the animation or null for Linear. (default CircleEase)
  129252. */
  129253. easingFunction?: EasingFunction;
  129254. }
  129255. /**
  129256. * Options to modify the vr experience helper's behavior.
  129257. */
  129258. export interface VRExperienceHelperOptions extends WebVROptions {
  129259. /**
  129260. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  129261. */
  129262. createDeviceOrientationCamera?: boolean;
  129263. /**
  129264. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  129265. */
  129266. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  129267. /**
  129268. * Uses the main button on the controller to toggle the laser casted. (default: true)
  129269. */
  129270. laserToggle?: boolean;
  129271. /**
  129272. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  129273. */
  129274. floorMeshes?: Mesh[];
  129275. /**
  129276. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  129277. */
  129278. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  129279. /**
  129280. * Defines if WebXR should be used instead of WebVR (if available)
  129281. */
  129282. useXR?: boolean;
  129283. }
  129284. /**
  129285. * Event containing information after VR has been entered
  129286. */
  129287. export class OnAfterEnteringVRObservableEvent {
  129288. /**
  129289. * If entering vr was successful
  129290. */
  129291. success: boolean;
  129292. }
  129293. /**
  129294. * Helps to quickly add VR support to an existing scene.
  129295. * See https://doc.babylonjs.com/how_to/webvr_helper
  129296. */
  129297. export class VRExperienceHelper {
  129298. /** Options to modify the vr experience helper's behavior. */
  129299. webVROptions: VRExperienceHelperOptions;
  129300. private _scene;
  129301. private _position;
  129302. private _btnVR;
  129303. private _btnVRDisplayed;
  129304. private _webVRsupported;
  129305. private _webVRready;
  129306. private _webVRrequesting;
  129307. private _webVRpresenting;
  129308. private _hasEnteredVR;
  129309. private _fullscreenVRpresenting;
  129310. private _inputElement;
  129311. private _webVRCamera;
  129312. private _vrDeviceOrientationCamera;
  129313. private _deviceOrientationCamera;
  129314. private _existingCamera;
  129315. private _onKeyDown;
  129316. private _onVrDisplayPresentChange;
  129317. private _onVRDisplayChanged;
  129318. private _onVRRequestPresentStart;
  129319. private _onVRRequestPresentComplete;
  129320. /**
  129321. * 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)
  129322. */
  129323. enableGazeEvenWhenNoPointerLock: boolean;
  129324. /**
  129325. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  129326. */
  129327. exitVROnDoubleTap: boolean;
  129328. /**
  129329. * Observable raised right before entering VR.
  129330. */
  129331. onEnteringVRObservable: Observable<VRExperienceHelper>;
  129332. /**
  129333. * Observable raised when entering VR has completed.
  129334. */
  129335. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  129336. /**
  129337. * Observable raised when exiting VR.
  129338. */
  129339. onExitingVRObservable: Observable<VRExperienceHelper>;
  129340. /**
  129341. * Observable raised when controller mesh is loaded.
  129342. */
  129343. onControllerMeshLoadedObservable: Observable<WebVRController>;
  129344. /** Return this.onEnteringVRObservable
  129345. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  129346. */
  129347. get onEnteringVR(): Observable<VRExperienceHelper>;
  129348. /** Return this.onExitingVRObservable
  129349. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  129350. */
  129351. get onExitingVR(): Observable<VRExperienceHelper>;
  129352. /** Return this.onControllerMeshLoadedObservable
  129353. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  129354. */
  129355. get onControllerMeshLoaded(): Observable<WebVRController>;
  129356. private _rayLength;
  129357. private _useCustomVRButton;
  129358. private _teleportationRequested;
  129359. private _teleportActive;
  129360. private _floorMeshName;
  129361. private _floorMeshesCollection;
  129362. private _teleportationMode;
  129363. private _teleportationTime;
  129364. private _teleportationSpeed;
  129365. private _teleportationEasing;
  129366. private _rotationAllowed;
  129367. private _teleportBackwardsVector;
  129368. private _teleportationTarget;
  129369. private _isDefaultTeleportationTarget;
  129370. private _postProcessMove;
  129371. private _teleportationFillColor;
  129372. private _teleportationBorderColor;
  129373. private _rotationAngle;
  129374. private _haloCenter;
  129375. private _cameraGazer;
  129376. private _padSensibilityUp;
  129377. private _padSensibilityDown;
  129378. private _leftController;
  129379. private _rightController;
  129380. private _gazeColor;
  129381. private _laserColor;
  129382. private _pickedLaserColor;
  129383. private _pickedGazeColor;
  129384. /**
  129385. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  129386. */
  129387. onNewMeshSelected: Observable<AbstractMesh>;
  129388. /**
  129389. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  129390. * This observable will provide the mesh and the controller used to select the mesh
  129391. */
  129392. onMeshSelectedWithController: Observable<{
  129393. mesh: AbstractMesh;
  129394. controller: WebVRController;
  129395. }>;
  129396. /**
  129397. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  129398. */
  129399. onNewMeshPicked: Observable<PickingInfo>;
  129400. private _circleEase;
  129401. /**
  129402. * Observable raised before camera teleportation
  129403. */
  129404. onBeforeCameraTeleport: Observable<Vector3>;
  129405. /**
  129406. * Observable raised after camera teleportation
  129407. */
  129408. onAfterCameraTeleport: Observable<Vector3>;
  129409. /**
  129410. * Observable raised when current selected mesh gets unselected
  129411. */
  129412. onSelectedMeshUnselected: Observable<AbstractMesh>;
  129413. private _raySelectionPredicate;
  129414. /**
  129415. * To be optionaly changed by user to define custom ray selection
  129416. */
  129417. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129418. /**
  129419. * To be optionaly changed by user to define custom selection logic (after ray selection)
  129420. */
  129421. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  129422. /**
  129423. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  129424. */
  129425. teleportationEnabled: boolean;
  129426. private _defaultHeight;
  129427. private _teleportationInitialized;
  129428. private _interactionsEnabled;
  129429. private _interactionsRequested;
  129430. private _displayGaze;
  129431. private _displayLaserPointer;
  129432. /**
  129433. * The mesh used to display where the user is going to teleport.
  129434. */
  129435. get teleportationTarget(): Mesh;
  129436. /**
  129437. * Sets the mesh to be used to display where the user is going to teleport.
  129438. */
  129439. set teleportationTarget(value: Mesh);
  129440. /**
  129441. * 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
  129442. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  129443. * See https://doc.babylonjs.com/resources/baking_transformations
  129444. */
  129445. get gazeTrackerMesh(): Mesh;
  129446. set gazeTrackerMesh(value: Mesh);
  129447. /**
  129448. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  129449. */
  129450. updateGazeTrackerScale: boolean;
  129451. /**
  129452. * If the gaze trackers color should be updated when selecting meshes
  129453. */
  129454. updateGazeTrackerColor: boolean;
  129455. /**
  129456. * If the controller laser color should be updated when selecting meshes
  129457. */
  129458. updateControllerLaserColor: boolean;
  129459. /**
  129460. * The gaze tracking mesh corresponding to the left controller
  129461. */
  129462. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  129463. /**
  129464. * The gaze tracking mesh corresponding to the right controller
  129465. */
  129466. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  129467. /**
  129468. * If the ray of the gaze should be displayed.
  129469. */
  129470. get displayGaze(): boolean;
  129471. /**
  129472. * Sets if the ray of the gaze should be displayed.
  129473. */
  129474. set displayGaze(value: boolean);
  129475. /**
  129476. * If the ray of the LaserPointer should be displayed.
  129477. */
  129478. get displayLaserPointer(): boolean;
  129479. /**
  129480. * Sets if the ray of the LaserPointer should be displayed.
  129481. */
  129482. set displayLaserPointer(value: boolean);
  129483. /**
  129484. * The deviceOrientationCamera used as the camera when not in VR.
  129485. */
  129486. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  129487. /**
  129488. * Based on the current WebVR support, returns the current VR camera used.
  129489. */
  129490. get currentVRCamera(): Nullable<Camera>;
  129491. /**
  129492. * The webVRCamera which is used when in VR.
  129493. */
  129494. get webVRCamera(): WebVRFreeCamera;
  129495. /**
  129496. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  129497. */
  129498. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  129499. /**
  129500. * The html button that is used to trigger entering into VR.
  129501. */
  129502. get vrButton(): Nullable<HTMLButtonElement>;
  129503. private get _teleportationRequestInitiated();
  129504. /**
  129505. * Defines whether or not Pointer lock should be requested when switching to
  129506. * full screen.
  129507. */
  129508. requestPointerLockOnFullScreen: boolean;
  129509. /**
  129510. * If asking to force XR, this will be populated with the default xr experience
  129511. */
  129512. xr: WebXRDefaultExperience;
  129513. /**
  129514. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  129515. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  129516. */
  129517. xrTestDone: boolean;
  129518. /**
  129519. * Instantiates a VRExperienceHelper.
  129520. * Helps to quickly add VR support to an existing scene.
  129521. * @param scene The scene the VRExperienceHelper belongs to.
  129522. * @param webVROptions Options to modify the vr experience helper's behavior.
  129523. */
  129524. constructor(scene: Scene,
  129525. /** Options to modify the vr experience helper's behavior. */
  129526. webVROptions?: VRExperienceHelperOptions);
  129527. private completeVRInit;
  129528. private _onDefaultMeshLoaded;
  129529. private _onResize;
  129530. private _onFullscreenChange;
  129531. /**
  129532. * Gets a value indicating if we are currently in VR mode.
  129533. */
  129534. get isInVRMode(): boolean;
  129535. private onVrDisplayPresentChange;
  129536. private onVRDisplayChanged;
  129537. private moveButtonToBottomRight;
  129538. private displayVRButton;
  129539. private updateButtonVisibility;
  129540. private _cachedAngularSensibility;
  129541. /**
  129542. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  129543. * Otherwise, will use the fullscreen API.
  129544. */
  129545. enterVR(): void;
  129546. /**
  129547. * Attempt to exit VR, or fullscreen.
  129548. */
  129549. exitVR(): void;
  129550. /**
  129551. * The position of the vr experience helper.
  129552. */
  129553. get position(): Vector3;
  129554. /**
  129555. * Sets the position of the vr experience helper.
  129556. */
  129557. set position(value: Vector3);
  129558. /**
  129559. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  129560. */
  129561. enableInteractions(): void;
  129562. private get _noControllerIsActive();
  129563. private beforeRender;
  129564. private _isTeleportationFloor;
  129565. /**
  129566. * Adds a floor mesh to be used for teleportation.
  129567. * @param floorMesh the mesh to be used for teleportation.
  129568. */
  129569. addFloorMesh(floorMesh: Mesh): void;
  129570. /**
  129571. * Removes a floor mesh from being used for teleportation.
  129572. * @param floorMesh the mesh to be removed.
  129573. */
  129574. removeFloorMesh(floorMesh: Mesh): void;
  129575. /**
  129576. * Enables interactions and teleportation using the VR controllers and gaze.
  129577. * @param vrTeleportationOptions options to modify teleportation behavior.
  129578. */
  129579. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  129580. private _onNewGamepadConnected;
  129581. private _tryEnableInteractionOnController;
  129582. private _onNewGamepadDisconnected;
  129583. private _enableInteractionOnController;
  129584. private _checkTeleportWithRay;
  129585. private _checkRotate;
  129586. private _checkTeleportBackwards;
  129587. private _enableTeleportationOnController;
  129588. private _createTeleportationCircles;
  129589. private _displayTeleportationTarget;
  129590. private _hideTeleportationTarget;
  129591. private _rotateCamera;
  129592. private _moveTeleportationSelectorTo;
  129593. private _workingVector;
  129594. private _workingQuaternion;
  129595. private _workingMatrix;
  129596. /**
  129597. * Time Constant Teleportation Mode
  129598. */
  129599. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  129600. /**
  129601. * Speed Constant Teleportation Mode
  129602. */
  129603. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  129604. /**
  129605. * Teleports the users feet to the desired location
  129606. * @param location The location where the user's feet should be placed
  129607. */
  129608. teleportCamera(location: Vector3): void;
  129609. private _convertNormalToDirectionOfRay;
  129610. private _castRayAndSelectObject;
  129611. private _notifySelectedMeshUnselected;
  129612. /**
  129613. * Permanently set new colors for the laser pointer
  129614. * @param color the new laser color
  129615. * @param pickedColor the new laser color when picked mesh detected
  129616. */
  129617. setLaserColor(color: Color3, pickedColor?: Color3): void;
  129618. /**
  129619. * Set lighting enabled / disabled on the laser pointer of both controllers
  129620. * @param enabled should the lighting be enabled on the laser pointer
  129621. */
  129622. setLaserLightingState(enabled?: boolean): void;
  129623. /**
  129624. * Permanently set new colors for the gaze pointer
  129625. * @param color the new gaze color
  129626. * @param pickedColor the new gaze color when picked mesh detected
  129627. */
  129628. setGazeColor(color: Color3, pickedColor?: Color3): void;
  129629. /**
  129630. * Sets the color of the laser ray from the vr controllers.
  129631. * @param color new color for the ray.
  129632. */
  129633. changeLaserColor(color: Color3): void;
  129634. /**
  129635. * Sets the color of the ray from the vr headsets gaze.
  129636. * @param color new color for the ray.
  129637. */
  129638. changeGazeColor(color: Color3): void;
  129639. /**
  129640. * Exits VR and disposes of the vr experience helper
  129641. */
  129642. dispose(): void;
  129643. /**
  129644. * Gets the name of the VRExperienceHelper class
  129645. * @returns "VRExperienceHelper"
  129646. */
  129647. getClassName(): string;
  129648. }
  129649. }
  129650. declare module BABYLON {
  129651. /**
  129652. * Contains an array of blocks representing the octree
  129653. */
  129654. export interface IOctreeContainer<T> {
  129655. /**
  129656. * Blocks within the octree
  129657. */
  129658. blocks: Array<OctreeBlock<T>>;
  129659. }
  129660. /**
  129661. * Class used to store a cell in an octree
  129662. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129663. */
  129664. export class OctreeBlock<T> {
  129665. /**
  129666. * Gets the content of the current block
  129667. */
  129668. entries: T[];
  129669. /**
  129670. * Gets the list of block children
  129671. */
  129672. blocks: Array<OctreeBlock<T>>;
  129673. private _depth;
  129674. private _maxDepth;
  129675. private _capacity;
  129676. private _minPoint;
  129677. private _maxPoint;
  129678. private _boundingVectors;
  129679. private _creationFunc;
  129680. /**
  129681. * Creates a new block
  129682. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  129683. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  129684. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129685. * @param depth defines the current depth of this block in the octree
  129686. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  129687. * @param creationFunc defines a callback to call when an element is added to the block
  129688. */
  129689. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  129690. /**
  129691. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129692. */
  129693. get capacity(): number;
  129694. /**
  129695. * Gets the minimum vector (in world space) of the block's bounding box
  129696. */
  129697. get minPoint(): Vector3;
  129698. /**
  129699. * Gets the maximum vector (in world space) of the block's bounding box
  129700. */
  129701. get maxPoint(): Vector3;
  129702. /**
  129703. * Add a new element to this block
  129704. * @param entry defines the element to add
  129705. */
  129706. addEntry(entry: T): void;
  129707. /**
  129708. * Remove an element from this block
  129709. * @param entry defines the element to remove
  129710. */
  129711. removeEntry(entry: T): void;
  129712. /**
  129713. * Add an array of elements to this block
  129714. * @param entries defines the array of elements to add
  129715. */
  129716. addEntries(entries: T[]): void;
  129717. /**
  129718. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  129719. * @param frustumPlanes defines the frustum planes to test
  129720. * @param selection defines the array to store current content if selection is positive
  129721. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129722. */
  129723. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129724. /**
  129725. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  129726. * @param sphereCenter defines the bounding sphere center
  129727. * @param sphereRadius defines the bounding sphere radius
  129728. * @param selection defines the array to store current content if selection is positive
  129729. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129730. */
  129731. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129732. /**
  129733. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  129734. * @param ray defines the ray to test with
  129735. * @param selection defines the array to store current content if selection is positive
  129736. */
  129737. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  129738. /**
  129739. * Subdivide the content into child blocks (this block will then be empty)
  129740. */
  129741. createInnerBlocks(): void;
  129742. /**
  129743. * @hidden
  129744. */
  129745. 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;
  129746. }
  129747. }
  129748. declare module BABYLON {
  129749. /**
  129750. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  129751. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129752. */
  129753. export class Octree<T> {
  129754. /** 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.) */
  129755. maxDepth: number;
  129756. /**
  129757. * Blocks within the octree containing objects
  129758. */
  129759. blocks: Array<OctreeBlock<T>>;
  129760. /**
  129761. * Content stored in the octree
  129762. */
  129763. dynamicContent: T[];
  129764. private _maxBlockCapacity;
  129765. private _selectionContent;
  129766. private _creationFunc;
  129767. /**
  129768. * Creates a octree
  129769. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129770. * @param creationFunc function to be used to instatiate the octree
  129771. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  129772. * @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.)
  129773. */
  129774. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  129775. /** 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.) */
  129776. maxDepth?: number);
  129777. /**
  129778. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  129779. * @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);
  129780. * @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);
  129781. * @param entries meshes to be added to the octree blocks
  129782. */
  129783. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  129784. /**
  129785. * Adds a mesh to the octree
  129786. * @param entry Mesh to add to the octree
  129787. */
  129788. addMesh(entry: T): void;
  129789. /**
  129790. * Remove an element from the octree
  129791. * @param entry defines the element to remove
  129792. */
  129793. removeMesh(entry: T): void;
  129794. /**
  129795. * Selects an array of meshes within the frustum
  129796. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  129797. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  129798. * @returns array of meshes within the frustum
  129799. */
  129800. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  129801. /**
  129802. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  129803. * @param sphereCenter defines the bounding sphere center
  129804. * @param sphereRadius defines the bounding sphere radius
  129805. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129806. * @returns an array of objects that intersect the sphere
  129807. */
  129808. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  129809. /**
  129810. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  129811. * @param ray defines the ray to test with
  129812. * @returns array of intersected objects
  129813. */
  129814. intersectsRay(ray: Ray): SmartArray<T>;
  129815. /**
  129816. * Adds a mesh into the octree block if it intersects the block
  129817. */
  129818. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  129819. /**
  129820. * Adds a submesh into the octree block if it intersects the block
  129821. */
  129822. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  129823. }
  129824. }
  129825. declare module BABYLON {
  129826. interface Scene {
  129827. /**
  129828. * @hidden
  129829. * Backing Filed
  129830. */
  129831. _selectionOctree: Octree<AbstractMesh>;
  129832. /**
  129833. * Gets the octree used to boost mesh selection (picking)
  129834. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129835. */
  129836. selectionOctree: Octree<AbstractMesh>;
  129837. /**
  129838. * Creates or updates the octree used to boost selection (picking)
  129839. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129840. * @param maxCapacity defines the maximum capacity per leaf
  129841. * @param maxDepth defines the maximum depth of the octree
  129842. * @returns an octree of AbstractMesh
  129843. */
  129844. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  129845. }
  129846. interface AbstractMesh {
  129847. /**
  129848. * @hidden
  129849. * Backing Field
  129850. */
  129851. _submeshesOctree: Octree<SubMesh>;
  129852. /**
  129853. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  129854. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  129855. * @param maxCapacity defines the maximum size of each block (64 by default)
  129856. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  129857. * @returns the new octree
  129858. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  129859. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129860. */
  129861. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  129862. }
  129863. /**
  129864. * Defines the octree scene component responsible to manage any octrees
  129865. * in a given scene.
  129866. */
  129867. export class OctreeSceneComponent {
  129868. /**
  129869. * The component name help to identify the component in the list of scene components.
  129870. */
  129871. readonly name: string;
  129872. /**
  129873. * The scene the component belongs to.
  129874. */
  129875. scene: Scene;
  129876. /**
  129877. * Indicates if the meshes have been checked to make sure they are isEnabled()
  129878. */
  129879. readonly checksIsEnabled: boolean;
  129880. /**
  129881. * Creates a new instance of the component for the given scene
  129882. * @param scene Defines the scene to register the component in
  129883. */
  129884. constructor(scene: Scene);
  129885. /**
  129886. * Registers the component in a given scene
  129887. */
  129888. register(): void;
  129889. /**
  129890. * Return the list of active meshes
  129891. * @returns the list of active meshes
  129892. */
  129893. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  129894. /**
  129895. * Return the list of active sub meshes
  129896. * @param mesh The mesh to get the candidates sub meshes from
  129897. * @returns the list of active sub meshes
  129898. */
  129899. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  129900. private _tempRay;
  129901. /**
  129902. * Return the list of sub meshes intersecting with a given local ray
  129903. * @param mesh defines the mesh to find the submesh for
  129904. * @param localRay defines the ray in local space
  129905. * @returns the list of intersecting sub meshes
  129906. */
  129907. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  129908. /**
  129909. * Return the list of sub meshes colliding with a collider
  129910. * @param mesh defines the mesh to find the submesh for
  129911. * @param collider defines the collider to evaluate the collision against
  129912. * @returns the list of colliding sub meshes
  129913. */
  129914. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  129915. /**
  129916. * Rebuilds the elements related to this component in case of
  129917. * context lost for instance.
  129918. */
  129919. rebuild(): void;
  129920. /**
  129921. * Disposes the component and the associated ressources.
  129922. */
  129923. dispose(): void;
  129924. }
  129925. }
  129926. declare module BABYLON {
  129927. /**
  129928. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  129929. */
  129930. export class Gizmo implements IDisposable {
  129931. /** The utility layer the gizmo will be added to */
  129932. gizmoLayer: UtilityLayerRenderer;
  129933. /**
  129934. * The root mesh of the gizmo
  129935. */
  129936. _rootMesh: Mesh;
  129937. private _attachedMesh;
  129938. private _attachedNode;
  129939. /**
  129940. * Ratio for the scale of the gizmo (Default: 1)
  129941. */
  129942. protected _scaleRatio: number;
  129943. /**
  129944. * Ratio for the scale of the gizmo (Default: 1)
  129945. */
  129946. set scaleRatio(value: number);
  129947. get scaleRatio(): number;
  129948. /**
  129949. * If a custom mesh has been set (Default: false)
  129950. */
  129951. protected _customMeshSet: boolean;
  129952. /**
  129953. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  129954. * * When set, interactions will be enabled
  129955. */
  129956. get attachedMesh(): Nullable<AbstractMesh>;
  129957. set attachedMesh(value: Nullable<AbstractMesh>);
  129958. /**
  129959. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  129960. * * When set, interactions will be enabled
  129961. */
  129962. get attachedNode(): Nullable<Node>;
  129963. set attachedNode(value: Nullable<Node>);
  129964. /**
  129965. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  129966. * @param mesh The mesh to replace the default mesh of the gizmo
  129967. */
  129968. setCustomMesh(mesh: Mesh): void;
  129969. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  129970. /**
  129971. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  129972. */
  129973. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  129974. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  129975. /**
  129976. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  129977. */
  129978. updateGizmoPositionToMatchAttachedMesh: boolean;
  129979. /**
  129980. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  129981. */
  129982. updateScale: boolean;
  129983. protected _interactionsEnabled: boolean;
  129984. protected _attachedNodeChanged(value: Nullable<Node>): void;
  129985. private _beforeRenderObserver;
  129986. private _tempQuaternion;
  129987. private _tempVector;
  129988. private _tempVector2;
  129989. /**
  129990. * Creates a gizmo
  129991. * @param gizmoLayer The utility layer the gizmo will be added to
  129992. */
  129993. constructor(
  129994. /** The utility layer the gizmo will be added to */
  129995. gizmoLayer?: UtilityLayerRenderer);
  129996. /**
  129997. * Updates the gizmo to match the attached mesh's position/rotation
  129998. */
  129999. protected _update(): void;
  130000. /**
  130001. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  130002. * @param value Node, TransformNode or mesh
  130003. */
  130004. protected _matrixChanged(): void;
  130005. /**
  130006. * Disposes of the gizmo
  130007. */
  130008. dispose(): void;
  130009. }
  130010. }
  130011. declare module BABYLON {
  130012. /**
  130013. * Single plane drag gizmo
  130014. */
  130015. export class PlaneDragGizmo extends Gizmo {
  130016. /**
  130017. * Drag behavior responsible for the gizmos dragging interactions
  130018. */
  130019. dragBehavior: PointerDragBehavior;
  130020. private _pointerObserver;
  130021. /**
  130022. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130023. */
  130024. snapDistance: number;
  130025. /**
  130026. * Event that fires each time the gizmo snaps to a new location.
  130027. * * snapDistance is the the change in distance
  130028. */
  130029. onSnapObservable: Observable<{
  130030. snapDistance: number;
  130031. }>;
  130032. private _plane;
  130033. private _coloredMaterial;
  130034. private _hoverMaterial;
  130035. private _isEnabled;
  130036. private _parent;
  130037. /** @hidden */
  130038. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  130039. /** @hidden */
  130040. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130041. /**
  130042. * Creates a PlaneDragGizmo
  130043. * @param gizmoLayer The utility layer the gizmo will be added to
  130044. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  130045. * @param color The color of the gizmo
  130046. */
  130047. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  130048. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130049. /**
  130050. * If the gizmo is enabled
  130051. */
  130052. set isEnabled(value: boolean);
  130053. get isEnabled(): boolean;
  130054. /**
  130055. * Disposes of the gizmo
  130056. */
  130057. dispose(): void;
  130058. }
  130059. }
  130060. declare module BABYLON {
  130061. /**
  130062. * Gizmo that enables dragging a mesh along 3 axis
  130063. */
  130064. export class PositionGizmo extends Gizmo {
  130065. /**
  130066. * Internal gizmo used for interactions on the x axis
  130067. */
  130068. xGizmo: AxisDragGizmo;
  130069. /**
  130070. * Internal gizmo used for interactions on the y axis
  130071. */
  130072. yGizmo: AxisDragGizmo;
  130073. /**
  130074. * Internal gizmo used for interactions on the z axis
  130075. */
  130076. zGizmo: AxisDragGizmo;
  130077. /**
  130078. * Internal gizmo used for interactions on the yz plane
  130079. */
  130080. xPlaneGizmo: PlaneDragGizmo;
  130081. /**
  130082. * Internal gizmo used for interactions on the xz plane
  130083. */
  130084. yPlaneGizmo: PlaneDragGizmo;
  130085. /**
  130086. * Internal gizmo used for interactions on the xy plane
  130087. */
  130088. zPlaneGizmo: PlaneDragGizmo;
  130089. /**
  130090. * private variables
  130091. */
  130092. private _meshAttached;
  130093. private _nodeAttached;
  130094. private _snapDistance;
  130095. /** Fires an event when any of it's sub gizmos are dragged */
  130096. onDragStartObservable: Observable<unknown>;
  130097. /** Fires an event when any of it's sub gizmos are released from dragging */
  130098. onDragEndObservable: Observable<unknown>;
  130099. /**
  130100. * If set to true, planar drag is enabled
  130101. */
  130102. private _planarGizmoEnabled;
  130103. get attachedMesh(): Nullable<AbstractMesh>;
  130104. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130105. get attachedNode(): Nullable<Node>;
  130106. set attachedNode(node: Nullable<Node>);
  130107. /**
  130108. * Creates a PositionGizmo
  130109. * @param gizmoLayer The utility layer the gizmo will be added to
  130110. @param thickness display gizmo axis thickness
  130111. */
  130112. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  130113. /**
  130114. * If the planar drag gizmo is enabled
  130115. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  130116. */
  130117. set planarGizmoEnabled(value: boolean);
  130118. get planarGizmoEnabled(): boolean;
  130119. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130120. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130121. /**
  130122. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130123. */
  130124. set snapDistance(value: number);
  130125. get snapDistance(): number;
  130126. /**
  130127. * Ratio for the scale of the gizmo (Default: 1)
  130128. */
  130129. set scaleRatio(value: number);
  130130. get scaleRatio(): number;
  130131. /**
  130132. * Disposes of the gizmo
  130133. */
  130134. dispose(): void;
  130135. /**
  130136. * CustomMeshes are not supported by this gizmo
  130137. * @param mesh The mesh to replace the default mesh of the gizmo
  130138. */
  130139. setCustomMesh(mesh: Mesh): void;
  130140. }
  130141. }
  130142. declare module BABYLON {
  130143. /**
  130144. * Single axis drag gizmo
  130145. */
  130146. export class AxisDragGizmo extends Gizmo {
  130147. /**
  130148. * Drag behavior responsible for the gizmos dragging interactions
  130149. */
  130150. dragBehavior: PointerDragBehavior;
  130151. private _pointerObserver;
  130152. /**
  130153. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130154. */
  130155. snapDistance: number;
  130156. /**
  130157. * Event that fires each time the gizmo snaps to a new location.
  130158. * * snapDistance is the the change in distance
  130159. */
  130160. onSnapObservable: Observable<{
  130161. snapDistance: number;
  130162. }>;
  130163. private _isEnabled;
  130164. private _parent;
  130165. private _arrow;
  130166. private _coloredMaterial;
  130167. private _hoverMaterial;
  130168. /** @hidden */
  130169. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  130170. /** @hidden */
  130171. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130172. /**
  130173. * Creates an AxisDragGizmo
  130174. * @param gizmoLayer The utility layer the gizmo will be added to
  130175. * @param dragAxis The axis which the gizmo will be able to drag on
  130176. * @param color The color of the gizmo
  130177. * @param thickness display gizmo axis thickness
  130178. */
  130179. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  130180. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130181. /**
  130182. * If the gizmo is enabled
  130183. */
  130184. set isEnabled(value: boolean);
  130185. get isEnabled(): boolean;
  130186. /**
  130187. * Disposes of the gizmo
  130188. */
  130189. dispose(): void;
  130190. }
  130191. }
  130192. declare module BABYLON.Debug {
  130193. /**
  130194. * The Axes viewer will show 3 axes in a specific point in space
  130195. */
  130196. export class AxesViewer {
  130197. private _xAxis;
  130198. private _yAxis;
  130199. private _zAxis;
  130200. private _scaleLinesFactor;
  130201. private _instanced;
  130202. /**
  130203. * Gets the hosting scene
  130204. */
  130205. scene: Nullable<Scene>;
  130206. /**
  130207. * Gets or sets a number used to scale line length
  130208. */
  130209. scaleLines: number;
  130210. /** Gets the node hierarchy used to render x-axis */
  130211. get xAxis(): TransformNode;
  130212. /** Gets the node hierarchy used to render y-axis */
  130213. get yAxis(): TransformNode;
  130214. /** Gets the node hierarchy used to render z-axis */
  130215. get zAxis(): TransformNode;
  130216. /**
  130217. * Creates a new AxesViewer
  130218. * @param scene defines the hosting scene
  130219. * @param scaleLines defines a number used to scale line length (1 by default)
  130220. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  130221. * @param xAxis defines the node hierarchy used to render the x-axis
  130222. * @param yAxis defines the node hierarchy used to render the y-axis
  130223. * @param zAxis defines the node hierarchy used to render the z-axis
  130224. */
  130225. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  130226. /**
  130227. * Force the viewer to update
  130228. * @param position defines the position of the viewer
  130229. * @param xaxis defines the x axis of the viewer
  130230. * @param yaxis defines the y axis of the viewer
  130231. * @param zaxis defines the z axis of the viewer
  130232. */
  130233. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  130234. /**
  130235. * Creates an instance of this axes viewer.
  130236. * @returns a new axes viewer with instanced meshes
  130237. */
  130238. createInstance(): AxesViewer;
  130239. /** Releases resources */
  130240. dispose(): void;
  130241. private static _SetRenderingGroupId;
  130242. }
  130243. }
  130244. declare module BABYLON.Debug {
  130245. /**
  130246. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  130247. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  130248. */
  130249. export class BoneAxesViewer extends AxesViewer {
  130250. /**
  130251. * Gets or sets the target mesh where to display the axes viewer
  130252. */
  130253. mesh: Nullable<Mesh>;
  130254. /**
  130255. * Gets or sets the target bone where to display the axes viewer
  130256. */
  130257. bone: Nullable<Bone>;
  130258. /** Gets current position */
  130259. pos: Vector3;
  130260. /** Gets direction of X axis */
  130261. xaxis: Vector3;
  130262. /** Gets direction of Y axis */
  130263. yaxis: Vector3;
  130264. /** Gets direction of Z axis */
  130265. zaxis: Vector3;
  130266. /**
  130267. * Creates a new BoneAxesViewer
  130268. * @param scene defines the hosting scene
  130269. * @param bone defines the target bone
  130270. * @param mesh defines the target mesh
  130271. * @param scaleLines defines a scaling factor for line length (1 by default)
  130272. */
  130273. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  130274. /**
  130275. * Force the viewer to update
  130276. */
  130277. update(): void;
  130278. /** Releases resources */
  130279. dispose(): void;
  130280. }
  130281. }
  130282. declare module BABYLON {
  130283. /**
  130284. * Interface used to define scene explorer extensibility option
  130285. */
  130286. export interface IExplorerExtensibilityOption {
  130287. /**
  130288. * Define the option label
  130289. */
  130290. label: string;
  130291. /**
  130292. * Defines the action to execute on click
  130293. */
  130294. action: (entity: any) => void;
  130295. }
  130296. /**
  130297. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  130298. */
  130299. export interface IExplorerExtensibilityGroup {
  130300. /**
  130301. * Defines a predicate to test if a given type mut be extended
  130302. */
  130303. predicate: (entity: any) => boolean;
  130304. /**
  130305. * Gets the list of options added to a type
  130306. */
  130307. entries: IExplorerExtensibilityOption[];
  130308. }
  130309. /**
  130310. * Interface used to define the options to use to create the Inspector
  130311. */
  130312. export interface IInspectorOptions {
  130313. /**
  130314. * Display in overlay mode (default: false)
  130315. */
  130316. overlay?: boolean;
  130317. /**
  130318. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  130319. */
  130320. globalRoot?: HTMLElement;
  130321. /**
  130322. * Display the Scene explorer
  130323. */
  130324. showExplorer?: boolean;
  130325. /**
  130326. * Display the property inspector
  130327. */
  130328. showInspector?: boolean;
  130329. /**
  130330. * Display in embed mode (both panes on the right)
  130331. */
  130332. embedMode?: boolean;
  130333. /**
  130334. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  130335. */
  130336. handleResize?: boolean;
  130337. /**
  130338. * Allow the panes to popup (default: true)
  130339. */
  130340. enablePopup?: boolean;
  130341. /**
  130342. * Allow the panes to be closed by users (default: true)
  130343. */
  130344. enableClose?: boolean;
  130345. /**
  130346. * Optional list of extensibility entries
  130347. */
  130348. explorerExtensibility?: IExplorerExtensibilityGroup[];
  130349. /**
  130350. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  130351. */
  130352. inspectorURL?: string;
  130353. /**
  130354. * Optional initial tab (default to DebugLayerTab.Properties)
  130355. */
  130356. initialTab?: DebugLayerTab;
  130357. }
  130358. interface Scene {
  130359. /**
  130360. * @hidden
  130361. * Backing field
  130362. */
  130363. _debugLayer: DebugLayer;
  130364. /**
  130365. * Gets the debug layer (aka Inspector) associated with the scene
  130366. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130367. */
  130368. debugLayer: DebugLayer;
  130369. }
  130370. /**
  130371. * Enum of inspector action tab
  130372. */
  130373. export enum DebugLayerTab {
  130374. /**
  130375. * Properties tag (default)
  130376. */
  130377. Properties = 0,
  130378. /**
  130379. * Debug tab
  130380. */
  130381. Debug = 1,
  130382. /**
  130383. * Statistics tab
  130384. */
  130385. Statistics = 2,
  130386. /**
  130387. * Tools tab
  130388. */
  130389. Tools = 3,
  130390. /**
  130391. * Settings tab
  130392. */
  130393. Settings = 4
  130394. }
  130395. /**
  130396. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130397. * what is happening in your scene
  130398. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130399. */
  130400. export class DebugLayer {
  130401. /**
  130402. * Define the url to get the inspector script from.
  130403. * By default it uses the babylonjs CDN.
  130404. * @ignoreNaming
  130405. */
  130406. static InspectorURL: string;
  130407. private _scene;
  130408. private BJSINSPECTOR;
  130409. private _onPropertyChangedObservable?;
  130410. /**
  130411. * Observable triggered when a property is changed through the inspector.
  130412. */
  130413. get onPropertyChangedObservable(): any;
  130414. /**
  130415. * Instantiates a new debug layer.
  130416. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130417. * what is happening in your scene
  130418. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130419. * @param scene Defines the scene to inspect
  130420. */
  130421. constructor(scene: Scene);
  130422. /** Creates the inspector window. */
  130423. private _createInspector;
  130424. /**
  130425. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  130426. * @param entity defines the entity to select
  130427. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  130428. */
  130429. select(entity: any, lineContainerTitles?: string | string[]): void;
  130430. /** Get the inspector from bundle or global */
  130431. private _getGlobalInspector;
  130432. /**
  130433. * Get if the inspector is visible or not.
  130434. * @returns true if visible otherwise, false
  130435. */
  130436. isVisible(): boolean;
  130437. /**
  130438. * Hide the inspector and close its window.
  130439. */
  130440. hide(): void;
  130441. /**
  130442. * Update the scene in the inspector
  130443. */
  130444. setAsActiveScene(): void;
  130445. /**
  130446. * Launch the debugLayer.
  130447. * @param config Define the configuration of the inspector
  130448. * @return a promise fulfilled when the debug layer is visible
  130449. */
  130450. show(config?: IInspectorOptions): Promise<DebugLayer>;
  130451. }
  130452. }
  130453. declare module BABYLON {
  130454. /**
  130455. * Class containing static functions to help procedurally build meshes
  130456. */
  130457. export class BoxBuilder {
  130458. /**
  130459. * Creates a box mesh
  130460. * * The parameter `size` sets the size (float) of each box side (default 1)
  130461. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  130462. * * 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)
  130463. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  130464. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130465. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130466. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130467. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  130468. * @param name defines the name of the mesh
  130469. * @param options defines the options used to create the mesh
  130470. * @param scene defines the hosting scene
  130471. * @returns the box mesh
  130472. */
  130473. static CreateBox(name: string, options: {
  130474. size?: number;
  130475. width?: number;
  130476. height?: number;
  130477. depth?: number;
  130478. faceUV?: Vector4[];
  130479. faceColors?: Color4[];
  130480. sideOrientation?: number;
  130481. frontUVs?: Vector4;
  130482. backUVs?: Vector4;
  130483. wrap?: boolean;
  130484. topBaseAt?: number;
  130485. bottomBaseAt?: number;
  130486. updatable?: boolean;
  130487. }, scene?: Nullable<Scene>): Mesh;
  130488. }
  130489. }
  130490. declare module BABYLON.Debug {
  130491. /**
  130492. * Used to show the physics impostor around the specific mesh
  130493. */
  130494. export class PhysicsViewer {
  130495. /** @hidden */
  130496. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  130497. /** @hidden */
  130498. protected _meshes: Array<Nullable<AbstractMesh>>;
  130499. /** @hidden */
  130500. protected _scene: Nullable<Scene>;
  130501. /** @hidden */
  130502. protected _numMeshes: number;
  130503. /** @hidden */
  130504. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  130505. private _renderFunction;
  130506. private _utilityLayer;
  130507. private _debugBoxMesh;
  130508. private _debugSphereMesh;
  130509. private _debugCylinderMesh;
  130510. private _debugMaterial;
  130511. private _debugMeshMeshes;
  130512. /**
  130513. * Creates a new PhysicsViewer
  130514. * @param scene defines the hosting scene
  130515. */
  130516. constructor(scene: Scene);
  130517. /** @hidden */
  130518. protected _updateDebugMeshes(): void;
  130519. /**
  130520. * Renders a specified physic impostor
  130521. * @param impostor defines the impostor to render
  130522. * @param targetMesh defines the mesh represented by the impostor
  130523. * @returns the new debug mesh used to render the impostor
  130524. */
  130525. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  130526. /**
  130527. * Hides a specified physic impostor
  130528. * @param impostor defines the impostor to hide
  130529. */
  130530. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  130531. private _getDebugMaterial;
  130532. private _getDebugBoxMesh;
  130533. private _getDebugSphereMesh;
  130534. private _getDebugCylinderMesh;
  130535. private _getDebugMeshMesh;
  130536. private _getDebugMesh;
  130537. /** Releases all resources */
  130538. dispose(): void;
  130539. }
  130540. }
  130541. declare module BABYLON {
  130542. /**
  130543. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130544. * in order to better appreciate the issue one might have.
  130545. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130546. */
  130547. export class RayHelper {
  130548. /**
  130549. * Defines the ray we are currently tryin to visualize.
  130550. */
  130551. ray: Nullable<Ray>;
  130552. private _renderPoints;
  130553. private _renderLine;
  130554. private _renderFunction;
  130555. private _scene;
  130556. private _onAfterRenderObserver;
  130557. private _onAfterStepObserver;
  130558. private _attachedToMesh;
  130559. private _meshSpaceDirection;
  130560. private _meshSpaceOrigin;
  130561. /**
  130562. * Helper function to create a colored helper in a scene in one line.
  130563. * @param ray Defines the ray we are currently tryin to visualize
  130564. * @param scene Defines the scene the ray is used in
  130565. * @param color Defines the color we want to see the ray in
  130566. * @returns The newly created ray helper.
  130567. */
  130568. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  130569. /**
  130570. * Instantiate a new ray helper.
  130571. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130572. * in order to better appreciate the issue one might have.
  130573. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130574. * @param ray Defines the ray we are currently tryin to visualize
  130575. */
  130576. constructor(ray: Ray);
  130577. /**
  130578. * Shows the ray we are willing to debug.
  130579. * @param scene Defines the scene the ray needs to be rendered in
  130580. * @param color Defines the color the ray needs to be rendered in
  130581. */
  130582. show(scene: Scene, color?: Color3): void;
  130583. /**
  130584. * Hides the ray we are debugging.
  130585. */
  130586. hide(): void;
  130587. private _render;
  130588. /**
  130589. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  130590. * @param mesh Defines the mesh we want the helper attached to
  130591. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  130592. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  130593. * @param length Defines the length of the ray
  130594. */
  130595. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  130596. /**
  130597. * Detach the ray helper from the mesh it has previously been attached to.
  130598. */
  130599. detachFromMesh(): void;
  130600. private _updateToMesh;
  130601. /**
  130602. * Dispose the helper and release its associated resources.
  130603. */
  130604. dispose(): void;
  130605. }
  130606. }
  130607. declare module BABYLON {
  130608. /**
  130609. * Defines the options associated with the creation of a SkeletonViewer.
  130610. */
  130611. export interface ISkeletonViewerOptions {
  130612. /** Should the system pause animations before building the Viewer? */
  130613. pauseAnimations: boolean;
  130614. /** Should the system return the skeleton to rest before building? */
  130615. returnToRest: boolean;
  130616. /** public Display Mode of the Viewer */
  130617. displayMode: number;
  130618. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130619. displayOptions: ISkeletonViewerDisplayOptions;
  130620. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130621. computeBonesUsingShaders: boolean;
  130622. }
  130623. /**
  130624. * Defines how to display the various bone meshes for the viewer.
  130625. */
  130626. export interface ISkeletonViewerDisplayOptions {
  130627. /** How far down to start tapering the bone spurs */
  130628. midStep?: number;
  130629. /** How big is the midStep? */
  130630. midStepFactor?: number;
  130631. /** Base for the Sphere Size */
  130632. sphereBaseSize?: number;
  130633. /** The ratio of the sphere to the longest bone in units */
  130634. sphereScaleUnit?: number;
  130635. /** Ratio for the Sphere Size */
  130636. sphereFactor?: number;
  130637. }
  130638. }
  130639. declare module BABYLON {
  130640. /**
  130641. * Class containing static functions to help procedurally build meshes
  130642. */
  130643. export class RibbonBuilder {
  130644. /**
  130645. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  130646. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  130647. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  130648. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  130649. * * 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
  130650. * * 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
  130651. * * 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
  130652. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130653. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130654. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130655. * * 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
  130656. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  130657. * * 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
  130658. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  130659. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130660. * @param name defines the name of the mesh
  130661. * @param options defines the options used to create the mesh
  130662. * @param scene defines the hosting scene
  130663. * @returns the ribbon mesh
  130664. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  130665. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130666. */
  130667. static CreateRibbon(name: string, options: {
  130668. pathArray: Vector3[][];
  130669. closeArray?: boolean;
  130670. closePath?: boolean;
  130671. offset?: number;
  130672. updatable?: boolean;
  130673. sideOrientation?: number;
  130674. frontUVs?: Vector4;
  130675. backUVs?: Vector4;
  130676. instance?: Mesh;
  130677. invertUV?: boolean;
  130678. uvs?: Vector2[];
  130679. colors?: Color4[];
  130680. }, scene?: Nullable<Scene>): Mesh;
  130681. }
  130682. }
  130683. declare module BABYLON {
  130684. /**
  130685. * Class containing static functions to help procedurally build meshes
  130686. */
  130687. export class ShapeBuilder {
  130688. /**
  130689. * 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.
  130690. * * 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.
  130691. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130692. * * 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.
  130693. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  130694. * * 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
  130695. * * 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
  130696. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  130697. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130698. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130699. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  130700. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130701. * @param name defines the name of the mesh
  130702. * @param options defines the options used to create the mesh
  130703. * @param scene defines the hosting scene
  130704. * @returns the extruded shape mesh
  130705. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130706. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130707. */
  130708. static ExtrudeShape(name: string, options: {
  130709. shape: Vector3[];
  130710. path: Vector3[];
  130711. scale?: number;
  130712. rotation?: number;
  130713. cap?: number;
  130714. updatable?: boolean;
  130715. sideOrientation?: number;
  130716. frontUVs?: Vector4;
  130717. backUVs?: Vector4;
  130718. instance?: Mesh;
  130719. invertUV?: boolean;
  130720. }, scene?: Nullable<Scene>): Mesh;
  130721. /**
  130722. * Creates an custom extruded shape mesh.
  130723. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  130724. * * 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.
  130725. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130726. * * 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
  130727. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  130728. * * 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
  130729. * * It must returns a float value that will be the scale value applied to the shape on each path point
  130730. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  130731. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  130732. * * 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
  130733. * * 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
  130734. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  130735. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130736. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130737. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130738. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130739. * @param name defines the name of the mesh
  130740. * @param options defines the options used to create the mesh
  130741. * @param scene defines the hosting scene
  130742. * @returns the custom extruded shape mesh
  130743. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  130744. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130745. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130746. */
  130747. static ExtrudeShapeCustom(name: string, options: {
  130748. shape: Vector3[];
  130749. path: Vector3[];
  130750. scaleFunction?: any;
  130751. rotationFunction?: any;
  130752. ribbonCloseArray?: boolean;
  130753. ribbonClosePath?: boolean;
  130754. cap?: number;
  130755. updatable?: boolean;
  130756. sideOrientation?: number;
  130757. frontUVs?: Vector4;
  130758. backUVs?: Vector4;
  130759. instance?: Mesh;
  130760. invertUV?: boolean;
  130761. }, scene?: Nullable<Scene>): Mesh;
  130762. private static _ExtrudeShapeGeneric;
  130763. }
  130764. }
  130765. declare module BABYLON.Debug {
  130766. /**
  130767. * Class used to render a debug view of a given skeleton
  130768. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  130769. */
  130770. export class SkeletonViewer {
  130771. /** defines the skeleton to render */
  130772. skeleton: Skeleton;
  130773. /** defines the mesh attached to the skeleton */
  130774. mesh: AbstractMesh;
  130775. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130776. autoUpdateBonesMatrices: boolean;
  130777. /** defines the rendering group id to use with the viewer */
  130778. renderingGroupId: number;
  130779. /** is the options for the viewer */
  130780. options: Partial<ISkeletonViewerOptions>;
  130781. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  130782. static readonly DISPLAY_LINES: number;
  130783. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  130784. static readonly DISPLAY_SPHERES: number;
  130785. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  130786. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  130787. /** If SkeletonViewer scene scope. */
  130788. private _scene;
  130789. /** Gets or sets the color used to render the skeleton */
  130790. color: Color3;
  130791. /** Array of the points of the skeleton fo the line view. */
  130792. private _debugLines;
  130793. /** The SkeletonViewers Mesh. */
  130794. private _debugMesh;
  130795. /** If SkeletonViewer is enabled. */
  130796. private _isEnabled;
  130797. /** If SkeletonViewer is ready. */
  130798. private _ready;
  130799. /** SkeletonViewer render observable. */
  130800. private _obs;
  130801. /** The Utility Layer to render the gizmos in. */
  130802. private _utilityLayer;
  130803. private _boneIndices;
  130804. /** Gets the Scene. */
  130805. get scene(): Scene;
  130806. /** Gets the utilityLayer. */
  130807. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  130808. /** Checks Ready Status. */
  130809. get isReady(): Boolean;
  130810. /** Sets Ready Status. */
  130811. set ready(value: boolean);
  130812. /** Gets the debugMesh */
  130813. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  130814. /** Sets the debugMesh */
  130815. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  130816. /** Gets the material */
  130817. get material(): StandardMaterial;
  130818. /** Sets the material */
  130819. set material(value: StandardMaterial);
  130820. /** Gets the material */
  130821. get displayMode(): number;
  130822. /** Sets the material */
  130823. set displayMode(value: number);
  130824. /**
  130825. * Creates a new SkeletonViewer
  130826. * @param skeleton defines the skeleton to render
  130827. * @param mesh defines the mesh attached to the skeleton
  130828. * @param scene defines the hosting scene
  130829. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  130830. * @param renderingGroupId defines the rendering group id to use with the viewer
  130831. * @param options All of the extra constructor options for the SkeletonViewer
  130832. */
  130833. constructor(
  130834. /** defines the skeleton to render */
  130835. skeleton: Skeleton,
  130836. /** defines the mesh attached to the skeleton */
  130837. mesh: AbstractMesh,
  130838. /** The Scene scope*/
  130839. scene: Scene,
  130840. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130841. autoUpdateBonesMatrices?: boolean,
  130842. /** defines the rendering group id to use with the viewer */
  130843. renderingGroupId?: number,
  130844. /** is the options for the viewer */
  130845. options?: Partial<ISkeletonViewerOptions>);
  130846. /** The Dynamic bindings for the update functions */
  130847. private _bindObs;
  130848. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  130849. update(): void;
  130850. /** Gets or sets a boolean indicating if the viewer is enabled */
  130851. set isEnabled(value: boolean);
  130852. get isEnabled(): boolean;
  130853. private _getBonePosition;
  130854. private _getLinesForBonesWithLength;
  130855. private _getLinesForBonesNoLength;
  130856. /** function to revert the mesh and scene back to the initial state. */
  130857. private _revert;
  130858. /** function to build and bind sphere joint points and spur bone representations. */
  130859. private _buildSpheresAndSpurs;
  130860. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  130861. private _displayLinesUpdate;
  130862. /** Changes the displayMode of the skeleton viewer
  130863. * @param mode The displayMode numerical value
  130864. */
  130865. changeDisplayMode(mode: number): void;
  130866. /** Changes the displayMode of the skeleton viewer
  130867. * @param option String of the option name
  130868. * @param value The numerical option value
  130869. */
  130870. changeDisplayOptions(option: string, value: number): void;
  130871. /** Release associated resources */
  130872. dispose(): void;
  130873. }
  130874. }
  130875. declare module BABYLON {
  130876. /**
  130877. * Enum for Device Types
  130878. */
  130879. export enum DeviceType {
  130880. /** Generic */
  130881. Generic = 0,
  130882. /** Keyboard */
  130883. Keyboard = 1,
  130884. /** Mouse */
  130885. Mouse = 2,
  130886. /** Touch Pointers */
  130887. Touch = 3,
  130888. /** PS4 Dual Shock */
  130889. DualShock = 4,
  130890. /** Xbox */
  130891. Xbox = 5,
  130892. /** Switch Controller */
  130893. Switch = 6
  130894. }
  130895. /**
  130896. * Enum for All Pointers (Touch/Mouse)
  130897. */
  130898. export enum PointerInput {
  130899. /** Horizontal Axis */
  130900. Horizontal = 0,
  130901. /** Vertical Axis */
  130902. Vertical = 1,
  130903. /** Left Click or Touch */
  130904. LeftClick = 2,
  130905. /** Middle Click */
  130906. MiddleClick = 3,
  130907. /** Right Click */
  130908. RightClick = 4,
  130909. /** Browser Back */
  130910. BrowserBack = 5,
  130911. /** Browser Forward */
  130912. BrowserForward = 6
  130913. }
  130914. /**
  130915. * Enum for Dual Shock Gamepad
  130916. */
  130917. export enum DualShockInput {
  130918. /** Cross */
  130919. Cross = 0,
  130920. /** Circle */
  130921. Circle = 1,
  130922. /** Square */
  130923. Square = 2,
  130924. /** Triangle */
  130925. Triangle = 3,
  130926. /** L1 */
  130927. L1 = 4,
  130928. /** R1 */
  130929. R1 = 5,
  130930. /** L2 */
  130931. L2 = 6,
  130932. /** R2 */
  130933. R2 = 7,
  130934. /** Share */
  130935. Share = 8,
  130936. /** Options */
  130937. Options = 9,
  130938. /** L3 */
  130939. L3 = 10,
  130940. /** R3 */
  130941. R3 = 11,
  130942. /** DPadUp */
  130943. DPadUp = 12,
  130944. /** DPadDown */
  130945. DPadDown = 13,
  130946. /** DPadLeft */
  130947. DPadLeft = 14,
  130948. /** DRight */
  130949. DPadRight = 15,
  130950. /** Home */
  130951. Home = 16,
  130952. /** TouchPad */
  130953. TouchPad = 17,
  130954. /** LStickXAxis */
  130955. LStickXAxis = 18,
  130956. /** LStickYAxis */
  130957. LStickYAxis = 19,
  130958. /** RStickXAxis */
  130959. RStickXAxis = 20,
  130960. /** RStickYAxis */
  130961. RStickYAxis = 21
  130962. }
  130963. /**
  130964. * Enum for Xbox Gamepad
  130965. */
  130966. export enum XboxInput {
  130967. /** A */
  130968. A = 0,
  130969. /** B */
  130970. B = 1,
  130971. /** X */
  130972. X = 2,
  130973. /** Y */
  130974. Y = 3,
  130975. /** LB */
  130976. LB = 4,
  130977. /** RB */
  130978. RB = 5,
  130979. /** LT */
  130980. LT = 6,
  130981. /** RT */
  130982. RT = 7,
  130983. /** Back */
  130984. Back = 8,
  130985. /** Start */
  130986. Start = 9,
  130987. /** LS */
  130988. LS = 10,
  130989. /** RS */
  130990. RS = 11,
  130991. /** DPadUp */
  130992. DPadUp = 12,
  130993. /** DPadDown */
  130994. DPadDown = 13,
  130995. /** DPadLeft */
  130996. DPadLeft = 14,
  130997. /** DRight */
  130998. DPadRight = 15,
  130999. /** Home */
  131000. Home = 16,
  131001. /** LStickXAxis */
  131002. LStickXAxis = 17,
  131003. /** LStickYAxis */
  131004. LStickYAxis = 18,
  131005. /** RStickXAxis */
  131006. RStickXAxis = 19,
  131007. /** RStickYAxis */
  131008. RStickYAxis = 20
  131009. }
  131010. /**
  131011. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  131012. */
  131013. export enum SwitchInput {
  131014. /** B */
  131015. B = 0,
  131016. /** A */
  131017. A = 1,
  131018. /** Y */
  131019. Y = 2,
  131020. /** X */
  131021. X = 3,
  131022. /** L */
  131023. L = 4,
  131024. /** R */
  131025. R = 5,
  131026. /** ZL */
  131027. ZL = 6,
  131028. /** ZR */
  131029. ZR = 7,
  131030. /** Minus */
  131031. Minus = 8,
  131032. /** Plus */
  131033. Plus = 9,
  131034. /** LS */
  131035. LS = 10,
  131036. /** RS */
  131037. RS = 11,
  131038. /** DPadUp */
  131039. DPadUp = 12,
  131040. /** DPadDown */
  131041. DPadDown = 13,
  131042. /** DPadLeft */
  131043. DPadLeft = 14,
  131044. /** DRight */
  131045. DPadRight = 15,
  131046. /** Home */
  131047. Home = 16,
  131048. /** Capture */
  131049. Capture = 17,
  131050. /** LStickXAxis */
  131051. LStickXAxis = 18,
  131052. /** LStickYAxis */
  131053. LStickYAxis = 19,
  131054. /** RStickXAxis */
  131055. RStickXAxis = 20,
  131056. /** RStickYAxis */
  131057. RStickYAxis = 21
  131058. }
  131059. }
  131060. declare module BABYLON {
  131061. /**
  131062. * This class will take all inputs from Keyboard, Pointer, and
  131063. * any Gamepads and provide a polling system that all devices
  131064. * will use. This class assumes that there will only be one
  131065. * pointer device and one keyboard.
  131066. */
  131067. export class DeviceInputSystem implements IDisposable {
  131068. /**
  131069. * Callback to be triggered when a device is connected
  131070. */
  131071. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131072. /**
  131073. * Callback to be triggered when a device is disconnected
  131074. */
  131075. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131076. /**
  131077. * Callback to be triggered when event driven input is updated
  131078. */
  131079. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  131080. private _inputs;
  131081. private _gamepads;
  131082. private _keyboardActive;
  131083. private _pointerActive;
  131084. private _elementToAttachTo;
  131085. private _keyboardDownEvent;
  131086. private _keyboardUpEvent;
  131087. private _pointerMoveEvent;
  131088. private _pointerDownEvent;
  131089. private _pointerUpEvent;
  131090. private _gamepadConnectedEvent;
  131091. private _gamepadDisconnectedEvent;
  131092. private static _MAX_KEYCODES;
  131093. private static _MAX_POINTER_INPUTS;
  131094. private constructor();
  131095. /**
  131096. * Creates a new DeviceInputSystem instance
  131097. * @param engine Engine to pull input element from
  131098. * @returns The new instance
  131099. */
  131100. static Create(engine: Engine): DeviceInputSystem;
  131101. /**
  131102. * Checks for current device input value, given an id and input index
  131103. * @param deviceName Id of connected device
  131104. * @param inputIndex Index of device input
  131105. * @returns Current value of input
  131106. */
  131107. /**
  131108. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  131109. * @param deviceType Enum specifiying device type
  131110. * @param deviceSlot "Slot" or index that device is referenced in
  131111. * @param inputIndex Id of input to be checked
  131112. * @returns Current value of input
  131113. */
  131114. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  131115. /**
  131116. * Dispose of all the eventlisteners
  131117. */
  131118. dispose(): void;
  131119. /**
  131120. * Add device and inputs to device array
  131121. * @param deviceType Enum specifiying device type
  131122. * @param deviceSlot "Slot" or index that device is referenced in
  131123. * @param numberOfInputs Number of input entries to create for given device
  131124. */
  131125. private _registerDevice;
  131126. /**
  131127. * Given a specific device name, remove that device from the device map
  131128. * @param deviceType Enum specifiying device type
  131129. * @param deviceSlot "Slot" or index that device is referenced in
  131130. */
  131131. private _unregisterDevice;
  131132. /**
  131133. * Handle all actions that come from keyboard interaction
  131134. */
  131135. private _handleKeyActions;
  131136. /**
  131137. * Handle all actions that come from pointer interaction
  131138. */
  131139. private _handlePointerActions;
  131140. /**
  131141. * Handle all actions that come from gamepad interaction
  131142. */
  131143. private _handleGamepadActions;
  131144. /**
  131145. * Update all non-event based devices with each frame
  131146. * @param deviceType Enum specifiying device type
  131147. * @param deviceSlot "Slot" or index that device is referenced in
  131148. * @param inputIndex Id of input to be checked
  131149. */
  131150. private _updateDevice;
  131151. /**
  131152. * Gets DeviceType from the device name
  131153. * @param deviceName Name of Device from DeviceInputSystem
  131154. * @returns DeviceType enum value
  131155. */
  131156. private _getGamepadDeviceType;
  131157. }
  131158. }
  131159. declare module BABYLON {
  131160. /**
  131161. * Type to handle enforcement of inputs
  131162. */
  131163. 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;
  131164. }
  131165. declare module BABYLON {
  131166. /**
  131167. * Class that handles all input for a specific device
  131168. */
  131169. export class DeviceSource<T extends DeviceType> {
  131170. /** Type of device */
  131171. readonly deviceType: DeviceType;
  131172. /** "Slot" or index that device is referenced in */
  131173. readonly deviceSlot: number;
  131174. /**
  131175. * Observable to handle device input changes per device
  131176. */
  131177. readonly onInputChangedObservable: Observable<{
  131178. inputIndex: DeviceInput<T>;
  131179. previousState: Nullable<number>;
  131180. currentState: Nullable<number>;
  131181. }>;
  131182. private readonly _deviceInputSystem;
  131183. /**
  131184. * Default Constructor
  131185. * @param deviceInputSystem Reference to DeviceInputSystem
  131186. * @param deviceType Type of device
  131187. * @param deviceSlot "Slot" or index that device is referenced in
  131188. */
  131189. constructor(deviceInputSystem: DeviceInputSystem,
  131190. /** Type of device */
  131191. deviceType: DeviceType,
  131192. /** "Slot" or index that device is referenced in */
  131193. deviceSlot?: number);
  131194. /**
  131195. * Get input for specific input
  131196. * @param inputIndex index of specific input on device
  131197. * @returns Input value from DeviceInputSystem
  131198. */
  131199. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  131200. }
  131201. /**
  131202. * Class to keep track of devices
  131203. */
  131204. export class DeviceSourceManager implements IDisposable {
  131205. /**
  131206. * Observable to be triggered when before a device is connected
  131207. */
  131208. readonly onBeforeDeviceConnectedObservable: Observable<{
  131209. deviceType: DeviceType;
  131210. deviceSlot: number;
  131211. }>;
  131212. /**
  131213. * Observable to be triggered when before a device is disconnected
  131214. */
  131215. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  131216. deviceType: DeviceType;
  131217. deviceSlot: number;
  131218. }>;
  131219. /**
  131220. * Observable to be triggered when after a device is connected
  131221. */
  131222. readonly onAfterDeviceConnectedObservable: Observable<{
  131223. deviceType: DeviceType;
  131224. deviceSlot: number;
  131225. }>;
  131226. /**
  131227. * Observable to be triggered when after a device is disconnected
  131228. */
  131229. readonly onAfterDeviceDisconnectedObservable: Observable<{
  131230. deviceType: DeviceType;
  131231. deviceSlot: number;
  131232. }>;
  131233. private readonly _devices;
  131234. private readonly _firstDevice;
  131235. private readonly _deviceInputSystem;
  131236. /**
  131237. * Default Constructor
  131238. * @param engine engine to pull input element from
  131239. */
  131240. constructor(engine: Engine);
  131241. /**
  131242. * Gets a DeviceSource, given a type and slot
  131243. * @param deviceType Enum specifying device type
  131244. * @param deviceSlot "Slot" or index that device is referenced in
  131245. * @returns DeviceSource object
  131246. */
  131247. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  131248. /**
  131249. * Gets an array of DeviceSource objects for a given device type
  131250. * @param deviceType Enum specifying device type
  131251. * @returns Array of DeviceSource objects
  131252. */
  131253. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  131254. /**
  131255. * Dispose of DeviceInputSystem and other parts
  131256. */
  131257. dispose(): void;
  131258. /**
  131259. * Function to add device name to device list
  131260. * @param deviceType Enum specifying device type
  131261. * @param deviceSlot "Slot" or index that device is referenced in
  131262. */
  131263. private _addDevice;
  131264. /**
  131265. * Function to remove device name to device list
  131266. * @param deviceType Enum specifying device type
  131267. * @param deviceSlot "Slot" or index that device is referenced in
  131268. */
  131269. private _removeDevice;
  131270. /**
  131271. * Updates array storing first connected device of each type
  131272. * @param type Type of Device
  131273. */
  131274. private _updateFirstDevices;
  131275. }
  131276. }
  131277. declare module BABYLON {
  131278. /**
  131279. * Options to create the null engine
  131280. */
  131281. export class NullEngineOptions {
  131282. /**
  131283. * Render width (Default: 512)
  131284. */
  131285. renderWidth: number;
  131286. /**
  131287. * Render height (Default: 256)
  131288. */
  131289. renderHeight: number;
  131290. /**
  131291. * Texture size (Default: 512)
  131292. */
  131293. textureSize: number;
  131294. /**
  131295. * If delta time between frames should be constant
  131296. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131297. */
  131298. deterministicLockstep: boolean;
  131299. /**
  131300. * Maximum about of steps between frames (Default: 4)
  131301. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131302. */
  131303. lockstepMaxSteps: number;
  131304. /**
  131305. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  131306. */
  131307. useHighPrecisionMatrix?: boolean;
  131308. }
  131309. /**
  131310. * The null engine class provides support for headless version of babylon.js.
  131311. * This can be used in server side scenario or for testing purposes
  131312. */
  131313. export class NullEngine extends Engine {
  131314. private _options;
  131315. /**
  131316. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  131317. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131318. * @returns true if engine is in deterministic lock step mode
  131319. */
  131320. isDeterministicLockStep(): boolean;
  131321. /**
  131322. * Gets the max steps when engine is running in deterministic lock step
  131323. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131324. * @returns the max steps
  131325. */
  131326. getLockstepMaxSteps(): number;
  131327. /**
  131328. * Gets the current hardware scaling level.
  131329. * By default the hardware scaling level is computed from the window device ratio.
  131330. * 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.
  131331. * @returns a number indicating the current hardware scaling level
  131332. */
  131333. getHardwareScalingLevel(): number;
  131334. constructor(options?: NullEngineOptions);
  131335. /**
  131336. * Creates a vertex buffer
  131337. * @param vertices the data for the vertex buffer
  131338. * @returns the new WebGL static buffer
  131339. */
  131340. createVertexBuffer(vertices: FloatArray): DataBuffer;
  131341. /**
  131342. * Creates a new index buffer
  131343. * @param indices defines the content of the index buffer
  131344. * @param updatable defines if the index buffer must be updatable
  131345. * @returns a new webGL buffer
  131346. */
  131347. createIndexBuffer(indices: IndicesArray): DataBuffer;
  131348. /**
  131349. * Clear the current render buffer or the current render target (if any is set up)
  131350. * @param color defines the color to use
  131351. * @param backBuffer defines if the back buffer must be cleared
  131352. * @param depth defines if the depth buffer must be cleared
  131353. * @param stencil defines if the stencil buffer must be cleared
  131354. */
  131355. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131356. /**
  131357. * Gets the current render width
  131358. * @param useScreen defines if screen size must be used (or the current render target if any)
  131359. * @returns a number defining the current render width
  131360. */
  131361. getRenderWidth(useScreen?: boolean): number;
  131362. /**
  131363. * Gets the current render height
  131364. * @param useScreen defines if screen size must be used (or the current render target if any)
  131365. * @returns a number defining the current render height
  131366. */
  131367. getRenderHeight(useScreen?: boolean): number;
  131368. /**
  131369. * Set the WebGL's viewport
  131370. * @param viewport defines the viewport element to be used
  131371. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  131372. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  131373. */
  131374. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  131375. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  131376. /**
  131377. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  131378. * @param pipelineContext defines the pipeline context to use
  131379. * @param uniformsNames defines the list of uniform names
  131380. * @returns an array of webGL uniform locations
  131381. */
  131382. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  131383. /**
  131384. * Gets the lsit of active attributes for a given webGL program
  131385. * @param pipelineContext defines the pipeline context to use
  131386. * @param attributesNames defines the list of attribute names to get
  131387. * @returns an array of indices indicating the offset of each attribute
  131388. */
  131389. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131390. /**
  131391. * Binds an effect to the webGL context
  131392. * @param effect defines the effect to bind
  131393. */
  131394. bindSamplers(effect: Effect): void;
  131395. /**
  131396. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  131397. * @param effect defines the effect to activate
  131398. */
  131399. enableEffect(effect: Effect): void;
  131400. /**
  131401. * Set various states to the webGL context
  131402. * @param culling defines backface culling state
  131403. * @param zOffset defines the value to apply to zOffset (0 by default)
  131404. * @param force defines if states must be applied even if cache is up to date
  131405. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  131406. */
  131407. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131408. /**
  131409. * Set the value of an uniform to an array of int32
  131410. * @param uniform defines the webGL uniform location where to store the value
  131411. * @param array defines the array of int32 to store
  131412. */
  131413. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  131414. /**
  131415. * Set the value of an uniform to an array of int32 (stored as vec2)
  131416. * @param uniform defines the webGL uniform location where to store the value
  131417. * @param array defines the array of int32 to store
  131418. */
  131419. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  131420. /**
  131421. * Set the value of an uniform to an array of int32 (stored as vec3)
  131422. * @param uniform defines the webGL uniform location where to store the value
  131423. * @param array defines the array of int32 to store
  131424. */
  131425. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  131426. /**
  131427. * Set the value of an uniform to an array of int32 (stored as vec4)
  131428. * @param uniform defines the webGL uniform location where to store the value
  131429. * @param array defines the array of int32 to store
  131430. */
  131431. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  131432. /**
  131433. * Set the value of an uniform to an array of float32
  131434. * @param uniform defines the webGL uniform location where to store the value
  131435. * @param array defines the array of float32 to store
  131436. */
  131437. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  131438. /**
  131439. * Set the value of an uniform to an array of float32 (stored as vec2)
  131440. * @param uniform defines the webGL uniform location where to store the value
  131441. * @param array defines the array of float32 to store
  131442. */
  131443. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  131444. /**
  131445. * Set the value of an uniform to an array of float32 (stored as vec3)
  131446. * @param uniform defines the webGL uniform location where to store the value
  131447. * @param array defines the array of float32 to store
  131448. */
  131449. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  131450. /**
  131451. * Set the value of an uniform to an array of float32 (stored as vec4)
  131452. * @param uniform defines the webGL uniform location where to store the value
  131453. * @param array defines the array of float32 to store
  131454. */
  131455. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  131456. /**
  131457. * Set the value of an uniform to an array of number
  131458. * @param uniform defines the webGL uniform location where to store the value
  131459. * @param array defines the array of number to store
  131460. */
  131461. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  131462. /**
  131463. * Set the value of an uniform to an array of number (stored as vec2)
  131464. * @param uniform defines the webGL uniform location where to store the value
  131465. * @param array defines the array of number to store
  131466. */
  131467. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  131468. /**
  131469. * Set the value of an uniform to an array of number (stored as vec3)
  131470. * @param uniform defines the webGL uniform location where to store the value
  131471. * @param array defines the array of number to store
  131472. */
  131473. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  131474. /**
  131475. * Set the value of an uniform to an array of number (stored as vec4)
  131476. * @param uniform defines the webGL uniform location where to store the value
  131477. * @param array defines the array of number to store
  131478. */
  131479. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  131480. /**
  131481. * Set the value of an uniform to an array of float32 (stored as matrices)
  131482. * @param uniform defines the webGL uniform location where to store the value
  131483. * @param matrices defines the array of float32 to store
  131484. */
  131485. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  131486. /**
  131487. * Set the value of an uniform to a matrix (3x3)
  131488. * @param uniform defines the webGL uniform location where to store the value
  131489. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  131490. */
  131491. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131492. /**
  131493. * Set the value of an uniform to a matrix (2x2)
  131494. * @param uniform defines the webGL uniform location where to store the value
  131495. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  131496. */
  131497. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131498. /**
  131499. * Set the value of an uniform to a number (float)
  131500. * @param uniform defines the webGL uniform location where to store the value
  131501. * @param value defines the float number to store
  131502. */
  131503. setFloat(uniform: WebGLUniformLocation, value: number): void;
  131504. /**
  131505. * Set the value of an uniform to a vec2
  131506. * @param uniform defines the webGL uniform location where to store the value
  131507. * @param x defines the 1st component of the value
  131508. * @param y defines the 2nd component of the value
  131509. */
  131510. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  131511. /**
  131512. * Set the value of an uniform to a vec3
  131513. * @param uniform defines the webGL uniform location where to store the value
  131514. * @param x defines the 1st component of the value
  131515. * @param y defines the 2nd component of the value
  131516. * @param z defines the 3rd component of the value
  131517. */
  131518. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131519. /**
  131520. * Set the value of an uniform to a boolean
  131521. * @param uniform defines the webGL uniform location where to store the value
  131522. * @param bool defines the boolean to store
  131523. */
  131524. setBool(uniform: WebGLUniformLocation, bool: number): void;
  131525. /**
  131526. * Set the value of an uniform to a vec4
  131527. * @param uniform defines the webGL uniform location where to store the value
  131528. * @param x defines the 1st component of the value
  131529. * @param y defines the 2nd component of the value
  131530. * @param z defines the 3rd component of the value
  131531. * @param w defines the 4th component of the value
  131532. */
  131533. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131534. /**
  131535. * Sets the current alpha mode
  131536. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  131537. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  131538. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  131539. */
  131540. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  131541. /**
  131542. * Bind webGl buffers directly to the webGL context
  131543. * @param vertexBuffers defines the vertex buffer to bind
  131544. * @param indexBuffer defines the index buffer to bind
  131545. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  131546. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  131547. * @param effect defines the effect associated with the vertex buffer
  131548. */
  131549. bindBuffers(vertexBuffers: {
  131550. [key: string]: VertexBuffer;
  131551. }, indexBuffer: DataBuffer, effect: Effect): void;
  131552. /**
  131553. * Force the entire cache to be cleared
  131554. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  131555. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  131556. */
  131557. wipeCaches(bruteForce?: boolean): void;
  131558. /**
  131559. * Send a draw order
  131560. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  131561. * @param indexStart defines the starting index
  131562. * @param indexCount defines the number of index to draw
  131563. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131564. */
  131565. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  131566. /**
  131567. * Draw a list of indexed primitives
  131568. * @param fillMode defines the primitive to use
  131569. * @param indexStart defines the starting index
  131570. * @param indexCount defines the number of index to draw
  131571. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131572. */
  131573. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131574. /**
  131575. * Draw a list of unindexed primitives
  131576. * @param fillMode defines the primitive to use
  131577. * @param verticesStart defines the index of first vertex to draw
  131578. * @param verticesCount defines the count of vertices to draw
  131579. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131580. */
  131581. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131582. /** @hidden */
  131583. _createTexture(): WebGLTexture;
  131584. /** @hidden */
  131585. _releaseTexture(texture: InternalTexture): void;
  131586. /**
  131587. * Usually called from Texture.ts.
  131588. * Passed information to create a WebGLTexture
  131589. * @param urlArg defines a value which contains one of the following:
  131590. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131591. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131592. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131593. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131594. * @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)
  131595. * @param scene needed for loading to the correct scene
  131596. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131597. * @param onLoad optional callback to be called upon successful completion
  131598. * @param onError optional callback to be called upon failure
  131599. * @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
  131600. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131601. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131602. * @param forcedExtension defines the extension to use to pick the right loader
  131603. * @param mimeType defines an optional mime type
  131604. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131605. */
  131606. 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;
  131607. /**
  131608. * Creates a new render target texture
  131609. * @param size defines the size of the texture
  131610. * @param options defines the options used to create the texture
  131611. * @returns a new render target texture stored in an InternalTexture
  131612. */
  131613. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  131614. /**
  131615. * Update the sampling mode of a given texture
  131616. * @param samplingMode defines the required sampling mode
  131617. * @param texture defines the texture to update
  131618. */
  131619. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131620. /**
  131621. * Binds the frame buffer to the specified texture.
  131622. * @param texture The texture to render to or null for the default canvas
  131623. * @param faceIndex The face of the texture to render to in case of cube texture
  131624. * @param requiredWidth The width of the target to render to
  131625. * @param requiredHeight The height of the target to render to
  131626. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  131627. * @param lodLevel defines le lod level to bind to the frame buffer
  131628. */
  131629. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131630. /**
  131631. * Unbind the current render target texture from the webGL context
  131632. * @param texture defines the render target texture to unbind
  131633. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  131634. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  131635. */
  131636. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131637. /**
  131638. * Creates a dynamic vertex buffer
  131639. * @param vertices the data for the dynamic vertex buffer
  131640. * @returns the new WebGL dynamic buffer
  131641. */
  131642. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  131643. /**
  131644. * Update the content of a dynamic texture
  131645. * @param texture defines the texture to update
  131646. * @param canvas defines the canvas containing the source
  131647. * @param invertY defines if data must be stored with Y axis inverted
  131648. * @param premulAlpha defines if alpha is stored as premultiplied
  131649. * @param format defines the format of the data
  131650. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  131651. */
  131652. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  131653. /**
  131654. * Gets a boolean indicating if all created effects are ready
  131655. * @returns true if all effects are ready
  131656. */
  131657. areAllEffectsReady(): boolean;
  131658. /**
  131659. * @hidden
  131660. * Get the current error code of the webGL context
  131661. * @returns the error code
  131662. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  131663. */
  131664. getError(): number;
  131665. /** @hidden */
  131666. _getUnpackAlignement(): number;
  131667. /** @hidden */
  131668. _unpackFlipY(value: boolean): void;
  131669. /**
  131670. * Update a dynamic index buffer
  131671. * @param indexBuffer defines the target index buffer
  131672. * @param indices defines the data to update
  131673. * @param offset defines the offset in the target index buffer where update should start
  131674. */
  131675. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  131676. /**
  131677. * Updates a dynamic vertex buffer.
  131678. * @param vertexBuffer the vertex buffer to update
  131679. * @param vertices the data used to update the vertex buffer
  131680. * @param byteOffset the byte offset of the data (optional)
  131681. * @param byteLength the byte length of the data (optional)
  131682. */
  131683. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  131684. /** @hidden */
  131685. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  131686. /** @hidden */
  131687. _bindTexture(channel: number, texture: InternalTexture): void;
  131688. protected _deleteBuffer(buffer: WebGLBuffer): void;
  131689. /**
  131690. * 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
  131691. */
  131692. releaseEffects(): void;
  131693. displayLoadingUI(): void;
  131694. hideLoadingUI(): void;
  131695. /** @hidden */
  131696. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131697. /** @hidden */
  131698. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131699. /** @hidden */
  131700. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131701. /** @hidden */
  131702. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131703. }
  131704. }
  131705. declare module BABYLON {
  131706. /**
  131707. * @hidden
  131708. **/
  131709. export class _TimeToken {
  131710. _startTimeQuery: Nullable<WebGLQuery>;
  131711. _endTimeQuery: Nullable<WebGLQuery>;
  131712. _timeElapsedQuery: Nullable<WebGLQuery>;
  131713. _timeElapsedQueryEnded: boolean;
  131714. }
  131715. }
  131716. declare module BABYLON {
  131717. /** @hidden */
  131718. export class _OcclusionDataStorage {
  131719. /** @hidden */
  131720. occlusionInternalRetryCounter: number;
  131721. /** @hidden */
  131722. isOcclusionQueryInProgress: boolean;
  131723. /** @hidden */
  131724. isOccluded: boolean;
  131725. /** @hidden */
  131726. occlusionRetryCount: number;
  131727. /** @hidden */
  131728. occlusionType: number;
  131729. /** @hidden */
  131730. occlusionQueryAlgorithmType: number;
  131731. }
  131732. interface Engine {
  131733. /**
  131734. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  131735. * @return the new query
  131736. */
  131737. createQuery(): WebGLQuery;
  131738. /**
  131739. * Delete and release a webGL query
  131740. * @param query defines the query to delete
  131741. * @return the current engine
  131742. */
  131743. deleteQuery(query: WebGLQuery): Engine;
  131744. /**
  131745. * Check if a given query has resolved and got its value
  131746. * @param query defines the query to check
  131747. * @returns true if the query got its value
  131748. */
  131749. isQueryResultAvailable(query: WebGLQuery): boolean;
  131750. /**
  131751. * Gets the value of a given query
  131752. * @param query defines the query to check
  131753. * @returns the value of the query
  131754. */
  131755. getQueryResult(query: WebGLQuery): number;
  131756. /**
  131757. * Initiates an occlusion query
  131758. * @param algorithmType defines the algorithm to use
  131759. * @param query defines the query to use
  131760. * @returns the current engine
  131761. * @see https://doc.babylonjs.com/features/occlusionquery
  131762. */
  131763. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  131764. /**
  131765. * Ends an occlusion query
  131766. * @see https://doc.babylonjs.com/features/occlusionquery
  131767. * @param algorithmType defines the algorithm to use
  131768. * @returns the current engine
  131769. */
  131770. endOcclusionQuery(algorithmType: number): Engine;
  131771. /**
  131772. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  131773. * Please note that only one query can be issued at a time
  131774. * @returns a time token used to track the time span
  131775. */
  131776. startTimeQuery(): Nullable<_TimeToken>;
  131777. /**
  131778. * Ends a time query
  131779. * @param token defines the token used to measure the time span
  131780. * @returns the time spent (in ns)
  131781. */
  131782. endTimeQuery(token: _TimeToken): int;
  131783. /** @hidden */
  131784. _currentNonTimestampToken: Nullable<_TimeToken>;
  131785. /** @hidden */
  131786. _createTimeQuery(): WebGLQuery;
  131787. /** @hidden */
  131788. _deleteTimeQuery(query: WebGLQuery): void;
  131789. /** @hidden */
  131790. _getGlAlgorithmType(algorithmType: number): number;
  131791. /** @hidden */
  131792. _getTimeQueryResult(query: WebGLQuery): any;
  131793. /** @hidden */
  131794. _getTimeQueryAvailability(query: WebGLQuery): any;
  131795. }
  131796. interface AbstractMesh {
  131797. /**
  131798. * Backing filed
  131799. * @hidden
  131800. */
  131801. __occlusionDataStorage: _OcclusionDataStorage;
  131802. /**
  131803. * Access property
  131804. * @hidden
  131805. */
  131806. _occlusionDataStorage: _OcclusionDataStorage;
  131807. /**
  131808. * 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.
  131809. * The default value is -1 which means don't break the query and wait till the result
  131810. * @see https://doc.babylonjs.com/features/occlusionquery
  131811. */
  131812. occlusionRetryCount: number;
  131813. /**
  131814. * 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:
  131815. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  131816. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  131817. * * 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.
  131818. * @see https://doc.babylonjs.com/features/occlusionquery
  131819. */
  131820. occlusionType: number;
  131821. /**
  131822. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  131823. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  131824. * * 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.
  131825. * @see https://doc.babylonjs.com/features/occlusionquery
  131826. */
  131827. occlusionQueryAlgorithmType: number;
  131828. /**
  131829. * 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
  131830. * @see https://doc.babylonjs.com/features/occlusionquery
  131831. */
  131832. isOccluded: boolean;
  131833. /**
  131834. * Flag to check the progress status of the query
  131835. * @see https://doc.babylonjs.com/features/occlusionquery
  131836. */
  131837. isOcclusionQueryInProgress: boolean;
  131838. }
  131839. }
  131840. declare module BABYLON {
  131841. /** @hidden */
  131842. export var _forceTransformFeedbackToBundle: boolean;
  131843. interface Engine {
  131844. /**
  131845. * Creates a webGL transform feedback object
  131846. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  131847. * @returns the webGL transform feedback object
  131848. */
  131849. createTransformFeedback(): WebGLTransformFeedback;
  131850. /**
  131851. * Delete a webGL transform feedback object
  131852. * @param value defines the webGL transform feedback object to delete
  131853. */
  131854. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  131855. /**
  131856. * Bind a webGL transform feedback object to the webgl context
  131857. * @param value defines the webGL transform feedback object to bind
  131858. */
  131859. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  131860. /**
  131861. * Begins a transform feedback operation
  131862. * @param usePoints defines if points or triangles must be used
  131863. */
  131864. beginTransformFeedback(usePoints: boolean): void;
  131865. /**
  131866. * Ends a transform feedback operation
  131867. */
  131868. endTransformFeedback(): void;
  131869. /**
  131870. * Specify the varyings to use with transform feedback
  131871. * @param program defines the associated webGL program
  131872. * @param value defines the list of strings representing the varying names
  131873. */
  131874. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  131875. /**
  131876. * Bind a webGL buffer for a transform feedback operation
  131877. * @param value defines the webGL buffer to bind
  131878. */
  131879. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  131880. }
  131881. }
  131882. declare module BABYLON {
  131883. /**
  131884. * Class used to define an additional view for the engine
  131885. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131886. */
  131887. export class EngineView {
  131888. /** Defines the canvas where to render the view */
  131889. target: HTMLCanvasElement;
  131890. /** Defines an optional camera used to render the view (will use active camera else) */
  131891. camera?: Camera;
  131892. }
  131893. interface Engine {
  131894. /**
  131895. * Gets or sets the HTML element to use for attaching events
  131896. */
  131897. inputElement: Nullable<HTMLElement>;
  131898. /**
  131899. * Gets the current engine view
  131900. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131901. */
  131902. activeView: Nullable<EngineView>;
  131903. /** Gets or sets the list of views */
  131904. views: EngineView[];
  131905. /**
  131906. * Register a new child canvas
  131907. * @param canvas defines the canvas to register
  131908. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  131909. * @returns the associated view
  131910. */
  131911. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  131912. /**
  131913. * Remove a registered child canvas
  131914. * @param canvas defines the canvas to remove
  131915. * @returns the current engine
  131916. */
  131917. unRegisterView(canvas: HTMLCanvasElement): Engine;
  131918. }
  131919. }
  131920. declare module BABYLON {
  131921. interface Engine {
  131922. /** @hidden */
  131923. _excludedCompressedTextures: string[];
  131924. /** @hidden */
  131925. _textureFormatInUse: string;
  131926. /**
  131927. * Gets the list of texture formats supported
  131928. */
  131929. readonly texturesSupported: Array<string>;
  131930. /**
  131931. * Gets the texture format in use
  131932. */
  131933. readonly textureFormatInUse: Nullable<string>;
  131934. /**
  131935. * Set the compressed texture extensions or file names to skip.
  131936. *
  131937. * @param skippedFiles defines the list of those texture files you want to skip
  131938. * Example: [".dds", ".env", "myfile.png"]
  131939. */
  131940. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  131941. /**
  131942. * Set the compressed texture format to use, based on the formats you have, and the formats
  131943. * supported by the hardware / browser.
  131944. *
  131945. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  131946. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  131947. * to API arguments needed to compressed textures. This puts the burden on the container
  131948. * generator to house the arcane code for determining these for current & future formats.
  131949. *
  131950. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  131951. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  131952. *
  131953. * Note: The result of this call is not taken into account when a texture is base64.
  131954. *
  131955. * @param formatsAvailable defines the list of those format families you have created
  131956. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  131957. *
  131958. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  131959. * @returns The extension selected.
  131960. */
  131961. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  131962. }
  131963. }
  131964. declare module BABYLON {
  131965. /**
  131966. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  131967. */
  131968. export interface CubeMapInfo {
  131969. /**
  131970. * The pixel array for the front face.
  131971. * This is stored in format, left to right, up to down format.
  131972. */
  131973. front: Nullable<ArrayBufferView>;
  131974. /**
  131975. * The pixel array for the back face.
  131976. * This is stored in format, left to right, up to down format.
  131977. */
  131978. back: Nullable<ArrayBufferView>;
  131979. /**
  131980. * The pixel array for the left face.
  131981. * This is stored in format, left to right, up to down format.
  131982. */
  131983. left: Nullable<ArrayBufferView>;
  131984. /**
  131985. * The pixel array for the right face.
  131986. * This is stored in format, left to right, up to down format.
  131987. */
  131988. right: Nullable<ArrayBufferView>;
  131989. /**
  131990. * The pixel array for the up face.
  131991. * This is stored in format, left to right, up to down format.
  131992. */
  131993. up: Nullable<ArrayBufferView>;
  131994. /**
  131995. * The pixel array for the down face.
  131996. * This is stored in format, left to right, up to down format.
  131997. */
  131998. down: Nullable<ArrayBufferView>;
  131999. /**
  132000. * The size of the cubemap stored.
  132001. *
  132002. * Each faces will be size * size pixels.
  132003. */
  132004. size: number;
  132005. /**
  132006. * The format of the texture.
  132007. *
  132008. * RGBA, RGB.
  132009. */
  132010. format: number;
  132011. /**
  132012. * The type of the texture data.
  132013. *
  132014. * UNSIGNED_INT, FLOAT.
  132015. */
  132016. type: number;
  132017. /**
  132018. * Specifies whether the texture is in gamma space.
  132019. */
  132020. gammaSpace: boolean;
  132021. }
  132022. /**
  132023. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  132024. */
  132025. export class PanoramaToCubeMapTools {
  132026. private static FACE_LEFT;
  132027. private static FACE_RIGHT;
  132028. private static FACE_FRONT;
  132029. private static FACE_BACK;
  132030. private static FACE_DOWN;
  132031. private static FACE_UP;
  132032. /**
  132033. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  132034. *
  132035. * @param float32Array The source data.
  132036. * @param inputWidth The width of the input panorama.
  132037. * @param inputHeight The height of the input panorama.
  132038. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  132039. * @return The cubemap data
  132040. */
  132041. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  132042. private static CreateCubemapTexture;
  132043. private static CalcProjectionSpherical;
  132044. }
  132045. }
  132046. declare module BABYLON {
  132047. /**
  132048. * Helper class dealing with the extraction of spherical polynomial dataArray
  132049. * from a cube map.
  132050. */
  132051. export class CubeMapToSphericalPolynomialTools {
  132052. private static FileFaces;
  132053. /**
  132054. * Converts a texture to the according Spherical Polynomial data.
  132055. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132056. *
  132057. * @param texture The texture to extract the information from.
  132058. * @return The Spherical Polynomial data.
  132059. */
  132060. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  132061. /**
  132062. * Converts a cubemap to the according Spherical Polynomial data.
  132063. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132064. *
  132065. * @param cubeInfo The Cube map to extract the information from.
  132066. * @return The Spherical Polynomial data.
  132067. */
  132068. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  132069. }
  132070. }
  132071. declare module BABYLON {
  132072. interface BaseTexture {
  132073. /**
  132074. * Get the polynomial representation of the texture data.
  132075. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  132076. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  132077. */
  132078. sphericalPolynomial: Nullable<SphericalPolynomial>;
  132079. }
  132080. }
  132081. declare module BABYLON {
  132082. /** @hidden */
  132083. export var rgbdEncodePixelShader: {
  132084. name: string;
  132085. shader: string;
  132086. };
  132087. }
  132088. declare module BABYLON {
  132089. /** @hidden */
  132090. export var rgbdDecodePixelShader: {
  132091. name: string;
  132092. shader: string;
  132093. };
  132094. }
  132095. declare module BABYLON {
  132096. /**
  132097. * Raw texture data and descriptor sufficient for WebGL texture upload
  132098. */
  132099. export interface EnvironmentTextureInfo {
  132100. /**
  132101. * Version of the environment map
  132102. */
  132103. version: number;
  132104. /**
  132105. * Width of image
  132106. */
  132107. width: number;
  132108. /**
  132109. * Irradiance information stored in the file.
  132110. */
  132111. irradiance: any;
  132112. /**
  132113. * Specular information stored in the file.
  132114. */
  132115. specular: any;
  132116. }
  132117. /**
  132118. * Defines One Image in the file. It requires only the position in the file
  132119. * as well as the length.
  132120. */
  132121. interface BufferImageData {
  132122. /**
  132123. * Length of the image data.
  132124. */
  132125. length: number;
  132126. /**
  132127. * Position of the data from the null terminator delimiting the end of the JSON.
  132128. */
  132129. position: number;
  132130. }
  132131. /**
  132132. * Defines the specular data enclosed in the file.
  132133. * This corresponds to the version 1 of the data.
  132134. */
  132135. export interface EnvironmentTextureSpecularInfoV1 {
  132136. /**
  132137. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  132138. */
  132139. specularDataPosition?: number;
  132140. /**
  132141. * This contains all the images data needed to reconstruct the cubemap.
  132142. */
  132143. mipmaps: Array<BufferImageData>;
  132144. /**
  132145. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  132146. */
  132147. lodGenerationScale: number;
  132148. }
  132149. /**
  132150. * Sets of helpers addressing the serialization and deserialization of environment texture
  132151. * stored in a BabylonJS env file.
  132152. * Those files are usually stored as .env files.
  132153. */
  132154. export class EnvironmentTextureTools {
  132155. /**
  132156. * Magic number identifying the env file.
  132157. */
  132158. private static _MagicBytes;
  132159. /**
  132160. * Gets the environment info from an env file.
  132161. * @param data The array buffer containing the .env bytes.
  132162. * @returns the environment file info (the json header) if successfully parsed.
  132163. */
  132164. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  132165. /**
  132166. * Creates an environment texture from a loaded cube texture.
  132167. * @param texture defines the cube texture to convert in env file
  132168. * @return a promise containing the environment data if succesfull.
  132169. */
  132170. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  132171. /**
  132172. * Creates a JSON representation of the spherical data.
  132173. * @param texture defines the texture containing the polynomials
  132174. * @return the JSON representation of the spherical info
  132175. */
  132176. private static _CreateEnvTextureIrradiance;
  132177. /**
  132178. * Creates the ArrayBufferViews used for initializing environment texture image data.
  132179. * @param data the image data
  132180. * @param info parameters that determine what views will be created for accessing the underlying buffer
  132181. * @return the views described by info providing access to the underlying buffer
  132182. */
  132183. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  132184. /**
  132185. * Uploads the texture info contained in the env file to the GPU.
  132186. * @param texture defines the internal texture to upload to
  132187. * @param data defines the data to load
  132188. * @param info defines the texture info retrieved through the GetEnvInfo method
  132189. * @returns a promise
  132190. */
  132191. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  132192. private static _OnImageReadyAsync;
  132193. /**
  132194. * Uploads the levels of image data to the GPU.
  132195. * @param texture defines the internal texture to upload to
  132196. * @param imageData defines the array buffer views of image data [mipmap][face]
  132197. * @returns a promise
  132198. */
  132199. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  132200. /**
  132201. * Uploads spherical polynomials information to the texture.
  132202. * @param texture defines the texture we are trying to upload the information to
  132203. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  132204. */
  132205. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  132206. /** @hidden */
  132207. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  132208. }
  132209. }
  132210. declare module BABYLON {
  132211. /**
  132212. * Class used to inline functions in shader code
  132213. */
  132214. export class ShaderCodeInliner {
  132215. private static readonly _RegexpFindFunctionNameAndType;
  132216. private _sourceCode;
  132217. private _functionDescr;
  132218. private _numMaxIterations;
  132219. /** Gets or sets the token used to mark the functions to inline */
  132220. inlineToken: string;
  132221. /** Gets or sets the debug mode */
  132222. debug: boolean;
  132223. /** Gets the code after the inlining process */
  132224. get code(): string;
  132225. /**
  132226. * Initializes the inliner
  132227. * @param sourceCode shader code source to inline
  132228. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  132229. */
  132230. constructor(sourceCode: string, numMaxIterations?: number);
  132231. /**
  132232. * Start the processing of the shader code
  132233. */
  132234. processCode(): void;
  132235. private _collectFunctions;
  132236. private _processInlining;
  132237. private _extractBetweenMarkers;
  132238. private _skipWhitespaces;
  132239. private _removeComments;
  132240. private _replaceFunctionCallsByCode;
  132241. private _findBackward;
  132242. private _escapeRegExp;
  132243. private _replaceNames;
  132244. }
  132245. }
  132246. declare module BABYLON {
  132247. /**
  132248. * Container for accessors for natively-stored mesh data buffers.
  132249. */
  132250. class NativeDataBuffer extends DataBuffer {
  132251. /**
  132252. * Accessor value used to identify/retrieve a natively-stored index buffer.
  132253. */
  132254. nativeIndexBuffer?: any;
  132255. /**
  132256. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  132257. */
  132258. nativeVertexBuffer?: any;
  132259. }
  132260. /** @hidden */
  132261. class NativeTexture extends InternalTexture {
  132262. getInternalTexture(): InternalTexture;
  132263. getViewCount(): number;
  132264. }
  132265. /** @hidden */
  132266. export class NativeEngine extends Engine {
  132267. private readonly _native;
  132268. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  132269. private readonly INVALID_HANDLE;
  132270. private _boundBuffersVertexArray;
  132271. getHardwareScalingLevel(): number;
  132272. constructor();
  132273. dispose(): void;
  132274. /**
  132275. * Can be used to override the current requestAnimationFrame requester.
  132276. * @hidden
  132277. */
  132278. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  132279. /**
  132280. * Override default engine behavior.
  132281. * @param color
  132282. * @param backBuffer
  132283. * @param depth
  132284. * @param stencil
  132285. */
  132286. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  132287. /**
  132288. * Gets host document
  132289. * @returns the host document object
  132290. */
  132291. getHostDocument(): Nullable<Document>;
  132292. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  132293. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  132294. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  132295. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  132296. [key: string]: VertexBuffer;
  132297. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132298. bindBuffers(vertexBuffers: {
  132299. [key: string]: VertexBuffer;
  132300. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132301. recordVertexArrayObject(vertexBuffers: {
  132302. [key: string]: VertexBuffer;
  132303. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  132304. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132305. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132306. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132307. /**
  132308. * Draw a list of indexed primitives
  132309. * @param fillMode defines the primitive to use
  132310. * @param indexStart defines the starting index
  132311. * @param indexCount defines the number of index to draw
  132312. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132313. */
  132314. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132315. /**
  132316. * Draw a list of unindexed primitives
  132317. * @param fillMode defines the primitive to use
  132318. * @param verticesStart defines the index of first vertex to draw
  132319. * @param verticesCount defines the count of vertices to draw
  132320. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132321. */
  132322. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132323. createPipelineContext(): IPipelineContext;
  132324. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  132325. /** @hidden */
  132326. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  132327. /** @hidden */
  132328. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  132329. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132330. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132331. protected _setProgram(program: WebGLProgram): void;
  132332. _releaseEffect(effect: Effect): void;
  132333. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  132334. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  132335. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  132336. bindSamplers(effect: Effect): void;
  132337. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  132338. getRenderWidth(useScreen?: boolean): number;
  132339. getRenderHeight(useScreen?: boolean): number;
  132340. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  132341. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132342. /**
  132343. * Set the z offset to apply to current rendering
  132344. * @param value defines the offset to apply
  132345. */
  132346. setZOffset(value: number): void;
  132347. /**
  132348. * Gets the current value of the zOffset
  132349. * @returns the current zOffset state
  132350. */
  132351. getZOffset(): number;
  132352. /**
  132353. * Enable or disable depth buffering
  132354. * @param enable defines the state to set
  132355. */
  132356. setDepthBuffer(enable: boolean): void;
  132357. /**
  132358. * Gets a boolean indicating if depth writing is enabled
  132359. * @returns the current depth writing state
  132360. */
  132361. getDepthWrite(): boolean;
  132362. /**
  132363. * Enable or disable depth writing
  132364. * @param enable defines the state to set
  132365. */
  132366. setDepthWrite(enable: boolean): void;
  132367. /**
  132368. * Enable or disable color writing
  132369. * @param enable defines the state to set
  132370. */
  132371. setColorWrite(enable: boolean): void;
  132372. /**
  132373. * Gets a boolean indicating if color writing is enabled
  132374. * @returns the current color writing state
  132375. */
  132376. getColorWrite(): boolean;
  132377. /**
  132378. * Sets alpha constants used by some alpha blending modes
  132379. * @param r defines the red component
  132380. * @param g defines the green component
  132381. * @param b defines the blue component
  132382. * @param a defines the alpha component
  132383. */
  132384. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  132385. /**
  132386. * Sets the current alpha mode
  132387. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  132388. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132389. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132390. */
  132391. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132392. /**
  132393. * Gets the current alpha mode
  132394. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132395. * @returns the current alpha mode
  132396. */
  132397. getAlphaMode(): number;
  132398. setInt(uniform: WebGLUniformLocation, int: number): void;
  132399. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  132400. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  132401. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  132402. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  132403. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  132404. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  132405. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  132406. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  132407. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  132408. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  132409. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  132410. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  132411. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  132412. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132413. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132414. setFloat(uniform: WebGLUniformLocation, value: number): void;
  132415. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  132416. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  132417. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  132418. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  132419. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  132420. wipeCaches(bruteForce?: boolean): void;
  132421. _createTexture(): WebGLTexture;
  132422. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  132423. /**
  132424. * Usually called from Texture.ts.
  132425. * Passed information to create a WebGLTexture
  132426. * @param url defines a value which contains one of the following:
  132427. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132428. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132429. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132430. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132431. * @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)
  132432. * @param scene needed for loading to the correct scene
  132433. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132434. * @param onLoad optional callback to be called upon successful completion
  132435. * @param onError optional callback to be called upon failure
  132436. * @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
  132437. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132438. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132439. * @param forcedExtension defines the extension to use to pick the right loader
  132440. * @param mimeType defines an optional mime type
  132441. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132442. */
  132443. 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;
  132444. /**
  132445. * Creates a cube texture
  132446. * @param rootUrl defines the url where the files to load is located
  132447. * @param scene defines the current scene
  132448. * @param files defines the list of files to load (1 per face)
  132449. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  132450. * @param onLoad defines an optional callback raised when the texture is loaded
  132451. * @param onError defines an optional callback raised if there is an issue to load the texture
  132452. * @param format defines the format of the data
  132453. * @param forcedExtension defines the extension to use to pick the right loader
  132454. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  132455. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  132456. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  132457. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  132458. * @returns the cube texture as an InternalTexture
  132459. */
  132460. 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;
  132461. private _getSamplingFilter;
  132462. private static _GetNativeTextureFormat;
  132463. createRenderTargetTexture(size: number | {
  132464. width: number;
  132465. height: number;
  132466. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  132467. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132468. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132469. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132470. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  132471. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  132472. /**
  132473. * Updates a dynamic vertex buffer.
  132474. * @param vertexBuffer the vertex buffer to update
  132475. * @param data the data used to update the vertex buffer
  132476. * @param byteOffset the byte offset of the data (optional)
  132477. * @param byteLength the byte length of the data (optional)
  132478. */
  132479. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  132480. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  132481. private _updateAnisotropicLevel;
  132482. private _getAddressMode;
  132483. /** @hidden */
  132484. _bindTexture(channel: number, texture: InternalTexture): void;
  132485. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  132486. releaseEffects(): void;
  132487. /** @hidden */
  132488. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132489. /** @hidden */
  132490. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132491. /** @hidden */
  132492. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132493. /** @hidden */
  132494. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132495. }
  132496. }
  132497. declare module BABYLON {
  132498. /**
  132499. * Gather the list of clipboard event types as constants.
  132500. */
  132501. export class ClipboardEventTypes {
  132502. /**
  132503. * The clipboard event is fired when a copy command is active (pressed).
  132504. */
  132505. static readonly COPY: number;
  132506. /**
  132507. * The clipboard event is fired when a cut command is active (pressed).
  132508. */
  132509. static readonly CUT: number;
  132510. /**
  132511. * The clipboard event is fired when a paste command is active (pressed).
  132512. */
  132513. static readonly PASTE: number;
  132514. }
  132515. /**
  132516. * This class is used to store clipboard related info for the onClipboardObservable event.
  132517. */
  132518. export class ClipboardInfo {
  132519. /**
  132520. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132521. */
  132522. type: number;
  132523. /**
  132524. * Defines the related dom event
  132525. */
  132526. event: ClipboardEvent;
  132527. /**
  132528. *Creates an instance of ClipboardInfo.
  132529. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  132530. * @param event Defines the related dom event
  132531. */
  132532. constructor(
  132533. /**
  132534. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132535. */
  132536. type: number,
  132537. /**
  132538. * Defines the related dom event
  132539. */
  132540. event: ClipboardEvent);
  132541. /**
  132542. * Get the clipboard event's type from the keycode.
  132543. * @param keyCode Defines the keyCode for the current keyboard event.
  132544. * @return {number}
  132545. */
  132546. static GetTypeFromCharacter(keyCode: number): number;
  132547. }
  132548. }
  132549. declare module BABYLON {
  132550. /**
  132551. * Google Daydream controller
  132552. */
  132553. export class DaydreamController extends WebVRController {
  132554. /**
  132555. * Base Url for the controller model.
  132556. */
  132557. static MODEL_BASE_URL: string;
  132558. /**
  132559. * File name for the controller model.
  132560. */
  132561. static MODEL_FILENAME: string;
  132562. /**
  132563. * Gamepad Id prefix used to identify Daydream Controller.
  132564. */
  132565. static readonly GAMEPAD_ID_PREFIX: string;
  132566. /**
  132567. * Creates a new DaydreamController from a gamepad
  132568. * @param vrGamepad the gamepad that the controller should be created from
  132569. */
  132570. constructor(vrGamepad: any);
  132571. /**
  132572. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132573. * @param scene scene in which to add meshes
  132574. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132575. */
  132576. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132577. /**
  132578. * Called once for each button that changed state since the last frame
  132579. * @param buttonIdx Which button index changed
  132580. * @param state New state of the button
  132581. * @param changes Which properties on the state changed since last frame
  132582. */
  132583. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132584. }
  132585. }
  132586. declare module BABYLON {
  132587. /**
  132588. * Gear VR Controller
  132589. */
  132590. export class GearVRController extends WebVRController {
  132591. /**
  132592. * Base Url for the controller model.
  132593. */
  132594. static MODEL_BASE_URL: string;
  132595. /**
  132596. * File name for the controller model.
  132597. */
  132598. static MODEL_FILENAME: string;
  132599. /**
  132600. * Gamepad Id prefix used to identify this controller.
  132601. */
  132602. static readonly GAMEPAD_ID_PREFIX: string;
  132603. private readonly _buttonIndexToObservableNameMap;
  132604. /**
  132605. * Creates a new GearVRController from a gamepad
  132606. * @param vrGamepad the gamepad that the controller should be created from
  132607. */
  132608. constructor(vrGamepad: any);
  132609. /**
  132610. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132611. * @param scene scene in which to add meshes
  132612. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132613. */
  132614. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132615. /**
  132616. * Called once for each button that changed state since the last frame
  132617. * @param buttonIdx Which button index changed
  132618. * @param state New state of the button
  132619. * @param changes Which properties on the state changed since last frame
  132620. */
  132621. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132622. }
  132623. }
  132624. declare module BABYLON {
  132625. /**
  132626. * Generic Controller
  132627. */
  132628. export class GenericController extends WebVRController {
  132629. /**
  132630. * Base Url for the controller model.
  132631. */
  132632. static readonly MODEL_BASE_URL: string;
  132633. /**
  132634. * File name for the controller model.
  132635. */
  132636. static readonly MODEL_FILENAME: string;
  132637. /**
  132638. * Creates a new GenericController from a gamepad
  132639. * @param vrGamepad the gamepad that the controller should be created from
  132640. */
  132641. constructor(vrGamepad: any);
  132642. /**
  132643. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132644. * @param scene scene in which to add meshes
  132645. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132646. */
  132647. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132648. /**
  132649. * Called once for each button that changed state since the last frame
  132650. * @param buttonIdx Which button index changed
  132651. * @param state New state of the button
  132652. * @param changes Which properties on the state changed since last frame
  132653. */
  132654. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132655. }
  132656. }
  132657. declare module BABYLON {
  132658. /**
  132659. * Oculus Touch Controller
  132660. */
  132661. export class OculusTouchController extends WebVRController {
  132662. /**
  132663. * Base Url for the controller model.
  132664. */
  132665. static MODEL_BASE_URL: string;
  132666. /**
  132667. * File name for the left controller model.
  132668. */
  132669. static MODEL_LEFT_FILENAME: string;
  132670. /**
  132671. * File name for the right controller model.
  132672. */
  132673. static MODEL_RIGHT_FILENAME: string;
  132674. /**
  132675. * Base Url for the Quest controller model.
  132676. */
  132677. static QUEST_MODEL_BASE_URL: string;
  132678. /**
  132679. * @hidden
  132680. * If the controllers are running on a device that needs the updated Quest controller models
  132681. */
  132682. static _IsQuest: boolean;
  132683. /**
  132684. * Fired when the secondary trigger on this controller is modified
  132685. */
  132686. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  132687. /**
  132688. * Fired when the thumb rest on this controller is modified
  132689. */
  132690. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  132691. /**
  132692. * Creates a new OculusTouchController from a gamepad
  132693. * @param vrGamepad the gamepad that the controller should be created from
  132694. */
  132695. constructor(vrGamepad: any);
  132696. /**
  132697. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132698. * @param scene scene in which to add meshes
  132699. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132700. */
  132701. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132702. /**
  132703. * Fired when the A button on this controller is modified
  132704. */
  132705. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132706. /**
  132707. * Fired when the B button on this controller is modified
  132708. */
  132709. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132710. /**
  132711. * Fired when the X button on this controller is modified
  132712. */
  132713. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132714. /**
  132715. * Fired when the Y button on this controller is modified
  132716. */
  132717. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132718. /**
  132719. * Called once for each button that changed state since the last frame
  132720. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  132721. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  132722. * 2) secondary trigger (same)
  132723. * 3) A (right) X (left), touch, pressed = value
  132724. * 4) B / Y
  132725. * 5) thumb rest
  132726. * @param buttonIdx Which button index changed
  132727. * @param state New state of the button
  132728. * @param changes Which properties on the state changed since last frame
  132729. */
  132730. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132731. }
  132732. }
  132733. declare module BABYLON {
  132734. /**
  132735. * Vive Controller
  132736. */
  132737. export class ViveController extends WebVRController {
  132738. /**
  132739. * Base Url for the controller model.
  132740. */
  132741. static MODEL_BASE_URL: string;
  132742. /**
  132743. * File name for the controller model.
  132744. */
  132745. static MODEL_FILENAME: string;
  132746. /**
  132747. * Creates a new ViveController from a gamepad
  132748. * @param vrGamepad the gamepad that the controller should be created from
  132749. */
  132750. constructor(vrGamepad: any);
  132751. /**
  132752. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132753. * @param scene scene in which to add meshes
  132754. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132755. */
  132756. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132757. /**
  132758. * Fired when the left button on this controller is modified
  132759. */
  132760. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132761. /**
  132762. * Fired when the right button on this controller is modified
  132763. */
  132764. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132765. /**
  132766. * Fired when the menu button on this controller is modified
  132767. */
  132768. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132769. /**
  132770. * Called once for each button that changed state since the last frame
  132771. * Vive mapping:
  132772. * 0: touchpad
  132773. * 1: trigger
  132774. * 2: left AND right buttons
  132775. * 3: menu button
  132776. * @param buttonIdx Which button index changed
  132777. * @param state New state of the button
  132778. * @param changes Which properties on the state changed since last frame
  132779. */
  132780. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132781. }
  132782. }
  132783. declare module BABYLON {
  132784. /**
  132785. * Defines the WindowsMotionController object that the state of the windows motion controller
  132786. */
  132787. export class WindowsMotionController extends WebVRController {
  132788. /**
  132789. * The base url used to load the left and right controller models
  132790. */
  132791. static MODEL_BASE_URL: string;
  132792. /**
  132793. * The name of the left controller model file
  132794. */
  132795. static MODEL_LEFT_FILENAME: string;
  132796. /**
  132797. * The name of the right controller model file
  132798. */
  132799. static MODEL_RIGHT_FILENAME: string;
  132800. /**
  132801. * The controller name prefix for this controller type
  132802. */
  132803. static readonly GAMEPAD_ID_PREFIX: string;
  132804. /**
  132805. * The controller id pattern for this controller type
  132806. */
  132807. private static readonly GAMEPAD_ID_PATTERN;
  132808. private _loadedMeshInfo;
  132809. protected readonly _mapping: {
  132810. buttons: string[];
  132811. buttonMeshNames: {
  132812. trigger: string;
  132813. menu: string;
  132814. grip: string;
  132815. thumbstick: string;
  132816. trackpad: string;
  132817. };
  132818. buttonObservableNames: {
  132819. trigger: string;
  132820. menu: string;
  132821. grip: string;
  132822. thumbstick: string;
  132823. trackpad: string;
  132824. };
  132825. axisMeshNames: string[];
  132826. pointingPoseMeshName: string;
  132827. };
  132828. /**
  132829. * Fired when the trackpad on this controller is clicked
  132830. */
  132831. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132832. /**
  132833. * Fired when the trackpad on this controller is modified
  132834. */
  132835. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132836. /**
  132837. * The current x and y values of this controller's trackpad
  132838. */
  132839. trackpad: StickValues;
  132840. /**
  132841. * Creates a new WindowsMotionController from a gamepad
  132842. * @param vrGamepad the gamepad that the controller should be created from
  132843. */
  132844. constructor(vrGamepad: any);
  132845. /**
  132846. * Fired when the trigger on this controller is modified
  132847. */
  132848. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132849. /**
  132850. * Fired when the menu button on this controller is modified
  132851. */
  132852. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132853. /**
  132854. * Fired when the grip button on this controller is modified
  132855. */
  132856. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132857. /**
  132858. * Fired when the thumbstick button on this controller is modified
  132859. */
  132860. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132861. /**
  132862. * Fired when the touchpad button on this controller is modified
  132863. */
  132864. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132865. /**
  132866. * Fired when the touchpad values on this controller are modified
  132867. */
  132868. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  132869. protected _updateTrackpad(): void;
  132870. /**
  132871. * Called once per frame by the engine.
  132872. */
  132873. update(): void;
  132874. /**
  132875. * Called once for each button that changed state since the last frame
  132876. * @param buttonIdx Which button index changed
  132877. * @param state New state of the button
  132878. * @param changes Which properties on the state changed since last frame
  132879. */
  132880. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132881. /**
  132882. * Moves the buttons on the controller mesh based on their current state
  132883. * @param buttonName the name of the button to move
  132884. * @param buttonValue the value of the button which determines the buttons new position
  132885. */
  132886. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  132887. /**
  132888. * Moves the axis on the controller mesh based on its current state
  132889. * @param axis the index of the axis
  132890. * @param axisValue the value of the axis which determines the meshes new position
  132891. * @hidden
  132892. */
  132893. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  132894. /**
  132895. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132896. * @param scene scene in which to add meshes
  132897. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132898. */
  132899. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  132900. /**
  132901. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  132902. * can be transformed by button presses and axes values, based on this._mapping.
  132903. *
  132904. * @param scene scene in which the meshes exist
  132905. * @param meshes list of meshes that make up the controller model to process
  132906. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  132907. */
  132908. private processModel;
  132909. private createMeshInfo;
  132910. /**
  132911. * Gets the ray of the controller in the direction the controller is pointing
  132912. * @param length the length the resulting ray should be
  132913. * @returns a ray in the direction the controller is pointing
  132914. */
  132915. getForwardRay(length?: number): Ray;
  132916. /**
  132917. * Disposes of the controller
  132918. */
  132919. dispose(): void;
  132920. }
  132921. /**
  132922. * This class represents a new windows motion controller in XR.
  132923. */
  132924. export class XRWindowsMotionController extends WindowsMotionController {
  132925. /**
  132926. * Changing the original WIndowsMotionController mapping to fir the new mapping
  132927. */
  132928. protected readonly _mapping: {
  132929. buttons: string[];
  132930. buttonMeshNames: {
  132931. trigger: string;
  132932. menu: string;
  132933. grip: string;
  132934. thumbstick: string;
  132935. trackpad: string;
  132936. };
  132937. buttonObservableNames: {
  132938. trigger: string;
  132939. menu: string;
  132940. grip: string;
  132941. thumbstick: string;
  132942. trackpad: string;
  132943. };
  132944. axisMeshNames: string[];
  132945. pointingPoseMeshName: string;
  132946. };
  132947. /**
  132948. * Construct a new XR-Based windows motion controller
  132949. *
  132950. * @param gamepadInfo the gamepad object from the browser
  132951. */
  132952. constructor(gamepadInfo: any);
  132953. /**
  132954. * holds the thumbstick values (X,Y)
  132955. */
  132956. thumbstickValues: StickValues;
  132957. /**
  132958. * Fired when the thumbstick on this controller is clicked
  132959. */
  132960. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  132961. /**
  132962. * Fired when the thumbstick on this controller is modified
  132963. */
  132964. onThumbstickValuesChangedObservable: Observable<StickValues>;
  132965. /**
  132966. * Fired when the touchpad button on this controller is modified
  132967. */
  132968. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132969. /**
  132970. * Fired when the touchpad values on this controller are modified
  132971. */
  132972. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132973. /**
  132974. * Fired when the thumbstick button on this controller is modified
  132975. * here to prevent breaking changes
  132976. */
  132977. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132978. /**
  132979. * updating the thumbstick(!) and not the trackpad.
  132980. * This is named this way due to the difference between WebVR and XR and to avoid
  132981. * changing the parent class.
  132982. */
  132983. protected _updateTrackpad(): void;
  132984. /**
  132985. * Disposes the class with joy
  132986. */
  132987. dispose(): void;
  132988. }
  132989. }
  132990. declare module BABYLON {
  132991. /**
  132992. * Class containing static functions to help procedurally build meshes
  132993. */
  132994. export class PolyhedronBuilder {
  132995. /**
  132996. * Creates a polyhedron mesh
  132997. * * 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
  132998. * * The parameter `size` (positive float, default 1) sets the polygon size
  132999. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  133000. * * 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`
  133001. * * 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
  133002. * * 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)`)
  133003. * * 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
  133004. * * 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
  133005. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  133006. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  133007. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  133008. * @param name defines the name of the mesh
  133009. * @param options defines the options used to create the mesh
  133010. * @param scene defines the hosting scene
  133011. * @returns the polyhedron mesh
  133012. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  133013. */
  133014. static CreatePolyhedron(name: string, options: {
  133015. type?: number;
  133016. size?: number;
  133017. sizeX?: number;
  133018. sizeY?: number;
  133019. sizeZ?: number;
  133020. custom?: any;
  133021. faceUV?: Vector4[];
  133022. faceColors?: Color4[];
  133023. flat?: boolean;
  133024. updatable?: boolean;
  133025. sideOrientation?: number;
  133026. frontUVs?: Vector4;
  133027. backUVs?: Vector4;
  133028. }, scene?: Nullable<Scene>): Mesh;
  133029. }
  133030. }
  133031. declare module BABYLON {
  133032. /**
  133033. * Gizmo that enables scaling a mesh along 3 axis
  133034. */
  133035. export class ScaleGizmo extends Gizmo {
  133036. /**
  133037. * Internal gizmo used for interactions on the x axis
  133038. */
  133039. xGizmo: AxisScaleGizmo;
  133040. /**
  133041. * Internal gizmo used for interactions on the y axis
  133042. */
  133043. yGizmo: AxisScaleGizmo;
  133044. /**
  133045. * Internal gizmo used for interactions on the z axis
  133046. */
  133047. zGizmo: AxisScaleGizmo;
  133048. /**
  133049. * Internal gizmo used to scale all axis equally
  133050. */
  133051. uniformScaleGizmo: AxisScaleGizmo;
  133052. private _meshAttached;
  133053. private _nodeAttached;
  133054. private _snapDistance;
  133055. private _uniformScalingMesh;
  133056. private _octahedron;
  133057. private _sensitivity;
  133058. /** Fires an event when any of it's sub gizmos are dragged */
  133059. onDragStartObservable: Observable<unknown>;
  133060. /** Fires an event when any of it's sub gizmos are released from dragging */
  133061. onDragEndObservable: Observable<unknown>;
  133062. get attachedMesh(): Nullable<AbstractMesh>;
  133063. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133064. get attachedNode(): Nullable<Node>;
  133065. set attachedNode(node: Nullable<Node>);
  133066. /**
  133067. * Creates a ScaleGizmo
  133068. * @param gizmoLayer The utility layer the gizmo will be added to
  133069. * @param thickness display gizmo axis thickness
  133070. */
  133071. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  133072. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133073. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133074. /**
  133075. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133076. */
  133077. set snapDistance(value: number);
  133078. get snapDistance(): number;
  133079. /**
  133080. * Ratio for the scale of the gizmo (Default: 1)
  133081. */
  133082. set scaleRatio(value: number);
  133083. get scaleRatio(): number;
  133084. /**
  133085. * Sensitivity factor for dragging (Default: 1)
  133086. */
  133087. set sensitivity(value: number);
  133088. get sensitivity(): number;
  133089. /**
  133090. * Disposes of the gizmo
  133091. */
  133092. dispose(): void;
  133093. }
  133094. }
  133095. declare module BABYLON {
  133096. /**
  133097. * Single axis scale gizmo
  133098. */
  133099. export class AxisScaleGizmo extends Gizmo {
  133100. /**
  133101. * Drag behavior responsible for the gizmos dragging interactions
  133102. */
  133103. dragBehavior: PointerDragBehavior;
  133104. private _pointerObserver;
  133105. /**
  133106. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133107. */
  133108. snapDistance: number;
  133109. /**
  133110. * Event that fires each time the gizmo snaps to a new location.
  133111. * * snapDistance is the the change in distance
  133112. */
  133113. onSnapObservable: Observable<{
  133114. snapDistance: number;
  133115. }>;
  133116. /**
  133117. * If the scaling operation should be done on all axis (default: false)
  133118. */
  133119. uniformScaling: boolean;
  133120. /**
  133121. * Custom sensitivity value for the drag strength
  133122. */
  133123. sensitivity: number;
  133124. private _isEnabled;
  133125. private _parent;
  133126. private _arrow;
  133127. private _coloredMaterial;
  133128. private _hoverMaterial;
  133129. /**
  133130. * Creates an AxisScaleGizmo
  133131. * @param gizmoLayer The utility layer the gizmo will be added to
  133132. * @param dragAxis The axis which the gizmo will be able to scale on
  133133. * @param color The color of the gizmo
  133134. * @param thickness display gizmo axis thickness
  133135. */
  133136. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  133137. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133138. /**
  133139. * If the gizmo is enabled
  133140. */
  133141. set isEnabled(value: boolean);
  133142. get isEnabled(): boolean;
  133143. /**
  133144. * Disposes of the gizmo
  133145. */
  133146. dispose(): void;
  133147. /**
  133148. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  133149. * @param mesh The mesh to replace the default mesh of the gizmo
  133150. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  133151. */
  133152. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  133153. }
  133154. }
  133155. declare module BABYLON {
  133156. /**
  133157. * Bounding box gizmo
  133158. */
  133159. export class BoundingBoxGizmo extends Gizmo {
  133160. private _lineBoundingBox;
  133161. private _rotateSpheresParent;
  133162. private _scaleBoxesParent;
  133163. private _boundingDimensions;
  133164. private _renderObserver;
  133165. private _pointerObserver;
  133166. private _scaleDragSpeed;
  133167. private _tmpQuaternion;
  133168. private _tmpVector;
  133169. private _tmpRotationMatrix;
  133170. /**
  133171. * 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)
  133172. */
  133173. ignoreChildren: boolean;
  133174. /**
  133175. * 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)
  133176. */
  133177. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  133178. /**
  133179. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  133180. */
  133181. rotationSphereSize: number;
  133182. /**
  133183. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  133184. */
  133185. scaleBoxSize: number;
  133186. /**
  133187. * 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)
  133188. */
  133189. fixedDragMeshScreenSize: boolean;
  133190. /**
  133191. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  133192. */
  133193. fixedDragMeshScreenSizeDistanceFactor: number;
  133194. /**
  133195. * Fired when a rotation sphere or scale box is dragged
  133196. */
  133197. onDragStartObservable: Observable<{}>;
  133198. /**
  133199. * Fired when a scale box is dragged
  133200. */
  133201. onScaleBoxDragObservable: Observable<{}>;
  133202. /**
  133203. * Fired when a scale box drag is ended
  133204. */
  133205. onScaleBoxDragEndObservable: Observable<{}>;
  133206. /**
  133207. * Fired when a rotation sphere is dragged
  133208. */
  133209. onRotationSphereDragObservable: Observable<{}>;
  133210. /**
  133211. * Fired when a rotation sphere drag is ended
  133212. */
  133213. onRotationSphereDragEndObservable: Observable<{}>;
  133214. /**
  133215. * 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)
  133216. */
  133217. scalePivot: Nullable<Vector3>;
  133218. /**
  133219. * Mesh used as a pivot to rotate the attached node
  133220. */
  133221. private _anchorMesh;
  133222. private _existingMeshScale;
  133223. private _dragMesh;
  133224. private pointerDragBehavior;
  133225. private coloredMaterial;
  133226. private hoverColoredMaterial;
  133227. /**
  133228. * Sets the color of the bounding box gizmo
  133229. * @param color the color to set
  133230. */
  133231. setColor(color: Color3): void;
  133232. /**
  133233. * Creates an BoundingBoxGizmo
  133234. * @param gizmoLayer The utility layer the gizmo will be added to
  133235. * @param color The color of the gizmo
  133236. */
  133237. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  133238. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  133239. private _selectNode;
  133240. /**
  133241. * Updates the bounding box information for the Gizmo
  133242. */
  133243. updateBoundingBox(): void;
  133244. private _updateRotationSpheres;
  133245. private _updateScaleBoxes;
  133246. /**
  133247. * Enables rotation on the specified axis and disables rotation on the others
  133248. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  133249. */
  133250. setEnabledRotationAxis(axis: string): void;
  133251. /**
  133252. * Enables/disables scaling
  133253. * @param enable if scaling should be enabled
  133254. * @param homogeneousScaling defines if scaling should only be homogeneous
  133255. */
  133256. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  133257. private _updateDummy;
  133258. /**
  133259. * Enables a pointer drag behavior on the bounding box of the gizmo
  133260. */
  133261. enableDragBehavior(): void;
  133262. /**
  133263. * Disposes of the gizmo
  133264. */
  133265. dispose(): void;
  133266. /**
  133267. * 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)
  133268. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  133269. * @returns the bounding box mesh with the passed in mesh as a child
  133270. */
  133271. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  133272. /**
  133273. * CustomMeshes are not supported by this gizmo
  133274. * @param mesh The mesh to replace the default mesh of the gizmo
  133275. */
  133276. setCustomMesh(mesh: Mesh): void;
  133277. }
  133278. }
  133279. declare module BABYLON {
  133280. /**
  133281. * Single plane rotation gizmo
  133282. */
  133283. export class PlaneRotationGizmo extends Gizmo {
  133284. /**
  133285. * Drag behavior responsible for the gizmos dragging interactions
  133286. */
  133287. dragBehavior: PointerDragBehavior;
  133288. private _pointerObserver;
  133289. /**
  133290. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  133291. */
  133292. snapDistance: number;
  133293. /**
  133294. * Event that fires each time the gizmo snaps to a new location.
  133295. * * snapDistance is the the change in distance
  133296. */
  133297. onSnapObservable: Observable<{
  133298. snapDistance: number;
  133299. }>;
  133300. private _isEnabled;
  133301. private _parent;
  133302. /**
  133303. * Creates a PlaneRotationGizmo
  133304. * @param gizmoLayer The utility layer the gizmo will be added to
  133305. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  133306. * @param color The color of the gizmo
  133307. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133308. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133309. * @param thickness display gizmo axis thickness
  133310. */
  133311. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  133312. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133313. /**
  133314. * If the gizmo is enabled
  133315. */
  133316. set isEnabled(value: boolean);
  133317. get isEnabled(): boolean;
  133318. /**
  133319. * Disposes of the gizmo
  133320. */
  133321. dispose(): void;
  133322. }
  133323. }
  133324. declare module BABYLON {
  133325. /**
  133326. * Gizmo that enables rotating a mesh along 3 axis
  133327. */
  133328. export class RotationGizmo extends Gizmo {
  133329. /**
  133330. * Internal gizmo used for interactions on the x axis
  133331. */
  133332. xGizmo: PlaneRotationGizmo;
  133333. /**
  133334. * Internal gizmo used for interactions on the y axis
  133335. */
  133336. yGizmo: PlaneRotationGizmo;
  133337. /**
  133338. * Internal gizmo used for interactions on the z axis
  133339. */
  133340. zGizmo: PlaneRotationGizmo;
  133341. /** Fires an event when any of it's sub gizmos are dragged */
  133342. onDragStartObservable: Observable<unknown>;
  133343. /** Fires an event when any of it's sub gizmos are released from dragging */
  133344. onDragEndObservable: Observable<unknown>;
  133345. private _meshAttached;
  133346. private _nodeAttached;
  133347. get attachedMesh(): Nullable<AbstractMesh>;
  133348. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133349. get attachedNode(): Nullable<Node>;
  133350. set attachedNode(node: Nullable<Node>);
  133351. /**
  133352. * Creates a RotationGizmo
  133353. * @param gizmoLayer The utility layer the gizmo will be added to
  133354. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133355. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133356. * @param thickness display gizmo axis thickness
  133357. */
  133358. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  133359. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133360. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133361. /**
  133362. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133363. */
  133364. set snapDistance(value: number);
  133365. get snapDistance(): number;
  133366. /**
  133367. * Ratio for the scale of the gizmo (Default: 1)
  133368. */
  133369. set scaleRatio(value: number);
  133370. get scaleRatio(): number;
  133371. /**
  133372. * Disposes of the gizmo
  133373. */
  133374. dispose(): void;
  133375. /**
  133376. * CustomMeshes are not supported by this gizmo
  133377. * @param mesh The mesh to replace the default mesh of the gizmo
  133378. */
  133379. setCustomMesh(mesh: Mesh): void;
  133380. }
  133381. }
  133382. declare module BABYLON {
  133383. /**
  133384. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  133385. */
  133386. export class GizmoManager implements IDisposable {
  133387. private scene;
  133388. /**
  133389. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  133390. */
  133391. gizmos: {
  133392. positionGizmo: Nullable<PositionGizmo>;
  133393. rotationGizmo: Nullable<RotationGizmo>;
  133394. scaleGizmo: Nullable<ScaleGizmo>;
  133395. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  133396. };
  133397. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  133398. clearGizmoOnEmptyPointerEvent: boolean;
  133399. /** Fires an event when the manager is attached to a mesh */
  133400. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  133401. /** Fires an event when the manager is attached to a node */
  133402. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  133403. private _gizmosEnabled;
  133404. private _pointerObserver;
  133405. private _attachedMesh;
  133406. private _attachedNode;
  133407. private _boundingBoxColor;
  133408. private _defaultUtilityLayer;
  133409. private _defaultKeepDepthUtilityLayer;
  133410. private _thickness;
  133411. /**
  133412. * When bounding box gizmo is enabled, this can be used to track drag/end events
  133413. */
  133414. boundingBoxDragBehavior: SixDofDragBehavior;
  133415. /**
  133416. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  133417. */
  133418. attachableMeshes: Nullable<Array<AbstractMesh>>;
  133419. /**
  133420. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  133421. */
  133422. attachableNodes: Nullable<Array<Node>>;
  133423. /**
  133424. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  133425. */
  133426. usePointerToAttachGizmos: boolean;
  133427. /**
  133428. * Utility layer that the bounding box gizmo belongs to
  133429. */
  133430. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  133431. /**
  133432. * Utility layer that all gizmos besides bounding box belong to
  133433. */
  133434. get utilityLayer(): UtilityLayerRenderer;
  133435. /**
  133436. * Instatiates a gizmo manager
  133437. * @param scene the scene to overlay the gizmos on top of
  133438. * @param thickness display gizmo axis thickness
  133439. */
  133440. constructor(scene: Scene, thickness?: number);
  133441. /**
  133442. * Attaches a set of gizmos to the specified mesh
  133443. * @param mesh The mesh the gizmo's should be attached to
  133444. */
  133445. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  133446. /**
  133447. * Attaches a set of gizmos to the specified node
  133448. * @param node The node the gizmo's should be attached to
  133449. */
  133450. attachToNode(node: Nullable<Node>): void;
  133451. /**
  133452. * If the position gizmo is enabled
  133453. */
  133454. set positionGizmoEnabled(value: boolean);
  133455. get positionGizmoEnabled(): boolean;
  133456. /**
  133457. * If the rotation gizmo is enabled
  133458. */
  133459. set rotationGizmoEnabled(value: boolean);
  133460. get rotationGizmoEnabled(): boolean;
  133461. /**
  133462. * If the scale gizmo is enabled
  133463. */
  133464. set scaleGizmoEnabled(value: boolean);
  133465. get scaleGizmoEnabled(): boolean;
  133466. /**
  133467. * If the boundingBox gizmo is enabled
  133468. */
  133469. set boundingBoxGizmoEnabled(value: boolean);
  133470. get boundingBoxGizmoEnabled(): boolean;
  133471. /**
  133472. * Disposes of the gizmo manager
  133473. */
  133474. dispose(): void;
  133475. }
  133476. }
  133477. declare module BABYLON {
  133478. /**
  133479. * A directional light is defined by a direction (what a surprise!).
  133480. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  133481. * 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.
  133482. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133483. */
  133484. export class DirectionalLight extends ShadowLight {
  133485. private _shadowFrustumSize;
  133486. /**
  133487. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  133488. */
  133489. get shadowFrustumSize(): number;
  133490. /**
  133491. * Specifies a fix frustum size for the shadow generation.
  133492. */
  133493. set shadowFrustumSize(value: number);
  133494. private _shadowOrthoScale;
  133495. /**
  133496. * Gets the shadow projection scale against the optimal computed one.
  133497. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133498. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133499. */
  133500. get shadowOrthoScale(): number;
  133501. /**
  133502. * Sets the shadow projection scale against the optimal computed one.
  133503. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133504. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133505. */
  133506. set shadowOrthoScale(value: number);
  133507. /**
  133508. * Automatically compute the projection matrix to best fit (including all the casters)
  133509. * on each frame.
  133510. */
  133511. autoUpdateExtends: boolean;
  133512. /**
  133513. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  133514. * on each frame. autoUpdateExtends must be set to true for this to work
  133515. */
  133516. autoCalcShadowZBounds: boolean;
  133517. private _orthoLeft;
  133518. private _orthoRight;
  133519. private _orthoTop;
  133520. private _orthoBottom;
  133521. /**
  133522. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  133523. * The directional light is emitted from everywhere in the given direction.
  133524. * It can cast shadows.
  133525. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133526. * @param name The friendly name of the light
  133527. * @param direction The direction of the light
  133528. * @param scene The scene the light belongs to
  133529. */
  133530. constructor(name: string, direction: Vector3, scene: Scene);
  133531. /**
  133532. * Returns the string "DirectionalLight".
  133533. * @return The class name
  133534. */
  133535. getClassName(): string;
  133536. /**
  133537. * Returns the integer 1.
  133538. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133539. */
  133540. getTypeID(): number;
  133541. /**
  133542. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  133543. * Returns the DirectionalLight Shadow projection matrix.
  133544. */
  133545. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133546. /**
  133547. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  133548. * Returns the DirectionalLight Shadow projection matrix.
  133549. */
  133550. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  133551. /**
  133552. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  133553. * Returns the DirectionalLight Shadow projection matrix.
  133554. */
  133555. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133556. protected _buildUniformLayout(): void;
  133557. /**
  133558. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  133559. * @param effect The effect to update
  133560. * @param lightIndex The index of the light in the effect to update
  133561. * @returns The directional light
  133562. */
  133563. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  133564. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  133565. /**
  133566. * Gets the minZ used for shadow according to both the scene and the light.
  133567. *
  133568. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133569. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133570. * @param activeCamera The camera we are returning the min for
  133571. * @returns the depth min z
  133572. */
  133573. getDepthMinZ(activeCamera: Camera): number;
  133574. /**
  133575. * Gets the maxZ used for shadow according to both the scene and the light.
  133576. *
  133577. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133578. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133579. * @param activeCamera The camera we are returning the max for
  133580. * @returns the depth max z
  133581. */
  133582. getDepthMaxZ(activeCamera: Camera): number;
  133583. /**
  133584. * Prepares the list of defines specific to the light type.
  133585. * @param defines the list of defines
  133586. * @param lightIndex defines the index of the light for the effect
  133587. */
  133588. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133589. }
  133590. }
  133591. declare module BABYLON {
  133592. /**
  133593. * Class containing static functions to help procedurally build meshes
  133594. */
  133595. export class HemisphereBuilder {
  133596. /**
  133597. * Creates a hemisphere mesh
  133598. * @param name defines the name of the mesh
  133599. * @param options defines the options used to create the mesh
  133600. * @param scene defines the hosting scene
  133601. * @returns the hemisphere mesh
  133602. */
  133603. static CreateHemisphere(name: string, options: {
  133604. segments?: number;
  133605. diameter?: number;
  133606. sideOrientation?: number;
  133607. }, scene: any): Mesh;
  133608. }
  133609. }
  133610. declare module BABYLON {
  133611. /**
  133612. * A spot light is defined by a position, a direction, an angle, and an exponent.
  133613. * These values define a cone of light starting from the position, emitting toward the direction.
  133614. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  133615. * and the exponent defines the speed of the decay of the light with distance (reach).
  133616. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133617. */
  133618. export class SpotLight extends ShadowLight {
  133619. private _angle;
  133620. private _innerAngle;
  133621. private _cosHalfAngle;
  133622. private _lightAngleScale;
  133623. private _lightAngleOffset;
  133624. /**
  133625. * Gets the cone angle of the spot light in Radians.
  133626. */
  133627. get angle(): number;
  133628. /**
  133629. * Sets the cone angle of the spot light in Radians.
  133630. */
  133631. set angle(value: number);
  133632. /**
  133633. * Only used in gltf falloff mode, this defines the angle where
  133634. * the directional falloff will start before cutting at angle which could be seen
  133635. * as outer angle.
  133636. */
  133637. get innerAngle(): number;
  133638. /**
  133639. * Only used in gltf falloff mode, this defines the angle where
  133640. * the directional falloff will start before cutting at angle which could be seen
  133641. * as outer angle.
  133642. */
  133643. set innerAngle(value: number);
  133644. private _shadowAngleScale;
  133645. /**
  133646. * Allows scaling the angle of the light for shadow generation only.
  133647. */
  133648. get shadowAngleScale(): number;
  133649. /**
  133650. * Allows scaling the angle of the light for shadow generation only.
  133651. */
  133652. set shadowAngleScale(value: number);
  133653. /**
  133654. * The light decay speed with the distance from the emission spot.
  133655. */
  133656. exponent: number;
  133657. private _projectionTextureMatrix;
  133658. /**
  133659. * Allows reading the projecton texture
  133660. */
  133661. get projectionTextureMatrix(): Matrix;
  133662. protected _projectionTextureLightNear: number;
  133663. /**
  133664. * Gets the near clip of the Spotlight for texture projection.
  133665. */
  133666. get projectionTextureLightNear(): number;
  133667. /**
  133668. * Sets the near clip of the Spotlight for texture projection.
  133669. */
  133670. set projectionTextureLightNear(value: number);
  133671. protected _projectionTextureLightFar: number;
  133672. /**
  133673. * Gets the far clip of the Spotlight for texture projection.
  133674. */
  133675. get projectionTextureLightFar(): number;
  133676. /**
  133677. * Sets the far clip of the Spotlight for texture projection.
  133678. */
  133679. set projectionTextureLightFar(value: number);
  133680. protected _projectionTextureUpDirection: Vector3;
  133681. /**
  133682. * Gets the Up vector of the Spotlight for texture projection.
  133683. */
  133684. get projectionTextureUpDirection(): Vector3;
  133685. /**
  133686. * Sets the Up vector of the Spotlight for texture projection.
  133687. */
  133688. set projectionTextureUpDirection(value: Vector3);
  133689. private _projectionTexture;
  133690. /**
  133691. * Gets the projection texture of the light.
  133692. */
  133693. get projectionTexture(): Nullable<BaseTexture>;
  133694. /**
  133695. * Sets the projection texture of the light.
  133696. */
  133697. set projectionTexture(value: Nullable<BaseTexture>);
  133698. private _projectionTextureViewLightDirty;
  133699. private _projectionTextureProjectionLightDirty;
  133700. private _projectionTextureDirty;
  133701. private _projectionTextureViewTargetVector;
  133702. private _projectionTextureViewLightMatrix;
  133703. private _projectionTextureProjectionLightMatrix;
  133704. private _projectionTextureScalingMatrix;
  133705. /**
  133706. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  133707. * It can cast shadows.
  133708. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133709. * @param name The light friendly name
  133710. * @param position The position of the spot light in the scene
  133711. * @param direction The direction of the light in the scene
  133712. * @param angle The cone angle of the light in Radians
  133713. * @param exponent The light decay speed with the distance from the emission spot
  133714. * @param scene The scene the lights belongs to
  133715. */
  133716. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  133717. /**
  133718. * Returns the string "SpotLight".
  133719. * @returns the class name
  133720. */
  133721. getClassName(): string;
  133722. /**
  133723. * Returns the integer 2.
  133724. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133725. */
  133726. getTypeID(): number;
  133727. /**
  133728. * Overrides the direction setter to recompute the projection texture view light Matrix.
  133729. */
  133730. protected _setDirection(value: Vector3): void;
  133731. /**
  133732. * Overrides the position setter to recompute the projection texture view light Matrix.
  133733. */
  133734. protected _setPosition(value: Vector3): void;
  133735. /**
  133736. * 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.
  133737. * Returns the SpotLight.
  133738. */
  133739. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133740. protected _computeProjectionTextureViewLightMatrix(): void;
  133741. protected _computeProjectionTextureProjectionLightMatrix(): void;
  133742. /**
  133743. * Main function for light texture projection matrix computing.
  133744. */
  133745. protected _computeProjectionTextureMatrix(): void;
  133746. protected _buildUniformLayout(): void;
  133747. private _computeAngleValues;
  133748. /**
  133749. * Sets the passed Effect "effect" with the Light textures.
  133750. * @param effect The effect to update
  133751. * @param lightIndex The index of the light in the effect to update
  133752. * @returns The light
  133753. */
  133754. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  133755. /**
  133756. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  133757. * @param effect The effect to update
  133758. * @param lightIndex The index of the light in the effect to update
  133759. * @returns The spot light
  133760. */
  133761. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  133762. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  133763. /**
  133764. * Disposes the light and the associated resources.
  133765. */
  133766. dispose(): void;
  133767. /**
  133768. * Prepares the list of defines specific to the light type.
  133769. * @param defines the list of defines
  133770. * @param lightIndex defines the index of the light for the effect
  133771. */
  133772. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133773. }
  133774. }
  133775. declare module BABYLON {
  133776. /**
  133777. * Gizmo that enables viewing a light
  133778. */
  133779. export class LightGizmo extends Gizmo {
  133780. private _lightMesh;
  133781. private _material;
  133782. private _cachedPosition;
  133783. private _cachedForward;
  133784. private _attachedMeshParent;
  133785. /**
  133786. * Creates a LightGizmo
  133787. * @param gizmoLayer The utility layer the gizmo will be added to
  133788. */
  133789. constructor(gizmoLayer?: UtilityLayerRenderer);
  133790. private _light;
  133791. /**
  133792. * The light that the gizmo is attached to
  133793. */
  133794. set light(light: Nullable<Light>);
  133795. get light(): Nullable<Light>;
  133796. /**
  133797. * Gets the material used to render the light gizmo
  133798. */
  133799. get material(): StandardMaterial;
  133800. /**
  133801. * @hidden
  133802. * Updates the gizmo to match the attached mesh's position/rotation
  133803. */
  133804. protected _update(): void;
  133805. private static _Scale;
  133806. /**
  133807. * Creates the lines for a light mesh
  133808. */
  133809. private static _CreateLightLines;
  133810. /**
  133811. * Disposes of the light gizmo
  133812. */
  133813. dispose(): void;
  133814. private static _CreateHemisphericLightMesh;
  133815. private static _CreatePointLightMesh;
  133816. private static _CreateSpotLightMesh;
  133817. private static _CreateDirectionalLightMesh;
  133818. }
  133819. }
  133820. declare module BABYLON {
  133821. /**
  133822. * Gizmo that enables viewing a camera
  133823. */
  133824. export class CameraGizmo extends Gizmo {
  133825. private _cameraMesh;
  133826. private _cameraLinesMesh;
  133827. private _material;
  133828. /**
  133829. * Creates a CameraGizmo
  133830. * @param gizmoLayer The utility layer the gizmo will be added to
  133831. */
  133832. constructor(gizmoLayer?: UtilityLayerRenderer);
  133833. private _camera;
  133834. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  133835. get displayFrustum(): boolean;
  133836. set displayFrustum(value: boolean);
  133837. /**
  133838. * The camera that the gizmo is attached to
  133839. */
  133840. set camera(camera: Nullable<Camera>);
  133841. get camera(): Nullable<Camera>;
  133842. /**
  133843. * Gets the material used to render the camera gizmo
  133844. */
  133845. get material(): StandardMaterial;
  133846. /**
  133847. * @hidden
  133848. * Updates the gizmo to match the attached mesh's position/rotation
  133849. */
  133850. protected _update(): void;
  133851. private static _Scale;
  133852. private _invProjection;
  133853. /**
  133854. * Disposes of the camera gizmo
  133855. */
  133856. dispose(): void;
  133857. private static _CreateCameraMesh;
  133858. private static _CreateCameraFrustum;
  133859. }
  133860. }
  133861. declare module BABYLON {
  133862. /** @hidden */
  133863. export var backgroundFragmentDeclaration: {
  133864. name: string;
  133865. shader: string;
  133866. };
  133867. }
  133868. declare module BABYLON {
  133869. /** @hidden */
  133870. export var backgroundUboDeclaration: {
  133871. name: string;
  133872. shader: string;
  133873. };
  133874. }
  133875. declare module BABYLON {
  133876. /** @hidden */
  133877. export var backgroundPixelShader: {
  133878. name: string;
  133879. shader: string;
  133880. };
  133881. }
  133882. declare module BABYLON {
  133883. /** @hidden */
  133884. export var backgroundVertexDeclaration: {
  133885. name: string;
  133886. shader: string;
  133887. };
  133888. }
  133889. declare module BABYLON {
  133890. /** @hidden */
  133891. export var backgroundVertexShader: {
  133892. name: string;
  133893. shader: string;
  133894. };
  133895. }
  133896. declare module BABYLON {
  133897. /**
  133898. * Background material used to create an efficient environement around your scene.
  133899. */
  133900. export class BackgroundMaterial extends PushMaterial {
  133901. /**
  133902. * Standard reflectance value at parallel view angle.
  133903. */
  133904. static StandardReflectance0: number;
  133905. /**
  133906. * Standard reflectance value at grazing angle.
  133907. */
  133908. static StandardReflectance90: number;
  133909. protected _primaryColor: Color3;
  133910. /**
  133911. * Key light Color (multiply against the environement texture)
  133912. */
  133913. primaryColor: Color3;
  133914. protected __perceptualColor: Nullable<Color3>;
  133915. /**
  133916. * Experimental Internal Use Only.
  133917. *
  133918. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  133919. * This acts as a helper to set the primary color to a more "human friendly" value.
  133920. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  133921. * output color as close as possible from the chosen value.
  133922. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  133923. * part of lighting setup.)
  133924. */
  133925. get _perceptualColor(): Nullable<Color3>;
  133926. set _perceptualColor(value: Nullable<Color3>);
  133927. protected _primaryColorShadowLevel: float;
  133928. /**
  133929. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  133930. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  133931. */
  133932. get primaryColorShadowLevel(): float;
  133933. set primaryColorShadowLevel(value: float);
  133934. protected _primaryColorHighlightLevel: float;
  133935. /**
  133936. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  133937. * The primary color is used at the level chosen to define what the white area would look.
  133938. */
  133939. get primaryColorHighlightLevel(): float;
  133940. set primaryColorHighlightLevel(value: float);
  133941. protected _reflectionTexture: Nullable<BaseTexture>;
  133942. /**
  133943. * Reflection Texture used in the material.
  133944. * Should be author in a specific way for the best result (refer to the documentation).
  133945. */
  133946. reflectionTexture: Nullable<BaseTexture>;
  133947. protected _reflectionBlur: float;
  133948. /**
  133949. * Reflection Texture level of blur.
  133950. *
  133951. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  133952. * texture twice.
  133953. */
  133954. reflectionBlur: float;
  133955. protected _diffuseTexture: Nullable<BaseTexture>;
  133956. /**
  133957. * Diffuse Texture used in the material.
  133958. * Should be author in a specific way for the best result (refer to the documentation).
  133959. */
  133960. diffuseTexture: Nullable<BaseTexture>;
  133961. protected _shadowLights: Nullable<IShadowLight[]>;
  133962. /**
  133963. * Specify the list of lights casting shadow on the material.
  133964. * All scene shadow lights will be included if null.
  133965. */
  133966. shadowLights: Nullable<IShadowLight[]>;
  133967. protected _shadowLevel: float;
  133968. /**
  133969. * Helps adjusting the shadow to a softer level if required.
  133970. * 0 means black shadows and 1 means no shadows.
  133971. */
  133972. shadowLevel: float;
  133973. protected _sceneCenter: Vector3;
  133974. /**
  133975. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  133976. * It is usually zero but might be interesting to modify according to your setup.
  133977. */
  133978. sceneCenter: Vector3;
  133979. protected _opacityFresnel: boolean;
  133980. /**
  133981. * This helps specifying that the material is falling off to the sky box at grazing angle.
  133982. * This helps ensuring a nice transition when the camera goes under the ground.
  133983. */
  133984. opacityFresnel: boolean;
  133985. protected _reflectionFresnel: boolean;
  133986. /**
  133987. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  133988. * This helps adding a mirror texture on the ground.
  133989. */
  133990. reflectionFresnel: boolean;
  133991. protected _reflectionFalloffDistance: number;
  133992. /**
  133993. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  133994. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  133995. */
  133996. reflectionFalloffDistance: number;
  133997. protected _reflectionAmount: number;
  133998. /**
  133999. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  134000. */
  134001. reflectionAmount: number;
  134002. protected _reflectionReflectance0: number;
  134003. /**
  134004. * This specifies the weight of the reflection at grazing angle.
  134005. */
  134006. reflectionReflectance0: number;
  134007. protected _reflectionReflectance90: number;
  134008. /**
  134009. * This specifies the weight of the reflection at a perpendicular point of view.
  134010. */
  134011. reflectionReflectance90: number;
  134012. /**
  134013. * Sets the reflection reflectance fresnel values according to the default standard
  134014. * empirically know to work well :-)
  134015. */
  134016. set reflectionStandardFresnelWeight(value: number);
  134017. protected _useRGBColor: boolean;
  134018. /**
  134019. * Helps to directly use the maps channels instead of their level.
  134020. */
  134021. useRGBColor: boolean;
  134022. protected _enableNoise: boolean;
  134023. /**
  134024. * This helps reducing the banding effect that could occur on the background.
  134025. */
  134026. enableNoise: boolean;
  134027. /**
  134028. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134029. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  134030. * Recommended to be keep at 1.0 except for special cases.
  134031. */
  134032. get fovMultiplier(): number;
  134033. set fovMultiplier(value: number);
  134034. private _fovMultiplier;
  134035. /**
  134036. * Enable the FOV adjustment feature controlled by fovMultiplier.
  134037. */
  134038. useEquirectangularFOV: boolean;
  134039. private _maxSimultaneousLights;
  134040. /**
  134041. * Number of Simultaneous lights allowed on the material.
  134042. */
  134043. maxSimultaneousLights: int;
  134044. private _shadowOnly;
  134045. /**
  134046. * Make the material only render shadows
  134047. */
  134048. shadowOnly: boolean;
  134049. /**
  134050. * Default configuration related to image processing available in the Background Material.
  134051. */
  134052. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134053. /**
  134054. * Keep track of the image processing observer to allow dispose and replace.
  134055. */
  134056. private _imageProcessingObserver;
  134057. /**
  134058. * Attaches a new image processing configuration to the PBR Material.
  134059. * @param configuration (if null the scene configuration will be use)
  134060. */
  134061. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134062. /**
  134063. * Gets the image processing configuration used either in this material.
  134064. */
  134065. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  134066. /**
  134067. * Sets the Default image processing configuration used either in the this material.
  134068. *
  134069. * If sets to null, the scene one is in use.
  134070. */
  134071. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  134072. /**
  134073. * Gets wether the color curves effect is enabled.
  134074. */
  134075. get cameraColorCurvesEnabled(): boolean;
  134076. /**
  134077. * Sets wether the color curves effect is enabled.
  134078. */
  134079. set cameraColorCurvesEnabled(value: boolean);
  134080. /**
  134081. * Gets wether the color grading effect is enabled.
  134082. */
  134083. get cameraColorGradingEnabled(): boolean;
  134084. /**
  134085. * Gets wether the color grading effect is enabled.
  134086. */
  134087. set cameraColorGradingEnabled(value: boolean);
  134088. /**
  134089. * Gets wether tonemapping is enabled or not.
  134090. */
  134091. get cameraToneMappingEnabled(): boolean;
  134092. /**
  134093. * Sets wether tonemapping is enabled or not
  134094. */
  134095. set cameraToneMappingEnabled(value: boolean);
  134096. /**
  134097. * The camera exposure used on this material.
  134098. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134099. * This corresponds to a photographic exposure.
  134100. */
  134101. get cameraExposure(): float;
  134102. /**
  134103. * The camera exposure used on this material.
  134104. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134105. * This corresponds to a photographic exposure.
  134106. */
  134107. set cameraExposure(value: float);
  134108. /**
  134109. * Gets The camera contrast used on this material.
  134110. */
  134111. get cameraContrast(): float;
  134112. /**
  134113. * Sets The camera contrast used on this material.
  134114. */
  134115. set cameraContrast(value: float);
  134116. /**
  134117. * Gets the Color Grading 2D Lookup Texture.
  134118. */
  134119. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  134120. /**
  134121. * Sets the Color Grading 2D Lookup Texture.
  134122. */
  134123. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  134124. /**
  134125. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134126. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134127. * 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;
  134128. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134129. */
  134130. get cameraColorCurves(): Nullable<ColorCurves>;
  134131. /**
  134132. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134133. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134134. * 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;
  134135. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134136. */
  134137. set cameraColorCurves(value: Nullable<ColorCurves>);
  134138. /**
  134139. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  134140. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  134141. */
  134142. switchToBGR: boolean;
  134143. private _renderTargets;
  134144. private _reflectionControls;
  134145. private _white;
  134146. private _primaryShadowColor;
  134147. private _primaryHighlightColor;
  134148. /**
  134149. * Instantiates a Background Material in the given scene
  134150. * @param name The friendly name of the material
  134151. * @param scene The scene to add the material to
  134152. */
  134153. constructor(name: string, scene: Scene);
  134154. /**
  134155. * Gets a boolean indicating that current material needs to register RTT
  134156. */
  134157. get hasRenderTargetTextures(): boolean;
  134158. /**
  134159. * The entire material has been created in order to prevent overdraw.
  134160. * @returns false
  134161. */
  134162. needAlphaTesting(): boolean;
  134163. /**
  134164. * The entire material has been created in order to prevent overdraw.
  134165. * @returns true if blending is enable
  134166. */
  134167. needAlphaBlending(): boolean;
  134168. /**
  134169. * Checks wether the material is ready to be rendered for a given mesh.
  134170. * @param mesh The mesh to render
  134171. * @param subMesh The submesh to check against
  134172. * @param useInstances Specify wether or not the material is used with instances
  134173. * @returns true if all the dependencies are ready (Textures, Effects...)
  134174. */
  134175. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  134176. /**
  134177. * Compute the primary color according to the chosen perceptual color.
  134178. */
  134179. private _computePrimaryColorFromPerceptualColor;
  134180. /**
  134181. * Compute the highlights and shadow colors according to their chosen levels.
  134182. */
  134183. private _computePrimaryColors;
  134184. /**
  134185. * Build the uniform buffer used in the material.
  134186. */
  134187. buildUniformLayout(): void;
  134188. /**
  134189. * Unbind the material.
  134190. */
  134191. unbind(): void;
  134192. /**
  134193. * Bind only the world matrix to the material.
  134194. * @param world The world matrix to bind.
  134195. */
  134196. bindOnlyWorldMatrix(world: Matrix): void;
  134197. /**
  134198. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  134199. * @param world The world matrix to bind.
  134200. * @param subMesh The submesh to bind for.
  134201. */
  134202. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  134203. /**
  134204. * Checks to see if a texture is used in the material.
  134205. * @param texture - Base texture to use.
  134206. * @returns - Boolean specifying if a texture is used in the material.
  134207. */
  134208. hasTexture(texture: BaseTexture): boolean;
  134209. /**
  134210. * Dispose the material.
  134211. * @param forceDisposeEffect Force disposal of the associated effect.
  134212. * @param forceDisposeTextures Force disposal of the associated textures.
  134213. */
  134214. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  134215. /**
  134216. * Clones the material.
  134217. * @param name The cloned name.
  134218. * @returns The cloned material.
  134219. */
  134220. clone(name: string): BackgroundMaterial;
  134221. /**
  134222. * Serializes the current material to its JSON representation.
  134223. * @returns The JSON representation.
  134224. */
  134225. serialize(): any;
  134226. /**
  134227. * Gets the class name of the material
  134228. * @returns "BackgroundMaterial"
  134229. */
  134230. getClassName(): string;
  134231. /**
  134232. * Parse a JSON input to create back a background material.
  134233. * @param source The JSON data to parse
  134234. * @param scene The scene to create the parsed material in
  134235. * @param rootUrl The root url of the assets the material depends upon
  134236. * @returns the instantiated BackgroundMaterial.
  134237. */
  134238. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  134239. }
  134240. }
  134241. declare module BABYLON {
  134242. /**
  134243. * Represents the different options available during the creation of
  134244. * a Environment helper.
  134245. *
  134246. * This can control the default ground, skybox and image processing setup of your scene.
  134247. */
  134248. export interface IEnvironmentHelperOptions {
  134249. /**
  134250. * Specifies whether or not to create a ground.
  134251. * True by default.
  134252. */
  134253. createGround: boolean;
  134254. /**
  134255. * Specifies the ground size.
  134256. * 15 by default.
  134257. */
  134258. groundSize: number;
  134259. /**
  134260. * The texture used on the ground for the main color.
  134261. * Comes from the BabylonJS CDN by default.
  134262. *
  134263. * Remarks: Can be either a texture or a url.
  134264. */
  134265. groundTexture: string | BaseTexture;
  134266. /**
  134267. * The color mixed in the ground texture by default.
  134268. * BabylonJS clearColor by default.
  134269. */
  134270. groundColor: Color3;
  134271. /**
  134272. * Specifies the ground opacity.
  134273. * 1 by default.
  134274. */
  134275. groundOpacity: number;
  134276. /**
  134277. * Enables the ground to receive shadows.
  134278. * True by default.
  134279. */
  134280. enableGroundShadow: boolean;
  134281. /**
  134282. * Helps preventing the shadow to be fully black on the ground.
  134283. * 0.5 by default.
  134284. */
  134285. groundShadowLevel: number;
  134286. /**
  134287. * Creates a mirror texture attach to the ground.
  134288. * false by default.
  134289. */
  134290. enableGroundMirror: boolean;
  134291. /**
  134292. * Specifies the ground mirror size ratio.
  134293. * 0.3 by default as the default kernel is 64.
  134294. */
  134295. groundMirrorSizeRatio: number;
  134296. /**
  134297. * Specifies the ground mirror blur kernel size.
  134298. * 64 by default.
  134299. */
  134300. groundMirrorBlurKernel: number;
  134301. /**
  134302. * Specifies the ground mirror visibility amount.
  134303. * 1 by default
  134304. */
  134305. groundMirrorAmount: number;
  134306. /**
  134307. * Specifies the ground mirror reflectance weight.
  134308. * This uses the standard weight of the background material to setup the fresnel effect
  134309. * of the mirror.
  134310. * 1 by default.
  134311. */
  134312. groundMirrorFresnelWeight: number;
  134313. /**
  134314. * Specifies the ground mirror Falloff distance.
  134315. * This can helps reducing the size of the reflection.
  134316. * 0 by Default.
  134317. */
  134318. groundMirrorFallOffDistance: number;
  134319. /**
  134320. * Specifies the ground mirror texture type.
  134321. * Unsigned Int by Default.
  134322. */
  134323. groundMirrorTextureType: number;
  134324. /**
  134325. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  134326. * the shown objects.
  134327. */
  134328. groundYBias: number;
  134329. /**
  134330. * Specifies whether or not to create a skybox.
  134331. * True by default.
  134332. */
  134333. createSkybox: boolean;
  134334. /**
  134335. * Specifies the skybox size.
  134336. * 20 by default.
  134337. */
  134338. skyboxSize: number;
  134339. /**
  134340. * The texture used on the skybox for the main color.
  134341. * Comes from the BabylonJS CDN by default.
  134342. *
  134343. * Remarks: Can be either a texture or a url.
  134344. */
  134345. skyboxTexture: string | BaseTexture;
  134346. /**
  134347. * The color mixed in the skybox texture by default.
  134348. * BabylonJS clearColor by default.
  134349. */
  134350. skyboxColor: Color3;
  134351. /**
  134352. * The background rotation around the Y axis of the scene.
  134353. * This helps aligning the key lights of your scene with the background.
  134354. * 0 by default.
  134355. */
  134356. backgroundYRotation: number;
  134357. /**
  134358. * Compute automatically the size of the elements to best fit with the scene.
  134359. */
  134360. sizeAuto: boolean;
  134361. /**
  134362. * Default position of the rootMesh if autoSize is not true.
  134363. */
  134364. rootPosition: Vector3;
  134365. /**
  134366. * Sets up the image processing in the scene.
  134367. * true by default.
  134368. */
  134369. setupImageProcessing: boolean;
  134370. /**
  134371. * The texture used as your environment texture in the scene.
  134372. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  134373. *
  134374. * Remarks: Can be either a texture or a url.
  134375. */
  134376. environmentTexture: string | BaseTexture;
  134377. /**
  134378. * The value of the exposure to apply to the scene.
  134379. * 0.6 by default if setupImageProcessing is true.
  134380. */
  134381. cameraExposure: number;
  134382. /**
  134383. * The value of the contrast to apply to the scene.
  134384. * 1.6 by default if setupImageProcessing is true.
  134385. */
  134386. cameraContrast: number;
  134387. /**
  134388. * Specifies whether or not tonemapping should be enabled in the scene.
  134389. * true by default if setupImageProcessing is true.
  134390. */
  134391. toneMappingEnabled: boolean;
  134392. }
  134393. /**
  134394. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  134395. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  134396. * It also helps with the default setup of your imageProcessing configuration.
  134397. */
  134398. export class EnvironmentHelper {
  134399. /**
  134400. * Default ground texture URL.
  134401. */
  134402. private static _groundTextureCDNUrl;
  134403. /**
  134404. * Default skybox texture URL.
  134405. */
  134406. private static _skyboxTextureCDNUrl;
  134407. /**
  134408. * Default environment texture URL.
  134409. */
  134410. private static _environmentTextureCDNUrl;
  134411. /**
  134412. * Creates the default options for the helper.
  134413. */
  134414. private static _getDefaultOptions;
  134415. private _rootMesh;
  134416. /**
  134417. * Gets the root mesh created by the helper.
  134418. */
  134419. get rootMesh(): Mesh;
  134420. private _skybox;
  134421. /**
  134422. * Gets the skybox created by the helper.
  134423. */
  134424. get skybox(): Nullable<Mesh>;
  134425. private _skyboxTexture;
  134426. /**
  134427. * Gets the skybox texture created by the helper.
  134428. */
  134429. get skyboxTexture(): Nullable<BaseTexture>;
  134430. private _skyboxMaterial;
  134431. /**
  134432. * Gets the skybox material created by the helper.
  134433. */
  134434. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  134435. private _ground;
  134436. /**
  134437. * Gets the ground mesh created by the helper.
  134438. */
  134439. get ground(): Nullable<Mesh>;
  134440. private _groundTexture;
  134441. /**
  134442. * Gets the ground texture created by the helper.
  134443. */
  134444. get groundTexture(): Nullable<BaseTexture>;
  134445. private _groundMirror;
  134446. /**
  134447. * Gets the ground mirror created by the helper.
  134448. */
  134449. get groundMirror(): Nullable<MirrorTexture>;
  134450. /**
  134451. * Gets the ground mirror render list to helps pushing the meshes
  134452. * you wish in the ground reflection.
  134453. */
  134454. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  134455. private _groundMaterial;
  134456. /**
  134457. * Gets the ground material created by the helper.
  134458. */
  134459. get groundMaterial(): Nullable<BackgroundMaterial>;
  134460. /**
  134461. * Stores the creation options.
  134462. */
  134463. private readonly _scene;
  134464. private _options;
  134465. /**
  134466. * This observable will be notified with any error during the creation of the environment,
  134467. * mainly texture creation errors.
  134468. */
  134469. onErrorObservable: Observable<{
  134470. message?: string;
  134471. exception?: any;
  134472. }>;
  134473. /**
  134474. * constructor
  134475. * @param options Defines the options we want to customize the helper
  134476. * @param scene The scene to add the material to
  134477. */
  134478. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  134479. /**
  134480. * Updates the background according to the new options
  134481. * @param options
  134482. */
  134483. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  134484. /**
  134485. * Sets the primary color of all the available elements.
  134486. * @param color the main color to affect to the ground and the background
  134487. */
  134488. setMainColor(color: Color3): void;
  134489. /**
  134490. * Setup the image processing according to the specified options.
  134491. */
  134492. private _setupImageProcessing;
  134493. /**
  134494. * Setup the environment texture according to the specified options.
  134495. */
  134496. private _setupEnvironmentTexture;
  134497. /**
  134498. * Setup the background according to the specified options.
  134499. */
  134500. private _setupBackground;
  134501. /**
  134502. * Get the scene sizes according to the setup.
  134503. */
  134504. private _getSceneSize;
  134505. /**
  134506. * Setup the ground according to the specified options.
  134507. */
  134508. private _setupGround;
  134509. /**
  134510. * Setup the ground material according to the specified options.
  134511. */
  134512. private _setupGroundMaterial;
  134513. /**
  134514. * Setup the ground diffuse texture according to the specified options.
  134515. */
  134516. private _setupGroundDiffuseTexture;
  134517. /**
  134518. * Setup the ground mirror texture according to the specified options.
  134519. */
  134520. private _setupGroundMirrorTexture;
  134521. /**
  134522. * Setup the ground to receive the mirror texture.
  134523. */
  134524. private _setupMirrorInGroundMaterial;
  134525. /**
  134526. * Setup the skybox according to the specified options.
  134527. */
  134528. private _setupSkybox;
  134529. /**
  134530. * Setup the skybox material according to the specified options.
  134531. */
  134532. private _setupSkyboxMaterial;
  134533. /**
  134534. * Setup the skybox reflection texture according to the specified options.
  134535. */
  134536. private _setupSkyboxReflectionTexture;
  134537. private _errorHandler;
  134538. /**
  134539. * Dispose all the elements created by the Helper.
  134540. */
  134541. dispose(): void;
  134542. }
  134543. }
  134544. declare module BABYLON {
  134545. /**
  134546. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  134547. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  134548. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134549. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134550. */
  134551. export abstract class TextureDome<T extends Texture> extends TransformNode {
  134552. protected onError: Nullable<(message?: string, exception?: any) => void>;
  134553. /**
  134554. * Define the source as a Monoscopic panoramic 360/180.
  134555. */
  134556. static readonly MODE_MONOSCOPIC: number;
  134557. /**
  134558. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  134559. */
  134560. static readonly MODE_TOPBOTTOM: number;
  134561. /**
  134562. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  134563. */
  134564. static readonly MODE_SIDEBYSIDE: number;
  134565. private _halfDome;
  134566. protected _useDirectMapping: boolean;
  134567. /**
  134568. * The texture being displayed on the sphere
  134569. */
  134570. protected _texture: T;
  134571. /**
  134572. * Gets the texture being displayed on the sphere
  134573. */
  134574. get texture(): T;
  134575. /**
  134576. * Sets the texture being displayed on the sphere
  134577. */
  134578. set texture(newTexture: T);
  134579. /**
  134580. * The skybox material
  134581. */
  134582. protected _material: BackgroundMaterial;
  134583. /**
  134584. * The surface used for the dome
  134585. */
  134586. protected _mesh: Mesh;
  134587. /**
  134588. * Gets the mesh used for the dome.
  134589. */
  134590. get mesh(): Mesh;
  134591. /**
  134592. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  134593. */
  134594. private _halfDomeMask;
  134595. /**
  134596. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134597. * Also see the options.resolution property.
  134598. */
  134599. get fovMultiplier(): number;
  134600. set fovMultiplier(value: number);
  134601. protected _textureMode: number;
  134602. /**
  134603. * Gets or set the current texture mode for the texture. It can be:
  134604. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134605. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134606. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134607. */
  134608. get textureMode(): number;
  134609. /**
  134610. * Sets the current texture mode for the texture. It can be:
  134611. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134612. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134613. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134614. */
  134615. set textureMode(value: number);
  134616. /**
  134617. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  134618. */
  134619. get halfDome(): boolean;
  134620. /**
  134621. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  134622. */
  134623. set halfDome(enabled: boolean);
  134624. /**
  134625. * Oberserver used in Stereoscopic VR Mode.
  134626. */
  134627. private _onBeforeCameraRenderObserver;
  134628. /**
  134629. * Observable raised when an error occured while loading the 360 image
  134630. */
  134631. onLoadErrorObservable: Observable<string>;
  134632. /**
  134633. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  134634. * @param name Element's name, child elements will append suffixes for their own names.
  134635. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  134636. * @param options An object containing optional or exposed sub element properties
  134637. */
  134638. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  134639. resolution?: number;
  134640. clickToPlay?: boolean;
  134641. autoPlay?: boolean;
  134642. loop?: boolean;
  134643. size?: number;
  134644. poster?: string;
  134645. faceForward?: boolean;
  134646. useDirectMapping?: boolean;
  134647. halfDomeMode?: boolean;
  134648. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  134649. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  134650. protected _changeTextureMode(value: number): void;
  134651. /**
  134652. * Releases resources associated with this node.
  134653. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134654. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134655. */
  134656. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134657. }
  134658. }
  134659. declare module BABYLON {
  134660. /**
  134661. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  134662. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  134663. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134664. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134665. */
  134666. export class PhotoDome extends TextureDome<Texture> {
  134667. /**
  134668. * Define the image as a Monoscopic panoramic 360 image.
  134669. */
  134670. static readonly MODE_MONOSCOPIC: number;
  134671. /**
  134672. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134673. */
  134674. static readonly MODE_TOPBOTTOM: number;
  134675. /**
  134676. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134677. */
  134678. static readonly MODE_SIDEBYSIDE: number;
  134679. /**
  134680. * Gets or sets the texture being displayed on the sphere
  134681. */
  134682. get photoTexture(): Texture;
  134683. /**
  134684. * sets the texture being displayed on the sphere
  134685. */
  134686. set photoTexture(value: Texture);
  134687. /**
  134688. * Gets the current video mode for the video. It can be:
  134689. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134690. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134691. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134692. */
  134693. get imageMode(): number;
  134694. /**
  134695. * Sets the current video mode for the video. It can be:
  134696. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134697. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134698. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134699. */
  134700. set imageMode(value: number);
  134701. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  134702. }
  134703. }
  134704. declare module BABYLON {
  134705. /**
  134706. * Class used to host RGBD texture specific utilities
  134707. */
  134708. export class RGBDTextureTools {
  134709. /**
  134710. * Expand the RGBD Texture from RGBD to Half Float if possible.
  134711. * @param texture the texture to expand.
  134712. */
  134713. static ExpandRGBDTexture(texture: Texture): void;
  134714. }
  134715. }
  134716. declare module BABYLON {
  134717. /**
  134718. * Class used to host texture specific utilities
  134719. */
  134720. export class BRDFTextureTools {
  134721. /**
  134722. * Prevents texture cache collision
  134723. */
  134724. private static _instanceNumber;
  134725. /**
  134726. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  134727. * @param scene defines the hosting scene
  134728. * @returns the environment BRDF texture
  134729. */
  134730. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  134731. private static _environmentBRDFBase64Texture;
  134732. }
  134733. }
  134734. declare module BABYLON {
  134735. /**
  134736. * @hidden
  134737. */
  134738. export interface IMaterialClearCoatDefines {
  134739. CLEARCOAT: boolean;
  134740. CLEARCOAT_DEFAULTIOR: boolean;
  134741. CLEARCOAT_TEXTURE: boolean;
  134742. CLEARCOAT_TEXTUREDIRECTUV: number;
  134743. CLEARCOAT_BUMP: boolean;
  134744. CLEARCOAT_BUMPDIRECTUV: number;
  134745. CLEARCOAT_TINT: boolean;
  134746. CLEARCOAT_TINT_TEXTURE: boolean;
  134747. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134748. /** @hidden */
  134749. _areTexturesDirty: boolean;
  134750. }
  134751. /**
  134752. * Define the code related to the clear coat parameters of the pbr material.
  134753. */
  134754. export class PBRClearCoatConfiguration {
  134755. /**
  134756. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134757. * The default fits with a polyurethane material.
  134758. */
  134759. private static readonly _DefaultIndexOfRefraction;
  134760. private _isEnabled;
  134761. /**
  134762. * Defines if the clear coat is enabled in the material.
  134763. */
  134764. isEnabled: boolean;
  134765. /**
  134766. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  134767. */
  134768. intensity: number;
  134769. /**
  134770. * Defines the clear coat layer roughness.
  134771. */
  134772. roughness: number;
  134773. private _indexOfRefraction;
  134774. /**
  134775. * Defines the index of refraction of the clear coat.
  134776. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134777. * The default fits with a polyurethane material.
  134778. * Changing the default value is more performance intensive.
  134779. */
  134780. indexOfRefraction: number;
  134781. private _texture;
  134782. /**
  134783. * Stores the clear coat values in a texture.
  134784. */
  134785. texture: Nullable<BaseTexture>;
  134786. private _bumpTexture;
  134787. /**
  134788. * Define the clear coat specific bump texture.
  134789. */
  134790. bumpTexture: Nullable<BaseTexture>;
  134791. private _isTintEnabled;
  134792. /**
  134793. * Defines if the clear coat tint is enabled in the material.
  134794. */
  134795. isTintEnabled: boolean;
  134796. /**
  134797. * Defines the clear coat tint of the material.
  134798. * This is only use if tint is enabled
  134799. */
  134800. tintColor: Color3;
  134801. /**
  134802. * Defines the distance at which the tint color should be found in the
  134803. * clear coat media.
  134804. * This is only use if tint is enabled
  134805. */
  134806. tintColorAtDistance: number;
  134807. /**
  134808. * Defines the clear coat layer thickness.
  134809. * This is only use if tint is enabled
  134810. */
  134811. tintThickness: number;
  134812. private _tintTexture;
  134813. /**
  134814. * Stores the clear tint values in a texture.
  134815. * rgb is tint
  134816. * a is a thickness factor
  134817. */
  134818. tintTexture: Nullable<BaseTexture>;
  134819. /** @hidden */
  134820. private _internalMarkAllSubMeshesAsTexturesDirty;
  134821. /** @hidden */
  134822. _markAllSubMeshesAsTexturesDirty(): void;
  134823. /**
  134824. * Instantiate a new istance of clear coat configuration.
  134825. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134826. */
  134827. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134828. /**
  134829. * Gets wehter the submesh is ready to be used or not.
  134830. * @param defines the list of "defines" to update.
  134831. * @param scene defines the scene the material belongs to.
  134832. * @param engine defines the engine the material belongs to.
  134833. * @param disableBumpMap defines wether the material disables bump or not.
  134834. * @returns - boolean indicating that the submesh is ready or not.
  134835. */
  134836. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  134837. /**
  134838. * Checks to see if a texture is used in the material.
  134839. * @param defines the list of "defines" to update.
  134840. * @param scene defines the scene to the material belongs to.
  134841. */
  134842. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  134843. /**
  134844. * Binds the material data.
  134845. * @param uniformBuffer defines the Uniform buffer to fill in.
  134846. * @param scene defines the scene the material belongs to.
  134847. * @param engine defines the engine the material belongs to.
  134848. * @param disableBumpMap defines wether the material disables bump or not.
  134849. * @param isFrozen defines wether the material is frozen or not.
  134850. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  134851. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  134852. */
  134853. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  134854. /**
  134855. * Checks to see if a texture is used in the material.
  134856. * @param texture - Base texture to use.
  134857. * @returns - Boolean specifying if a texture is used in the material.
  134858. */
  134859. hasTexture(texture: BaseTexture): boolean;
  134860. /**
  134861. * Returns an array of the actively used textures.
  134862. * @param activeTextures Array of BaseTextures
  134863. */
  134864. getActiveTextures(activeTextures: BaseTexture[]): void;
  134865. /**
  134866. * Returns the animatable textures.
  134867. * @param animatables Array of animatable textures.
  134868. */
  134869. getAnimatables(animatables: IAnimatable[]): void;
  134870. /**
  134871. * Disposes the resources of the material.
  134872. * @param forceDisposeTextures - Forces the disposal of all textures.
  134873. */
  134874. dispose(forceDisposeTextures?: boolean): void;
  134875. /**
  134876. * Get the current class name of the texture useful for serialization or dynamic coding.
  134877. * @returns "PBRClearCoatConfiguration"
  134878. */
  134879. getClassName(): string;
  134880. /**
  134881. * Add fallbacks to the effect fallbacks list.
  134882. * @param defines defines the Base texture to use.
  134883. * @param fallbacks defines the current fallback list.
  134884. * @param currentRank defines the current fallback rank.
  134885. * @returns the new fallback rank.
  134886. */
  134887. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134888. /**
  134889. * Add the required uniforms to the current list.
  134890. * @param uniforms defines the current uniform list.
  134891. */
  134892. static AddUniforms(uniforms: string[]): void;
  134893. /**
  134894. * Add the required samplers to the current list.
  134895. * @param samplers defines the current sampler list.
  134896. */
  134897. static AddSamplers(samplers: string[]): void;
  134898. /**
  134899. * Add the required uniforms to the current buffer.
  134900. * @param uniformBuffer defines the current uniform buffer.
  134901. */
  134902. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134903. /**
  134904. * Makes a duplicate of the current configuration into another one.
  134905. * @param clearCoatConfiguration define the config where to copy the info
  134906. */
  134907. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  134908. /**
  134909. * Serializes this clear coat configuration.
  134910. * @returns - An object with the serialized config.
  134911. */
  134912. serialize(): any;
  134913. /**
  134914. * Parses a anisotropy Configuration from a serialized object.
  134915. * @param source - Serialized object.
  134916. * @param scene Defines the scene we are parsing for
  134917. * @param rootUrl Defines the rootUrl to load from
  134918. */
  134919. parse(source: any, scene: Scene, rootUrl: string): void;
  134920. }
  134921. }
  134922. declare module BABYLON {
  134923. /**
  134924. * @hidden
  134925. */
  134926. export interface IMaterialAnisotropicDefines {
  134927. ANISOTROPIC: boolean;
  134928. ANISOTROPIC_TEXTURE: boolean;
  134929. ANISOTROPIC_TEXTUREDIRECTUV: number;
  134930. MAINUV1: boolean;
  134931. _areTexturesDirty: boolean;
  134932. _needUVs: boolean;
  134933. }
  134934. /**
  134935. * Define the code related to the anisotropic parameters of the pbr material.
  134936. */
  134937. export class PBRAnisotropicConfiguration {
  134938. private _isEnabled;
  134939. /**
  134940. * Defines if the anisotropy is enabled in the material.
  134941. */
  134942. isEnabled: boolean;
  134943. /**
  134944. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  134945. */
  134946. intensity: number;
  134947. /**
  134948. * Defines if the effect is along the tangents, bitangents or in between.
  134949. * By default, the effect is "strectching" the highlights along the tangents.
  134950. */
  134951. direction: Vector2;
  134952. private _texture;
  134953. /**
  134954. * Stores the anisotropy values in a texture.
  134955. * rg is direction (like normal from -1 to 1)
  134956. * b is a intensity
  134957. */
  134958. texture: Nullable<BaseTexture>;
  134959. /** @hidden */
  134960. private _internalMarkAllSubMeshesAsTexturesDirty;
  134961. /** @hidden */
  134962. _markAllSubMeshesAsTexturesDirty(): void;
  134963. /**
  134964. * Instantiate a new istance of anisotropy configuration.
  134965. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134966. */
  134967. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134968. /**
  134969. * Specifies that the submesh is ready to be used.
  134970. * @param defines the list of "defines" to update.
  134971. * @param scene defines the scene the material belongs to.
  134972. * @returns - boolean indicating that the submesh is ready or not.
  134973. */
  134974. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  134975. /**
  134976. * Checks to see if a texture is used in the material.
  134977. * @param defines the list of "defines" to update.
  134978. * @param mesh the mesh we are preparing the defines for.
  134979. * @param scene defines the scene the material belongs to.
  134980. */
  134981. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  134982. /**
  134983. * Binds the material data.
  134984. * @param uniformBuffer defines the Uniform buffer to fill in.
  134985. * @param scene defines the scene the material belongs to.
  134986. * @param isFrozen defines wether the material is frozen or not.
  134987. */
  134988. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  134989. /**
  134990. * Checks to see if a texture is used in the material.
  134991. * @param texture - Base texture to use.
  134992. * @returns - Boolean specifying if a texture is used in the material.
  134993. */
  134994. hasTexture(texture: BaseTexture): boolean;
  134995. /**
  134996. * Returns an array of the actively used textures.
  134997. * @param activeTextures Array of BaseTextures
  134998. */
  134999. getActiveTextures(activeTextures: BaseTexture[]): void;
  135000. /**
  135001. * Returns the animatable textures.
  135002. * @param animatables Array of animatable textures.
  135003. */
  135004. getAnimatables(animatables: IAnimatable[]): void;
  135005. /**
  135006. * Disposes the resources of the material.
  135007. * @param forceDisposeTextures - Forces the disposal of all textures.
  135008. */
  135009. dispose(forceDisposeTextures?: boolean): void;
  135010. /**
  135011. * Get the current class name of the texture useful for serialization or dynamic coding.
  135012. * @returns "PBRAnisotropicConfiguration"
  135013. */
  135014. getClassName(): string;
  135015. /**
  135016. * Add fallbacks to the effect fallbacks list.
  135017. * @param defines defines the Base texture to use.
  135018. * @param fallbacks defines the current fallback list.
  135019. * @param currentRank defines the current fallback rank.
  135020. * @returns the new fallback rank.
  135021. */
  135022. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135023. /**
  135024. * Add the required uniforms to the current list.
  135025. * @param uniforms defines the current uniform list.
  135026. */
  135027. static AddUniforms(uniforms: string[]): void;
  135028. /**
  135029. * Add the required uniforms to the current buffer.
  135030. * @param uniformBuffer defines the current uniform buffer.
  135031. */
  135032. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135033. /**
  135034. * Add the required samplers to the current list.
  135035. * @param samplers defines the current sampler list.
  135036. */
  135037. static AddSamplers(samplers: string[]): void;
  135038. /**
  135039. * Makes a duplicate of the current configuration into another one.
  135040. * @param anisotropicConfiguration define the config where to copy the info
  135041. */
  135042. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  135043. /**
  135044. * Serializes this anisotropy configuration.
  135045. * @returns - An object with the serialized config.
  135046. */
  135047. serialize(): any;
  135048. /**
  135049. * Parses a anisotropy Configuration from a serialized object.
  135050. * @param source - Serialized object.
  135051. * @param scene Defines the scene we are parsing for
  135052. * @param rootUrl Defines the rootUrl to load from
  135053. */
  135054. parse(source: any, scene: Scene, rootUrl: string): void;
  135055. }
  135056. }
  135057. declare module BABYLON {
  135058. /**
  135059. * @hidden
  135060. */
  135061. export interface IMaterialBRDFDefines {
  135062. BRDF_V_HEIGHT_CORRELATED: boolean;
  135063. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135064. SPHERICAL_HARMONICS: boolean;
  135065. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135066. /** @hidden */
  135067. _areMiscDirty: boolean;
  135068. }
  135069. /**
  135070. * Define the code related to the BRDF parameters of the pbr material.
  135071. */
  135072. export class PBRBRDFConfiguration {
  135073. /**
  135074. * Default value used for the energy conservation.
  135075. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135076. */
  135077. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  135078. /**
  135079. * Default value used for the Smith Visibility Height Correlated mode.
  135080. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135081. */
  135082. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  135083. /**
  135084. * Default value used for the IBL diffuse part.
  135085. * This can help switching back to the polynomials mode globally which is a tiny bit
  135086. * less GPU intensive at the drawback of a lower quality.
  135087. */
  135088. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  135089. /**
  135090. * Default value used for activating energy conservation for the specular workflow.
  135091. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135092. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135093. */
  135094. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  135095. private _useEnergyConservation;
  135096. /**
  135097. * Defines if the material uses energy conservation.
  135098. */
  135099. useEnergyConservation: boolean;
  135100. private _useSmithVisibilityHeightCorrelated;
  135101. /**
  135102. * LEGACY Mode set to false
  135103. * Defines if the material uses height smith correlated visibility term.
  135104. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  135105. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  135106. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  135107. * Not relying on height correlated will also disable energy conservation.
  135108. */
  135109. useSmithVisibilityHeightCorrelated: boolean;
  135110. private _useSphericalHarmonics;
  135111. /**
  135112. * LEGACY Mode set to false
  135113. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  135114. * diffuse part of the IBL.
  135115. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  135116. * to the ground truth.
  135117. */
  135118. useSphericalHarmonics: boolean;
  135119. private _useSpecularGlossinessInputEnergyConservation;
  135120. /**
  135121. * Defines if the material uses energy conservation, when the specular workflow is active.
  135122. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135123. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135124. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  135125. */
  135126. useSpecularGlossinessInputEnergyConservation: boolean;
  135127. /** @hidden */
  135128. private _internalMarkAllSubMeshesAsMiscDirty;
  135129. /** @hidden */
  135130. _markAllSubMeshesAsMiscDirty(): void;
  135131. /**
  135132. * Instantiate a new istance of clear coat configuration.
  135133. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  135134. */
  135135. constructor(markAllSubMeshesAsMiscDirty: () => void);
  135136. /**
  135137. * Checks to see if a texture is used in the material.
  135138. * @param defines the list of "defines" to update.
  135139. */
  135140. prepareDefines(defines: IMaterialBRDFDefines): void;
  135141. /**
  135142. * Get the current class name of the texture useful for serialization or dynamic coding.
  135143. * @returns "PBRClearCoatConfiguration"
  135144. */
  135145. getClassName(): string;
  135146. /**
  135147. * Makes a duplicate of the current configuration into another one.
  135148. * @param brdfConfiguration define the config where to copy the info
  135149. */
  135150. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  135151. /**
  135152. * Serializes this BRDF configuration.
  135153. * @returns - An object with the serialized config.
  135154. */
  135155. serialize(): any;
  135156. /**
  135157. * Parses a anisotropy Configuration from a serialized object.
  135158. * @param source - Serialized object.
  135159. * @param scene Defines the scene we are parsing for
  135160. * @param rootUrl Defines the rootUrl to load from
  135161. */
  135162. parse(source: any, scene: Scene, rootUrl: string): void;
  135163. }
  135164. }
  135165. declare module BABYLON {
  135166. /**
  135167. * @hidden
  135168. */
  135169. export interface IMaterialSheenDefines {
  135170. SHEEN: boolean;
  135171. SHEEN_TEXTURE: boolean;
  135172. SHEEN_TEXTUREDIRECTUV: number;
  135173. SHEEN_LINKWITHALBEDO: boolean;
  135174. SHEEN_ROUGHNESS: boolean;
  135175. SHEEN_ALBEDOSCALING: boolean;
  135176. /** @hidden */
  135177. _areTexturesDirty: boolean;
  135178. }
  135179. /**
  135180. * Define the code related to the Sheen parameters of the pbr material.
  135181. */
  135182. export class PBRSheenConfiguration {
  135183. private _isEnabled;
  135184. /**
  135185. * Defines if the material uses sheen.
  135186. */
  135187. isEnabled: boolean;
  135188. private _linkSheenWithAlbedo;
  135189. /**
  135190. * Defines if the sheen is linked to the sheen color.
  135191. */
  135192. linkSheenWithAlbedo: boolean;
  135193. /**
  135194. * Defines the sheen intensity.
  135195. */
  135196. intensity: number;
  135197. /**
  135198. * Defines the sheen color.
  135199. */
  135200. color: Color3;
  135201. private _texture;
  135202. /**
  135203. * Stores the sheen tint values in a texture.
  135204. * rgb is tint
  135205. * a is a intensity or roughness if roughness has been defined
  135206. */
  135207. texture: Nullable<BaseTexture>;
  135208. private _roughness;
  135209. /**
  135210. * Defines the sheen roughness.
  135211. * It is not taken into account if linkSheenWithAlbedo is true.
  135212. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  135213. */
  135214. roughness: Nullable<number>;
  135215. private _albedoScaling;
  135216. /**
  135217. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  135218. * It allows the strength of the sheen effect to not depend on the base color of the material,
  135219. * making it easier to setup and tweak the effect
  135220. */
  135221. albedoScaling: boolean;
  135222. /** @hidden */
  135223. private _internalMarkAllSubMeshesAsTexturesDirty;
  135224. /** @hidden */
  135225. _markAllSubMeshesAsTexturesDirty(): void;
  135226. /**
  135227. * Instantiate a new istance of clear coat configuration.
  135228. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135229. */
  135230. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135231. /**
  135232. * Specifies that the submesh is ready to be used.
  135233. * @param defines the list of "defines" to update.
  135234. * @param scene defines the scene the material belongs to.
  135235. * @returns - boolean indicating that the submesh is ready or not.
  135236. */
  135237. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  135238. /**
  135239. * Checks to see if a texture is used in the material.
  135240. * @param defines the list of "defines" to update.
  135241. * @param scene defines the scene the material belongs to.
  135242. */
  135243. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  135244. /**
  135245. * Binds the material data.
  135246. * @param uniformBuffer defines the Uniform buffer to fill in.
  135247. * @param scene defines the scene the material belongs to.
  135248. * @param isFrozen defines wether the material is frozen or not.
  135249. */
  135250. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135251. /**
  135252. * Checks to see if a texture is used in the material.
  135253. * @param texture - Base texture to use.
  135254. * @returns - Boolean specifying if a texture is used in the material.
  135255. */
  135256. hasTexture(texture: BaseTexture): boolean;
  135257. /**
  135258. * Returns an array of the actively used textures.
  135259. * @param activeTextures Array of BaseTextures
  135260. */
  135261. getActiveTextures(activeTextures: BaseTexture[]): void;
  135262. /**
  135263. * Returns the animatable textures.
  135264. * @param animatables Array of animatable textures.
  135265. */
  135266. getAnimatables(animatables: IAnimatable[]): void;
  135267. /**
  135268. * Disposes the resources of the material.
  135269. * @param forceDisposeTextures - Forces the disposal of all textures.
  135270. */
  135271. dispose(forceDisposeTextures?: boolean): void;
  135272. /**
  135273. * Get the current class name of the texture useful for serialization or dynamic coding.
  135274. * @returns "PBRSheenConfiguration"
  135275. */
  135276. getClassName(): string;
  135277. /**
  135278. * Add fallbacks to the effect fallbacks list.
  135279. * @param defines defines the Base texture to use.
  135280. * @param fallbacks defines the current fallback list.
  135281. * @param currentRank defines the current fallback rank.
  135282. * @returns the new fallback rank.
  135283. */
  135284. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135285. /**
  135286. * Add the required uniforms to the current list.
  135287. * @param uniforms defines the current uniform list.
  135288. */
  135289. static AddUniforms(uniforms: string[]): void;
  135290. /**
  135291. * Add the required uniforms to the current buffer.
  135292. * @param uniformBuffer defines the current uniform buffer.
  135293. */
  135294. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135295. /**
  135296. * Add the required samplers to the current list.
  135297. * @param samplers defines the current sampler list.
  135298. */
  135299. static AddSamplers(samplers: string[]): void;
  135300. /**
  135301. * Makes a duplicate of the current configuration into another one.
  135302. * @param sheenConfiguration define the config where to copy the info
  135303. */
  135304. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  135305. /**
  135306. * Serializes this BRDF configuration.
  135307. * @returns - An object with the serialized config.
  135308. */
  135309. serialize(): any;
  135310. /**
  135311. * Parses a anisotropy Configuration from a serialized object.
  135312. * @param source - Serialized object.
  135313. * @param scene Defines the scene we are parsing for
  135314. * @param rootUrl Defines the rootUrl to load from
  135315. */
  135316. parse(source: any, scene: Scene, rootUrl: string): void;
  135317. }
  135318. }
  135319. declare module BABYLON {
  135320. /**
  135321. * @hidden
  135322. */
  135323. export interface IMaterialSubSurfaceDefines {
  135324. SUBSURFACE: boolean;
  135325. SS_REFRACTION: boolean;
  135326. SS_TRANSLUCENCY: boolean;
  135327. SS_SCATTERING: boolean;
  135328. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135329. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135330. SS_REFRACTIONMAP_3D: boolean;
  135331. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135332. SS_LODINREFRACTIONALPHA: boolean;
  135333. SS_GAMMAREFRACTION: boolean;
  135334. SS_RGBDREFRACTION: boolean;
  135335. SS_LINEARSPECULARREFRACTION: boolean;
  135336. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135337. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135338. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135339. /** @hidden */
  135340. _areTexturesDirty: boolean;
  135341. }
  135342. /**
  135343. * Define the code related to the sub surface parameters of the pbr material.
  135344. */
  135345. export class PBRSubSurfaceConfiguration {
  135346. private _isRefractionEnabled;
  135347. /**
  135348. * Defines if the refraction is enabled in the material.
  135349. */
  135350. isRefractionEnabled: boolean;
  135351. private _isTranslucencyEnabled;
  135352. /**
  135353. * Defines if the translucency is enabled in the material.
  135354. */
  135355. isTranslucencyEnabled: boolean;
  135356. private _isScatteringEnabled;
  135357. /**
  135358. * Defines if the sub surface scattering is enabled in the material.
  135359. */
  135360. isScatteringEnabled: boolean;
  135361. private _scatteringDiffusionProfileIndex;
  135362. /**
  135363. * Diffusion profile for subsurface scattering.
  135364. * Useful for better scattering in the skins or foliages.
  135365. */
  135366. get scatteringDiffusionProfile(): Nullable<Color3>;
  135367. set scatteringDiffusionProfile(c: Nullable<Color3>);
  135368. /**
  135369. * Defines the refraction intensity of the material.
  135370. * The refraction when enabled replaces the Diffuse part of the material.
  135371. * The intensity helps transitionning between diffuse and refraction.
  135372. */
  135373. refractionIntensity: number;
  135374. /**
  135375. * Defines the translucency intensity of the material.
  135376. * When translucency has been enabled, this defines how much of the "translucency"
  135377. * is addded to the diffuse part of the material.
  135378. */
  135379. translucencyIntensity: number;
  135380. /**
  135381. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  135382. */
  135383. useAlbedoToTintRefraction: boolean;
  135384. private _thicknessTexture;
  135385. /**
  135386. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  135387. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  135388. * 0 would mean minimumThickness
  135389. * 1 would mean maximumThickness
  135390. * The other channels might be use as a mask to vary the different effects intensity.
  135391. */
  135392. thicknessTexture: Nullable<BaseTexture>;
  135393. private _refractionTexture;
  135394. /**
  135395. * Defines the texture to use for refraction.
  135396. */
  135397. refractionTexture: Nullable<BaseTexture>;
  135398. private _indexOfRefraction;
  135399. /**
  135400. * Index of refraction of the material base layer.
  135401. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135402. *
  135403. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  135404. *
  135405. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  135406. */
  135407. indexOfRefraction: number;
  135408. private _volumeIndexOfRefraction;
  135409. /**
  135410. * Index of refraction of the material's volume.
  135411. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135412. *
  135413. * This ONLY impacts refraction. If not provided or given a non-valid value,
  135414. * the volume will use the same IOR as the surface.
  135415. */
  135416. get volumeIndexOfRefraction(): number;
  135417. set volumeIndexOfRefraction(value: number);
  135418. private _invertRefractionY;
  135419. /**
  135420. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  135421. */
  135422. invertRefractionY: boolean;
  135423. private _linkRefractionWithTransparency;
  135424. /**
  135425. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  135426. * Materials half opaque for instance using refraction could benefit from this control.
  135427. */
  135428. linkRefractionWithTransparency: boolean;
  135429. /**
  135430. * Defines the minimum thickness stored in the thickness map.
  135431. * If no thickness map is defined, this value will be used to simulate thickness.
  135432. */
  135433. minimumThickness: number;
  135434. /**
  135435. * Defines the maximum thickness stored in the thickness map.
  135436. */
  135437. maximumThickness: number;
  135438. /**
  135439. * Defines the volume tint of the material.
  135440. * This is used for both translucency and scattering.
  135441. */
  135442. tintColor: Color3;
  135443. /**
  135444. * Defines the distance at which the tint color should be found in the media.
  135445. * This is used for refraction only.
  135446. */
  135447. tintColorAtDistance: number;
  135448. /**
  135449. * Defines how far each channel transmit through the media.
  135450. * It is defined as a color to simplify it selection.
  135451. */
  135452. diffusionDistance: Color3;
  135453. private _useMaskFromThicknessTexture;
  135454. /**
  135455. * Stores the intensity of the different subsurface effects in the thickness texture.
  135456. * * the green channel is the translucency intensity.
  135457. * * the blue channel is the scattering intensity.
  135458. * * the alpha channel is the refraction intensity.
  135459. */
  135460. useMaskFromThicknessTexture: boolean;
  135461. private _scene;
  135462. /** @hidden */
  135463. private _internalMarkAllSubMeshesAsTexturesDirty;
  135464. private _internalMarkScenePrePassDirty;
  135465. /** @hidden */
  135466. _markAllSubMeshesAsTexturesDirty(): void;
  135467. /** @hidden */
  135468. _markScenePrePassDirty(): void;
  135469. /**
  135470. * Instantiate a new istance of sub surface configuration.
  135471. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135472. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  135473. * @param scene The scene
  135474. */
  135475. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  135476. /**
  135477. * Gets wehter the submesh is ready to be used or not.
  135478. * @param defines the list of "defines" to update.
  135479. * @param scene defines the scene the material belongs to.
  135480. * @returns - boolean indicating that the submesh is ready or not.
  135481. */
  135482. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  135483. /**
  135484. * Checks to see if a texture is used in the material.
  135485. * @param defines the list of "defines" to update.
  135486. * @param scene defines the scene to the material belongs to.
  135487. */
  135488. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  135489. /**
  135490. * Binds the material data.
  135491. * @param uniformBuffer defines the Uniform buffer to fill in.
  135492. * @param scene defines the scene the material belongs to.
  135493. * @param engine defines the engine the material belongs to.
  135494. * @param isFrozen defines whether the material is frozen or not.
  135495. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  135496. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  135497. */
  135498. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  135499. /**
  135500. * Unbinds the material from the mesh.
  135501. * @param activeEffect defines the effect that should be unbound from.
  135502. * @returns true if unbound, otherwise false
  135503. */
  135504. unbind(activeEffect: Effect): boolean;
  135505. /**
  135506. * Returns the texture used for refraction or null if none is used.
  135507. * @param scene defines the scene the material belongs to.
  135508. * @returns - Refraction texture if present. If no refraction texture and refraction
  135509. * is linked with transparency, returns environment texture. Otherwise, returns null.
  135510. */
  135511. private _getRefractionTexture;
  135512. /**
  135513. * Returns true if alpha blending should be disabled.
  135514. */
  135515. get disableAlphaBlending(): boolean;
  135516. /**
  135517. * Fills the list of render target textures.
  135518. * @param renderTargets the list of render targets to update
  135519. */
  135520. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  135521. /**
  135522. * Checks to see if a texture is used in the material.
  135523. * @param texture - Base texture to use.
  135524. * @returns - Boolean specifying if a texture is used in the material.
  135525. */
  135526. hasTexture(texture: BaseTexture): boolean;
  135527. /**
  135528. * Gets a boolean indicating that current material needs to register RTT
  135529. * @returns true if this uses a render target otherwise false.
  135530. */
  135531. hasRenderTargetTextures(): boolean;
  135532. /**
  135533. * Returns an array of the actively used textures.
  135534. * @param activeTextures Array of BaseTextures
  135535. */
  135536. getActiveTextures(activeTextures: BaseTexture[]): void;
  135537. /**
  135538. * Returns the animatable textures.
  135539. * @param animatables Array of animatable textures.
  135540. */
  135541. getAnimatables(animatables: IAnimatable[]): void;
  135542. /**
  135543. * Disposes the resources of the material.
  135544. * @param forceDisposeTextures - Forces the disposal of all textures.
  135545. */
  135546. dispose(forceDisposeTextures?: boolean): void;
  135547. /**
  135548. * Get the current class name of the texture useful for serialization or dynamic coding.
  135549. * @returns "PBRSubSurfaceConfiguration"
  135550. */
  135551. getClassName(): string;
  135552. /**
  135553. * Add fallbacks to the effect fallbacks list.
  135554. * @param defines defines the Base texture to use.
  135555. * @param fallbacks defines the current fallback list.
  135556. * @param currentRank defines the current fallback rank.
  135557. * @returns the new fallback rank.
  135558. */
  135559. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135560. /**
  135561. * Add the required uniforms to the current list.
  135562. * @param uniforms defines the current uniform list.
  135563. */
  135564. static AddUniforms(uniforms: string[]): void;
  135565. /**
  135566. * Add the required samplers to the current list.
  135567. * @param samplers defines the current sampler list.
  135568. */
  135569. static AddSamplers(samplers: string[]): void;
  135570. /**
  135571. * Add the required uniforms to the current buffer.
  135572. * @param uniformBuffer defines the current uniform buffer.
  135573. */
  135574. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135575. /**
  135576. * Makes a duplicate of the current configuration into another one.
  135577. * @param configuration define the config where to copy the info
  135578. */
  135579. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  135580. /**
  135581. * Serializes this Sub Surface configuration.
  135582. * @returns - An object with the serialized config.
  135583. */
  135584. serialize(): any;
  135585. /**
  135586. * Parses a anisotropy Configuration from a serialized object.
  135587. * @param source - Serialized object.
  135588. * @param scene Defines the scene we are parsing for
  135589. * @param rootUrl Defines the rootUrl to load from
  135590. */
  135591. parse(source: any, scene: Scene, rootUrl: string): void;
  135592. }
  135593. }
  135594. declare module BABYLON {
  135595. /** @hidden */
  135596. export var pbrFragmentDeclaration: {
  135597. name: string;
  135598. shader: string;
  135599. };
  135600. }
  135601. declare module BABYLON {
  135602. /** @hidden */
  135603. export var pbrUboDeclaration: {
  135604. name: string;
  135605. shader: string;
  135606. };
  135607. }
  135608. declare module BABYLON {
  135609. /** @hidden */
  135610. export var pbrFragmentExtraDeclaration: {
  135611. name: string;
  135612. shader: string;
  135613. };
  135614. }
  135615. declare module BABYLON {
  135616. /** @hidden */
  135617. export var pbrFragmentSamplersDeclaration: {
  135618. name: string;
  135619. shader: string;
  135620. };
  135621. }
  135622. declare module BABYLON {
  135623. /** @hidden */
  135624. export var importanceSampling: {
  135625. name: string;
  135626. shader: string;
  135627. };
  135628. }
  135629. declare module BABYLON {
  135630. /** @hidden */
  135631. export var pbrHelperFunctions: {
  135632. name: string;
  135633. shader: string;
  135634. };
  135635. }
  135636. declare module BABYLON {
  135637. /** @hidden */
  135638. export var harmonicsFunctions: {
  135639. name: string;
  135640. shader: string;
  135641. };
  135642. }
  135643. declare module BABYLON {
  135644. /** @hidden */
  135645. export var pbrDirectLightingSetupFunctions: {
  135646. name: string;
  135647. shader: string;
  135648. };
  135649. }
  135650. declare module BABYLON {
  135651. /** @hidden */
  135652. export var pbrDirectLightingFalloffFunctions: {
  135653. name: string;
  135654. shader: string;
  135655. };
  135656. }
  135657. declare module BABYLON {
  135658. /** @hidden */
  135659. export var pbrBRDFFunctions: {
  135660. name: string;
  135661. shader: string;
  135662. };
  135663. }
  135664. declare module BABYLON {
  135665. /** @hidden */
  135666. export var hdrFilteringFunctions: {
  135667. name: string;
  135668. shader: string;
  135669. };
  135670. }
  135671. declare module BABYLON {
  135672. /** @hidden */
  135673. export var pbrDirectLightingFunctions: {
  135674. name: string;
  135675. shader: string;
  135676. };
  135677. }
  135678. declare module BABYLON {
  135679. /** @hidden */
  135680. export var pbrIBLFunctions: {
  135681. name: string;
  135682. shader: string;
  135683. };
  135684. }
  135685. declare module BABYLON {
  135686. /** @hidden */
  135687. export var pbrBlockAlbedoOpacity: {
  135688. name: string;
  135689. shader: string;
  135690. };
  135691. }
  135692. declare module BABYLON {
  135693. /** @hidden */
  135694. export var pbrBlockReflectivity: {
  135695. name: string;
  135696. shader: string;
  135697. };
  135698. }
  135699. declare module BABYLON {
  135700. /** @hidden */
  135701. export var pbrBlockAmbientOcclusion: {
  135702. name: string;
  135703. shader: string;
  135704. };
  135705. }
  135706. declare module BABYLON {
  135707. /** @hidden */
  135708. export var pbrBlockAlphaFresnel: {
  135709. name: string;
  135710. shader: string;
  135711. };
  135712. }
  135713. declare module BABYLON {
  135714. /** @hidden */
  135715. export var pbrBlockAnisotropic: {
  135716. name: string;
  135717. shader: string;
  135718. };
  135719. }
  135720. declare module BABYLON {
  135721. /** @hidden */
  135722. export var pbrBlockReflection: {
  135723. name: string;
  135724. shader: string;
  135725. };
  135726. }
  135727. declare module BABYLON {
  135728. /** @hidden */
  135729. export var pbrBlockSheen: {
  135730. name: string;
  135731. shader: string;
  135732. };
  135733. }
  135734. declare module BABYLON {
  135735. /** @hidden */
  135736. export var pbrBlockClearcoat: {
  135737. name: string;
  135738. shader: string;
  135739. };
  135740. }
  135741. declare module BABYLON {
  135742. /** @hidden */
  135743. export var pbrBlockSubSurface: {
  135744. name: string;
  135745. shader: string;
  135746. };
  135747. }
  135748. declare module BABYLON {
  135749. /** @hidden */
  135750. export var pbrBlockNormalGeometric: {
  135751. name: string;
  135752. shader: string;
  135753. };
  135754. }
  135755. declare module BABYLON {
  135756. /** @hidden */
  135757. export var pbrBlockNormalFinal: {
  135758. name: string;
  135759. shader: string;
  135760. };
  135761. }
  135762. declare module BABYLON {
  135763. /** @hidden */
  135764. export var pbrBlockLightmapInit: {
  135765. name: string;
  135766. shader: string;
  135767. };
  135768. }
  135769. declare module BABYLON {
  135770. /** @hidden */
  135771. export var pbrBlockGeometryInfo: {
  135772. name: string;
  135773. shader: string;
  135774. };
  135775. }
  135776. declare module BABYLON {
  135777. /** @hidden */
  135778. export var pbrBlockReflectance0: {
  135779. name: string;
  135780. shader: string;
  135781. };
  135782. }
  135783. declare module BABYLON {
  135784. /** @hidden */
  135785. export var pbrBlockReflectance: {
  135786. name: string;
  135787. shader: string;
  135788. };
  135789. }
  135790. declare module BABYLON {
  135791. /** @hidden */
  135792. export var pbrBlockDirectLighting: {
  135793. name: string;
  135794. shader: string;
  135795. };
  135796. }
  135797. declare module BABYLON {
  135798. /** @hidden */
  135799. export var pbrBlockFinalLitComponents: {
  135800. name: string;
  135801. shader: string;
  135802. };
  135803. }
  135804. declare module BABYLON {
  135805. /** @hidden */
  135806. export var pbrBlockFinalUnlitComponents: {
  135807. name: string;
  135808. shader: string;
  135809. };
  135810. }
  135811. declare module BABYLON {
  135812. /** @hidden */
  135813. export var pbrBlockFinalColorComposition: {
  135814. name: string;
  135815. shader: string;
  135816. };
  135817. }
  135818. declare module BABYLON {
  135819. /** @hidden */
  135820. export var pbrBlockImageProcessing: {
  135821. name: string;
  135822. shader: string;
  135823. };
  135824. }
  135825. declare module BABYLON {
  135826. /** @hidden */
  135827. export var pbrDebug: {
  135828. name: string;
  135829. shader: string;
  135830. };
  135831. }
  135832. declare module BABYLON {
  135833. /** @hidden */
  135834. export var pbrPixelShader: {
  135835. name: string;
  135836. shader: string;
  135837. };
  135838. }
  135839. declare module BABYLON {
  135840. /** @hidden */
  135841. export var pbrVertexDeclaration: {
  135842. name: string;
  135843. shader: string;
  135844. };
  135845. }
  135846. declare module BABYLON {
  135847. /** @hidden */
  135848. export var pbrVertexShader: {
  135849. name: string;
  135850. shader: string;
  135851. };
  135852. }
  135853. declare module BABYLON {
  135854. /**
  135855. * Manages the defines for the PBR Material.
  135856. * @hidden
  135857. */
  135858. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  135859. PBR: boolean;
  135860. NUM_SAMPLES: string;
  135861. REALTIME_FILTERING: boolean;
  135862. MAINUV1: boolean;
  135863. MAINUV2: boolean;
  135864. UV1: boolean;
  135865. UV2: boolean;
  135866. ALBEDO: boolean;
  135867. GAMMAALBEDO: boolean;
  135868. ALBEDODIRECTUV: number;
  135869. VERTEXCOLOR: boolean;
  135870. DETAIL: boolean;
  135871. DETAILDIRECTUV: number;
  135872. DETAIL_NORMALBLENDMETHOD: number;
  135873. AMBIENT: boolean;
  135874. AMBIENTDIRECTUV: number;
  135875. AMBIENTINGRAYSCALE: boolean;
  135876. OPACITY: boolean;
  135877. VERTEXALPHA: boolean;
  135878. OPACITYDIRECTUV: number;
  135879. OPACITYRGB: boolean;
  135880. ALPHATEST: boolean;
  135881. DEPTHPREPASS: boolean;
  135882. ALPHABLEND: boolean;
  135883. ALPHAFROMALBEDO: boolean;
  135884. ALPHATESTVALUE: string;
  135885. SPECULAROVERALPHA: boolean;
  135886. RADIANCEOVERALPHA: boolean;
  135887. ALPHAFRESNEL: boolean;
  135888. LINEARALPHAFRESNEL: boolean;
  135889. PREMULTIPLYALPHA: boolean;
  135890. EMISSIVE: boolean;
  135891. EMISSIVEDIRECTUV: number;
  135892. REFLECTIVITY: boolean;
  135893. REFLECTIVITYDIRECTUV: number;
  135894. SPECULARTERM: boolean;
  135895. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  135896. MICROSURFACEAUTOMATIC: boolean;
  135897. LODBASEDMICROSFURACE: boolean;
  135898. MICROSURFACEMAP: boolean;
  135899. MICROSURFACEMAPDIRECTUV: number;
  135900. METALLICWORKFLOW: boolean;
  135901. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  135902. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  135903. METALLNESSSTOREINMETALMAPBLUE: boolean;
  135904. AOSTOREINMETALMAPRED: boolean;
  135905. METALLIC_REFLECTANCE: boolean;
  135906. METALLIC_REFLECTANCEDIRECTUV: number;
  135907. ENVIRONMENTBRDF: boolean;
  135908. ENVIRONMENTBRDF_RGBD: boolean;
  135909. NORMAL: boolean;
  135910. TANGENT: boolean;
  135911. BUMP: boolean;
  135912. BUMPDIRECTUV: number;
  135913. OBJECTSPACE_NORMALMAP: boolean;
  135914. PARALLAX: boolean;
  135915. PARALLAXOCCLUSION: boolean;
  135916. NORMALXYSCALE: boolean;
  135917. LIGHTMAP: boolean;
  135918. LIGHTMAPDIRECTUV: number;
  135919. USELIGHTMAPASSHADOWMAP: boolean;
  135920. GAMMALIGHTMAP: boolean;
  135921. RGBDLIGHTMAP: boolean;
  135922. REFLECTION: boolean;
  135923. REFLECTIONMAP_3D: boolean;
  135924. REFLECTIONMAP_SPHERICAL: boolean;
  135925. REFLECTIONMAP_PLANAR: boolean;
  135926. REFLECTIONMAP_CUBIC: boolean;
  135927. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  135928. REFLECTIONMAP_PROJECTION: boolean;
  135929. REFLECTIONMAP_SKYBOX: boolean;
  135930. REFLECTIONMAP_EXPLICIT: boolean;
  135931. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  135932. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  135933. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  135934. INVERTCUBICMAP: boolean;
  135935. USESPHERICALFROMREFLECTIONMAP: boolean;
  135936. USEIRRADIANCEMAP: boolean;
  135937. SPHERICAL_HARMONICS: boolean;
  135938. USESPHERICALINVERTEX: boolean;
  135939. REFLECTIONMAP_OPPOSITEZ: boolean;
  135940. LODINREFLECTIONALPHA: boolean;
  135941. GAMMAREFLECTION: boolean;
  135942. RGBDREFLECTION: boolean;
  135943. LINEARSPECULARREFLECTION: boolean;
  135944. RADIANCEOCCLUSION: boolean;
  135945. HORIZONOCCLUSION: boolean;
  135946. INSTANCES: boolean;
  135947. THIN_INSTANCES: boolean;
  135948. PREPASS: boolean;
  135949. SCENE_MRT_COUNT: number;
  135950. NUM_BONE_INFLUENCERS: number;
  135951. BonesPerMesh: number;
  135952. BONETEXTURE: boolean;
  135953. NONUNIFORMSCALING: boolean;
  135954. MORPHTARGETS: boolean;
  135955. MORPHTARGETS_NORMAL: boolean;
  135956. MORPHTARGETS_TANGENT: boolean;
  135957. MORPHTARGETS_UV: boolean;
  135958. NUM_MORPH_INFLUENCERS: number;
  135959. IMAGEPROCESSING: boolean;
  135960. VIGNETTE: boolean;
  135961. VIGNETTEBLENDMODEMULTIPLY: boolean;
  135962. VIGNETTEBLENDMODEOPAQUE: boolean;
  135963. TONEMAPPING: boolean;
  135964. TONEMAPPING_ACES: boolean;
  135965. CONTRAST: boolean;
  135966. COLORCURVES: boolean;
  135967. COLORGRADING: boolean;
  135968. COLORGRADING3D: boolean;
  135969. SAMPLER3DGREENDEPTH: boolean;
  135970. SAMPLER3DBGRMAP: boolean;
  135971. IMAGEPROCESSINGPOSTPROCESS: boolean;
  135972. EXPOSURE: boolean;
  135973. MULTIVIEW: boolean;
  135974. USEPHYSICALLIGHTFALLOFF: boolean;
  135975. USEGLTFLIGHTFALLOFF: boolean;
  135976. TWOSIDEDLIGHTING: boolean;
  135977. SHADOWFLOAT: boolean;
  135978. CLIPPLANE: boolean;
  135979. CLIPPLANE2: boolean;
  135980. CLIPPLANE3: boolean;
  135981. CLIPPLANE4: boolean;
  135982. CLIPPLANE5: boolean;
  135983. CLIPPLANE6: boolean;
  135984. POINTSIZE: boolean;
  135985. FOG: boolean;
  135986. LOGARITHMICDEPTH: boolean;
  135987. FORCENORMALFORWARD: boolean;
  135988. SPECULARAA: boolean;
  135989. CLEARCOAT: boolean;
  135990. CLEARCOAT_DEFAULTIOR: boolean;
  135991. CLEARCOAT_TEXTURE: boolean;
  135992. CLEARCOAT_TEXTUREDIRECTUV: number;
  135993. CLEARCOAT_BUMP: boolean;
  135994. CLEARCOAT_BUMPDIRECTUV: number;
  135995. CLEARCOAT_TINT: boolean;
  135996. CLEARCOAT_TINT_TEXTURE: boolean;
  135997. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  135998. ANISOTROPIC: boolean;
  135999. ANISOTROPIC_TEXTURE: boolean;
  136000. ANISOTROPIC_TEXTUREDIRECTUV: number;
  136001. BRDF_V_HEIGHT_CORRELATED: boolean;
  136002. MS_BRDF_ENERGY_CONSERVATION: boolean;
  136003. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  136004. SHEEN: boolean;
  136005. SHEEN_TEXTURE: boolean;
  136006. SHEEN_TEXTUREDIRECTUV: number;
  136007. SHEEN_LINKWITHALBEDO: boolean;
  136008. SHEEN_ROUGHNESS: boolean;
  136009. SHEEN_ALBEDOSCALING: boolean;
  136010. SUBSURFACE: boolean;
  136011. SS_REFRACTION: boolean;
  136012. SS_TRANSLUCENCY: boolean;
  136013. SS_SCATTERING: boolean;
  136014. SS_THICKNESSANDMASK_TEXTURE: boolean;
  136015. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136016. SS_REFRACTIONMAP_3D: boolean;
  136017. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136018. SS_LODINREFRACTIONALPHA: boolean;
  136019. SS_GAMMAREFRACTION: boolean;
  136020. SS_RGBDREFRACTION: boolean;
  136021. SS_LINEARSPECULARREFRACTION: boolean;
  136022. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136023. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136024. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136025. UNLIT: boolean;
  136026. DEBUGMODE: number;
  136027. /**
  136028. * Initializes the PBR Material defines.
  136029. */
  136030. constructor();
  136031. /**
  136032. * Resets the PBR Material defines.
  136033. */
  136034. reset(): void;
  136035. }
  136036. /**
  136037. * The Physically based material base class of BJS.
  136038. *
  136039. * This offers the main features of a standard PBR material.
  136040. * For more information, please refer to the documentation :
  136041. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136042. */
  136043. export abstract class PBRBaseMaterial extends PushMaterial {
  136044. /**
  136045. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136046. */
  136047. static readonly PBRMATERIAL_OPAQUE: number;
  136048. /**
  136049. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136050. */
  136051. static readonly PBRMATERIAL_ALPHATEST: number;
  136052. /**
  136053. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136054. */
  136055. static readonly PBRMATERIAL_ALPHABLEND: number;
  136056. /**
  136057. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136058. * They are also discarded below the alpha cutoff threshold to improve performances.
  136059. */
  136060. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136061. /**
  136062. * Defines the default value of how much AO map is occluding the analytical lights
  136063. * (point spot...).
  136064. */
  136065. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136066. /**
  136067. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  136068. */
  136069. static readonly LIGHTFALLOFF_PHYSICAL: number;
  136070. /**
  136071. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  136072. * to enhance interoperability with other engines.
  136073. */
  136074. static readonly LIGHTFALLOFF_GLTF: number;
  136075. /**
  136076. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  136077. * to enhance interoperability with other materials.
  136078. */
  136079. static readonly LIGHTFALLOFF_STANDARD: number;
  136080. /**
  136081. * Intensity of the direct lights e.g. the four lights available in your scene.
  136082. * This impacts both the direct diffuse and specular highlights.
  136083. */
  136084. protected _directIntensity: number;
  136085. /**
  136086. * Intensity of the emissive part of the material.
  136087. * This helps controlling the emissive effect without modifying the emissive color.
  136088. */
  136089. protected _emissiveIntensity: number;
  136090. /**
  136091. * Intensity of the environment e.g. how much the environment will light the object
  136092. * either through harmonics for rough material or through the refelction for shiny ones.
  136093. */
  136094. protected _environmentIntensity: number;
  136095. /**
  136096. * This is a special control allowing the reduction of the specular highlights coming from the
  136097. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136098. */
  136099. protected _specularIntensity: number;
  136100. /**
  136101. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  136102. */
  136103. private _lightingInfos;
  136104. /**
  136105. * Debug Control allowing disabling the bump map on this material.
  136106. */
  136107. protected _disableBumpMap: boolean;
  136108. /**
  136109. * AKA Diffuse Texture in standard nomenclature.
  136110. */
  136111. protected _albedoTexture: Nullable<BaseTexture>;
  136112. /**
  136113. * AKA Occlusion Texture in other nomenclature.
  136114. */
  136115. protected _ambientTexture: Nullable<BaseTexture>;
  136116. /**
  136117. * AKA Occlusion Texture Intensity in other nomenclature.
  136118. */
  136119. protected _ambientTextureStrength: number;
  136120. /**
  136121. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136122. * 1 means it completely occludes it
  136123. * 0 mean it has no impact
  136124. */
  136125. protected _ambientTextureImpactOnAnalyticalLights: number;
  136126. /**
  136127. * Stores the alpha values in a texture.
  136128. */
  136129. protected _opacityTexture: Nullable<BaseTexture>;
  136130. /**
  136131. * Stores the reflection values in a texture.
  136132. */
  136133. protected _reflectionTexture: Nullable<BaseTexture>;
  136134. /**
  136135. * Stores the emissive values in a texture.
  136136. */
  136137. protected _emissiveTexture: Nullable<BaseTexture>;
  136138. /**
  136139. * AKA Specular texture in other nomenclature.
  136140. */
  136141. protected _reflectivityTexture: Nullable<BaseTexture>;
  136142. /**
  136143. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136144. */
  136145. protected _metallicTexture: Nullable<BaseTexture>;
  136146. /**
  136147. * Specifies the metallic scalar of the metallic/roughness workflow.
  136148. * Can also be used to scale the metalness values of the metallic texture.
  136149. */
  136150. protected _metallic: Nullable<number>;
  136151. /**
  136152. * Specifies the roughness scalar of the metallic/roughness workflow.
  136153. * Can also be used to scale the roughness values of the metallic texture.
  136154. */
  136155. protected _roughness: Nullable<number>;
  136156. /**
  136157. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136158. * By default the indexOfrefraction is used to compute F0;
  136159. *
  136160. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136161. *
  136162. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136163. * F90 = metallicReflectanceColor;
  136164. */
  136165. protected _metallicF0Factor: number;
  136166. /**
  136167. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136168. * By default the F90 is always 1;
  136169. *
  136170. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136171. *
  136172. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136173. * F90 = metallicReflectanceColor;
  136174. */
  136175. protected _metallicReflectanceColor: Color3;
  136176. /**
  136177. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136178. * This is multiply against the scalar values defined in the material.
  136179. */
  136180. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  136181. /**
  136182. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136183. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136184. */
  136185. protected _microSurfaceTexture: Nullable<BaseTexture>;
  136186. /**
  136187. * Stores surface normal data used to displace a mesh in a texture.
  136188. */
  136189. protected _bumpTexture: Nullable<BaseTexture>;
  136190. /**
  136191. * Stores the pre-calculated light information of a mesh in a texture.
  136192. */
  136193. protected _lightmapTexture: Nullable<BaseTexture>;
  136194. /**
  136195. * The color of a material in ambient lighting.
  136196. */
  136197. protected _ambientColor: Color3;
  136198. /**
  136199. * AKA Diffuse Color in other nomenclature.
  136200. */
  136201. protected _albedoColor: Color3;
  136202. /**
  136203. * AKA Specular Color in other nomenclature.
  136204. */
  136205. protected _reflectivityColor: Color3;
  136206. /**
  136207. * The color applied when light is reflected from a material.
  136208. */
  136209. protected _reflectionColor: Color3;
  136210. /**
  136211. * The color applied when light is emitted from a material.
  136212. */
  136213. protected _emissiveColor: Color3;
  136214. /**
  136215. * AKA Glossiness in other nomenclature.
  136216. */
  136217. protected _microSurface: number;
  136218. /**
  136219. * Specifies that the material will use the light map as a show map.
  136220. */
  136221. protected _useLightmapAsShadowmap: boolean;
  136222. /**
  136223. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136224. * makes the reflect vector face the model (under horizon).
  136225. */
  136226. protected _useHorizonOcclusion: boolean;
  136227. /**
  136228. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136229. * too much the area relying on ambient texture to define their ambient occlusion.
  136230. */
  136231. protected _useRadianceOcclusion: boolean;
  136232. /**
  136233. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136234. */
  136235. protected _useAlphaFromAlbedoTexture: boolean;
  136236. /**
  136237. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  136238. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136239. */
  136240. protected _useSpecularOverAlpha: boolean;
  136241. /**
  136242. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136243. */
  136244. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136245. /**
  136246. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136247. */
  136248. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  136249. /**
  136250. * Specifies if the metallic texture contains the roughness information in its green channel.
  136251. */
  136252. protected _useRoughnessFromMetallicTextureGreen: boolean;
  136253. /**
  136254. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136255. */
  136256. protected _useMetallnessFromMetallicTextureBlue: boolean;
  136257. /**
  136258. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136259. */
  136260. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  136261. /**
  136262. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136263. */
  136264. protected _useAmbientInGrayScale: boolean;
  136265. /**
  136266. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136267. * The material will try to infer what glossiness each pixel should be.
  136268. */
  136269. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  136270. /**
  136271. * Defines the falloff type used in this material.
  136272. * It by default is Physical.
  136273. */
  136274. protected _lightFalloff: number;
  136275. /**
  136276. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136277. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136278. */
  136279. protected _useRadianceOverAlpha: boolean;
  136280. /**
  136281. * Allows using an object space normal map (instead of tangent space).
  136282. */
  136283. protected _useObjectSpaceNormalMap: boolean;
  136284. /**
  136285. * Allows using the bump map in parallax mode.
  136286. */
  136287. protected _useParallax: boolean;
  136288. /**
  136289. * Allows using the bump map in parallax occlusion mode.
  136290. */
  136291. protected _useParallaxOcclusion: boolean;
  136292. /**
  136293. * Controls the scale bias of the parallax mode.
  136294. */
  136295. protected _parallaxScaleBias: number;
  136296. /**
  136297. * If sets to true, disables all the lights affecting the material.
  136298. */
  136299. protected _disableLighting: boolean;
  136300. /**
  136301. * Number of Simultaneous lights allowed on the material.
  136302. */
  136303. protected _maxSimultaneousLights: number;
  136304. /**
  136305. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  136306. */
  136307. protected _invertNormalMapX: boolean;
  136308. /**
  136309. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  136310. */
  136311. protected _invertNormalMapY: boolean;
  136312. /**
  136313. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136314. */
  136315. protected _twoSidedLighting: boolean;
  136316. /**
  136317. * Defines the alpha limits in alpha test mode.
  136318. */
  136319. protected _alphaCutOff: number;
  136320. /**
  136321. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136322. */
  136323. protected _forceAlphaTest: boolean;
  136324. /**
  136325. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136326. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136327. */
  136328. protected _useAlphaFresnel: boolean;
  136329. /**
  136330. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136331. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136332. */
  136333. protected _useLinearAlphaFresnel: boolean;
  136334. /**
  136335. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  136336. * from cos thetav and roughness:
  136337. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  136338. */
  136339. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  136340. /**
  136341. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136342. */
  136343. protected _forceIrradianceInFragment: boolean;
  136344. private _realTimeFiltering;
  136345. /**
  136346. * Enables realtime filtering on the texture.
  136347. */
  136348. get realTimeFiltering(): boolean;
  136349. set realTimeFiltering(b: boolean);
  136350. private _realTimeFilteringQuality;
  136351. /**
  136352. * Quality switch for realtime filtering
  136353. */
  136354. get realTimeFilteringQuality(): number;
  136355. set realTimeFilteringQuality(n: number);
  136356. /**
  136357. * Can this material render to several textures at once
  136358. */
  136359. get canRenderToMRT(): boolean;
  136360. /**
  136361. * Force normal to face away from face.
  136362. */
  136363. protected _forceNormalForward: boolean;
  136364. /**
  136365. * Enables specular anti aliasing in the PBR shader.
  136366. * It will both interacts on the Geometry for analytical and IBL lighting.
  136367. * It also prefilter the roughness map based on the bump values.
  136368. */
  136369. protected _enableSpecularAntiAliasing: boolean;
  136370. /**
  136371. * Default configuration related to image processing available in the PBR Material.
  136372. */
  136373. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  136374. /**
  136375. * Keep track of the image processing observer to allow dispose and replace.
  136376. */
  136377. private _imageProcessingObserver;
  136378. /**
  136379. * Attaches a new image processing configuration to the PBR Material.
  136380. * @param configuration
  136381. */
  136382. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  136383. /**
  136384. * Stores the available render targets.
  136385. */
  136386. private _renderTargets;
  136387. /**
  136388. * Sets the global ambient color for the material used in lighting calculations.
  136389. */
  136390. private _globalAmbientColor;
  136391. /**
  136392. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  136393. */
  136394. private _useLogarithmicDepth;
  136395. /**
  136396. * If set to true, no lighting calculations will be applied.
  136397. */
  136398. private _unlit;
  136399. private _debugMode;
  136400. /**
  136401. * @hidden
  136402. * This is reserved for the inspector.
  136403. * Defines the material debug mode.
  136404. * It helps seeing only some components of the material while troubleshooting.
  136405. */
  136406. debugMode: number;
  136407. /**
  136408. * @hidden
  136409. * This is reserved for the inspector.
  136410. * Specify from where on screen the debug mode should start.
  136411. * The value goes from -1 (full screen) to 1 (not visible)
  136412. * It helps with side by side comparison against the final render
  136413. * This defaults to -1
  136414. */
  136415. private debugLimit;
  136416. /**
  136417. * @hidden
  136418. * This is reserved for the inspector.
  136419. * As the default viewing range might not be enough (if the ambient is really small for instance)
  136420. * You can use the factor to better multiply the final value.
  136421. */
  136422. private debugFactor;
  136423. /**
  136424. * Defines the clear coat layer parameters for the material.
  136425. */
  136426. readonly clearCoat: PBRClearCoatConfiguration;
  136427. /**
  136428. * Defines the anisotropic parameters for the material.
  136429. */
  136430. readonly anisotropy: PBRAnisotropicConfiguration;
  136431. /**
  136432. * Defines the BRDF parameters for the material.
  136433. */
  136434. readonly brdf: PBRBRDFConfiguration;
  136435. /**
  136436. * Defines the Sheen parameters for the material.
  136437. */
  136438. readonly sheen: PBRSheenConfiguration;
  136439. /**
  136440. * Defines the SubSurface parameters for the material.
  136441. */
  136442. readonly subSurface: PBRSubSurfaceConfiguration;
  136443. /**
  136444. * Defines the detail map parameters for the material.
  136445. */
  136446. readonly detailMap: DetailMapConfiguration;
  136447. protected _rebuildInParallel: boolean;
  136448. /**
  136449. * Instantiates a new PBRMaterial instance.
  136450. *
  136451. * @param name The material name
  136452. * @param scene The scene the material will be use in.
  136453. */
  136454. constructor(name: string, scene: Scene);
  136455. /**
  136456. * Gets a boolean indicating that current material needs to register RTT
  136457. */
  136458. get hasRenderTargetTextures(): boolean;
  136459. /**
  136460. * Gets the name of the material class.
  136461. */
  136462. getClassName(): string;
  136463. /**
  136464. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136465. */
  136466. get useLogarithmicDepth(): boolean;
  136467. /**
  136468. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136469. */
  136470. set useLogarithmicDepth(value: boolean);
  136471. /**
  136472. * Returns true if alpha blending should be disabled.
  136473. */
  136474. protected get _disableAlphaBlending(): boolean;
  136475. /**
  136476. * Specifies whether or not this material should be rendered in alpha blend mode.
  136477. */
  136478. needAlphaBlending(): boolean;
  136479. /**
  136480. * Specifies whether or not this material should be rendered in alpha test mode.
  136481. */
  136482. needAlphaTesting(): boolean;
  136483. /**
  136484. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  136485. */
  136486. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  136487. /**
  136488. * Gets the texture used for the alpha test.
  136489. */
  136490. getAlphaTestTexture(): Nullable<BaseTexture>;
  136491. /**
  136492. * Specifies that the submesh is ready to be used.
  136493. * @param mesh - BJS mesh.
  136494. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  136495. * @param useInstances - Specifies that instances should be used.
  136496. * @returns - boolean indicating that the submesh is ready or not.
  136497. */
  136498. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  136499. /**
  136500. * Specifies if the material uses metallic roughness workflow.
  136501. * @returns boolean specifiying if the material uses metallic roughness workflow.
  136502. */
  136503. isMetallicWorkflow(): boolean;
  136504. private _prepareEffect;
  136505. private _prepareDefines;
  136506. /**
  136507. * Force shader compilation
  136508. */
  136509. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  136510. /**
  136511. * Initializes the uniform buffer layout for the shader.
  136512. */
  136513. buildUniformLayout(): void;
  136514. /**
  136515. * Unbinds the material from the mesh
  136516. */
  136517. unbind(): void;
  136518. /**
  136519. * Binds the submesh data.
  136520. * @param world - The world matrix.
  136521. * @param mesh - The BJS mesh.
  136522. * @param subMesh - A submesh of the BJS mesh.
  136523. */
  136524. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  136525. /**
  136526. * Returns the animatable textures.
  136527. * @returns - Array of animatable textures.
  136528. */
  136529. getAnimatables(): IAnimatable[];
  136530. /**
  136531. * Returns the texture used for reflections.
  136532. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  136533. */
  136534. private _getReflectionTexture;
  136535. /**
  136536. * Returns an array of the actively used textures.
  136537. * @returns - Array of BaseTextures
  136538. */
  136539. getActiveTextures(): BaseTexture[];
  136540. /**
  136541. * Checks to see if a texture is used in the material.
  136542. * @param texture - Base texture to use.
  136543. * @returns - Boolean specifying if a texture is used in the material.
  136544. */
  136545. hasTexture(texture: BaseTexture): boolean;
  136546. /**
  136547. * Sets the required values to the prepass renderer.
  136548. * @param prePassRenderer defines the prepass renderer to setup
  136549. */
  136550. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  136551. /**
  136552. * Disposes the resources of the material.
  136553. * @param forceDisposeEffect - Forces the disposal of effects.
  136554. * @param forceDisposeTextures - Forces the disposal of all textures.
  136555. */
  136556. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  136557. }
  136558. }
  136559. declare module BABYLON {
  136560. /**
  136561. * The Physically based material of BJS.
  136562. *
  136563. * This offers the main features of a standard PBR material.
  136564. * For more information, please refer to the documentation :
  136565. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136566. */
  136567. export class PBRMaterial extends PBRBaseMaterial {
  136568. /**
  136569. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136570. */
  136571. static readonly PBRMATERIAL_OPAQUE: number;
  136572. /**
  136573. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136574. */
  136575. static readonly PBRMATERIAL_ALPHATEST: number;
  136576. /**
  136577. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136578. */
  136579. static readonly PBRMATERIAL_ALPHABLEND: number;
  136580. /**
  136581. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136582. * They are also discarded below the alpha cutoff threshold to improve performances.
  136583. */
  136584. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136585. /**
  136586. * Defines the default value of how much AO map is occluding the analytical lights
  136587. * (point spot...).
  136588. */
  136589. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136590. /**
  136591. * Intensity of the direct lights e.g. the four lights available in your scene.
  136592. * This impacts both the direct diffuse and specular highlights.
  136593. */
  136594. directIntensity: number;
  136595. /**
  136596. * Intensity of the emissive part of the material.
  136597. * This helps controlling the emissive effect without modifying the emissive color.
  136598. */
  136599. emissiveIntensity: number;
  136600. /**
  136601. * Intensity of the environment e.g. how much the environment will light the object
  136602. * either through harmonics for rough material or through the refelction for shiny ones.
  136603. */
  136604. environmentIntensity: number;
  136605. /**
  136606. * This is a special control allowing the reduction of the specular highlights coming from the
  136607. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136608. */
  136609. specularIntensity: number;
  136610. /**
  136611. * Debug Control allowing disabling the bump map on this material.
  136612. */
  136613. disableBumpMap: boolean;
  136614. /**
  136615. * AKA Diffuse Texture in standard nomenclature.
  136616. */
  136617. albedoTexture: BaseTexture;
  136618. /**
  136619. * AKA Occlusion Texture in other nomenclature.
  136620. */
  136621. ambientTexture: BaseTexture;
  136622. /**
  136623. * AKA Occlusion Texture Intensity in other nomenclature.
  136624. */
  136625. ambientTextureStrength: number;
  136626. /**
  136627. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136628. * 1 means it completely occludes it
  136629. * 0 mean it has no impact
  136630. */
  136631. ambientTextureImpactOnAnalyticalLights: number;
  136632. /**
  136633. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  136634. */
  136635. opacityTexture: BaseTexture;
  136636. /**
  136637. * Stores the reflection values in a texture.
  136638. */
  136639. reflectionTexture: Nullable<BaseTexture>;
  136640. /**
  136641. * Stores the emissive values in a texture.
  136642. */
  136643. emissiveTexture: BaseTexture;
  136644. /**
  136645. * AKA Specular texture in other nomenclature.
  136646. */
  136647. reflectivityTexture: BaseTexture;
  136648. /**
  136649. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136650. */
  136651. metallicTexture: BaseTexture;
  136652. /**
  136653. * Specifies the metallic scalar of the metallic/roughness workflow.
  136654. * Can also be used to scale the metalness values of the metallic texture.
  136655. */
  136656. metallic: Nullable<number>;
  136657. /**
  136658. * Specifies the roughness scalar of the metallic/roughness workflow.
  136659. * Can also be used to scale the roughness values of the metallic texture.
  136660. */
  136661. roughness: Nullable<number>;
  136662. /**
  136663. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136664. * By default the indexOfrefraction is used to compute F0;
  136665. *
  136666. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136667. *
  136668. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136669. * F90 = metallicReflectanceColor;
  136670. */
  136671. metallicF0Factor: number;
  136672. /**
  136673. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136674. * By default the F90 is always 1;
  136675. *
  136676. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136677. *
  136678. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136679. * F90 = metallicReflectanceColor;
  136680. */
  136681. metallicReflectanceColor: Color3;
  136682. /**
  136683. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136684. * This is multiply against the scalar values defined in the material.
  136685. */
  136686. metallicReflectanceTexture: Nullable<BaseTexture>;
  136687. /**
  136688. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136689. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136690. */
  136691. microSurfaceTexture: BaseTexture;
  136692. /**
  136693. * Stores surface normal data used to displace a mesh in a texture.
  136694. */
  136695. bumpTexture: BaseTexture;
  136696. /**
  136697. * Stores the pre-calculated light information of a mesh in a texture.
  136698. */
  136699. lightmapTexture: BaseTexture;
  136700. /**
  136701. * Stores the refracted light information in a texture.
  136702. */
  136703. get refractionTexture(): Nullable<BaseTexture>;
  136704. set refractionTexture(value: Nullable<BaseTexture>);
  136705. /**
  136706. * The color of a material in ambient lighting.
  136707. */
  136708. ambientColor: Color3;
  136709. /**
  136710. * AKA Diffuse Color in other nomenclature.
  136711. */
  136712. albedoColor: Color3;
  136713. /**
  136714. * AKA Specular Color in other nomenclature.
  136715. */
  136716. reflectivityColor: Color3;
  136717. /**
  136718. * The color reflected from the material.
  136719. */
  136720. reflectionColor: Color3;
  136721. /**
  136722. * The color emitted from the material.
  136723. */
  136724. emissiveColor: Color3;
  136725. /**
  136726. * AKA Glossiness in other nomenclature.
  136727. */
  136728. microSurface: number;
  136729. /**
  136730. * Index of refraction of the material base layer.
  136731. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136732. *
  136733. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136734. *
  136735. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136736. */
  136737. get indexOfRefraction(): number;
  136738. set indexOfRefraction(value: number);
  136739. /**
  136740. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136741. */
  136742. get invertRefractionY(): boolean;
  136743. set invertRefractionY(value: boolean);
  136744. /**
  136745. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136746. * Materials half opaque for instance using refraction could benefit from this control.
  136747. */
  136748. get linkRefractionWithTransparency(): boolean;
  136749. set linkRefractionWithTransparency(value: boolean);
  136750. /**
  136751. * If true, the light map contains occlusion information instead of lighting info.
  136752. */
  136753. useLightmapAsShadowmap: boolean;
  136754. /**
  136755. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136756. */
  136757. useAlphaFromAlbedoTexture: boolean;
  136758. /**
  136759. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136760. */
  136761. forceAlphaTest: boolean;
  136762. /**
  136763. * Defines the alpha limits in alpha test mode.
  136764. */
  136765. alphaCutOff: number;
  136766. /**
  136767. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  136768. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136769. */
  136770. useSpecularOverAlpha: boolean;
  136771. /**
  136772. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136773. */
  136774. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136775. /**
  136776. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136777. */
  136778. useRoughnessFromMetallicTextureAlpha: boolean;
  136779. /**
  136780. * Specifies if the metallic texture contains the roughness information in its green channel.
  136781. */
  136782. useRoughnessFromMetallicTextureGreen: boolean;
  136783. /**
  136784. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136785. */
  136786. useMetallnessFromMetallicTextureBlue: boolean;
  136787. /**
  136788. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136789. */
  136790. useAmbientOcclusionFromMetallicTextureRed: boolean;
  136791. /**
  136792. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136793. */
  136794. useAmbientInGrayScale: boolean;
  136795. /**
  136796. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136797. * The material will try to infer what glossiness each pixel should be.
  136798. */
  136799. useAutoMicroSurfaceFromReflectivityMap: boolean;
  136800. /**
  136801. * BJS is using an harcoded light falloff based on a manually sets up range.
  136802. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136803. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136804. */
  136805. get usePhysicalLightFalloff(): boolean;
  136806. /**
  136807. * BJS is using an harcoded light falloff based on a manually sets up range.
  136808. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136809. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136810. */
  136811. set usePhysicalLightFalloff(value: boolean);
  136812. /**
  136813. * In order to support the falloff compatibility with gltf, a special mode has been added
  136814. * to reproduce the gltf light falloff.
  136815. */
  136816. get useGLTFLightFalloff(): boolean;
  136817. /**
  136818. * In order to support the falloff compatibility with gltf, a special mode has been added
  136819. * to reproduce the gltf light falloff.
  136820. */
  136821. set useGLTFLightFalloff(value: boolean);
  136822. /**
  136823. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136824. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136825. */
  136826. useRadianceOverAlpha: boolean;
  136827. /**
  136828. * Allows using an object space normal map (instead of tangent space).
  136829. */
  136830. useObjectSpaceNormalMap: boolean;
  136831. /**
  136832. * Allows using the bump map in parallax mode.
  136833. */
  136834. useParallax: boolean;
  136835. /**
  136836. * Allows using the bump map in parallax occlusion mode.
  136837. */
  136838. useParallaxOcclusion: boolean;
  136839. /**
  136840. * Controls the scale bias of the parallax mode.
  136841. */
  136842. parallaxScaleBias: number;
  136843. /**
  136844. * If sets to true, disables all the lights affecting the material.
  136845. */
  136846. disableLighting: boolean;
  136847. /**
  136848. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136849. */
  136850. forceIrradianceInFragment: boolean;
  136851. /**
  136852. * Number of Simultaneous lights allowed on the material.
  136853. */
  136854. maxSimultaneousLights: number;
  136855. /**
  136856. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  136857. */
  136858. invertNormalMapX: boolean;
  136859. /**
  136860. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  136861. */
  136862. invertNormalMapY: boolean;
  136863. /**
  136864. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136865. */
  136866. twoSidedLighting: boolean;
  136867. /**
  136868. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136869. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136870. */
  136871. useAlphaFresnel: boolean;
  136872. /**
  136873. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136874. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136875. */
  136876. useLinearAlphaFresnel: boolean;
  136877. /**
  136878. * Let user defines the brdf lookup texture used for IBL.
  136879. * A default 8bit version is embedded but you could point at :
  136880. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  136881. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  136882. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  136883. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  136884. */
  136885. environmentBRDFTexture: Nullable<BaseTexture>;
  136886. /**
  136887. * Force normal to face away from face.
  136888. */
  136889. forceNormalForward: boolean;
  136890. /**
  136891. * Enables specular anti aliasing in the PBR shader.
  136892. * It will both interacts on the Geometry for analytical and IBL lighting.
  136893. * It also prefilter the roughness map based on the bump values.
  136894. */
  136895. enableSpecularAntiAliasing: boolean;
  136896. /**
  136897. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136898. * makes the reflect vector face the model (under horizon).
  136899. */
  136900. useHorizonOcclusion: boolean;
  136901. /**
  136902. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136903. * too much the area relying on ambient texture to define their ambient occlusion.
  136904. */
  136905. useRadianceOcclusion: boolean;
  136906. /**
  136907. * If set to true, no lighting calculations will be applied.
  136908. */
  136909. unlit: boolean;
  136910. /**
  136911. * Gets the image processing configuration used either in this material.
  136912. */
  136913. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  136914. /**
  136915. * Sets the Default image processing configuration used either in the this material.
  136916. *
  136917. * If sets to null, the scene one is in use.
  136918. */
  136919. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  136920. /**
  136921. * Gets wether the color curves effect is enabled.
  136922. */
  136923. get cameraColorCurvesEnabled(): boolean;
  136924. /**
  136925. * Sets wether the color curves effect is enabled.
  136926. */
  136927. set cameraColorCurvesEnabled(value: boolean);
  136928. /**
  136929. * Gets wether the color grading effect is enabled.
  136930. */
  136931. get cameraColorGradingEnabled(): boolean;
  136932. /**
  136933. * Gets wether the color grading effect is enabled.
  136934. */
  136935. set cameraColorGradingEnabled(value: boolean);
  136936. /**
  136937. * Gets wether tonemapping is enabled or not.
  136938. */
  136939. get cameraToneMappingEnabled(): boolean;
  136940. /**
  136941. * Sets wether tonemapping is enabled or not
  136942. */
  136943. set cameraToneMappingEnabled(value: boolean);
  136944. /**
  136945. * The camera exposure used on this material.
  136946. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136947. * This corresponds to a photographic exposure.
  136948. */
  136949. get cameraExposure(): number;
  136950. /**
  136951. * The camera exposure used on this material.
  136952. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136953. * This corresponds to a photographic exposure.
  136954. */
  136955. set cameraExposure(value: number);
  136956. /**
  136957. * Gets The camera contrast used on this material.
  136958. */
  136959. get cameraContrast(): number;
  136960. /**
  136961. * Sets The camera contrast used on this material.
  136962. */
  136963. set cameraContrast(value: number);
  136964. /**
  136965. * Gets the Color Grading 2D Lookup Texture.
  136966. */
  136967. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  136968. /**
  136969. * Sets the Color Grading 2D Lookup Texture.
  136970. */
  136971. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  136972. /**
  136973. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136974. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136975. * 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;
  136976. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136977. */
  136978. get cameraColorCurves(): Nullable<ColorCurves>;
  136979. /**
  136980. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136981. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136982. * 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;
  136983. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136984. */
  136985. set cameraColorCurves(value: Nullable<ColorCurves>);
  136986. /**
  136987. * Instantiates a new PBRMaterial instance.
  136988. *
  136989. * @param name The material name
  136990. * @param scene The scene the material will be use in.
  136991. */
  136992. constructor(name: string, scene: Scene);
  136993. /**
  136994. * Returns the name of this material class.
  136995. */
  136996. getClassName(): string;
  136997. /**
  136998. * Makes a duplicate of the current material.
  136999. * @param name - name to use for the new material.
  137000. */
  137001. clone(name: string): PBRMaterial;
  137002. /**
  137003. * Serializes this PBR Material.
  137004. * @returns - An object with the serialized material.
  137005. */
  137006. serialize(): any;
  137007. /**
  137008. * Parses a PBR Material from a serialized object.
  137009. * @param source - Serialized object.
  137010. * @param scene - BJS scene instance.
  137011. * @param rootUrl - url for the scene object
  137012. * @returns - PBRMaterial
  137013. */
  137014. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  137015. }
  137016. }
  137017. declare module BABYLON {
  137018. /**
  137019. * Direct draw surface info
  137020. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  137021. */
  137022. export interface DDSInfo {
  137023. /**
  137024. * Width of the texture
  137025. */
  137026. width: number;
  137027. /**
  137028. * Width of the texture
  137029. */
  137030. height: number;
  137031. /**
  137032. * Number of Mipmaps for the texture
  137033. * @see https://en.wikipedia.org/wiki/Mipmap
  137034. */
  137035. mipmapCount: number;
  137036. /**
  137037. * If the textures format is a known fourCC format
  137038. * @see https://www.fourcc.org/
  137039. */
  137040. isFourCC: boolean;
  137041. /**
  137042. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  137043. */
  137044. isRGB: boolean;
  137045. /**
  137046. * If the texture is a lumincance format
  137047. */
  137048. isLuminance: boolean;
  137049. /**
  137050. * If this is a cube texture
  137051. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  137052. */
  137053. isCube: boolean;
  137054. /**
  137055. * If the texture is a compressed format eg. FOURCC_DXT1
  137056. */
  137057. isCompressed: boolean;
  137058. /**
  137059. * The dxgiFormat of the texture
  137060. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  137061. */
  137062. dxgiFormat: number;
  137063. /**
  137064. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  137065. */
  137066. textureType: number;
  137067. /**
  137068. * Sphericle polynomial created for the dds texture
  137069. */
  137070. sphericalPolynomial?: SphericalPolynomial;
  137071. }
  137072. /**
  137073. * Class used to provide DDS decompression tools
  137074. */
  137075. export class DDSTools {
  137076. /**
  137077. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  137078. */
  137079. static StoreLODInAlphaChannel: boolean;
  137080. /**
  137081. * Gets DDS information from an array buffer
  137082. * @param data defines the array buffer view to read data from
  137083. * @returns the DDS information
  137084. */
  137085. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  137086. private static _FloatView;
  137087. private static _Int32View;
  137088. private static _ToHalfFloat;
  137089. private static _FromHalfFloat;
  137090. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  137091. private static _GetHalfFloatRGBAArrayBuffer;
  137092. private static _GetFloatRGBAArrayBuffer;
  137093. private static _GetFloatAsUIntRGBAArrayBuffer;
  137094. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  137095. private static _GetRGBAArrayBuffer;
  137096. private static _ExtractLongWordOrder;
  137097. private static _GetRGBArrayBuffer;
  137098. private static _GetLuminanceArrayBuffer;
  137099. /**
  137100. * Uploads DDS Levels to a Babylon Texture
  137101. * @hidden
  137102. */
  137103. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  137104. }
  137105. interface ThinEngine {
  137106. /**
  137107. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  137108. * @param rootUrl defines the url where the file to load is located
  137109. * @param scene defines the current scene
  137110. * @param lodScale defines scale to apply to the mip map selection
  137111. * @param lodOffset defines offset to apply to the mip map selection
  137112. * @param onLoad defines an optional callback raised when the texture is loaded
  137113. * @param onError defines an optional callback raised if there is an issue to load the texture
  137114. * @param format defines the format of the data
  137115. * @param forcedExtension defines the extension to use to pick the right loader
  137116. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  137117. * @returns the cube texture as an InternalTexture
  137118. */
  137119. 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;
  137120. }
  137121. }
  137122. declare module BABYLON {
  137123. /**
  137124. * Implementation of the DDS Texture Loader.
  137125. * @hidden
  137126. */
  137127. export class _DDSTextureLoader implements IInternalTextureLoader {
  137128. /**
  137129. * Defines wether the loader supports cascade loading the different faces.
  137130. */
  137131. readonly supportCascades: boolean;
  137132. /**
  137133. * This returns if the loader support the current file information.
  137134. * @param extension defines the file extension of the file being loaded
  137135. * @returns true if the loader can load the specified file
  137136. */
  137137. canLoad(extension: string): boolean;
  137138. /**
  137139. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137140. * @param data contains the texture data
  137141. * @param texture defines the BabylonJS internal texture
  137142. * @param createPolynomials will be true if polynomials have been requested
  137143. * @param onLoad defines the callback to trigger once the texture is ready
  137144. * @param onError defines the callback to trigger in case of error
  137145. */
  137146. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137147. /**
  137148. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137149. * @param data contains the texture data
  137150. * @param texture defines the BabylonJS internal texture
  137151. * @param callback defines the method to call once ready to upload
  137152. */
  137153. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137154. }
  137155. }
  137156. declare module BABYLON {
  137157. /**
  137158. * Implementation of the ENV Texture Loader.
  137159. * @hidden
  137160. */
  137161. export class _ENVTextureLoader implements IInternalTextureLoader {
  137162. /**
  137163. * Defines wether the loader supports cascade loading the different faces.
  137164. */
  137165. readonly supportCascades: boolean;
  137166. /**
  137167. * This returns if the loader support the current file information.
  137168. * @param extension defines the file extension of the file being loaded
  137169. * @returns true if the loader can load the specified file
  137170. */
  137171. canLoad(extension: string): boolean;
  137172. /**
  137173. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137174. * @param data contains the texture data
  137175. * @param texture defines the BabylonJS internal texture
  137176. * @param createPolynomials will be true if polynomials have been requested
  137177. * @param onLoad defines the callback to trigger once the texture is ready
  137178. * @param onError defines the callback to trigger in case of error
  137179. */
  137180. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137181. /**
  137182. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137183. * @param data contains the texture data
  137184. * @param texture defines the BabylonJS internal texture
  137185. * @param callback defines the method to call once ready to upload
  137186. */
  137187. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137188. }
  137189. }
  137190. declare module BABYLON {
  137191. /**
  137192. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  137193. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  137194. */
  137195. export class KhronosTextureContainer {
  137196. /** contents of the KTX container file */
  137197. data: ArrayBufferView;
  137198. private static HEADER_LEN;
  137199. private static COMPRESSED_2D;
  137200. private static COMPRESSED_3D;
  137201. private static TEX_2D;
  137202. private static TEX_3D;
  137203. /**
  137204. * Gets the openGL type
  137205. */
  137206. glType: number;
  137207. /**
  137208. * Gets the openGL type size
  137209. */
  137210. glTypeSize: number;
  137211. /**
  137212. * Gets the openGL format
  137213. */
  137214. glFormat: number;
  137215. /**
  137216. * Gets the openGL internal format
  137217. */
  137218. glInternalFormat: number;
  137219. /**
  137220. * Gets the base internal format
  137221. */
  137222. glBaseInternalFormat: number;
  137223. /**
  137224. * Gets image width in pixel
  137225. */
  137226. pixelWidth: number;
  137227. /**
  137228. * Gets image height in pixel
  137229. */
  137230. pixelHeight: number;
  137231. /**
  137232. * Gets image depth in pixels
  137233. */
  137234. pixelDepth: number;
  137235. /**
  137236. * Gets the number of array elements
  137237. */
  137238. numberOfArrayElements: number;
  137239. /**
  137240. * Gets the number of faces
  137241. */
  137242. numberOfFaces: number;
  137243. /**
  137244. * Gets the number of mipmap levels
  137245. */
  137246. numberOfMipmapLevels: number;
  137247. /**
  137248. * Gets the bytes of key value data
  137249. */
  137250. bytesOfKeyValueData: number;
  137251. /**
  137252. * Gets the load type
  137253. */
  137254. loadType: number;
  137255. /**
  137256. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  137257. */
  137258. isInvalid: boolean;
  137259. /**
  137260. * Creates a new KhronosTextureContainer
  137261. * @param data contents of the KTX container file
  137262. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  137263. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  137264. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  137265. */
  137266. constructor(
  137267. /** contents of the KTX container file */
  137268. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  137269. /**
  137270. * Uploads KTX content to a Babylon Texture.
  137271. * It is assumed that the texture has already been created & is currently bound
  137272. * @hidden
  137273. */
  137274. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  137275. private _upload2DCompressedLevels;
  137276. /**
  137277. * Checks if the given data starts with a KTX file identifier.
  137278. * @param data the data to check
  137279. * @returns true if the data is a KTX file or false otherwise
  137280. */
  137281. static IsValid(data: ArrayBufferView): boolean;
  137282. }
  137283. }
  137284. declare module BABYLON {
  137285. /**
  137286. * Class for loading KTX2 files
  137287. * !!! Experimental Extension Subject to Changes !!!
  137288. * @hidden
  137289. */
  137290. export class KhronosTextureContainer2 {
  137291. private static _ModulePromise;
  137292. private static _TranscodeFormat;
  137293. constructor(engine: ThinEngine);
  137294. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  137295. private _determineTranscodeFormat;
  137296. /**
  137297. * Checks if the given data starts with a KTX2 file identifier.
  137298. * @param data the data to check
  137299. * @returns true if the data is a KTX2 file or false otherwise
  137300. */
  137301. static IsValid(data: ArrayBufferView): boolean;
  137302. }
  137303. }
  137304. declare module BABYLON {
  137305. /**
  137306. * Implementation of the KTX Texture Loader.
  137307. * @hidden
  137308. */
  137309. export class _KTXTextureLoader implements IInternalTextureLoader {
  137310. /**
  137311. * Defines wether the loader supports cascade loading the different faces.
  137312. */
  137313. readonly supportCascades: boolean;
  137314. /**
  137315. * This returns if the loader support the current file information.
  137316. * @param extension defines the file extension of the file being loaded
  137317. * @param mimeType defines the optional mime type of the file being loaded
  137318. * @returns true if the loader can load the specified file
  137319. */
  137320. canLoad(extension: string, mimeType?: string): boolean;
  137321. /**
  137322. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137323. * @param data contains the texture data
  137324. * @param texture defines the BabylonJS internal texture
  137325. * @param createPolynomials will be true if polynomials have been requested
  137326. * @param onLoad defines the callback to trigger once the texture is ready
  137327. * @param onError defines the callback to trigger in case of error
  137328. */
  137329. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137330. /**
  137331. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137332. * @param data contains the texture data
  137333. * @param texture defines the BabylonJS internal texture
  137334. * @param callback defines the method to call once ready to upload
  137335. */
  137336. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  137337. }
  137338. }
  137339. declare module BABYLON {
  137340. /** @hidden */
  137341. export var _forceSceneHelpersToBundle: boolean;
  137342. interface Scene {
  137343. /**
  137344. * Creates a default light for the scene.
  137345. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  137346. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  137347. */
  137348. createDefaultLight(replace?: boolean): void;
  137349. /**
  137350. * Creates a default camera for the scene.
  137351. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  137352. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137353. * @param replace has default false, when true replaces the active camera in the scene
  137354. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  137355. */
  137356. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137357. /**
  137358. * Creates a default camera and a default light.
  137359. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  137360. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137361. * @param replace has the default false, when true replaces the active camera/light in the scene
  137362. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  137363. */
  137364. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137365. /**
  137366. * Creates a new sky box
  137367. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  137368. * @param environmentTexture defines the texture to use as environment texture
  137369. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  137370. * @param scale defines the overall scale of the skybox
  137371. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  137372. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  137373. * @returns a new mesh holding the sky box
  137374. */
  137375. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  137376. /**
  137377. * Creates a new environment
  137378. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  137379. * @param options defines the options you can use to configure the environment
  137380. * @returns the new EnvironmentHelper
  137381. */
  137382. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  137383. /**
  137384. * Creates a new VREXperienceHelper
  137385. * @see https://doc.babylonjs.com/how_to/webvr_helper
  137386. * @param webVROptions defines the options used to create the new VREXperienceHelper
  137387. * @returns a new VREXperienceHelper
  137388. */
  137389. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  137390. /**
  137391. * Creates a new WebXRDefaultExperience
  137392. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  137393. * @param options experience options
  137394. * @returns a promise for a new WebXRDefaultExperience
  137395. */
  137396. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  137397. }
  137398. }
  137399. declare module BABYLON {
  137400. /**
  137401. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  137402. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  137403. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  137404. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  137405. */
  137406. export class VideoDome extends TextureDome<VideoTexture> {
  137407. /**
  137408. * Define the video source as a Monoscopic panoramic 360 video.
  137409. */
  137410. static readonly MODE_MONOSCOPIC: number;
  137411. /**
  137412. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  137413. */
  137414. static readonly MODE_TOPBOTTOM: number;
  137415. /**
  137416. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  137417. */
  137418. static readonly MODE_SIDEBYSIDE: number;
  137419. /**
  137420. * Get the video texture associated with this video dome
  137421. */
  137422. get videoTexture(): VideoTexture;
  137423. /**
  137424. * Get the video mode of this dome
  137425. */
  137426. get videoMode(): number;
  137427. /**
  137428. * Set the video mode of this dome.
  137429. * @see textureMode
  137430. */
  137431. set videoMode(value: number);
  137432. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  137433. }
  137434. }
  137435. declare module BABYLON {
  137436. /**
  137437. * This class can be used to get instrumentation data from a Babylon engine
  137438. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137439. */
  137440. export class EngineInstrumentation implements IDisposable {
  137441. /**
  137442. * Define the instrumented engine.
  137443. */
  137444. engine: Engine;
  137445. private _captureGPUFrameTime;
  137446. private _gpuFrameTimeToken;
  137447. private _gpuFrameTime;
  137448. private _captureShaderCompilationTime;
  137449. private _shaderCompilationTime;
  137450. private _onBeginFrameObserver;
  137451. private _onEndFrameObserver;
  137452. private _onBeforeShaderCompilationObserver;
  137453. private _onAfterShaderCompilationObserver;
  137454. /**
  137455. * Gets the perf counter used for GPU frame time
  137456. */
  137457. get gpuFrameTimeCounter(): PerfCounter;
  137458. /**
  137459. * Gets the GPU frame time capture status
  137460. */
  137461. get captureGPUFrameTime(): boolean;
  137462. /**
  137463. * Enable or disable the GPU frame time capture
  137464. */
  137465. set captureGPUFrameTime(value: boolean);
  137466. /**
  137467. * Gets the perf counter used for shader compilation time
  137468. */
  137469. get shaderCompilationTimeCounter(): PerfCounter;
  137470. /**
  137471. * Gets the shader compilation time capture status
  137472. */
  137473. get captureShaderCompilationTime(): boolean;
  137474. /**
  137475. * Enable or disable the shader compilation time capture
  137476. */
  137477. set captureShaderCompilationTime(value: boolean);
  137478. /**
  137479. * Instantiates a new engine instrumentation.
  137480. * This class can be used to get instrumentation data from a Babylon engine
  137481. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137482. * @param engine Defines the engine to instrument
  137483. */
  137484. constructor(
  137485. /**
  137486. * Define the instrumented engine.
  137487. */
  137488. engine: Engine);
  137489. /**
  137490. * Dispose and release associated resources.
  137491. */
  137492. dispose(): void;
  137493. }
  137494. }
  137495. declare module BABYLON {
  137496. /**
  137497. * This class can be used to get instrumentation data from a Babylon engine
  137498. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137499. */
  137500. export class SceneInstrumentation implements IDisposable {
  137501. /**
  137502. * Defines the scene to instrument
  137503. */
  137504. scene: Scene;
  137505. private _captureActiveMeshesEvaluationTime;
  137506. private _activeMeshesEvaluationTime;
  137507. private _captureRenderTargetsRenderTime;
  137508. private _renderTargetsRenderTime;
  137509. private _captureFrameTime;
  137510. private _frameTime;
  137511. private _captureRenderTime;
  137512. private _renderTime;
  137513. private _captureInterFrameTime;
  137514. private _interFrameTime;
  137515. private _captureParticlesRenderTime;
  137516. private _particlesRenderTime;
  137517. private _captureSpritesRenderTime;
  137518. private _spritesRenderTime;
  137519. private _capturePhysicsTime;
  137520. private _physicsTime;
  137521. private _captureAnimationsTime;
  137522. private _animationsTime;
  137523. private _captureCameraRenderTime;
  137524. private _cameraRenderTime;
  137525. private _onBeforeActiveMeshesEvaluationObserver;
  137526. private _onAfterActiveMeshesEvaluationObserver;
  137527. private _onBeforeRenderTargetsRenderObserver;
  137528. private _onAfterRenderTargetsRenderObserver;
  137529. private _onAfterRenderObserver;
  137530. private _onBeforeDrawPhaseObserver;
  137531. private _onAfterDrawPhaseObserver;
  137532. private _onBeforeAnimationsObserver;
  137533. private _onBeforeParticlesRenderingObserver;
  137534. private _onAfterParticlesRenderingObserver;
  137535. private _onBeforeSpritesRenderingObserver;
  137536. private _onAfterSpritesRenderingObserver;
  137537. private _onBeforePhysicsObserver;
  137538. private _onAfterPhysicsObserver;
  137539. private _onAfterAnimationsObserver;
  137540. private _onBeforeCameraRenderObserver;
  137541. private _onAfterCameraRenderObserver;
  137542. /**
  137543. * Gets the perf counter used for active meshes evaluation time
  137544. */
  137545. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  137546. /**
  137547. * Gets the active meshes evaluation time capture status
  137548. */
  137549. get captureActiveMeshesEvaluationTime(): boolean;
  137550. /**
  137551. * Enable or disable the active meshes evaluation time capture
  137552. */
  137553. set captureActiveMeshesEvaluationTime(value: boolean);
  137554. /**
  137555. * Gets the perf counter used for render targets render time
  137556. */
  137557. get renderTargetsRenderTimeCounter(): PerfCounter;
  137558. /**
  137559. * Gets the render targets render time capture status
  137560. */
  137561. get captureRenderTargetsRenderTime(): boolean;
  137562. /**
  137563. * Enable or disable the render targets render time capture
  137564. */
  137565. set captureRenderTargetsRenderTime(value: boolean);
  137566. /**
  137567. * Gets the perf counter used for particles render time
  137568. */
  137569. get particlesRenderTimeCounter(): PerfCounter;
  137570. /**
  137571. * Gets the particles render time capture status
  137572. */
  137573. get captureParticlesRenderTime(): boolean;
  137574. /**
  137575. * Enable or disable the particles render time capture
  137576. */
  137577. set captureParticlesRenderTime(value: boolean);
  137578. /**
  137579. * Gets the perf counter used for sprites render time
  137580. */
  137581. get spritesRenderTimeCounter(): PerfCounter;
  137582. /**
  137583. * Gets the sprites render time capture status
  137584. */
  137585. get captureSpritesRenderTime(): boolean;
  137586. /**
  137587. * Enable or disable the sprites render time capture
  137588. */
  137589. set captureSpritesRenderTime(value: boolean);
  137590. /**
  137591. * Gets the perf counter used for physics time
  137592. */
  137593. get physicsTimeCounter(): PerfCounter;
  137594. /**
  137595. * Gets the physics time capture status
  137596. */
  137597. get capturePhysicsTime(): boolean;
  137598. /**
  137599. * Enable or disable the physics time capture
  137600. */
  137601. set capturePhysicsTime(value: boolean);
  137602. /**
  137603. * Gets the perf counter used for animations time
  137604. */
  137605. get animationsTimeCounter(): PerfCounter;
  137606. /**
  137607. * Gets the animations time capture status
  137608. */
  137609. get captureAnimationsTime(): boolean;
  137610. /**
  137611. * Enable or disable the animations time capture
  137612. */
  137613. set captureAnimationsTime(value: boolean);
  137614. /**
  137615. * Gets the perf counter used for frame time capture
  137616. */
  137617. get frameTimeCounter(): PerfCounter;
  137618. /**
  137619. * Gets the frame time capture status
  137620. */
  137621. get captureFrameTime(): boolean;
  137622. /**
  137623. * Enable or disable the frame time capture
  137624. */
  137625. set captureFrameTime(value: boolean);
  137626. /**
  137627. * Gets the perf counter used for inter-frames time capture
  137628. */
  137629. get interFrameTimeCounter(): PerfCounter;
  137630. /**
  137631. * Gets the inter-frames time capture status
  137632. */
  137633. get captureInterFrameTime(): boolean;
  137634. /**
  137635. * Enable or disable the inter-frames time capture
  137636. */
  137637. set captureInterFrameTime(value: boolean);
  137638. /**
  137639. * Gets the perf counter used for render time capture
  137640. */
  137641. get renderTimeCounter(): PerfCounter;
  137642. /**
  137643. * Gets the render time capture status
  137644. */
  137645. get captureRenderTime(): boolean;
  137646. /**
  137647. * Enable or disable the render time capture
  137648. */
  137649. set captureRenderTime(value: boolean);
  137650. /**
  137651. * Gets the perf counter used for camera render time capture
  137652. */
  137653. get cameraRenderTimeCounter(): PerfCounter;
  137654. /**
  137655. * Gets the camera render time capture status
  137656. */
  137657. get captureCameraRenderTime(): boolean;
  137658. /**
  137659. * Enable or disable the camera render time capture
  137660. */
  137661. set captureCameraRenderTime(value: boolean);
  137662. /**
  137663. * Gets the perf counter used for draw calls
  137664. */
  137665. get drawCallsCounter(): PerfCounter;
  137666. /**
  137667. * Instantiates a new scene instrumentation.
  137668. * This class can be used to get instrumentation data from a Babylon engine
  137669. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137670. * @param scene Defines the scene to instrument
  137671. */
  137672. constructor(
  137673. /**
  137674. * Defines the scene to instrument
  137675. */
  137676. scene: Scene);
  137677. /**
  137678. * Dispose and release associated resources.
  137679. */
  137680. dispose(): void;
  137681. }
  137682. }
  137683. declare module BABYLON {
  137684. /** @hidden */
  137685. export var glowMapGenerationPixelShader: {
  137686. name: string;
  137687. shader: string;
  137688. };
  137689. }
  137690. declare module BABYLON {
  137691. /** @hidden */
  137692. export var glowMapGenerationVertexShader: {
  137693. name: string;
  137694. shader: string;
  137695. };
  137696. }
  137697. declare module BABYLON {
  137698. /**
  137699. * Effect layer options. This helps customizing the behaviour
  137700. * of the effect layer.
  137701. */
  137702. export interface IEffectLayerOptions {
  137703. /**
  137704. * Multiplication factor apply to the canvas size to compute the render target size
  137705. * used to generated the objects (the smaller the faster).
  137706. */
  137707. mainTextureRatio: number;
  137708. /**
  137709. * Enforces a fixed size texture to ensure effect stability across devices.
  137710. */
  137711. mainTextureFixedSize?: number;
  137712. /**
  137713. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  137714. */
  137715. alphaBlendingMode: number;
  137716. /**
  137717. * The camera attached to the layer.
  137718. */
  137719. camera: Nullable<Camera>;
  137720. /**
  137721. * The rendering group to draw the layer in.
  137722. */
  137723. renderingGroupId: number;
  137724. }
  137725. /**
  137726. * The effect layer Helps adding post process effect blended with the main pass.
  137727. *
  137728. * This can be for instance use to generate glow or higlight effects on the scene.
  137729. *
  137730. * The effect layer class can not be used directly and is intented to inherited from to be
  137731. * customized per effects.
  137732. */
  137733. export abstract class EffectLayer {
  137734. private _vertexBuffers;
  137735. private _indexBuffer;
  137736. private _cachedDefines;
  137737. private _effectLayerMapGenerationEffect;
  137738. private _effectLayerOptions;
  137739. private _mergeEffect;
  137740. protected _scene: Scene;
  137741. protected _engine: Engine;
  137742. protected _maxSize: number;
  137743. protected _mainTextureDesiredSize: ISize;
  137744. protected _mainTexture: RenderTargetTexture;
  137745. protected _shouldRender: boolean;
  137746. protected _postProcesses: PostProcess[];
  137747. protected _textures: BaseTexture[];
  137748. protected _emissiveTextureAndColor: {
  137749. texture: Nullable<BaseTexture>;
  137750. color: Color4;
  137751. };
  137752. /**
  137753. * The name of the layer
  137754. */
  137755. name: string;
  137756. /**
  137757. * The clear color of the texture used to generate the glow map.
  137758. */
  137759. neutralColor: Color4;
  137760. /**
  137761. * Specifies whether the highlight layer is enabled or not.
  137762. */
  137763. isEnabled: boolean;
  137764. /**
  137765. * Gets the camera attached to the layer.
  137766. */
  137767. get camera(): Nullable<Camera>;
  137768. /**
  137769. * Gets the rendering group id the layer should render in.
  137770. */
  137771. get renderingGroupId(): number;
  137772. set renderingGroupId(renderingGroupId: number);
  137773. /**
  137774. * An event triggered when the effect layer has been disposed.
  137775. */
  137776. onDisposeObservable: Observable<EffectLayer>;
  137777. /**
  137778. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  137779. */
  137780. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  137781. /**
  137782. * An event triggered when the generated texture is being merged in the scene.
  137783. */
  137784. onBeforeComposeObservable: Observable<EffectLayer>;
  137785. /**
  137786. * An event triggered when the mesh is rendered into the effect render target.
  137787. */
  137788. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  137789. /**
  137790. * An event triggered after the mesh has been rendered into the effect render target.
  137791. */
  137792. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  137793. /**
  137794. * An event triggered when the generated texture has been merged in the scene.
  137795. */
  137796. onAfterComposeObservable: Observable<EffectLayer>;
  137797. /**
  137798. * An event triggered when the efffect layer changes its size.
  137799. */
  137800. onSizeChangedObservable: Observable<EffectLayer>;
  137801. /** @hidden */
  137802. static _SceneComponentInitialization: (scene: Scene) => void;
  137803. /**
  137804. * Instantiates a new effect Layer and references it in the scene.
  137805. * @param name The name of the layer
  137806. * @param scene The scene to use the layer in
  137807. */
  137808. constructor(
  137809. /** The Friendly of the effect in the scene */
  137810. name: string, scene: Scene);
  137811. /**
  137812. * Get the effect name of the layer.
  137813. * @return The effect name
  137814. */
  137815. abstract getEffectName(): string;
  137816. /**
  137817. * Checks for the readiness of the element composing the layer.
  137818. * @param subMesh the mesh to check for
  137819. * @param useInstances specify whether or not to use instances to render the mesh
  137820. * @return true if ready otherwise, false
  137821. */
  137822. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137823. /**
  137824. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  137825. * @returns true if the effect requires stencil during the main canvas render pass.
  137826. */
  137827. abstract needStencil(): boolean;
  137828. /**
  137829. * Create the merge effect. This is the shader use to blit the information back
  137830. * to the main canvas at the end of the scene rendering.
  137831. * @returns The effect containing the shader used to merge the effect on the main canvas
  137832. */
  137833. protected abstract _createMergeEffect(): Effect;
  137834. /**
  137835. * Creates the render target textures and post processes used in the effect layer.
  137836. */
  137837. protected abstract _createTextureAndPostProcesses(): void;
  137838. /**
  137839. * Implementation specific of rendering the generating effect on the main canvas.
  137840. * @param effect The effect used to render through
  137841. */
  137842. protected abstract _internalRender(effect: Effect): void;
  137843. /**
  137844. * Sets the required values for both the emissive texture and and the main color.
  137845. */
  137846. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  137847. /**
  137848. * Free any resources and references associated to a mesh.
  137849. * Internal use
  137850. * @param mesh The mesh to free.
  137851. */
  137852. abstract _disposeMesh(mesh: Mesh): void;
  137853. /**
  137854. * Serializes this layer (Glow or Highlight for example)
  137855. * @returns a serialized layer object
  137856. */
  137857. abstract serialize?(): any;
  137858. /**
  137859. * Initializes the effect layer with the required options.
  137860. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  137861. */
  137862. protected _init(options: Partial<IEffectLayerOptions>): void;
  137863. /**
  137864. * Generates the index buffer of the full screen quad blending to the main canvas.
  137865. */
  137866. private _generateIndexBuffer;
  137867. /**
  137868. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  137869. */
  137870. private _generateVertexBuffer;
  137871. /**
  137872. * Sets the main texture desired size which is the closest power of two
  137873. * of the engine canvas size.
  137874. */
  137875. private _setMainTextureSize;
  137876. /**
  137877. * Creates the main texture for the effect layer.
  137878. */
  137879. protected _createMainTexture(): void;
  137880. /**
  137881. * Adds specific effects defines.
  137882. * @param defines The defines to add specifics to.
  137883. */
  137884. protected _addCustomEffectDefines(defines: string[]): void;
  137885. /**
  137886. * Checks for the readiness of the element composing the layer.
  137887. * @param subMesh the mesh to check for
  137888. * @param useInstances specify whether or not to use instances to render the mesh
  137889. * @param emissiveTexture the associated emissive texture used to generate the glow
  137890. * @return true if ready otherwise, false
  137891. */
  137892. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  137893. /**
  137894. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  137895. */
  137896. render(): void;
  137897. /**
  137898. * Determine if a given mesh will be used in the current effect.
  137899. * @param mesh mesh to test
  137900. * @returns true if the mesh will be used
  137901. */
  137902. hasMesh(mesh: AbstractMesh): boolean;
  137903. /**
  137904. * Returns true if the layer contains information to display, otherwise false.
  137905. * @returns true if the glow layer should be rendered
  137906. */
  137907. shouldRender(): boolean;
  137908. /**
  137909. * Returns true if the mesh should render, otherwise false.
  137910. * @param mesh The mesh to render
  137911. * @returns true if it should render otherwise false
  137912. */
  137913. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  137914. /**
  137915. * Returns true if the mesh can be rendered, otherwise false.
  137916. * @param mesh The mesh to render
  137917. * @param material The material used on the mesh
  137918. * @returns true if it can be rendered otherwise false
  137919. */
  137920. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  137921. /**
  137922. * Returns true if the mesh should render, otherwise false.
  137923. * @param mesh The mesh to render
  137924. * @returns true if it should render otherwise false
  137925. */
  137926. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  137927. /**
  137928. * Renders the submesh passed in parameter to the generation map.
  137929. */
  137930. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  137931. /**
  137932. * Defines whether the current material of the mesh should be use to render the effect.
  137933. * @param mesh defines the current mesh to render
  137934. */
  137935. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  137936. /**
  137937. * Rebuild the required buffers.
  137938. * @hidden Internal use only.
  137939. */
  137940. _rebuild(): void;
  137941. /**
  137942. * Dispose only the render target textures and post process.
  137943. */
  137944. private _disposeTextureAndPostProcesses;
  137945. /**
  137946. * Dispose the highlight layer and free resources.
  137947. */
  137948. dispose(): void;
  137949. /**
  137950. * Gets the class name of the effect layer
  137951. * @returns the string with the class name of the effect layer
  137952. */
  137953. getClassName(): string;
  137954. /**
  137955. * Creates an effect layer from parsed effect layer data
  137956. * @param parsedEffectLayer defines effect layer data
  137957. * @param scene defines the current scene
  137958. * @param rootUrl defines the root URL containing the effect layer information
  137959. * @returns a parsed effect Layer
  137960. */
  137961. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  137962. }
  137963. }
  137964. declare module BABYLON {
  137965. interface AbstractScene {
  137966. /**
  137967. * The list of effect layers (highlights/glow) added to the scene
  137968. * @see https://doc.babylonjs.com/how_to/highlight_layer
  137969. * @see https://doc.babylonjs.com/how_to/glow_layer
  137970. */
  137971. effectLayers: Array<EffectLayer>;
  137972. /**
  137973. * Removes the given effect layer from this scene.
  137974. * @param toRemove defines the effect layer to remove
  137975. * @returns the index of the removed effect layer
  137976. */
  137977. removeEffectLayer(toRemove: EffectLayer): number;
  137978. /**
  137979. * Adds the given effect layer to this scene
  137980. * @param newEffectLayer defines the effect layer to add
  137981. */
  137982. addEffectLayer(newEffectLayer: EffectLayer): void;
  137983. }
  137984. /**
  137985. * Defines the layer scene component responsible to manage any effect layers
  137986. * in a given scene.
  137987. */
  137988. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  137989. /**
  137990. * The component name helpfull to identify the component in the list of scene components.
  137991. */
  137992. readonly name: string;
  137993. /**
  137994. * The scene the component belongs to.
  137995. */
  137996. scene: Scene;
  137997. private _engine;
  137998. private _renderEffects;
  137999. private _needStencil;
  138000. private _previousStencilState;
  138001. /**
  138002. * Creates a new instance of the component for the given scene
  138003. * @param scene Defines the scene to register the component in
  138004. */
  138005. constructor(scene: Scene);
  138006. /**
  138007. * Registers the component in a given scene
  138008. */
  138009. register(): void;
  138010. /**
  138011. * Rebuilds the elements related to this component in case of
  138012. * context lost for instance.
  138013. */
  138014. rebuild(): void;
  138015. /**
  138016. * Serializes the component data to the specified json object
  138017. * @param serializationObject The object to serialize to
  138018. */
  138019. serialize(serializationObject: any): void;
  138020. /**
  138021. * Adds all the elements from the container to the scene
  138022. * @param container the container holding the elements
  138023. */
  138024. addFromContainer(container: AbstractScene): void;
  138025. /**
  138026. * Removes all the elements in the container from the scene
  138027. * @param container contains the elements to remove
  138028. * @param dispose if the removed element should be disposed (default: false)
  138029. */
  138030. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138031. /**
  138032. * Disposes the component and the associated ressources.
  138033. */
  138034. dispose(): void;
  138035. private _isReadyForMesh;
  138036. private _renderMainTexture;
  138037. private _setStencil;
  138038. private _setStencilBack;
  138039. private _draw;
  138040. private _drawCamera;
  138041. private _drawRenderingGroup;
  138042. }
  138043. }
  138044. declare module BABYLON {
  138045. /** @hidden */
  138046. export var glowMapMergePixelShader: {
  138047. name: string;
  138048. shader: string;
  138049. };
  138050. }
  138051. declare module BABYLON {
  138052. /** @hidden */
  138053. export var glowMapMergeVertexShader: {
  138054. name: string;
  138055. shader: string;
  138056. };
  138057. }
  138058. declare module BABYLON {
  138059. interface AbstractScene {
  138060. /**
  138061. * Return a the first highlight layer of the scene with a given name.
  138062. * @param name The name of the highlight layer to look for.
  138063. * @return The highlight layer if found otherwise null.
  138064. */
  138065. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  138066. }
  138067. /**
  138068. * Glow layer options. This helps customizing the behaviour
  138069. * of the glow layer.
  138070. */
  138071. export interface IGlowLayerOptions {
  138072. /**
  138073. * Multiplication factor apply to the canvas size to compute the render target size
  138074. * used to generated the glowing objects (the smaller the faster).
  138075. */
  138076. mainTextureRatio: number;
  138077. /**
  138078. * Enforces a fixed size texture to ensure resize independant blur.
  138079. */
  138080. mainTextureFixedSize?: number;
  138081. /**
  138082. * How big is the kernel of the blur texture.
  138083. */
  138084. blurKernelSize: number;
  138085. /**
  138086. * The camera attached to the layer.
  138087. */
  138088. camera: Nullable<Camera>;
  138089. /**
  138090. * Enable MSAA by chosing the number of samples.
  138091. */
  138092. mainTextureSamples?: number;
  138093. /**
  138094. * The rendering group to draw the layer in.
  138095. */
  138096. renderingGroupId: number;
  138097. }
  138098. /**
  138099. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  138100. *
  138101. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  138102. *
  138103. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  138104. */
  138105. export class GlowLayer extends EffectLayer {
  138106. /**
  138107. * Effect Name of the layer.
  138108. */
  138109. static readonly EffectName: string;
  138110. /**
  138111. * The default blur kernel size used for the glow.
  138112. */
  138113. static DefaultBlurKernelSize: number;
  138114. /**
  138115. * The default texture size ratio used for the glow.
  138116. */
  138117. static DefaultTextureRatio: number;
  138118. /**
  138119. * Sets the kernel size of the blur.
  138120. */
  138121. set blurKernelSize(value: number);
  138122. /**
  138123. * Gets the kernel size of the blur.
  138124. */
  138125. get blurKernelSize(): number;
  138126. /**
  138127. * Sets the glow intensity.
  138128. */
  138129. set intensity(value: number);
  138130. /**
  138131. * Gets the glow intensity.
  138132. */
  138133. get intensity(): number;
  138134. private _options;
  138135. private _intensity;
  138136. private _horizontalBlurPostprocess1;
  138137. private _verticalBlurPostprocess1;
  138138. private _horizontalBlurPostprocess2;
  138139. private _verticalBlurPostprocess2;
  138140. private _blurTexture1;
  138141. private _blurTexture2;
  138142. private _postProcesses1;
  138143. private _postProcesses2;
  138144. private _includedOnlyMeshes;
  138145. private _excludedMeshes;
  138146. private _meshesUsingTheirOwnMaterials;
  138147. /**
  138148. * Callback used to let the user override the color selection on a per mesh basis
  138149. */
  138150. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  138151. /**
  138152. * Callback used to let the user override the texture selection on a per mesh basis
  138153. */
  138154. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  138155. /**
  138156. * Instantiates a new glow Layer and references it to the scene.
  138157. * @param name The name of the layer
  138158. * @param scene The scene to use the layer in
  138159. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  138160. */
  138161. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  138162. /**
  138163. * Get the effect name of the layer.
  138164. * @return The effect name
  138165. */
  138166. getEffectName(): string;
  138167. /**
  138168. * Create the merge effect. This is the shader use to blit the information back
  138169. * to the main canvas at the end of the scene rendering.
  138170. */
  138171. protected _createMergeEffect(): Effect;
  138172. /**
  138173. * Creates the render target textures and post processes used in the glow layer.
  138174. */
  138175. protected _createTextureAndPostProcesses(): void;
  138176. /**
  138177. * Checks for the readiness of the element composing the layer.
  138178. * @param subMesh the mesh to check for
  138179. * @param useInstances specify wether or not to use instances to render the mesh
  138180. * @param emissiveTexture the associated emissive texture used to generate the glow
  138181. * @return true if ready otherwise, false
  138182. */
  138183. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138184. /**
  138185. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138186. */
  138187. needStencil(): boolean;
  138188. /**
  138189. * Returns true if the mesh can be rendered, otherwise false.
  138190. * @param mesh The mesh to render
  138191. * @param material The material used on the mesh
  138192. * @returns true if it can be rendered otherwise false
  138193. */
  138194. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138195. /**
  138196. * Implementation specific of rendering the generating effect on the main canvas.
  138197. * @param effect The effect used to render through
  138198. */
  138199. protected _internalRender(effect: Effect): void;
  138200. /**
  138201. * Sets the required values for both the emissive texture and and the main color.
  138202. */
  138203. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138204. /**
  138205. * Returns true if the mesh should render, otherwise false.
  138206. * @param mesh The mesh to render
  138207. * @returns true if it should render otherwise false
  138208. */
  138209. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138210. /**
  138211. * Adds specific effects defines.
  138212. * @param defines The defines to add specifics to.
  138213. */
  138214. protected _addCustomEffectDefines(defines: string[]): void;
  138215. /**
  138216. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  138217. * @param mesh The mesh to exclude from the glow layer
  138218. */
  138219. addExcludedMesh(mesh: Mesh): void;
  138220. /**
  138221. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  138222. * @param mesh The mesh to remove
  138223. */
  138224. removeExcludedMesh(mesh: Mesh): void;
  138225. /**
  138226. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  138227. * @param mesh The mesh to include in the glow layer
  138228. */
  138229. addIncludedOnlyMesh(mesh: Mesh): void;
  138230. /**
  138231. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  138232. * @param mesh The mesh to remove
  138233. */
  138234. removeIncludedOnlyMesh(mesh: Mesh): void;
  138235. /**
  138236. * Determine if a given mesh will be used in the glow layer
  138237. * @param mesh The mesh to test
  138238. * @returns true if the mesh will be highlighted by the current glow layer
  138239. */
  138240. hasMesh(mesh: AbstractMesh): boolean;
  138241. /**
  138242. * Defines whether the current material of the mesh should be use to render the effect.
  138243. * @param mesh defines the current mesh to render
  138244. */
  138245. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138246. /**
  138247. * Add a mesh to be rendered through its own material and not with emissive only.
  138248. * @param mesh The mesh for which we need to use its material
  138249. */
  138250. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  138251. /**
  138252. * Remove a mesh from being rendered through its own material and not with emissive only.
  138253. * @param mesh The mesh for which we need to not use its material
  138254. */
  138255. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  138256. /**
  138257. * Free any resources and references associated to a mesh.
  138258. * Internal use
  138259. * @param mesh The mesh to free.
  138260. * @hidden
  138261. */
  138262. _disposeMesh(mesh: Mesh): void;
  138263. /**
  138264. * Gets the class name of the effect layer
  138265. * @returns the string with the class name of the effect layer
  138266. */
  138267. getClassName(): string;
  138268. /**
  138269. * Serializes this glow layer
  138270. * @returns a serialized glow layer object
  138271. */
  138272. serialize(): any;
  138273. /**
  138274. * Creates a Glow Layer from parsed glow layer data
  138275. * @param parsedGlowLayer defines glow layer data
  138276. * @param scene defines the current scene
  138277. * @param rootUrl defines the root URL containing the glow layer information
  138278. * @returns a parsed Glow Layer
  138279. */
  138280. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  138281. }
  138282. }
  138283. declare module BABYLON {
  138284. /** @hidden */
  138285. export var glowBlurPostProcessPixelShader: {
  138286. name: string;
  138287. shader: string;
  138288. };
  138289. }
  138290. declare module BABYLON {
  138291. interface AbstractScene {
  138292. /**
  138293. * Return a the first highlight layer of the scene with a given name.
  138294. * @param name The name of the highlight layer to look for.
  138295. * @return The highlight layer if found otherwise null.
  138296. */
  138297. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  138298. }
  138299. /**
  138300. * Highlight layer options. This helps customizing the behaviour
  138301. * of the highlight layer.
  138302. */
  138303. export interface IHighlightLayerOptions {
  138304. /**
  138305. * Multiplication factor apply to the canvas size to compute the render target size
  138306. * used to generated the glowing objects (the smaller the faster).
  138307. */
  138308. mainTextureRatio: number;
  138309. /**
  138310. * Enforces a fixed size texture to ensure resize independant blur.
  138311. */
  138312. mainTextureFixedSize?: number;
  138313. /**
  138314. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  138315. * of the picture to blur (the smaller the faster).
  138316. */
  138317. blurTextureSizeRatio: number;
  138318. /**
  138319. * How big in texel of the blur texture is the vertical blur.
  138320. */
  138321. blurVerticalSize: number;
  138322. /**
  138323. * How big in texel of the blur texture is the horizontal blur.
  138324. */
  138325. blurHorizontalSize: number;
  138326. /**
  138327. * Alpha blending mode used to apply the blur. Default is combine.
  138328. */
  138329. alphaBlendingMode: number;
  138330. /**
  138331. * The camera attached to the layer.
  138332. */
  138333. camera: Nullable<Camera>;
  138334. /**
  138335. * Should we display highlight as a solid stroke?
  138336. */
  138337. isStroke?: boolean;
  138338. /**
  138339. * The rendering group to draw the layer in.
  138340. */
  138341. renderingGroupId: number;
  138342. }
  138343. /**
  138344. * The highlight layer Helps adding a glow effect around a mesh.
  138345. *
  138346. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  138347. * glowy meshes to your scene.
  138348. *
  138349. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  138350. */
  138351. export class HighlightLayer extends EffectLayer {
  138352. name: string;
  138353. /**
  138354. * Effect Name of the highlight layer.
  138355. */
  138356. static readonly EffectName: string;
  138357. /**
  138358. * The neutral color used during the preparation of the glow effect.
  138359. * This is black by default as the blend operation is a blend operation.
  138360. */
  138361. static NeutralColor: Color4;
  138362. /**
  138363. * Stencil value used for glowing meshes.
  138364. */
  138365. static GlowingMeshStencilReference: number;
  138366. /**
  138367. * Stencil value used for the other meshes in the scene.
  138368. */
  138369. static NormalMeshStencilReference: number;
  138370. /**
  138371. * Specifies whether or not the inner glow is ACTIVE in the layer.
  138372. */
  138373. innerGlow: boolean;
  138374. /**
  138375. * Specifies whether or not the outer glow is ACTIVE in the layer.
  138376. */
  138377. outerGlow: boolean;
  138378. /**
  138379. * Specifies the horizontal size of the blur.
  138380. */
  138381. set blurHorizontalSize(value: number);
  138382. /**
  138383. * Specifies the vertical size of the blur.
  138384. */
  138385. set blurVerticalSize(value: number);
  138386. /**
  138387. * Gets the horizontal size of the blur.
  138388. */
  138389. get blurHorizontalSize(): number;
  138390. /**
  138391. * Gets the vertical size of the blur.
  138392. */
  138393. get blurVerticalSize(): number;
  138394. /**
  138395. * An event triggered when the highlight layer is being blurred.
  138396. */
  138397. onBeforeBlurObservable: Observable<HighlightLayer>;
  138398. /**
  138399. * An event triggered when the highlight layer has been blurred.
  138400. */
  138401. onAfterBlurObservable: Observable<HighlightLayer>;
  138402. private _instanceGlowingMeshStencilReference;
  138403. private _options;
  138404. private _downSamplePostprocess;
  138405. private _horizontalBlurPostprocess;
  138406. private _verticalBlurPostprocess;
  138407. private _blurTexture;
  138408. private _meshes;
  138409. private _excludedMeshes;
  138410. /**
  138411. * Instantiates a new highlight Layer and references it to the scene..
  138412. * @param name The name of the layer
  138413. * @param scene The scene to use the layer in
  138414. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  138415. */
  138416. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  138417. /**
  138418. * Get the effect name of the layer.
  138419. * @return The effect name
  138420. */
  138421. getEffectName(): string;
  138422. /**
  138423. * Create the merge effect. This is the shader use to blit the information back
  138424. * to the main canvas at the end of the scene rendering.
  138425. */
  138426. protected _createMergeEffect(): Effect;
  138427. /**
  138428. * Creates the render target textures and post processes used in the highlight layer.
  138429. */
  138430. protected _createTextureAndPostProcesses(): void;
  138431. /**
  138432. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  138433. */
  138434. needStencil(): boolean;
  138435. /**
  138436. * Checks for the readiness of the element composing the layer.
  138437. * @param subMesh the mesh to check for
  138438. * @param useInstances specify wether or not to use instances to render the mesh
  138439. * @param emissiveTexture the associated emissive texture used to generate the glow
  138440. * @return true if ready otherwise, false
  138441. */
  138442. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138443. /**
  138444. * Implementation specific of rendering the generating effect on the main canvas.
  138445. * @param effect The effect used to render through
  138446. */
  138447. protected _internalRender(effect: Effect): void;
  138448. /**
  138449. * Returns true if the layer contains information to display, otherwise false.
  138450. */
  138451. shouldRender(): boolean;
  138452. /**
  138453. * Returns true if the mesh should render, otherwise false.
  138454. * @param mesh The mesh to render
  138455. * @returns true if it should render otherwise false
  138456. */
  138457. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138458. /**
  138459. * Returns true if the mesh can be rendered, otherwise false.
  138460. * @param mesh The mesh to render
  138461. * @param material The material used on the mesh
  138462. * @returns true if it can be rendered otherwise false
  138463. */
  138464. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138465. /**
  138466. * Adds specific effects defines.
  138467. * @param defines The defines to add specifics to.
  138468. */
  138469. protected _addCustomEffectDefines(defines: string[]): void;
  138470. /**
  138471. * Sets the required values for both the emissive texture and and the main color.
  138472. */
  138473. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138474. /**
  138475. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  138476. * @param mesh The mesh to exclude from the highlight layer
  138477. */
  138478. addExcludedMesh(mesh: Mesh): void;
  138479. /**
  138480. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  138481. * @param mesh The mesh to highlight
  138482. */
  138483. removeExcludedMesh(mesh: Mesh): void;
  138484. /**
  138485. * Determine if a given mesh will be highlighted by the current HighlightLayer
  138486. * @param mesh mesh to test
  138487. * @returns true if the mesh will be highlighted by the current HighlightLayer
  138488. */
  138489. hasMesh(mesh: AbstractMesh): boolean;
  138490. /**
  138491. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  138492. * @param mesh The mesh to highlight
  138493. * @param color The color of the highlight
  138494. * @param glowEmissiveOnly Extract the glow from the emissive texture
  138495. */
  138496. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  138497. /**
  138498. * Remove a mesh from the highlight layer in order to make it stop glowing.
  138499. * @param mesh The mesh to highlight
  138500. */
  138501. removeMesh(mesh: Mesh): void;
  138502. /**
  138503. * Remove all the meshes currently referenced in the highlight layer
  138504. */
  138505. removeAllMeshes(): void;
  138506. /**
  138507. * Force the stencil to the normal expected value for none glowing parts
  138508. */
  138509. private _defaultStencilReference;
  138510. /**
  138511. * Free any resources and references associated to a mesh.
  138512. * Internal use
  138513. * @param mesh The mesh to free.
  138514. * @hidden
  138515. */
  138516. _disposeMesh(mesh: Mesh): void;
  138517. /**
  138518. * Dispose the highlight layer and free resources.
  138519. */
  138520. dispose(): void;
  138521. /**
  138522. * Gets the class name of the effect layer
  138523. * @returns the string with the class name of the effect layer
  138524. */
  138525. getClassName(): string;
  138526. /**
  138527. * Serializes this Highlight layer
  138528. * @returns a serialized Highlight layer object
  138529. */
  138530. serialize(): any;
  138531. /**
  138532. * Creates a Highlight layer from parsed Highlight layer data
  138533. * @param parsedHightlightLayer defines the Highlight layer data
  138534. * @param scene defines the current scene
  138535. * @param rootUrl defines the root URL containing the Highlight layer information
  138536. * @returns a parsed Highlight layer
  138537. */
  138538. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  138539. }
  138540. }
  138541. declare module BABYLON {
  138542. interface AbstractScene {
  138543. /**
  138544. * The list of layers (background and foreground) of the scene
  138545. */
  138546. layers: Array<Layer>;
  138547. }
  138548. /**
  138549. * Defines the layer scene component responsible to manage any layers
  138550. * in a given scene.
  138551. */
  138552. export class LayerSceneComponent implements ISceneComponent {
  138553. /**
  138554. * The component name helpfull to identify the component in the list of scene components.
  138555. */
  138556. readonly name: string;
  138557. /**
  138558. * The scene the component belongs to.
  138559. */
  138560. scene: Scene;
  138561. private _engine;
  138562. /**
  138563. * Creates a new instance of the component for the given scene
  138564. * @param scene Defines the scene to register the component in
  138565. */
  138566. constructor(scene: Scene);
  138567. /**
  138568. * Registers the component in a given scene
  138569. */
  138570. register(): void;
  138571. /**
  138572. * Rebuilds the elements related to this component in case of
  138573. * context lost for instance.
  138574. */
  138575. rebuild(): void;
  138576. /**
  138577. * Disposes the component and the associated ressources.
  138578. */
  138579. dispose(): void;
  138580. private _draw;
  138581. private _drawCameraPredicate;
  138582. private _drawCameraBackground;
  138583. private _drawCameraForeground;
  138584. private _drawRenderTargetPredicate;
  138585. private _drawRenderTargetBackground;
  138586. private _drawRenderTargetForeground;
  138587. /**
  138588. * Adds all the elements from the container to the scene
  138589. * @param container the container holding the elements
  138590. */
  138591. addFromContainer(container: AbstractScene): void;
  138592. /**
  138593. * Removes all the elements in the container from the scene
  138594. * @param container contains the elements to remove
  138595. * @param dispose if the removed element should be disposed (default: false)
  138596. */
  138597. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138598. }
  138599. }
  138600. declare module BABYLON {
  138601. /** @hidden */
  138602. export var layerPixelShader: {
  138603. name: string;
  138604. shader: string;
  138605. };
  138606. }
  138607. declare module BABYLON {
  138608. /** @hidden */
  138609. export var layerVertexShader: {
  138610. name: string;
  138611. shader: string;
  138612. };
  138613. }
  138614. declare module BABYLON {
  138615. /**
  138616. * This represents a full screen 2d layer.
  138617. * This can be useful to display a picture in the background of your scene for instance.
  138618. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138619. */
  138620. export class Layer {
  138621. /**
  138622. * Define the name of the layer.
  138623. */
  138624. name: string;
  138625. /**
  138626. * Define the texture the layer should display.
  138627. */
  138628. texture: Nullable<Texture>;
  138629. /**
  138630. * Is the layer in background or foreground.
  138631. */
  138632. isBackground: boolean;
  138633. /**
  138634. * Define the color of the layer (instead of texture).
  138635. */
  138636. color: Color4;
  138637. /**
  138638. * Define the scale of the layer in order to zoom in out of the texture.
  138639. */
  138640. scale: Vector2;
  138641. /**
  138642. * Define an offset for the layer in order to shift the texture.
  138643. */
  138644. offset: Vector2;
  138645. /**
  138646. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  138647. */
  138648. alphaBlendingMode: number;
  138649. /**
  138650. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  138651. * Alpha test will not mix with the background color in case of transparency.
  138652. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  138653. */
  138654. alphaTest: boolean;
  138655. /**
  138656. * Define a mask to restrict the layer to only some of the scene cameras.
  138657. */
  138658. layerMask: number;
  138659. /**
  138660. * Define the list of render target the layer is visible into.
  138661. */
  138662. renderTargetTextures: RenderTargetTexture[];
  138663. /**
  138664. * Define if the layer is only used in renderTarget or if it also
  138665. * renders in the main frame buffer of the canvas.
  138666. */
  138667. renderOnlyInRenderTargetTextures: boolean;
  138668. private _scene;
  138669. private _vertexBuffers;
  138670. private _indexBuffer;
  138671. private _effect;
  138672. private _previousDefines;
  138673. /**
  138674. * An event triggered when the layer is disposed.
  138675. */
  138676. onDisposeObservable: Observable<Layer>;
  138677. private _onDisposeObserver;
  138678. /**
  138679. * Back compatibility with callback before the onDisposeObservable existed.
  138680. * The set callback will be triggered when the layer has been disposed.
  138681. */
  138682. set onDispose(callback: () => void);
  138683. /**
  138684. * An event triggered before rendering the scene
  138685. */
  138686. onBeforeRenderObservable: Observable<Layer>;
  138687. private _onBeforeRenderObserver;
  138688. /**
  138689. * Back compatibility with callback before the onBeforeRenderObservable existed.
  138690. * The set callback will be triggered just before rendering the layer.
  138691. */
  138692. set onBeforeRender(callback: () => void);
  138693. /**
  138694. * An event triggered after rendering the scene
  138695. */
  138696. onAfterRenderObservable: Observable<Layer>;
  138697. private _onAfterRenderObserver;
  138698. /**
  138699. * Back compatibility with callback before the onAfterRenderObservable existed.
  138700. * The set callback will be triggered just after rendering the layer.
  138701. */
  138702. set onAfterRender(callback: () => void);
  138703. /**
  138704. * Instantiates a new layer.
  138705. * This represents a full screen 2d layer.
  138706. * This can be useful to display a picture in the background of your scene for instance.
  138707. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138708. * @param name Define the name of the layer in the scene
  138709. * @param imgUrl Define the url of the texture to display in the layer
  138710. * @param scene Define the scene the layer belongs to
  138711. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  138712. * @param color Defines a color for the layer
  138713. */
  138714. constructor(
  138715. /**
  138716. * Define the name of the layer.
  138717. */
  138718. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  138719. private _createIndexBuffer;
  138720. /** @hidden */
  138721. _rebuild(): void;
  138722. /**
  138723. * Renders the layer in the scene.
  138724. */
  138725. render(): void;
  138726. /**
  138727. * Disposes and releases the associated ressources.
  138728. */
  138729. dispose(): void;
  138730. }
  138731. }
  138732. declare module BABYLON {
  138733. /** @hidden */
  138734. export var lensFlarePixelShader: {
  138735. name: string;
  138736. shader: string;
  138737. };
  138738. }
  138739. declare module BABYLON {
  138740. /** @hidden */
  138741. export var lensFlareVertexShader: {
  138742. name: string;
  138743. shader: string;
  138744. };
  138745. }
  138746. declare module BABYLON {
  138747. /**
  138748. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138749. * It is usually composed of several `lensFlare`.
  138750. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138751. */
  138752. export class LensFlareSystem {
  138753. /**
  138754. * Define the name of the lens flare system
  138755. */
  138756. name: string;
  138757. /**
  138758. * List of lens flares used in this system.
  138759. */
  138760. lensFlares: LensFlare[];
  138761. /**
  138762. * Define a limit from the border the lens flare can be visible.
  138763. */
  138764. borderLimit: number;
  138765. /**
  138766. * Define a viewport border we do not want to see the lens flare in.
  138767. */
  138768. viewportBorder: number;
  138769. /**
  138770. * Define a predicate which could limit the list of meshes able to occlude the effect.
  138771. */
  138772. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  138773. /**
  138774. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  138775. */
  138776. layerMask: number;
  138777. /**
  138778. * Define the id of the lens flare system in the scene.
  138779. * (equal to name by default)
  138780. */
  138781. id: string;
  138782. private _scene;
  138783. private _emitter;
  138784. private _vertexBuffers;
  138785. private _indexBuffer;
  138786. private _effect;
  138787. private _positionX;
  138788. private _positionY;
  138789. private _isEnabled;
  138790. /** @hidden */
  138791. static _SceneComponentInitialization: (scene: Scene) => void;
  138792. /**
  138793. * Instantiates a lens flare system.
  138794. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138795. * It is usually composed of several `lensFlare`.
  138796. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138797. * @param name Define the name of the lens flare system in the scene
  138798. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  138799. * @param scene Define the scene the lens flare system belongs to
  138800. */
  138801. constructor(
  138802. /**
  138803. * Define the name of the lens flare system
  138804. */
  138805. name: string, emitter: any, scene: Scene);
  138806. /**
  138807. * Define if the lens flare system is enabled.
  138808. */
  138809. get isEnabled(): boolean;
  138810. set isEnabled(value: boolean);
  138811. /**
  138812. * Get the scene the effects belongs to.
  138813. * @returns the scene holding the lens flare system
  138814. */
  138815. getScene(): Scene;
  138816. /**
  138817. * Get the emitter of the lens flare system.
  138818. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138819. * @returns the emitter of the lens flare system
  138820. */
  138821. getEmitter(): any;
  138822. /**
  138823. * Set the emitter of the lens flare system.
  138824. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138825. * @param newEmitter Define the new emitter of the system
  138826. */
  138827. setEmitter(newEmitter: any): void;
  138828. /**
  138829. * Get the lens flare system emitter position.
  138830. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  138831. * @returns the position
  138832. */
  138833. getEmitterPosition(): Vector3;
  138834. /**
  138835. * @hidden
  138836. */
  138837. computeEffectivePosition(globalViewport: Viewport): boolean;
  138838. /** @hidden */
  138839. _isVisible(): boolean;
  138840. /**
  138841. * @hidden
  138842. */
  138843. render(): boolean;
  138844. /**
  138845. * Dispose and release the lens flare with its associated resources.
  138846. */
  138847. dispose(): void;
  138848. /**
  138849. * Parse a lens flare system from a JSON repressentation
  138850. * @param parsedLensFlareSystem Define the JSON to parse
  138851. * @param scene Define the scene the parsed system should be instantiated in
  138852. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  138853. * @returns the parsed system
  138854. */
  138855. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  138856. /**
  138857. * Serialize the current Lens Flare System into a JSON representation.
  138858. * @returns the serialized JSON
  138859. */
  138860. serialize(): any;
  138861. }
  138862. }
  138863. declare module BABYLON {
  138864. /**
  138865. * This represents one of the lens effect in a `lensFlareSystem`.
  138866. * It controls one of the indiviual texture used in the effect.
  138867. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138868. */
  138869. export class LensFlare {
  138870. /**
  138871. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138872. */
  138873. size: number;
  138874. /**
  138875. * 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.
  138876. */
  138877. position: number;
  138878. /**
  138879. * Define the lens color.
  138880. */
  138881. color: Color3;
  138882. /**
  138883. * Define the lens texture.
  138884. */
  138885. texture: Nullable<Texture>;
  138886. /**
  138887. * Define the alpha mode to render this particular lens.
  138888. */
  138889. alphaMode: number;
  138890. private _system;
  138891. /**
  138892. * Creates a new Lens Flare.
  138893. * This represents one of the lens effect in a `lensFlareSystem`.
  138894. * It controls one of the indiviual texture used in the effect.
  138895. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138896. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  138897. * @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.
  138898. * @param color Define the lens color
  138899. * @param imgUrl Define the lens texture url
  138900. * @param system Define the `lensFlareSystem` this flare is part of
  138901. * @returns The newly created Lens Flare
  138902. */
  138903. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  138904. /**
  138905. * Instantiates a new Lens Flare.
  138906. * This represents one of the lens effect in a `lensFlareSystem`.
  138907. * It controls one of the indiviual texture used in the effect.
  138908. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138909. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  138910. * @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.
  138911. * @param color Define the lens color
  138912. * @param imgUrl Define the lens texture url
  138913. * @param system Define the `lensFlareSystem` this flare is part of
  138914. */
  138915. constructor(
  138916. /**
  138917. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138918. */
  138919. size: number,
  138920. /**
  138921. * 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.
  138922. */
  138923. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  138924. /**
  138925. * Dispose and release the lens flare with its associated resources.
  138926. */
  138927. dispose(): void;
  138928. }
  138929. }
  138930. declare module BABYLON {
  138931. interface AbstractScene {
  138932. /**
  138933. * The list of lens flare system added to the scene
  138934. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138935. */
  138936. lensFlareSystems: Array<LensFlareSystem>;
  138937. /**
  138938. * Removes the given lens flare system from this scene.
  138939. * @param toRemove The lens flare system to remove
  138940. * @returns The index of the removed lens flare system
  138941. */
  138942. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  138943. /**
  138944. * Adds the given lens flare system to this scene
  138945. * @param newLensFlareSystem The lens flare system to add
  138946. */
  138947. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  138948. /**
  138949. * Gets a lens flare system using its name
  138950. * @param name defines the name to look for
  138951. * @returns the lens flare system or null if not found
  138952. */
  138953. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  138954. /**
  138955. * Gets a lens flare system using its id
  138956. * @param id defines the id to look for
  138957. * @returns the lens flare system or null if not found
  138958. */
  138959. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  138960. }
  138961. /**
  138962. * Defines the lens flare scene component responsible to manage any lens flares
  138963. * in a given scene.
  138964. */
  138965. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  138966. /**
  138967. * The component name helpfull to identify the component in the list of scene components.
  138968. */
  138969. readonly name: string;
  138970. /**
  138971. * The scene the component belongs to.
  138972. */
  138973. scene: Scene;
  138974. /**
  138975. * Creates a new instance of the component for the given scene
  138976. * @param scene Defines the scene to register the component in
  138977. */
  138978. constructor(scene: Scene);
  138979. /**
  138980. * Registers the component in a given scene
  138981. */
  138982. register(): void;
  138983. /**
  138984. * Rebuilds the elements related to this component in case of
  138985. * context lost for instance.
  138986. */
  138987. rebuild(): void;
  138988. /**
  138989. * Adds all the elements from the container to the scene
  138990. * @param container the container holding the elements
  138991. */
  138992. addFromContainer(container: AbstractScene): void;
  138993. /**
  138994. * Removes all the elements in the container from the scene
  138995. * @param container contains the elements to remove
  138996. * @param dispose if the removed element should be disposed (default: false)
  138997. */
  138998. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138999. /**
  139000. * Serializes the component data to the specified json object
  139001. * @param serializationObject The object to serialize to
  139002. */
  139003. serialize(serializationObject: any): void;
  139004. /**
  139005. * Disposes the component and the associated ressources.
  139006. */
  139007. dispose(): void;
  139008. private _draw;
  139009. }
  139010. }
  139011. declare module BABYLON {
  139012. /** @hidden */
  139013. export var depthPixelShader: {
  139014. name: string;
  139015. shader: string;
  139016. };
  139017. }
  139018. declare module BABYLON {
  139019. /** @hidden */
  139020. export var depthVertexShader: {
  139021. name: string;
  139022. shader: string;
  139023. };
  139024. }
  139025. declare module BABYLON {
  139026. /**
  139027. * This represents a depth renderer in Babylon.
  139028. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  139029. */
  139030. export class DepthRenderer {
  139031. private _scene;
  139032. private _depthMap;
  139033. private _effect;
  139034. private readonly _storeNonLinearDepth;
  139035. private readonly _clearColor;
  139036. /** Get if the depth renderer is using packed depth or not */
  139037. readonly isPacked: boolean;
  139038. private _cachedDefines;
  139039. private _camera;
  139040. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  139041. enabled: boolean;
  139042. /**
  139043. * Specifiess that the depth renderer will only be used within
  139044. * the camera it is created for.
  139045. * This can help forcing its rendering during the camera processing.
  139046. */
  139047. useOnlyInActiveCamera: boolean;
  139048. /** @hidden */
  139049. static _SceneComponentInitialization: (scene: Scene) => void;
  139050. /**
  139051. * Instantiates a depth renderer
  139052. * @param scene The scene the renderer belongs to
  139053. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  139054. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  139055. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  139056. */
  139057. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  139058. /**
  139059. * Creates the depth rendering effect and checks if the effect is ready.
  139060. * @param subMesh The submesh to be used to render the depth map of
  139061. * @param useInstances If multiple world instances should be used
  139062. * @returns if the depth renderer is ready to render the depth map
  139063. */
  139064. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139065. /**
  139066. * Gets the texture which the depth map will be written to.
  139067. * @returns The depth map texture
  139068. */
  139069. getDepthMap(): RenderTargetTexture;
  139070. /**
  139071. * Disposes of the depth renderer.
  139072. */
  139073. dispose(): void;
  139074. }
  139075. }
  139076. declare module BABYLON {
  139077. /** @hidden */
  139078. export var minmaxReduxPixelShader: {
  139079. name: string;
  139080. shader: string;
  139081. };
  139082. }
  139083. declare module BABYLON {
  139084. /**
  139085. * This class computes a min/max reduction from a texture: it means it computes the minimum
  139086. * and maximum values from all values of the texture.
  139087. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  139088. * The source values are read from the red channel of the texture.
  139089. */
  139090. export class MinMaxReducer {
  139091. /**
  139092. * Observable triggered when the computation has been performed
  139093. */
  139094. onAfterReductionPerformed: Observable<{
  139095. min: number;
  139096. max: number;
  139097. }>;
  139098. protected _camera: Camera;
  139099. protected _sourceTexture: Nullable<RenderTargetTexture>;
  139100. protected _reductionSteps: Nullable<Array<PostProcess>>;
  139101. protected _postProcessManager: PostProcessManager;
  139102. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  139103. protected _forceFullscreenViewport: boolean;
  139104. /**
  139105. * Creates a min/max reducer
  139106. * @param camera The camera to use for the post processes
  139107. */
  139108. constructor(camera: Camera);
  139109. /**
  139110. * Gets the texture used to read the values from.
  139111. */
  139112. get sourceTexture(): Nullable<RenderTargetTexture>;
  139113. /**
  139114. * Sets the source texture to read the values from.
  139115. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  139116. * because in such textures '1' value must not be taken into account to compute the maximum
  139117. * as this value is used to clear the texture.
  139118. * Note that the computation is not activated by calling this function, you must call activate() for that!
  139119. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  139120. * @param depthRedux Indicates if the texture is a depth texture or not
  139121. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  139122. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139123. */
  139124. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139125. /**
  139126. * Defines the refresh rate of the computation.
  139127. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139128. */
  139129. get refreshRate(): number;
  139130. set refreshRate(value: number);
  139131. protected _activated: boolean;
  139132. /**
  139133. * Gets the activation status of the reducer
  139134. */
  139135. get activated(): boolean;
  139136. /**
  139137. * Activates the reduction computation.
  139138. * When activated, the observers registered in onAfterReductionPerformed are
  139139. * called after the compuation is performed
  139140. */
  139141. activate(): void;
  139142. /**
  139143. * Deactivates the reduction computation.
  139144. */
  139145. deactivate(): void;
  139146. /**
  139147. * Disposes the min/max reducer
  139148. * @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.
  139149. */
  139150. dispose(disposeAll?: boolean): void;
  139151. }
  139152. }
  139153. declare module BABYLON {
  139154. /**
  139155. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  139156. */
  139157. export class DepthReducer extends MinMaxReducer {
  139158. private _depthRenderer;
  139159. private _depthRendererId;
  139160. /**
  139161. * Gets the depth renderer used for the computation.
  139162. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  139163. */
  139164. get depthRenderer(): Nullable<DepthRenderer>;
  139165. /**
  139166. * Creates a depth reducer
  139167. * @param camera The camera used to render the depth texture
  139168. */
  139169. constructor(camera: Camera);
  139170. /**
  139171. * Sets the depth renderer to use to generate the depth map
  139172. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  139173. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  139174. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139175. */
  139176. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  139177. /** @hidden */
  139178. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139179. /**
  139180. * Activates the reduction computation.
  139181. * When activated, the observers registered in onAfterReductionPerformed are
  139182. * called after the compuation is performed
  139183. */
  139184. activate(): void;
  139185. /**
  139186. * Deactivates the reduction computation.
  139187. */
  139188. deactivate(): void;
  139189. /**
  139190. * Disposes the depth reducer
  139191. * @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.
  139192. */
  139193. dispose(disposeAll?: boolean): void;
  139194. }
  139195. }
  139196. declare module BABYLON {
  139197. /**
  139198. * A CSM implementation allowing casting shadows on large scenes.
  139199. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139200. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  139201. */
  139202. export class CascadedShadowGenerator extends ShadowGenerator {
  139203. private static readonly frustumCornersNDCSpace;
  139204. /**
  139205. * Name of the CSM class
  139206. */
  139207. static CLASSNAME: string;
  139208. /**
  139209. * Defines the default number of cascades used by the CSM.
  139210. */
  139211. static readonly DEFAULT_CASCADES_COUNT: number;
  139212. /**
  139213. * Defines the minimum number of cascades used by the CSM.
  139214. */
  139215. static readonly MIN_CASCADES_COUNT: number;
  139216. /**
  139217. * Defines the maximum number of cascades used by the CSM.
  139218. */
  139219. static readonly MAX_CASCADES_COUNT: number;
  139220. protected _validateFilter(filter: number): number;
  139221. /**
  139222. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  139223. */
  139224. penumbraDarkness: number;
  139225. private _numCascades;
  139226. /**
  139227. * Gets or set the number of cascades used by the CSM.
  139228. */
  139229. get numCascades(): number;
  139230. set numCascades(value: number);
  139231. /**
  139232. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  139233. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  139234. */
  139235. stabilizeCascades: boolean;
  139236. private _freezeShadowCastersBoundingInfo;
  139237. private _freezeShadowCastersBoundingInfoObservable;
  139238. /**
  139239. * Enables or disables the shadow casters bounding info computation.
  139240. * If your shadow casters don't move, you can disable this feature.
  139241. * If it is enabled, the bounding box computation is done every frame.
  139242. */
  139243. get freezeShadowCastersBoundingInfo(): boolean;
  139244. set freezeShadowCastersBoundingInfo(freeze: boolean);
  139245. private _scbiMin;
  139246. private _scbiMax;
  139247. protected _computeShadowCastersBoundingInfo(): void;
  139248. protected _shadowCastersBoundingInfo: BoundingInfo;
  139249. /**
  139250. * Gets or sets the shadow casters bounding info.
  139251. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  139252. * so that the system won't overwrite the bounds you provide
  139253. */
  139254. get shadowCastersBoundingInfo(): BoundingInfo;
  139255. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  139256. protected _breaksAreDirty: boolean;
  139257. protected _minDistance: number;
  139258. protected _maxDistance: number;
  139259. /**
  139260. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  139261. *
  139262. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  139263. * If you don't know these values, simply leave them to their defaults and don't call this function.
  139264. * @param min minimal distance for the breaks (default to 0.)
  139265. * @param max maximal distance for the breaks (default to 1.)
  139266. */
  139267. setMinMaxDistance(min: number, max: number): void;
  139268. /** Gets the minimal distance used in the cascade break computation */
  139269. get minDistance(): number;
  139270. /** Gets the maximal distance used in the cascade break computation */
  139271. get maxDistance(): number;
  139272. /**
  139273. * Gets the class name of that object
  139274. * @returns "CascadedShadowGenerator"
  139275. */
  139276. getClassName(): string;
  139277. private _cascadeMinExtents;
  139278. private _cascadeMaxExtents;
  139279. /**
  139280. * Gets a cascade minimum extents
  139281. * @param cascadeIndex index of the cascade
  139282. * @returns the minimum cascade extents
  139283. */
  139284. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  139285. /**
  139286. * Gets a cascade maximum extents
  139287. * @param cascadeIndex index of the cascade
  139288. * @returns the maximum cascade extents
  139289. */
  139290. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  139291. private _cascades;
  139292. private _currentLayer;
  139293. private _viewSpaceFrustumsZ;
  139294. private _viewMatrices;
  139295. private _projectionMatrices;
  139296. private _transformMatrices;
  139297. private _transformMatricesAsArray;
  139298. private _frustumLengths;
  139299. private _lightSizeUVCorrection;
  139300. private _depthCorrection;
  139301. private _frustumCornersWorldSpace;
  139302. private _frustumCenter;
  139303. private _shadowCameraPos;
  139304. private _shadowMaxZ;
  139305. /**
  139306. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  139307. * It defaults to camera.maxZ
  139308. */
  139309. get shadowMaxZ(): number;
  139310. /**
  139311. * Sets the shadow max z distance.
  139312. */
  139313. set shadowMaxZ(value: number);
  139314. protected _debug: boolean;
  139315. /**
  139316. * Gets or sets the debug flag.
  139317. * When enabled, the cascades are materialized by different colors on the screen.
  139318. */
  139319. get debug(): boolean;
  139320. set debug(dbg: boolean);
  139321. private _depthClamp;
  139322. /**
  139323. * Gets or sets the depth clamping value.
  139324. *
  139325. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  139326. * to account for the shadow casters far away.
  139327. *
  139328. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  139329. */
  139330. get depthClamp(): boolean;
  139331. set depthClamp(value: boolean);
  139332. private _cascadeBlendPercentage;
  139333. /**
  139334. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  139335. * It defaults to 0.1 (10% blending).
  139336. */
  139337. get cascadeBlendPercentage(): number;
  139338. set cascadeBlendPercentage(value: number);
  139339. private _lambda;
  139340. /**
  139341. * Gets or set the lambda parameter.
  139342. * This parameter is used to split the camera frustum and create the cascades.
  139343. * 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.
  139344. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  139345. */
  139346. get lambda(): number;
  139347. set lambda(value: number);
  139348. /**
  139349. * Gets the view matrix corresponding to a given cascade
  139350. * @param cascadeNum cascade to retrieve the view matrix from
  139351. * @returns the cascade view matrix
  139352. */
  139353. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  139354. /**
  139355. * Gets the projection matrix corresponding to a given cascade
  139356. * @param cascadeNum cascade to retrieve the projection matrix from
  139357. * @returns the cascade projection matrix
  139358. */
  139359. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  139360. /**
  139361. * Gets the transformation matrix corresponding to a given cascade
  139362. * @param cascadeNum cascade to retrieve the transformation matrix from
  139363. * @returns the cascade transformation matrix
  139364. */
  139365. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  139366. private _depthRenderer;
  139367. /**
  139368. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  139369. *
  139370. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  139371. *
  139372. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  139373. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  139374. * @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
  139375. */
  139376. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  139377. private _depthReducer;
  139378. private _autoCalcDepthBounds;
  139379. /**
  139380. * Gets or sets the autoCalcDepthBounds property.
  139381. *
  139382. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  139383. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  139384. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  139385. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  139386. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  139387. */
  139388. get autoCalcDepthBounds(): boolean;
  139389. set autoCalcDepthBounds(value: boolean);
  139390. /**
  139391. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  139392. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139393. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  139394. * for setting the refresh rate on the renderer yourself!
  139395. */
  139396. get autoCalcDepthBoundsRefreshRate(): number;
  139397. set autoCalcDepthBoundsRefreshRate(value: number);
  139398. /**
  139399. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  139400. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  139401. * you change the camera near/far planes!
  139402. */
  139403. splitFrustum(): void;
  139404. private _splitFrustum;
  139405. private _computeMatrices;
  139406. private _computeFrustumInWorldSpace;
  139407. private _computeCascadeFrustum;
  139408. /**
  139409. * Support test.
  139410. */
  139411. static get IsSupported(): boolean;
  139412. /** @hidden */
  139413. static _SceneComponentInitialization: (scene: Scene) => void;
  139414. /**
  139415. * Creates a Cascaded Shadow Generator object.
  139416. * A ShadowGenerator is the required tool to use the shadows.
  139417. * Each directional light casting shadows needs to use its own ShadowGenerator.
  139418. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139419. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  139420. * @param light The directional light object generating the shadows.
  139421. * @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.
  139422. */
  139423. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  139424. protected _initializeGenerator(): void;
  139425. protected _createTargetRenderTexture(): void;
  139426. protected _initializeShadowMap(): void;
  139427. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  139428. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  139429. /**
  139430. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  139431. * @param defines Defines of the material we want to update
  139432. * @param lightIndex Index of the light in the enabled light list of the material
  139433. */
  139434. prepareDefines(defines: any, lightIndex: number): void;
  139435. /**
  139436. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  139437. * defined in the generator but impacting the effect).
  139438. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  139439. * @param effect The effect we are binfing the information for
  139440. */
  139441. bindShadowLight(lightIndex: string, effect: Effect): void;
  139442. /**
  139443. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  139444. * (eq to view projection * shadow projection matrices)
  139445. * @returns The transform matrix used to create the shadow map
  139446. */
  139447. getTransformMatrix(): Matrix;
  139448. /**
  139449. * Disposes the ShadowGenerator.
  139450. * Returns nothing.
  139451. */
  139452. dispose(): void;
  139453. /**
  139454. * Serializes the shadow generator setup to a json object.
  139455. * @returns The serialized JSON object
  139456. */
  139457. serialize(): any;
  139458. /**
  139459. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  139460. * @param parsedShadowGenerator The JSON object to parse
  139461. * @param scene The scene to create the shadow map for
  139462. * @returns The parsed shadow generator
  139463. */
  139464. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  139465. }
  139466. }
  139467. declare module BABYLON {
  139468. /**
  139469. * Defines the shadow generator component responsible to manage any shadow generators
  139470. * in a given scene.
  139471. */
  139472. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  139473. /**
  139474. * The component name helpfull to identify the component in the list of scene components.
  139475. */
  139476. readonly name: string;
  139477. /**
  139478. * The scene the component belongs to.
  139479. */
  139480. scene: Scene;
  139481. /**
  139482. * Creates a new instance of the component for the given scene
  139483. * @param scene Defines the scene to register the component in
  139484. */
  139485. constructor(scene: Scene);
  139486. /**
  139487. * Registers the component in a given scene
  139488. */
  139489. register(): void;
  139490. /**
  139491. * Rebuilds the elements related to this component in case of
  139492. * context lost for instance.
  139493. */
  139494. rebuild(): void;
  139495. /**
  139496. * Serializes the component data to the specified json object
  139497. * @param serializationObject The object to serialize to
  139498. */
  139499. serialize(serializationObject: any): void;
  139500. /**
  139501. * Adds all the elements from the container to the scene
  139502. * @param container the container holding the elements
  139503. */
  139504. addFromContainer(container: AbstractScene): void;
  139505. /**
  139506. * Removes all the elements in the container from the scene
  139507. * @param container contains the elements to remove
  139508. * @param dispose if the removed element should be disposed (default: false)
  139509. */
  139510. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139511. /**
  139512. * Rebuilds the elements related to this component in case of
  139513. * context lost for instance.
  139514. */
  139515. dispose(): void;
  139516. private _gatherRenderTargets;
  139517. }
  139518. }
  139519. declare module BABYLON {
  139520. /**
  139521. * A point light is a light defined by an unique point in world space.
  139522. * The light is emitted in every direction from this point.
  139523. * A good example of a point light is a standard light bulb.
  139524. * Documentation: https://doc.babylonjs.com/babylon101/lights
  139525. */
  139526. export class PointLight extends ShadowLight {
  139527. private _shadowAngle;
  139528. /**
  139529. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139530. * This specifies what angle the shadow will use to be created.
  139531. *
  139532. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139533. */
  139534. get shadowAngle(): number;
  139535. /**
  139536. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139537. * This specifies what angle the shadow will use to be created.
  139538. *
  139539. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139540. */
  139541. set shadowAngle(value: number);
  139542. /**
  139543. * Gets the direction if it has been set.
  139544. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139545. */
  139546. get direction(): Vector3;
  139547. /**
  139548. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139549. */
  139550. set direction(value: Vector3);
  139551. /**
  139552. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  139553. * A PointLight emits the light in every direction.
  139554. * It can cast shadows.
  139555. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  139556. * ```javascript
  139557. * var pointLight = new PointLight("pl", camera.position, scene);
  139558. * ```
  139559. * Documentation : https://doc.babylonjs.com/babylon101/lights
  139560. * @param name The light friendly name
  139561. * @param position The position of the point light in the scene
  139562. * @param scene The scene the lights belongs to
  139563. */
  139564. constructor(name: string, position: Vector3, scene: Scene);
  139565. /**
  139566. * Returns the string "PointLight"
  139567. * @returns the class name
  139568. */
  139569. getClassName(): string;
  139570. /**
  139571. * Returns the integer 0.
  139572. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  139573. */
  139574. getTypeID(): number;
  139575. /**
  139576. * Specifies wether or not the shadowmap should be a cube texture.
  139577. * @returns true if the shadowmap needs to be a cube texture.
  139578. */
  139579. needCube(): boolean;
  139580. /**
  139581. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  139582. * @param faceIndex The index of the face we are computed the direction to generate shadow
  139583. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  139584. */
  139585. getShadowDirection(faceIndex?: number): Vector3;
  139586. /**
  139587. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  139588. * - fov = PI / 2
  139589. * - aspect ratio : 1.0
  139590. * - z-near and far equal to the active camera minZ and maxZ.
  139591. * Returns the PointLight.
  139592. */
  139593. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  139594. protected _buildUniformLayout(): void;
  139595. /**
  139596. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  139597. * @param effect The effect to update
  139598. * @param lightIndex The index of the light in the effect to update
  139599. * @returns The point light
  139600. */
  139601. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  139602. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  139603. /**
  139604. * Prepares the list of defines specific to the light type.
  139605. * @param defines the list of defines
  139606. * @param lightIndex defines the index of the light for the effect
  139607. */
  139608. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  139609. }
  139610. }
  139611. declare module BABYLON {
  139612. /**
  139613. * Header information of HDR texture files.
  139614. */
  139615. export interface HDRInfo {
  139616. /**
  139617. * The height of the texture in pixels.
  139618. */
  139619. height: number;
  139620. /**
  139621. * The width of the texture in pixels.
  139622. */
  139623. width: number;
  139624. /**
  139625. * The index of the beginning of the data in the binary file.
  139626. */
  139627. dataPosition: number;
  139628. }
  139629. /**
  139630. * This groups tools to convert HDR texture to native colors array.
  139631. */
  139632. export class HDRTools {
  139633. private static Ldexp;
  139634. private static Rgbe2float;
  139635. private static readStringLine;
  139636. /**
  139637. * Reads header information from an RGBE texture stored in a native array.
  139638. * More information on this format are available here:
  139639. * https://en.wikipedia.org/wiki/RGBE_image_format
  139640. *
  139641. * @param uint8array The binary file stored in native array.
  139642. * @return The header information.
  139643. */
  139644. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  139645. /**
  139646. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  139647. * This RGBE texture needs to store the information as a panorama.
  139648. *
  139649. * More information on this format are available here:
  139650. * https://en.wikipedia.org/wiki/RGBE_image_format
  139651. *
  139652. * @param buffer The binary file stored in an array buffer.
  139653. * @param size The expected size of the extracted cubemap.
  139654. * @return The Cube Map information.
  139655. */
  139656. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  139657. /**
  139658. * Returns the pixels data extracted from an RGBE texture.
  139659. * This pixels will be stored left to right up to down in the R G B order in one array.
  139660. *
  139661. * More information on this format are available here:
  139662. * https://en.wikipedia.org/wiki/RGBE_image_format
  139663. *
  139664. * @param uint8array The binary file stored in an array buffer.
  139665. * @param hdrInfo The header information of the file.
  139666. * @return The pixels data in RGB right to left up to down order.
  139667. */
  139668. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  139669. private static RGBE_ReadPixels_RLE;
  139670. private static RGBE_ReadPixels_NOT_RLE;
  139671. }
  139672. }
  139673. declare module BABYLON {
  139674. /**
  139675. * Effect Render Options
  139676. */
  139677. export interface IEffectRendererOptions {
  139678. /**
  139679. * Defines the vertices positions.
  139680. */
  139681. positions?: number[];
  139682. /**
  139683. * Defines the indices.
  139684. */
  139685. indices?: number[];
  139686. }
  139687. /**
  139688. * Helper class to render one or more effects.
  139689. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  139690. */
  139691. export class EffectRenderer {
  139692. private engine;
  139693. private static _DefaultOptions;
  139694. private _vertexBuffers;
  139695. private _indexBuffer;
  139696. private _fullscreenViewport;
  139697. /**
  139698. * Creates an effect renderer
  139699. * @param engine the engine to use for rendering
  139700. * @param options defines the options of the effect renderer
  139701. */
  139702. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  139703. /**
  139704. * Sets the current viewport in normalized coordinates 0-1
  139705. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  139706. */
  139707. setViewport(viewport?: Viewport): void;
  139708. /**
  139709. * Binds the embedded attributes buffer to the effect.
  139710. * @param effect Defines the effect to bind the attributes for
  139711. */
  139712. bindBuffers(effect: Effect): void;
  139713. /**
  139714. * Sets the current effect wrapper to use during draw.
  139715. * The effect needs to be ready before calling this api.
  139716. * This also sets the default full screen position attribute.
  139717. * @param effectWrapper Defines the effect to draw with
  139718. */
  139719. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  139720. /**
  139721. * Restores engine states
  139722. */
  139723. restoreStates(): void;
  139724. /**
  139725. * Draws a full screen quad.
  139726. */
  139727. draw(): void;
  139728. private isRenderTargetTexture;
  139729. /**
  139730. * renders one or more effects to a specified texture
  139731. * @param effectWrapper the effect to renderer
  139732. * @param outputTexture texture to draw to, if null it will render to the screen.
  139733. */
  139734. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  139735. /**
  139736. * Disposes of the effect renderer
  139737. */
  139738. dispose(): void;
  139739. }
  139740. /**
  139741. * Options to create an EffectWrapper
  139742. */
  139743. interface EffectWrapperCreationOptions {
  139744. /**
  139745. * Engine to use to create the effect
  139746. */
  139747. engine: ThinEngine;
  139748. /**
  139749. * Fragment shader for the effect
  139750. */
  139751. fragmentShader: string;
  139752. /**
  139753. * Use the shader store instead of direct source code
  139754. */
  139755. useShaderStore?: boolean;
  139756. /**
  139757. * Vertex shader for the effect
  139758. */
  139759. vertexShader?: string;
  139760. /**
  139761. * Attributes to use in the shader
  139762. */
  139763. attributeNames?: Array<string>;
  139764. /**
  139765. * Uniforms to use in the shader
  139766. */
  139767. uniformNames?: Array<string>;
  139768. /**
  139769. * Texture sampler names to use in the shader
  139770. */
  139771. samplerNames?: Array<string>;
  139772. /**
  139773. * Defines to use in the shader
  139774. */
  139775. defines?: Array<string>;
  139776. /**
  139777. * Callback when effect is compiled
  139778. */
  139779. onCompiled?: Nullable<(effect: Effect) => void>;
  139780. /**
  139781. * The friendly name of the effect displayed in Spector.
  139782. */
  139783. name?: string;
  139784. }
  139785. /**
  139786. * Wraps an effect to be used for rendering
  139787. */
  139788. export class EffectWrapper {
  139789. /**
  139790. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  139791. */
  139792. onApplyObservable: Observable<{}>;
  139793. /**
  139794. * The underlying effect
  139795. */
  139796. effect: Effect;
  139797. /**
  139798. * Creates an effect to be renderer
  139799. * @param creationOptions options to create the effect
  139800. */
  139801. constructor(creationOptions: EffectWrapperCreationOptions);
  139802. /**
  139803. * Disposes of the effect wrapper
  139804. */
  139805. dispose(): void;
  139806. }
  139807. }
  139808. declare module BABYLON {
  139809. /** @hidden */
  139810. export var hdrFilteringVertexShader: {
  139811. name: string;
  139812. shader: string;
  139813. };
  139814. }
  139815. declare module BABYLON {
  139816. /** @hidden */
  139817. export var hdrFilteringPixelShader: {
  139818. name: string;
  139819. shader: string;
  139820. };
  139821. }
  139822. declare module BABYLON {
  139823. /**
  139824. * Options for texture filtering
  139825. */
  139826. interface IHDRFilteringOptions {
  139827. /**
  139828. * Scales pixel intensity for the input HDR map.
  139829. */
  139830. hdrScale?: number;
  139831. /**
  139832. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  139833. */
  139834. quality?: number;
  139835. }
  139836. /**
  139837. * Filters HDR maps to get correct renderings of PBR reflections
  139838. */
  139839. export class HDRFiltering {
  139840. private _engine;
  139841. private _effectRenderer;
  139842. private _effectWrapper;
  139843. private _lodGenerationOffset;
  139844. private _lodGenerationScale;
  139845. /**
  139846. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  139847. * you care about baking speed.
  139848. */
  139849. quality: number;
  139850. /**
  139851. * Scales pixel intensity for the input HDR map.
  139852. */
  139853. hdrScale: number;
  139854. /**
  139855. * Instantiates HDR filter for reflection maps
  139856. *
  139857. * @param engine Thin engine
  139858. * @param options Options
  139859. */
  139860. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  139861. private _createRenderTarget;
  139862. private _prefilterInternal;
  139863. private _createEffect;
  139864. /**
  139865. * Get a value indicating if the filter is ready to be used
  139866. * @param texture Texture to filter
  139867. * @returns true if the filter is ready
  139868. */
  139869. isReady(texture: BaseTexture): boolean;
  139870. /**
  139871. * Prefilters a cube texture to have mipmap levels representing roughness values.
  139872. * Prefiltering will be invoked at the end of next rendering pass.
  139873. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  139874. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  139875. * @param texture Texture to filter
  139876. * @param onFinished Callback when filtering is done
  139877. * @return Promise called when prefiltering is done
  139878. */
  139879. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  139880. }
  139881. }
  139882. declare module BABYLON {
  139883. /**
  139884. * This represents a texture coming from an HDR input.
  139885. *
  139886. * The only supported format is currently panorama picture stored in RGBE format.
  139887. * Example of such files can be found on HDRLib: http://hdrlib.com/
  139888. */
  139889. export class HDRCubeTexture extends BaseTexture {
  139890. private static _facesMapping;
  139891. private _generateHarmonics;
  139892. private _noMipmap;
  139893. private _prefilterOnLoad;
  139894. private _textureMatrix;
  139895. private _size;
  139896. private _onLoad;
  139897. private _onError;
  139898. /**
  139899. * The texture URL.
  139900. */
  139901. url: string;
  139902. protected _isBlocking: boolean;
  139903. /**
  139904. * Sets wether or not the texture is blocking during loading.
  139905. */
  139906. set isBlocking(value: boolean);
  139907. /**
  139908. * Gets wether or not the texture is blocking during loading.
  139909. */
  139910. get isBlocking(): boolean;
  139911. protected _rotationY: number;
  139912. /**
  139913. * Sets texture matrix rotation angle around Y axis in radians.
  139914. */
  139915. set rotationY(value: number);
  139916. /**
  139917. * Gets texture matrix rotation angle around Y axis radians.
  139918. */
  139919. get rotationY(): number;
  139920. /**
  139921. * Gets or sets the center of the bounding box associated with the cube texture
  139922. * It must define where the camera used to render the texture was set
  139923. */
  139924. boundingBoxPosition: Vector3;
  139925. private _boundingBoxSize;
  139926. /**
  139927. * Gets or sets the size of the bounding box associated with the cube texture
  139928. * When defined, the cubemap will switch to local mode
  139929. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  139930. * @example https://www.babylonjs-playground.com/#RNASML
  139931. */
  139932. set boundingBoxSize(value: Vector3);
  139933. get boundingBoxSize(): Vector3;
  139934. /**
  139935. * Instantiates an HDRTexture from the following parameters.
  139936. *
  139937. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  139938. * @param sceneOrEngine The scene or engine the texture will be used in
  139939. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  139940. * @param noMipmap Forces to not generate the mipmap if true
  139941. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  139942. * @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)
  139943. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  139944. */
  139945. 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>);
  139946. /**
  139947. * Get the current class name of the texture useful for serialization or dynamic coding.
  139948. * @returns "HDRCubeTexture"
  139949. */
  139950. getClassName(): string;
  139951. /**
  139952. * Occurs when the file is raw .hdr file.
  139953. */
  139954. private loadTexture;
  139955. clone(): HDRCubeTexture;
  139956. delayLoad(): void;
  139957. /**
  139958. * Get the texture reflection matrix used to rotate/transform the reflection.
  139959. * @returns the reflection matrix
  139960. */
  139961. getReflectionTextureMatrix(): Matrix;
  139962. /**
  139963. * Set the texture reflection matrix used to rotate/transform the reflection.
  139964. * @param value Define the reflection matrix to set
  139965. */
  139966. setReflectionTextureMatrix(value: Matrix): void;
  139967. /**
  139968. * Parses a JSON representation of an HDR Texture in order to create the texture
  139969. * @param parsedTexture Define the JSON representation
  139970. * @param scene Define the scene the texture should be created in
  139971. * @param rootUrl Define the root url in case we need to load relative dependencies
  139972. * @returns the newly created texture after parsing
  139973. */
  139974. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  139975. serialize(): any;
  139976. }
  139977. }
  139978. declare module BABYLON {
  139979. /**
  139980. * Class used to control physics engine
  139981. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  139982. */
  139983. export class PhysicsEngine implements IPhysicsEngine {
  139984. private _physicsPlugin;
  139985. /**
  139986. * Global value used to control the smallest number supported by the simulation
  139987. */
  139988. static Epsilon: number;
  139989. private _impostors;
  139990. private _joints;
  139991. private _subTimeStep;
  139992. /**
  139993. * Gets the gravity vector used by the simulation
  139994. */
  139995. gravity: Vector3;
  139996. /**
  139997. * Factory used to create the default physics plugin.
  139998. * @returns The default physics plugin
  139999. */
  140000. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  140001. /**
  140002. * Creates a new Physics Engine
  140003. * @param gravity defines the gravity vector used by the simulation
  140004. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  140005. */
  140006. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  140007. /**
  140008. * Sets the gravity vector used by the simulation
  140009. * @param gravity defines the gravity vector to use
  140010. */
  140011. setGravity(gravity: Vector3): void;
  140012. /**
  140013. * Set the time step of the physics engine.
  140014. * Default is 1/60.
  140015. * To slow it down, enter 1/600 for example.
  140016. * To speed it up, 1/30
  140017. * @param newTimeStep defines the new timestep to apply to this world.
  140018. */
  140019. setTimeStep(newTimeStep?: number): void;
  140020. /**
  140021. * Get the time step of the physics engine.
  140022. * @returns the current time step
  140023. */
  140024. getTimeStep(): number;
  140025. /**
  140026. * Set the sub time step of the physics engine.
  140027. * Default is 0 meaning there is no sub steps
  140028. * To increase physics resolution precision, set a small value (like 1 ms)
  140029. * @param subTimeStep defines the new sub timestep used for physics resolution.
  140030. */
  140031. setSubTimeStep(subTimeStep?: number): void;
  140032. /**
  140033. * Get the sub time step of the physics engine.
  140034. * @returns the current sub time step
  140035. */
  140036. getSubTimeStep(): number;
  140037. /**
  140038. * Release all resources
  140039. */
  140040. dispose(): void;
  140041. /**
  140042. * Gets the name of the current physics plugin
  140043. * @returns the name of the plugin
  140044. */
  140045. getPhysicsPluginName(): string;
  140046. /**
  140047. * Adding a new impostor for the impostor tracking.
  140048. * This will be done by the impostor itself.
  140049. * @param impostor the impostor to add
  140050. */
  140051. addImpostor(impostor: PhysicsImpostor): void;
  140052. /**
  140053. * Remove an impostor from the engine.
  140054. * This impostor and its mesh will not longer be updated by the physics engine.
  140055. * @param impostor the impostor to remove
  140056. */
  140057. removeImpostor(impostor: PhysicsImpostor): void;
  140058. /**
  140059. * Add a joint to the physics engine
  140060. * @param mainImpostor defines the main impostor to which the joint is added.
  140061. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  140062. * @param joint defines the joint that will connect both impostors.
  140063. */
  140064. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140065. /**
  140066. * Removes a joint from the simulation
  140067. * @param mainImpostor defines the impostor used with the joint
  140068. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  140069. * @param joint defines the joint to remove
  140070. */
  140071. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140072. /**
  140073. * Called by the scene. No need to call it.
  140074. * @param delta defines the timespam between frames
  140075. */
  140076. _step(delta: number): void;
  140077. /**
  140078. * Gets the current plugin used to run the simulation
  140079. * @returns current plugin
  140080. */
  140081. getPhysicsPlugin(): IPhysicsEnginePlugin;
  140082. /**
  140083. * Gets the list of physic impostors
  140084. * @returns an array of PhysicsImpostor
  140085. */
  140086. getImpostors(): Array<PhysicsImpostor>;
  140087. /**
  140088. * Gets the impostor for a physics enabled object
  140089. * @param object defines the object impersonated by the impostor
  140090. * @returns the PhysicsImpostor or null if not found
  140091. */
  140092. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  140093. /**
  140094. * Gets the impostor for a physics body object
  140095. * @param body defines physics body used by the impostor
  140096. * @returns the PhysicsImpostor or null if not found
  140097. */
  140098. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  140099. /**
  140100. * Does a raycast in the physics world
  140101. * @param from when should the ray start?
  140102. * @param to when should the ray end?
  140103. * @returns PhysicsRaycastResult
  140104. */
  140105. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140106. }
  140107. }
  140108. declare module BABYLON {
  140109. /** @hidden */
  140110. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  140111. private _useDeltaForWorldStep;
  140112. world: any;
  140113. name: string;
  140114. private _physicsMaterials;
  140115. private _fixedTimeStep;
  140116. private _cannonRaycastResult;
  140117. private _raycastResult;
  140118. private _physicsBodysToRemoveAfterStep;
  140119. private _firstFrame;
  140120. BJSCANNON: any;
  140121. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  140122. setGravity(gravity: Vector3): void;
  140123. setTimeStep(timeStep: number): void;
  140124. getTimeStep(): number;
  140125. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140126. private _removeMarkedPhysicsBodiesFromWorld;
  140127. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140128. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140129. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140130. private _processChildMeshes;
  140131. removePhysicsBody(impostor: PhysicsImpostor): void;
  140132. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140133. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140134. private _addMaterial;
  140135. private _checkWithEpsilon;
  140136. private _createShape;
  140137. private _createHeightmap;
  140138. private _minus90X;
  140139. private _plus90X;
  140140. private _tmpPosition;
  140141. private _tmpDeltaPosition;
  140142. private _tmpUnityRotation;
  140143. private _updatePhysicsBodyTransformation;
  140144. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140145. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140146. isSupported(): boolean;
  140147. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140148. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140149. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140150. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140151. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140152. getBodyMass(impostor: PhysicsImpostor): number;
  140153. getBodyFriction(impostor: PhysicsImpostor): number;
  140154. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140155. getBodyRestitution(impostor: PhysicsImpostor): number;
  140156. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140157. sleepBody(impostor: PhysicsImpostor): void;
  140158. wakeUpBody(impostor: PhysicsImpostor): void;
  140159. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  140160. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140161. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140162. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140163. getRadius(impostor: PhysicsImpostor): number;
  140164. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140165. dispose(): void;
  140166. private _extendNamespace;
  140167. /**
  140168. * Does a raycast in the physics world
  140169. * @param from when should the ray start?
  140170. * @param to when should the ray end?
  140171. * @returns PhysicsRaycastResult
  140172. */
  140173. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140174. }
  140175. }
  140176. declare module BABYLON {
  140177. /** @hidden */
  140178. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  140179. private _useDeltaForWorldStep;
  140180. world: any;
  140181. name: string;
  140182. BJSOIMO: any;
  140183. private _raycastResult;
  140184. private _fixedTimeStep;
  140185. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  140186. setGravity(gravity: Vector3): void;
  140187. setTimeStep(timeStep: number): void;
  140188. getTimeStep(): number;
  140189. private _tmpImpostorsArray;
  140190. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140191. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140192. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140193. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140194. private _tmpPositionVector;
  140195. removePhysicsBody(impostor: PhysicsImpostor): void;
  140196. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140197. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140198. isSupported(): boolean;
  140199. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140200. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140201. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140202. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140203. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140204. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140205. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140206. getBodyMass(impostor: PhysicsImpostor): number;
  140207. getBodyFriction(impostor: PhysicsImpostor): number;
  140208. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140209. getBodyRestitution(impostor: PhysicsImpostor): number;
  140210. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140211. sleepBody(impostor: PhysicsImpostor): void;
  140212. wakeUpBody(impostor: PhysicsImpostor): void;
  140213. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140214. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  140215. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  140216. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140217. getRadius(impostor: PhysicsImpostor): number;
  140218. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140219. dispose(): void;
  140220. /**
  140221. * Does a raycast in the physics world
  140222. * @param from when should the ray start?
  140223. * @param to when should the ray end?
  140224. * @returns PhysicsRaycastResult
  140225. */
  140226. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140227. }
  140228. }
  140229. declare module BABYLON {
  140230. /**
  140231. * AmmoJS Physics plugin
  140232. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140233. * @see https://github.com/kripken/ammo.js/
  140234. */
  140235. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  140236. private _useDeltaForWorldStep;
  140237. /**
  140238. * Reference to the Ammo library
  140239. */
  140240. bjsAMMO: any;
  140241. /**
  140242. * Created ammoJS world which physics bodies are added to
  140243. */
  140244. world: any;
  140245. /**
  140246. * Name of the plugin
  140247. */
  140248. name: string;
  140249. private _timeStep;
  140250. private _fixedTimeStep;
  140251. private _maxSteps;
  140252. private _tmpQuaternion;
  140253. private _tmpAmmoTransform;
  140254. private _tmpAmmoQuaternion;
  140255. private _tmpAmmoConcreteContactResultCallback;
  140256. private _collisionConfiguration;
  140257. private _dispatcher;
  140258. private _overlappingPairCache;
  140259. private _solver;
  140260. private _softBodySolver;
  140261. private _tmpAmmoVectorA;
  140262. private _tmpAmmoVectorB;
  140263. private _tmpAmmoVectorC;
  140264. private _tmpAmmoVectorD;
  140265. private _tmpContactCallbackResult;
  140266. private _tmpAmmoVectorRCA;
  140267. private _tmpAmmoVectorRCB;
  140268. private _raycastResult;
  140269. private static readonly DISABLE_COLLISION_FLAG;
  140270. private static readonly KINEMATIC_FLAG;
  140271. private static readonly DISABLE_DEACTIVATION_FLAG;
  140272. /**
  140273. * Initializes the ammoJS plugin
  140274. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  140275. * @param ammoInjection can be used to inject your own ammo reference
  140276. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  140277. */
  140278. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  140279. /**
  140280. * Sets the gravity of the physics world (m/(s^2))
  140281. * @param gravity Gravity to set
  140282. */
  140283. setGravity(gravity: Vector3): void;
  140284. /**
  140285. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  140286. * @param timeStep timestep to use in seconds
  140287. */
  140288. setTimeStep(timeStep: number): void;
  140289. /**
  140290. * 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)
  140291. * @param fixedTimeStep fixedTimeStep to use in seconds
  140292. */
  140293. setFixedTimeStep(fixedTimeStep: number): void;
  140294. /**
  140295. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  140296. * @param maxSteps the maximum number of steps by the physics engine per frame
  140297. */
  140298. setMaxSteps(maxSteps: number): void;
  140299. /**
  140300. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  140301. * @returns the current timestep in seconds
  140302. */
  140303. getTimeStep(): number;
  140304. /**
  140305. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  140306. */
  140307. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  140308. private _isImpostorInContact;
  140309. private _isImpostorPairInContact;
  140310. private _stepSimulation;
  140311. /**
  140312. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  140313. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  140314. * After the step the babylon meshes are set to the position of the physics imposters
  140315. * @param delta amount of time to step forward
  140316. * @param impostors array of imposters to update before/after the step
  140317. */
  140318. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140319. /**
  140320. * Update babylon mesh to match physics world object
  140321. * @param impostor imposter to match
  140322. */
  140323. private _afterSoftStep;
  140324. /**
  140325. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140326. * @param impostor imposter to match
  140327. */
  140328. private _ropeStep;
  140329. /**
  140330. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140331. * @param impostor imposter to match
  140332. */
  140333. private _softbodyOrClothStep;
  140334. private _tmpMatrix;
  140335. /**
  140336. * Applies an impulse on the imposter
  140337. * @param impostor imposter to apply impulse to
  140338. * @param force amount of force to be applied to the imposter
  140339. * @param contactPoint the location to apply the impulse on the imposter
  140340. */
  140341. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140342. /**
  140343. * Applies a force on the imposter
  140344. * @param impostor imposter to apply force
  140345. * @param force amount of force to be applied to the imposter
  140346. * @param contactPoint the location to apply the force on the imposter
  140347. */
  140348. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140349. /**
  140350. * Creates a physics body using the plugin
  140351. * @param impostor the imposter to create the physics body on
  140352. */
  140353. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140354. /**
  140355. * Removes the physics body from the imposter and disposes of the body's memory
  140356. * @param impostor imposter to remove the physics body from
  140357. */
  140358. removePhysicsBody(impostor: PhysicsImpostor): void;
  140359. /**
  140360. * Generates a joint
  140361. * @param impostorJoint the imposter joint to create the joint with
  140362. */
  140363. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140364. /**
  140365. * Removes a joint
  140366. * @param impostorJoint the imposter joint to remove the joint from
  140367. */
  140368. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140369. private _addMeshVerts;
  140370. /**
  140371. * Initialise the soft body vertices to match its object's (mesh) vertices
  140372. * Softbody vertices (nodes) are in world space and to match this
  140373. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  140374. * @param impostor to create the softbody for
  140375. */
  140376. private _softVertexData;
  140377. /**
  140378. * Create an impostor's soft body
  140379. * @param impostor to create the softbody for
  140380. */
  140381. private _createSoftbody;
  140382. /**
  140383. * Create cloth for an impostor
  140384. * @param impostor to create the softbody for
  140385. */
  140386. private _createCloth;
  140387. /**
  140388. * Create rope for an impostor
  140389. * @param impostor to create the softbody for
  140390. */
  140391. private _createRope;
  140392. /**
  140393. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  140394. * @param impostor to create the custom physics shape for
  140395. */
  140396. private _createCustom;
  140397. private _addHullVerts;
  140398. private _createShape;
  140399. /**
  140400. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  140401. * @param impostor imposter containing the physics body and babylon object
  140402. */
  140403. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140404. /**
  140405. * Sets the babylon object's position/rotation from the physics body's position/rotation
  140406. * @param impostor imposter containing the physics body and babylon object
  140407. * @param newPosition new position
  140408. * @param newRotation new rotation
  140409. */
  140410. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140411. /**
  140412. * If this plugin is supported
  140413. * @returns true if its supported
  140414. */
  140415. isSupported(): boolean;
  140416. /**
  140417. * Sets the linear velocity of the physics body
  140418. * @param impostor imposter to set the velocity on
  140419. * @param velocity velocity to set
  140420. */
  140421. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140422. /**
  140423. * Sets the angular velocity of the physics body
  140424. * @param impostor imposter to set the velocity on
  140425. * @param velocity velocity to set
  140426. */
  140427. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140428. /**
  140429. * gets the linear velocity
  140430. * @param impostor imposter to get linear velocity from
  140431. * @returns linear velocity
  140432. */
  140433. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140434. /**
  140435. * gets the angular velocity
  140436. * @param impostor imposter to get angular velocity from
  140437. * @returns angular velocity
  140438. */
  140439. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140440. /**
  140441. * Sets the mass of physics body
  140442. * @param impostor imposter to set the mass on
  140443. * @param mass mass to set
  140444. */
  140445. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140446. /**
  140447. * Gets the mass of the physics body
  140448. * @param impostor imposter to get the mass from
  140449. * @returns mass
  140450. */
  140451. getBodyMass(impostor: PhysicsImpostor): number;
  140452. /**
  140453. * Gets friction of the impostor
  140454. * @param impostor impostor to get friction from
  140455. * @returns friction value
  140456. */
  140457. getBodyFriction(impostor: PhysicsImpostor): number;
  140458. /**
  140459. * Sets friction of the impostor
  140460. * @param impostor impostor to set friction on
  140461. * @param friction friction value
  140462. */
  140463. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140464. /**
  140465. * Gets restitution of the impostor
  140466. * @param impostor impostor to get restitution from
  140467. * @returns restitution value
  140468. */
  140469. getBodyRestitution(impostor: PhysicsImpostor): number;
  140470. /**
  140471. * Sets resitution of the impostor
  140472. * @param impostor impostor to set resitution on
  140473. * @param restitution resitution value
  140474. */
  140475. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140476. /**
  140477. * Gets pressure inside the impostor
  140478. * @param impostor impostor to get pressure from
  140479. * @returns pressure value
  140480. */
  140481. getBodyPressure(impostor: PhysicsImpostor): number;
  140482. /**
  140483. * Sets pressure inside a soft body impostor
  140484. * Cloth and rope must remain 0 pressure
  140485. * @param impostor impostor to set pressure on
  140486. * @param pressure pressure value
  140487. */
  140488. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  140489. /**
  140490. * Gets stiffness of the impostor
  140491. * @param impostor impostor to get stiffness from
  140492. * @returns pressure value
  140493. */
  140494. getBodyStiffness(impostor: PhysicsImpostor): number;
  140495. /**
  140496. * Sets stiffness of the impostor
  140497. * @param impostor impostor to set stiffness on
  140498. * @param stiffness stiffness value from 0 to 1
  140499. */
  140500. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  140501. /**
  140502. * Gets velocityIterations of the impostor
  140503. * @param impostor impostor to get velocity iterations from
  140504. * @returns velocityIterations value
  140505. */
  140506. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  140507. /**
  140508. * Sets velocityIterations of the impostor
  140509. * @param impostor impostor to set velocity iterations on
  140510. * @param velocityIterations velocityIterations value
  140511. */
  140512. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  140513. /**
  140514. * Gets positionIterations of the impostor
  140515. * @param impostor impostor to get position iterations from
  140516. * @returns positionIterations value
  140517. */
  140518. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  140519. /**
  140520. * Sets positionIterations of the impostor
  140521. * @param impostor impostor to set position on
  140522. * @param positionIterations positionIterations value
  140523. */
  140524. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  140525. /**
  140526. * Append an anchor to a cloth object
  140527. * @param impostor is the cloth impostor to add anchor to
  140528. * @param otherImpostor is the rigid impostor to anchor to
  140529. * @param width ratio across width from 0 to 1
  140530. * @param height ratio up height from 0 to 1
  140531. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  140532. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140533. */
  140534. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140535. /**
  140536. * Append an hook to a rope object
  140537. * @param impostor is the rope impostor to add hook to
  140538. * @param otherImpostor is the rigid impostor to hook to
  140539. * @param length ratio along the rope from 0 to 1
  140540. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  140541. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140542. */
  140543. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140544. /**
  140545. * Sleeps the physics body and stops it from being active
  140546. * @param impostor impostor to sleep
  140547. */
  140548. sleepBody(impostor: PhysicsImpostor): void;
  140549. /**
  140550. * Activates the physics body
  140551. * @param impostor impostor to activate
  140552. */
  140553. wakeUpBody(impostor: PhysicsImpostor): void;
  140554. /**
  140555. * Updates the distance parameters of the joint
  140556. * @param joint joint to update
  140557. * @param maxDistance maximum distance of the joint
  140558. * @param minDistance minimum distance of the joint
  140559. */
  140560. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140561. /**
  140562. * Sets a motor on the joint
  140563. * @param joint joint to set motor on
  140564. * @param speed speed of the motor
  140565. * @param maxForce maximum force of the motor
  140566. * @param motorIndex index of the motor
  140567. */
  140568. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140569. /**
  140570. * Sets the motors limit
  140571. * @param joint joint to set limit on
  140572. * @param upperLimit upper limit
  140573. * @param lowerLimit lower limit
  140574. */
  140575. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140576. /**
  140577. * Syncs the position and rotation of a mesh with the impostor
  140578. * @param mesh mesh to sync
  140579. * @param impostor impostor to update the mesh with
  140580. */
  140581. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140582. /**
  140583. * Gets the radius of the impostor
  140584. * @param impostor impostor to get radius from
  140585. * @returns the radius
  140586. */
  140587. getRadius(impostor: PhysicsImpostor): number;
  140588. /**
  140589. * Gets the box size of the impostor
  140590. * @param impostor impostor to get box size from
  140591. * @param result the resulting box size
  140592. */
  140593. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140594. /**
  140595. * Disposes of the impostor
  140596. */
  140597. dispose(): void;
  140598. /**
  140599. * Does a raycast in the physics world
  140600. * @param from when should the ray start?
  140601. * @param to when should the ray end?
  140602. * @returns PhysicsRaycastResult
  140603. */
  140604. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140605. }
  140606. }
  140607. declare module BABYLON {
  140608. interface AbstractScene {
  140609. /**
  140610. * The list of reflection probes added to the scene
  140611. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140612. */
  140613. reflectionProbes: Array<ReflectionProbe>;
  140614. /**
  140615. * Removes the given reflection probe from this scene.
  140616. * @param toRemove The reflection probe to remove
  140617. * @returns The index of the removed reflection probe
  140618. */
  140619. removeReflectionProbe(toRemove: ReflectionProbe): number;
  140620. /**
  140621. * Adds the given reflection probe to this scene.
  140622. * @param newReflectionProbe The reflection probe to add
  140623. */
  140624. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  140625. }
  140626. /**
  140627. * Class used to generate realtime reflection / refraction cube textures
  140628. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140629. */
  140630. export class ReflectionProbe {
  140631. /** defines the name of the probe */
  140632. name: string;
  140633. private _scene;
  140634. private _renderTargetTexture;
  140635. private _projectionMatrix;
  140636. private _viewMatrix;
  140637. private _target;
  140638. private _add;
  140639. private _attachedMesh;
  140640. private _invertYAxis;
  140641. /** Gets or sets probe position (center of the cube map) */
  140642. position: Vector3;
  140643. /**
  140644. * Creates a new reflection probe
  140645. * @param name defines the name of the probe
  140646. * @param size defines the texture resolution (for each face)
  140647. * @param scene defines the hosting scene
  140648. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  140649. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  140650. */
  140651. constructor(
  140652. /** defines the name of the probe */
  140653. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  140654. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  140655. get samples(): number;
  140656. set samples(value: number);
  140657. /** Gets or sets the refresh rate to use (on every frame by default) */
  140658. get refreshRate(): number;
  140659. set refreshRate(value: number);
  140660. /**
  140661. * Gets the hosting scene
  140662. * @returns a Scene
  140663. */
  140664. getScene(): Scene;
  140665. /** Gets the internal CubeTexture used to render to */
  140666. get cubeTexture(): RenderTargetTexture;
  140667. /** Gets the list of meshes to render */
  140668. get renderList(): Nullable<AbstractMesh[]>;
  140669. /**
  140670. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  140671. * @param mesh defines the mesh to attach to
  140672. */
  140673. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  140674. /**
  140675. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  140676. * @param renderingGroupId The rendering group id corresponding to its index
  140677. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  140678. */
  140679. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  140680. /**
  140681. * Clean all associated resources
  140682. */
  140683. dispose(): void;
  140684. /**
  140685. * Converts the reflection probe information to a readable string for debug purpose.
  140686. * @param fullDetails Supports for multiple levels of logging within scene loading
  140687. * @returns the human readable reflection probe info
  140688. */
  140689. toString(fullDetails?: boolean): string;
  140690. /**
  140691. * Get the class name of the relfection probe.
  140692. * @returns "ReflectionProbe"
  140693. */
  140694. getClassName(): string;
  140695. /**
  140696. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  140697. * @returns The JSON representation of the texture
  140698. */
  140699. serialize(): any;
  140700. /**
  140701. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  140702. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  140703. * @param scene Define the scene the parsed reflection probe should be instantiated in
  140704. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  140705. * @returns The parsed reflection probe if successful
  140706. */
  140707. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  140708. }
  140709. }
  140710. declare module BABYLON {
  140711. /** @hidden */
  140712. export var _BabylonLoaderRegistered: boolean;
  140713. /**
  140714. * Helps setting up some configuration for the babylon file loader.
  140715. */
  140716. export class BabylonFileLoaderConfiguration {
  140717. /**
  140718. * The loader does not allow injecting custom physix engine into the plugins.
  140719. * Unfortunately in ES6, we need to manually inject them into the plugin.
  140720. * So you could set this variable to your engine import to make it work.
  140721. */
  140722. static LoaderInjectedPhysicsEngine: any;
  140723. }
  140724. }
  140725. declare module BABYLON {
  140726. /**
  140727. * The Physically based simple base material of BJS.
  140728. *
  140729. * This enables better naming and convention enforcements on top of the pbrMaterial.
  140730. * It is used as the base class for both the specGloss and metalRough conventions.
  140731. */
  140732. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  140733. /**
  140734. * Number of Simultaneous lights allowed on the material.
  140735. */
  140736. maxSimultaneousLights: number;
  140737. /**
  140738. * If sets to true, disables all the lights affecting the material.
  140739. */
  140740. disableLighting: boolean;
  140741. /**
  140742. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  140743. */
  140744. environmentTexture: BaseTexture;
  140745. /**
  140746. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  140747. */
  140748. invertNormalMapX: boolean;
  140749. /**
  140750. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  140751. */
  140752. invertNormalMapY: boolean;
  140753. /**
  140754. * Normal map used in the model.
  140755. */
  140756. normalTexture: BaseTexture;
  140757. /**
  140758. * Emissivie color used to self-illuminate the model.
  140759. */
  140760. emissiveColor: Color3;
  140761. /**
  140762. * Emissivie texture used to self-illuminate the model.
  140763. */
  140764. emissiveTexture: BaseTexture;
  140765. /**
  140766. * Occlusion Channel Strenght.
  140767. */
  140768. occlusionStrength: number;
  140769. /**
  140770. * Occlusion Texture of the material (adding extra occlusion effects).
  140771. */
  140772. occlusionTexture: BaseTexture;
  140773. /**
  140774. * Defines the alpha limits in alpha test mode.
  140775. */
  140776. alphaCutOff: number;
  140777. /**
  140778. * Gets the current double sided mode.
  140779. */
  140780. get doubleSided(): boolean;
  140781. /**
  140782. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  140783. */
  140784. set doubleSided(value: boolean);
  140785. /**
  140786. * Stores the pre-calculated light information of a mesh in a texture.
  140787. */
  140788. lightmapTexture: BaseTexture;
  140789. /**
  140790. * If true, the light map contains occlusion information instead of lighting info.
  140791. */
  140792. useLightmapAsShadowmap: boolean;
  140793. /**
  140794. * Instantiates a new PBRMaterial instance.
  140795. *
  140796. * @param name The material name
  140797. * @param scene The scene the material will be use in.
  140798. */
  140799. constructor(name: string, scene: Scene);
  140800. getClassName(): string;
  140801. }
  140802. }
  140803. declare module BABYLON {
  140804. /**
  140805. * The PBR material of BJS following the metal roughness convention.
  140806. *
  140807. * This fits to the PBR convention in the GLTF definition:
  140808. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  140809. */
  140810. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  140811. /**
  140812. * The base color has two different interpretations depending on the value of metalness.
  140813. * When the material is a metal, the base color is the specific measured reflectance value
  140814. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  140815. * of the material.
  140816. */
  140817. baseColor: Color3;
  140818. /**
  140819. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  140820. * well as opacity information in the alpha channel.
  140821. */
  140822. baseTexture: BaseTexture;
  140823. /**
  140824. * Specifies the metallic scalar value of the material.
  140825. * Can also be used to scale the metalness values of the metallic texture.
  140826. */
  140827. metallic: number;
  140828. /**
  140829. * Specifies the roughness scalar value of the material.
  140830. * Can also be used to scale the roughness values of the metallic texture.
  140831. */
  140832. roughness: number;
  140833. /**
  140834. * Texture containing both the metallic value in the B channel and the
  140835. * roughness value in the G channel to keep better precision.
  140836. */
  140837. metallicRoughnessTexture: BaseTexture;
  140838. /**
  140839. * Instantiates a new PBRMetalRoughnessMaterial instance.
  140840. *
  140841. * @param name The material name
  140842. * @param scene The scene the material will be use in.
  140843. */
  140844. constructor(name: string, scene: Scene);
  140845. /**
  140846. * Return the currrent class name of the material.
  140847. */
  140848. getClassName(): string;
  140849. /**
  140850. * Makes a duplicate of the current material.
  140851. * @param name - name to use for the new material.
  140852. */
  140853. clone(name: string): PBRMetallicRoughnessMaterial;
  140854. /**
  140855. * Serialize the material to a parsable JSON object.
  140856. */
  140857. serialize(): any;
  140858. /**
  140859. * Parses a JSON object correponding to the serialize function.
  140860. */
  140861. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  140862. }
  140863. }
  140864. declare module BABYLON {
  140865. /**
  140866. * The PBR material of BJS following the specular glossiness convention.
  140867. *
  140868. * This fits to the PBR convention in the GLTF definition:
  140869. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  140870. */
  140871. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  140872. /**
  140873. * Specifies the diffuse color of the material.
  140874. */
  140875. diffuseColor: Color3;
  140876. /**
  140877. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  140878. * channel.
  140879. */
  140880. diffuseTexture: BaseTexture;
  140881. /**
  140882. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  140883. */
  140884. specularColor: Color3;
  140885. /**
  140886. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  140887. */
  140888. glossiness: number;
  140889. /**
  140890. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  140891. */
  140892. specularGlossinessTexture: BaseTexture;
  140893. /**
  140894. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  140895. *
  140896. * @param name The material name
  140897. * @param scene The scene the material will be use in.
  140898. */
  140899. constructor(name: string, scene: Scene);
  140900. /**
  140901. * Return the currrent class name of the material.
  140902. */
  140903. getClassName(): string;
  140904. /**
  140905. * Makes a duplicate of the current material.
  140906. * @param name - name to use for the new material.
  140907. */
  140908. clone(name: string): PBRSpecularGlossinessMaterial;
  140909. /**
  140910. * Serialize the material to a parsable JSON object.
  140911. */
  140912. serialize(): any;
  140913. /**
  140914. * Parses a JSON object correponding to the serialize function.
  140915. */
  140916. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  140917. }
  140918. }
  140919. declare module BABYLON {
  140920. /**
  140921. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  140922. * It can help converting any input color in a desired output one. This can then be used to create effects
  140923. * from sepia, black and white to sixties or futuristic rendering...
  140924. *
  140925. * The only supported format is currently 3dl.
  140926. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  140927. */
  140928. export class ColorGradingTexture extends BaseTexture {
  140929. /**
  140930. * The texture URL.
  140931. */
  140932. url: string;
  140933. /**
  140934. * Empty line regex stored for GC.
  140935. */
  140936. private static _noneEmptyLineRegex;
  140937. private _textureMatrix;
  140938. private _onLoad;
  140939. /**
  140940. * Instantiates a ColorGradingTexture from the following parameters.
  140941. *
  140942. * @param url The location of the color gradind data (currently only supporting 3dl)
  140943. * @param sceneOrEngine The scene or engine the texture will be used in
  140944. * @param onLoad defines a callback triggered when the texture has been loaded
  140945. */
  140946. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  140947. /**
  140948. * Fires the onload event from the constructor if requested.
  140949. */
  140950. private _triggerOnLoad;
  140951. /**
  140952. * Returns the texture matrix used in most of the material.
  140953. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  140954. */
  140955. getTextureMatrix(): Matrix;
  140956. /**
  140957. * Occurs when the file being loaded is a .3dl LUT file.
  140958. */
  140959. private load3dlTexture;
  140960. /**
  140961. * Starts the loading process of the texture.
  140962. */
  140963. private loadTexture;
  140964. /**
  140965. * Clones the color gradind texture.
  140966. */
  140967. clone(): ColorGradingTexture;
  140968. /**
  140969. * Called during delayed load for textures.
  140970. */
  140971. delayLoad(): void;
  140972. /**
  140973. * Parses a color grading texture serialized by Babylon.
  140974. * @param parsedTexture The texture information being parsedTexture
  140975. * @param scene The scene to load the texture in
  140976. * @param rootUrl The root url of the data assets to load
  140977. * @return A color gradind texture
  140978. */
  140979. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  140980. /**
  140981. * Serializes the LUT texture to json format.
  140982. */
  140983. serialize(): any;
  140984. }
  140985. }
  140986. declare module BABYLON {
  140987. /**
  140988. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  140989. */
  140990. export class EquiRectangularCubeTexture extends BaseTexture {
  140991. /** The six faces of the cube. */
  140992. private static _FacesMapping;
  140993. private _noMipmap;
  140994. private _onLoad;
  140995. private _onError;
  140996. /** The size of the cubemap. */
  140997. private _size;
  140998. /** The buffer of the image. */
  140999. private _buffer;
  141000. /** The width of the input image. */
  141001. private _width;
  141002. /** The height of the input image. */
  141003. private _height;
  141004. /** The URL to the image. */
  141005. url: string;
  141006. /**
  141007. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  141008. * @param url The location of the image
  141009. * @param scene The scene the texture will be used in
  141010. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  141011. * @param noMipmap Forces to not generate the mipmap if true
  141012. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  141013. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  141014. * @param onLoad — defines a callback called when texture is loaded
  141015. * @param onError — defines a callback called if there is an error
  141016. */
  141017. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  141018. /**
  141019. * Load the image data, by putting the image on a canvas and extracting its buffer.
  141020. */
  141021. private loadImage;
  141022. /**
  141023. * Convert the image buffer into a cubemap and create a CubeTexture.
  141024. */
  141025. private loadTexture;
  141026. /**
  141027. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  141028. * @param buffer The ArrayBuffer that should be converted.
  141029. * @returns The buffer as Float32Array.
  141030. */
  141031. private getFloat32ArrayFromArrayBuffer;
  141032. /**
  141033. * Get the current class name of the texture useful for serialization or dynamic coding.
  141034. * @returns "EquiRectangularCubeTexture"
  141035. */
  141036. getClassName(): string;
  141037. /**
  141038. * Create a clone of the current EquiRectangularCubeTexture and return it.
  141039. * @returns A clone of the current EquiRectangularCubeTexture.
  141040. */
  141041. clone(): EquiRectangularCubeTexture;
  141042. }
  141043. }
  141044. declare module BABYLON {
  141045. /**
  141046. * Defines the options related to the creation of an HtmlElementTexture
  141047. */
  141048. export interface IHtmlElementTextureOptions {
  141049. /**
  141050. * Defines wether mip maps should be created or not.
  141051. */
  141052. generateMipMaps?: boolean;
  141053. /**
  141054. * Defines the sampling mode of the texture.
  141055. */
  141056. samplingMode?: number;
  141057. /**
  141058. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  141059. */
  141060. engine: Nullable<ThinEngine>;
  141061. /**
  141062. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  141063. */
  141064. scene: Nullable<Scene>;
  141065. }
  141066. /**
  141067. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  141068. * To be as efficient as possible depending on your constraints nothing aside the first upload
  141069. * is automatically managed.
  141070. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  141071. * in your application.
  141072. *
  141073. * As the update is not automatic, you need to call them manually.
  141074. */
  141075. export class HtmlElementTexture extends BaseTexture {
  141076. /**
  141077. * The texture URL.
  141078. */
  141079. element: HTMLVideoElement | HTMLCanvasElement;
  141080. private static readonly DefaultOptions;
  141081. private _textureMatrix;
  141082. private _isVideo;
  141083. private _generateMipMaps;
  141084. private _samplingMode;
  141085. /**
  141086. * Instantiates a HtmlElementTexture from the following parameters.
  141087. *
  141088. * @param name Defines the name of the texture
  141089. * @param element Defines the video or canvas the texture is filled with
  141090. * @param options Defines the other none mandatory texture creation options
  141091. */
  141092. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  141093. private _createInternalTexture;
  141094. /**
  141095. * Returns the texture matrix used in most of the material.
  141096. */
  141097. getTextureMatrix(): Matrix;
  141098. /**
  141099. * Updates the content of the texture.
  141100. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  141101. */
  141102. update(invertY?: Nullable<boolean>): void;
  141103. }
  141104. }
  141105. declare module BABYLON {
  141106. /**
  141107. * Based on jsTGALoader - Javascript loader for TGA file
  141108. * By Vincent Thibault
  141109. * @see http://blog.robrowser.com/javascript-tga-loader.html
  141110. */
  141111. export class TGATools {
  141112. private static _TYPE_INDEXED;
  141113. private static _TYPE_RGB;
  141114. private static _TYPE_GREY;
  141115. private static _TYPE_RLE_INDEXED;
  141116. private static _TYPE_RLE_RGB;
  141117. private static _TYPE_RLE_GREY;
  141118. private static _ORIGIN_MASK;
  141119. private static _ORIGIN_SHIFT;
  141120. private static _ORIGIN_BL;
  141121. private static _ORIGIN_BR;
  141122. private static _ORIGIN_UL;
  141123. private static _ORIGIN_UR;
  141124. /**
  141125. * Gets the header of a TGA file
  141126. * @param data defines the TGA data
  141127. * @returns the header
  141128. */
  141129. static GetTGAHeader(data: Uint8Array): any;
  141130. /**
  141131. * Uploads TGA content to a Babylon Texture
  141132. * @hidden
  141133. */
  141134. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  141135. /** @hidden */
  141136. 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;
  141137. /** @hidden */
  141138. 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;
  141139. /** @hidden */
  141140. 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;
  141141. /** @hidden */
  141142. 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;
  141143. /** @hidden */
  141144. 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;
  141145. /** @hidden */
  141146. 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;
  141147. }
  141148. }
  141149. declare module BABYLON {
  141150. /**
  141151. * Implementation of the TGA Texture Loader.
  141152. * @hidden
  141153. */
  141154. export class _TGATextureLoader implements IInternalTextureLoader {
  141155. /**
  141156. * Defines wether the loader supports cascade loading the different faces.
  141157. */
  141158. readonly supportCascades: boolean;
  141159. /**
  141160. * This returns if the loader support the current file information.
  141161. * @param extension defines the file extension of the file being loaded
  141162. * @returns true if the loader can load the specified file
  141163. */
  141164. canLoad(extension: string): boolean;
  141165. /**
  141166. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141167. * @param data contains the texture data
  141168. * @param texture defines the BabylonJS internal texture
  141169. * @param createPolynomials will be true if polynomials have been requested
  141170. * @param onLoad defines the callback to trigger once the texture is ready
  141171. * @param onError defines the callback to trigger in case of error
  141172. */
  141173. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141174. /**
  141175. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141176. * @param data contains the texture data
  141177. * @param texture defines the BabylonJS internal texture
  141178. * @param callback defines the method to call once ready to upload
  141179. */
  141180. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141181. }
  141182. }
  141183. declare module BABYLON {
  141184. /**
  141185. * Info about the .basis files
  141186. */
  141187. class BasisFileInfo {
  141188. /**
  141189. * If the file has alpha
  141190. */
  141191. hasAlpha: boolean;
  141192. /**
  141193. * Info about each image of the basis file
  141194. */
  141195. images: Array<{
  141196. levels: Array<{
  141197. width: number;
  141198. height: number;
  141199. transcodedPixels: ArrayBufferView;
  141200. }>;
  141201. }>;
  141202. }
  141203. /**
  141204. * Result of transcoding a basis file
  141205. */
  141206. class TranscodeResult {
  141207. /**
  141208. * Info about the .basis file
  141209. */
  141210. fileInfo: BasisFileInfo;
  141211. /**
  141212. * Format to use when loading the file
  141213. */
  141214. format: number;
  141215. }
  141216. /**
  141217. * Configuration options for the Basis transcoder
  141218. */
  141219. export class BasisTranscodeConfiguration {
  141220. /**
  141221. * Supported compression formats used to determine the supported output format of the transcoder
  141222. */
  141223. supportedCompressionFormats?: {
  141224. /**
  141225. * etc1 compression format
  141226. */
  141227. etc1?: boolean;
  141228. /**
  141229. * s3tc compression format
  141230. */
  141231. s3tc?: boolean;
  141232. /**
  141233. * pvrtc compression format
  141234. */
  141235. pvrtc?: boolean;
  141236. /**
  141237. * etc2 compression format
  141238. */
  141239. etc2?: boolean;
  141240. };
  141241. /**
  141242. * If mipmap levels should be loaded for transcoded images (Default: true)
  141243. */
  141244. loadMipmapLevels?: boolean;
  141245. /**
  141246. * Index of a single image to load (Default: all images)
  141247. */
  141248. loadSingleImage?: number;
  141249. }
  141250. /**
  141251. * Used to load .Basis files
  141252. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  141253. */
  141254. export class BasisTools {
  141255. private static _IgnoreSupportedFormats;
  141256. /**
  141257. * URL to use when loading the basis transcoder
  141258. */
  141259. static JSModuleURL: string;
  141260. /**
  141261. * URL to use when loading the wasm module for the transcoder
  141262. */
  141263. static WasmModuleURL: string;
  141264. /**
  141265. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  141266. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  141267. * @returns internal format corresponding to the Basis format
  141268. */
  141269. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  141270. private static _WorkerPromise;
  141271. private static _Worker;
  141272. private static _actionId;
  141273. private static _CreateWorkerAsync;
  141274. /**
  141275. * Transcodes a loaded image file to compressed pixel data
  141276. * @param data image data to transcode
  141277. * @param config configuration options for the transcoding
  141278. * @returns a promise resulting in the transcoded image
  141279. */
  141280. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  141281. /**
  141282. * Loads a texture from the transcode result
  141283. * @param texture texture load to
  141284. * @param transcodeResult the result of transcoding the basis file to load from
  141285. */
  141286. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  141287. }
  141288. }
  141289. declare module BABYLON {
  141290. /**
  141291. * Loader for .basis file format
  141292. */
  141293. export class _BasisTextureLoader implements IInternalTextureLoader {
  141294. /**
  141295. * Defines whether the loader supports cascade loading the different faces.
  141296. */
  141297. readonly supportCascades: boolean;
  141298. /**
  141299. * This returns if the loader support the current file information.
  141300. * @param extension defines the file extension of the file being loaded
  141301. * @returns true if the loader can load the specified file
  141302. */
  141303. canLoad(extension: string): boolean;
  141304. /**
  141305. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141306. * @param data contains the texture data
  141307. * @param texture defines the BabylonJS internal texture
  141308. * @param createPolynomials will be true if polynomials have been requested
  141309. * @param onLoad defines the callback to trigger once the texture is ready
  141310. * @param onError defines the callback to trigger in case of error
  141311. */
  141312. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141313. /**
  141314. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141315. * @param data contains the texture data
  141316. * @param texture defines the BabylonJS internal texture
  141317. * @param callback defines the method to call once ready to upload
  141318. */
  141319. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141320. }
  141321. }
  141322. declare module BABYLON {
  141323. /**
  141324. * Defines the basic options interface of a TexturePacker Frame
  141325. */
  141326. export interface ITexturePackerFrame {
  141327. /**
  141328. * The frame ID
  141329. */
  141330. id: number;
  141331. /**
  141332. * The frames Scale
  141333. */
  141334. scale: Vector2;
  141335. /**
  141336. * The Frames offset
  141337. */
  141338. offset: Vector2;
  141339. }
  141340. /**
  141341. * This is a support class for frame Data on texture packer sets.
  141342. */
  141343. export class TexturePackerFrame implements ITexturePackerFrame {
  141344. /**
  141345. * The frame ID
  141346. */
  141347. id: number;
  141348. /**
  141349. * The frames Scale
  141350. */
  141351. scale: Vector2;
  141352. /**
  141353. * The Frames offset
  141354. */
  141355. offset: Vector2;
  141356. /**
  141357. * Initializes a texture package frame.
  141358. * @param id The numerical frame identifier
  141359. * @param scale Scalar Vector2 for UV frame
  141360. * @param offset Vector2 for the frame position in UV units.
  141361. * @returns TexturePackerFrame
  141362. */
  141363. constructor(id: number, scale: Vector2, offset: Vector2);
  141364. }
  141365. }
  141366. declare module BABYLON {
  141367. /**
  141368. * Defines the basic options interface of a TexturePacker
  141369. */
  141370. export interface ITexturePackerOptions {
  141371. /**
  141372. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  141373. */
  141374. map?: string[];
  141375. /**
  141376. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141377. */
  141378. uvsIn?: string;
  141379. /**
  141380. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141381. */
  141382. uvsOut?: string;
  141383. /**
  141384. * number representing the layout style. Defaults to LAYOUT_STRIP
  141385. */
  141386. layout?: number;
  141387. /**
  141388. * number of columns if using custom column count layout(2). This defaults to 4.
  141389. */
  141390. colnum?: number;
  141391. /**
  141392. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  141393. */
  141394. updateInputMeshes?: boolean;
  141395. /**
  141396. * boolean flag to dispose all the source textures. Defaults to true.
  141397. */
  141398. disposeSources?: boolean;
  141399. /**
  141400. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  141401. */
  141402. fillBlanks?: boolean;
  141403. /**
  141404. * string value representing the context fill style color. Defaults to 'black'.
  141405. */
  141406. customFillColor?: string;
  141407. /**
  141408. * Width and Height Value of each Frame in the TexturePacker Sets
  141409. */
  141410. frameSize?: number;
  141411. /**
  141412. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  141413. */
  141414. paddingRatio?: number;
  141415. /**
  141416. * Number that declares the fill method for the padding gutter.
  141417. */
  141418. paddingMode?: number;
  141419. /**
  141420. * If in SUBUV_COLOR padding mode what color to use.
  141421. */
  141422. paddingColor?: Color3 | Color4;
  141423. }
  141424. /**
  141425. * Defines the basic interface of a TexturePacker JSON File
  141426. */
  141427. export interface ITexturePackerJSON {
  141428. /**
  141429. * The frame ID
  141430. */
  141431. name: string;
  141432. /**
  141433. * The base64 channel data
  141434. */
  141435. sets: any;
  141436. /**
  141437. * The options of the Packer
  141438. */
  141439. options: ITexturePackerOptions;
  141440. /**
  141441. * The frame data of the Packer
  141442. */
  141443. frames: Array<number>;
  141444. }
  141445. /**
  141446. * This is a support class that generates a series of packed texture sets.
  141447. * @see https://doc.babylonjs.com/babylon101/materials
  141448. */
  141449. export class TexturePacker {
  141450. /** Packer Layout Constant 0 */
  141451. static readonly LAYOUT_STRIP: number;
  141452. /** Packer Layout Constant 1 */
  141453. static readonly LAYOUT_POWER2: number;
  141454. /** Packer Layout Constant 2 */
  141455. static readonly LAYOUT_COLNUM: number;
  141456. /** Packer Layout Constant 0 */
  141457. static readonly SUBUV_WRAP: number;
  141458. /** Packer Layout Constant 1 */
  141459. static readonly SUBUV_EXTEND: number;
  141460. /** Packer Layout Constant 2 */
  141461. static readonly SUBUV_COLOR: number;
  141462. /** The Name of the Texture Package */
  141463. name: string;
  141464. /** The scene scope of the TexturePacker */
  141465. scene: Scene;
  141466. /** The Meshes to target */
  141467. meshes: AbstractMesh[];
  141468. /** Arguments passed with the Constructor */
  141469. options: ITexturePackerOptions;
  141470. /** The promise that is started upon initialization */
  141471. promise: Nullable<Promise<TexturePacker | string>>;
  141472. /** The Container object for the channel sets that are generated */
  141473. sets: object;
  141474. /** The Container array for the frames that are generated */
  141475. frames: TexturePackerFrame[];
  141476. /** The expected number of textures the system is parsing. */
  141477. private _expecting;
  141478. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  141479. private _paddingValue;
  141480. /**
  141481. * Initializes a texture package series from an array of meshes or a single mesh.
  141482. * @param name The name of the package
  141483. * @param meshes The target meshes to compose the package from
  141484. * @param options The arguments that texture packer should follow while building.
  141485. * @param scene The scene which the textures are scoped to.
  141486. * @returns TexturePacker
  141487. */
  141488. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  141489. /**
  141490. * Starts the package process
  141491. * @param resolve The promises resolution function
  141492. * @returns TexturePacker
  141493. */
  141494. private _createFrames;
  141495. /**
  141496. * Calculates the Size of the Channel Sets
  141497. * @returns Vector2
  141498. */
  141499. private _calculateSize;
  141500. /**
  141501. * Calculates the UV data for the frames.
  141502. * @param baseSize the base frameSize
  141503. * @param padding the base frame padding
  141504. * @param dtSize size of the Dynamic Texture for that channel
  141505. * @param dtUnits is 1/dtSize
  141506. * @param update flag to update the input meshes
  141507. */
  141508. private _calculateMeshUVFrames;
  141509. /**
  141510. * Calculates the frames Offset.
  141511. * @param index of the frame
  141512. * @returns Vector2
  141513. */
  141514. private _getFrameOffset;
  141515. /**
  141516. * Updates a Mesh to the frame data
  141517. * @param mesh that is the target
  141518. * @param frameID or the frame index
  141519. */
  141520. private _updateMeshUV;
  141521. /**
  141522. * Updates a Meshes materials to use the texture packer channels
  141523. * @param m is the mesh to target
  141524. * @param force all channels on the packer to be set.
  141525. */
  141526. private _updateTextureReferences;
  141527. /**
  141528. * Public method to set a Mesh to a frame
  141529. * @param m that is the target
  141530. * @param frameID or the frame index
  141531. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  141532. */
  141533. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  141534. /**
  141535. * Starts the async promise to compile the texture packer.
  141536. * @returns Promise<void>
  141537. */
  141538. processAsync(): Promise<void>;
  141539. /**
  141540. * Disposes all textures associated with this packer
  141541. */
  141542. dispose(): void;
  141543. /**
  141544. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  141545. * @param imageType is the image type to use.
  141546. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  141547. */
  141548. download(imageType?: string, quality?: number): void;
  141549. /**
  141550. * Public method to load a texturePacker JSON file.
  141551. * @param data of the JSON file in string format.
  141552. */
  141553. updateFromJSON(data: string): void;
  141554. }
  141555. }
  141556. declare module BABYLON {
  141557. /**
  141558. * 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.
  141559. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141560. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141561. */
  141562. export class CustomProceduralTexture extends ProceduralTexture {
  141563. private _animate;
  141564. private _time;
  141565. private _config;
  141566. private _texturePath;
  141567. /**
  141568. * Instantiates a new Custom Procedural Texture.
  141569. * 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.
  141570. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141571. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141572. * @param name Define the name of the texture
  141573. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  141574. * @param size Define the size of the texture to create
  141575. * @param scene Define the scene the texture belongs to
  141576. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  141577. * @param generateMipMaps Define if the texture should creates mip maps or not
  141578. */
  141579. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141580. private _loadJson;
  141581. /**
  141582. * Is the texture ready to be used ? (rendered at least once)
  141583. * @returns true if ready, otherwise, false.
  141584. */
  141585. isReady(): boolean;
  141586. /**
  141587. * Render the texture to its associated render target.
  141588. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  141589. */
  141590. render(useCameraPostProcess?: boolean): void;
  141591. /**
  141592. * Update the list of dependant textures samplers in the shader.
  141593. */
  141594. updateTextures(): void;
  141595. /**
  141596. * Update the uniform values of the procedural texture in the shader.
  141597. */
  141598. updateShaderUniforms(): void;
  141599. /**
  141600. * Define if the texture animates or not.
  141601. */
  141602. get animate(): boolean;
  141603. set animate(value: boolean);
  141604. }
  141605. }
  141606. declare module BABYLON {
  141607. /** @hidden */
  141608. export var noisePixelShader: {
  141609. name: string;
  141610. shader: string;
  141611. };
  141612. }
  141613. declare module BABYLON {
  141614. /**
  141615. * Class used to generate noise procedural textures
  141616. */
  141617. export class NoiseProceduralTexture extends ProceduralTexture {
  141618. private _time;
  141619. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  141620. brightness: number;
  141621. /** Defines the number of octaves to process */
  141622. octaves: number;
  141623. /** Defines the level of persistence (0.8 by default) */
  141624. persistence: number;
  141625. /** Gets or sets animation speed factor (default is 1) */
  141626. animationSpeedFactor: number;
  141627. /**
  141628. * Creates a new NoiseProceduralTexture
  141629. * @param name defines the name fo the texture
  141630. * @param size defines the size of the texture (default is 256)
  141631. * @param scene defines the hosting scene
  141632. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  141633. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  141634. */
  141635. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141636. private _updateShaderUniforms;
  141637. protected _getDefines(): string;
  141638. /** Generate the current state of the procedural texture */
  141639. render(useCameraPostProcess?: boolean): void;
  141640. /**
  141641. * Serializes this noise procedural texture
  141642. * @returns a serialized noise procedural texture object
  141643. */
  141644. serialize(): any;
  141645. /**
  141646. * Clone the texture.
  141647. * @returns the cloned texture
  141648. */
  141649. clone(): NoiseProceduralTexture;
  141650. /**
  141651. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  141652. * @param parsedTexture defines parsed texture data
  141653. * @param scene defines the current scene
  141654. * @param rootUrl defines the root URL containing noise procedural texture information
  141655. * @returns a parsed NoiseProceduralTexture
  141656. */
  141657. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  141658. }
  141659. }
  141660. declare module BABYLON {
  141661. /**
  141662. * Raw cube texture where the raw buffers are passed in
  141663. */
  141664. export class RawCubeTexture extends CubeTexture {
  141665. /**
  141666. * Creates a cube texture where the raw buffers are passed in.
  141667. * @param scene defines the scene the texture is attached to
  141668. * @param data defines the array of data to use to create each face
  141669. * @param size defines the size of the textures
  141670. * @param format defines the format of the data
  141671. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  141672. * @param generateMipMaps defines if the engine should generate the mip levels
  141673. * @param invertY defines if data must be stored with Y axis inverted
  141674. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  141675. * @param compression defines the compression used (null by default)
  141676. */
  141677. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  141678. /**
  141679. * Updates the raw cube texture.
  141680. * @param data defines the data to store
  141681. * @param format defines the data format
  141682. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  141683. * @param invertY defines if data must be stored with Y axis inverted
  141684. * @param compression defines the compression used (null by default)
  141685. * @param level defines which level of the texture to update
  141686. */
  141687. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  141688. /**
  141689. * Updates a raw cube texture with RGBD encoded data.
  141690. * @param data defines the array of data [mipmap][face] to use to create each face
  141691. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  141692. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  141693. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  141694. * @returns a promsie that resolves when the operation is complete
  141695. */
  141696. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  141697. /**
  141698. * Clones the raw cube texture.
  141699. * @return a new cube texture
  141700. */
  141701. clone(): CubeTexture;
  141702. /** @hidden */
  141703. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  141704. }
  141705. }
  141706. declare module BABYLON {
  141707. /**
  141708. * Class used to store 2D array textures containing user data
  141709. */
  141710. export class RawTexture2DArray extends Texture {
  141711. /** Gets or sets the texture format to use */
  141712. format: number;
  141713. /**
  141714. * Create a new RawTexture2DArray
  141715. * @param data defines the data of the texture
  141716. * @param width defines the width of the texture
  141717. * @param height defines the height of the texture
  141718. * @param depth defines the number of layers of the texture
  141719. * @param format defines the texture format to use
  141720. * @param scene defines the hosting scene
  141721. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141722. * @param invertY defines if texture must be stored with Y axis inverted
  141723. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141724. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141725. */
  141726. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141727. /** Gets or sets the texture format to use */
  141728. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141729. /**
  141730. * Update the texture with new data
  141731. * @param data defines the data to store in the texture
  141732. */
  141733. update(data: ArrayBufferView): void;
  141734. }
  141735. }
  141736. declare module BABYLON {
  141737. /**
  141738. * Class used to store 3D textures containing user data
  141739. */
  141740. export class RawTexture3D extends Texture {
  141741. /** Gets or sets the texture format to use */
  141742. format: number;
  141743. /**
  141744. * Create a new RawTexture3D
  141745. * @param data defines the data of the texture
  141746. * @param width defines the width of the texture
  141747. * @param height defines the height of the texture
  141748. * @param depth defines the depth of the texture
  141749. * @param format defines the texture format to use
  141750. * @param scene defines the hosting scene
  141751. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141752. * @param invertY defines if texture must be stored with Y axis inverted
  141753. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141754. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141755. */
  141756. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141757. /** Gets or sets the texture format to use */
  141758. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141759. /**
  141760. * Update the texture with new data
  141761. * @param data defines the data to store in the texture
  141762. */
  141763. update(data: ArrayBufferView): void;
  141764. }
  141765. }
  141766. declare module BABYLON {
  141767. /**
  141768. * Creates a refraction texture used by refraction channel of the standard material.
  141769. * It is like a mirror but to see through a material.
  141770. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141771. */
  141772. export class RefractionTexture extends RenderTargetTexture {
  141773. /**
  141774. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  141775. * 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.
  141776. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141777. */
  141778. refractionPlane: Plane;
  141779. /**
  141780. * Define how deep under the surface we should see.
  141781. */
  141782. depth: number;
  141783. /**
  141784. * Creates a refraction texture used by refraction channel of the standard material.
  141785. * It is like a mirror but to see through a material.
  141786. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141787. * @param name Define the texture name
  141788. * @param size Define the size of the underlying texture
  141789. * @param scene Define the scene the refraction belongs to
  141790. * @param generateMipMaps Define if we need to generate mips level for the refraction
  141791. */
  141792. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  141793. /**
  141794. * Clone the refraction texture.
  141795. * @returns the cloned texture
  141796. */
  141797. clone(): RefractionTexture;
  141798. /**
  141799. * Serialize the texture to a JSON representation you could use in Parse later on
  141800. * @returns the serialized JSON representation
  141801. */
  141802. serialize(): any;
  141803. }
  141804. }
  141805. declare module BABYLON {
  141806. /**
  141807. * Block used to add support for vertex skinning (bones)
  141808. */
  141809. export class BonesBlock extends NodeMaterialBlock {
  141810. /**
  141811. * Creates a new BonesBlock
  141812. * @param name defines the block name
  141813. */
  141814. constructor(name: string);
  141815. /**
  141816. * Initialize the block and prepare the context for build
  141817. * @param state defines the state that will be used for the build
  141818. */
  141819. initialize(state: NodeMaterialBuildState): void;
  141820. /**
  141821. * Gets the current class name
  141822. * @returns the class name
  141823. */
  141824. getClassName(): string;
  141825. /**
  141826. * Gets the matrix indices input component
  141827. */
  141828. get matricesIndices(): NodeMaterialConnectionPoint;
  141829. /**
  141830. * Gets the matrix weights input component
  141831. */
  141832. get matricesWeights(): NodeMaterialConnectionPoint;
  141833. /**
  141834. * Gets the extra matrix indices input component
  141835. */
  141836. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  141837. /**
  141838. * Gets the extra matrix weights input component
  141839. */
  141840. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  141841. /**
  141842. * Gets the world input component
  141843. */
  141844. get world(): NodeMaterialConnectionPoint;
  141845. /**
  141846. * Gets the output component
  141847. */
  141848. get output(): NodeMaterialConnectionPoint;
  141849. autoConfigure(material: NodeMaterial): void;
  141850. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  141851. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141852. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141853. protected _buildBlock(state: NodeMaterialBuildState): this;
  141854. }
  141855. }
  141856. declare module BABYLON {
  141857. /**
  141858. * Block used to add support for instances
  141859. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  141860. */
  141861. export class InstancesBlock extends NodeMaterialBlock {
  141862. /**
  141863. * Creates a new InstancesBlock
  141864. * @param name defines the block name
  141865. */
  141866. constructor(name: string);
  141867. /**
  141868. * Gets the current class name
  141869. * @returns the class name
  141870. */
  141871. getClassName(): string;
  141872. /**
  141873. * Gets the first world row input component
  141874. */
  141875. get world0(): NodeMaterialConnectionPoint;
  141876. /**
  141877. * Gets the second world row input component
  141878. */
  141879. get world1(): NodeMaterialConnectionPoint;
  141880. /**
  141881. * Gets the third world row input component
  141882. */
  141883. get world2(): NodeMaterialConnectionPoint;
  141884. /**
  141885. * Gets the forth world row input component
  141886. */
  141887. get world3(): NodeMaterialConnectionPoint;
  141888. /**
  141889. * Gets the world input component
  141890. */
  141891. get world(): NodeMaterialConnectionPoint;
  141892. /**
  141893. * Gets the output component
  141894. */
  141895. get output(): NodeMaterialConnectionPoint;
  141896. /**
  141897. * Gets the isntanceID component
  141898. */
  141899. get instanceID(): NodeMaterialConnectionPoint;
  141900. autoConfigure(material: NodeMaterial): void;
  141901. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  141902. protected _buildBlock(state: NodeMaterialBuildState): this;
  141903. }
  141904. }
  141905. declare module BABYLON {
  141906. /**
  141907. * Block used to add morph targets support to vertex shader
  141908. */
  141909. export class MorphTargetsBlock extends NodeMaterialBlock {
  141910. private _repeatableContentAnchor;
  141911. /**
  141912. * Create a new MorphTargetsBlock
  141913. * @param name defines the block name
  141914. */
  141915. constructor(name: string);
  141916. /**
  141917. * Gets the current class name
  141918. * @returns the class name
  141919. */
  141920. getClassName(): string;
  141921. /**
  141922. * Gets the position input component
  141923. */
  141924. get position(): NodeMaterialConnectionPoint;
  141925. /**
  141926. * Gets the normal input component
  141927. */
  141928. get normal(): NodeMaterialConnectionPoint;
  141929. /**
  141930. * Gets the tangent input component
  141931. */
  141932. get tangent(): NodeMaterialConnectionPoint;
  141933. /**
  141934. * Gets the tangent input component
  141935. */
  141936. get uv(): NodeMaterialConnectionPoint;
  141937. /**
  141938. * Gets the position output component
  141939. */
  141940. get positionOutput(): NodeMaterialConnectionPoint;
  141941. /**
  141942. * Gets the normal output component
  141943. */
  141944. get normalOutput(): NodeMaterialConnectionPoint;
  141945. /**
  141946. * Gets the tangent output component
  141947. */
  141948. get tangentOutput(): NodeMaterialConnectionPoint;
  141949. /**
  141950. * Gets the tangent output component
  141951. */
  141952. get uvOutput(): NodeMaterialConnectionPoint;
  141953. initialize(state: NodeMaterialBuildState): void;
  141954. autoConfigure(material: NodeMaterial): void;
  141955. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141956. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141957. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  141958. protected _buildBlock(state: NodeMaterialBuildState): this;
  141959. }
  141960. }
  141961. declare module BABYLON {
  141962. /**
  141963. * Block used to get data information from a light
  141964. */
  141965. export class LightInformationBlock extends NodeMaterialBlock {
  141966. private _lightDataUniformName;
  141967. private _lightColorUniformName;
  141968. private _lightTypeDefineName;
  141969. /**
  141970. * Gets or sets the light associated with this block
  141971. */
  141972. light: Nullable<Light>;
  141973. /**
  141974. * Creates a new LightInformationBlock
  141975. * @param name defines the block name
  141976. */
  141977. constructor(name: string);
  141978. /**
  141979. * Gets the current class name
  141980. * @returns the class name
  141981. */
  141982. getClassName(): string;
  141983. /**
  141984. * Gets the world position input component
  141985. */
  141986. get worldPosition(): NodeMaterialConnectionPoint;
  141987. /**
  141988. * Gets the direction output component
  141989. */
  141990. get direction(): NodeMaterialConnectionPoint;
  141991. /**
  141992. * Gets the direction output component
  141993. */
  141994. get color(): NodeMaterialConnectionPoint;
  141995. /**
  141996. * Gets the direction output component
  141997. */
  141998. get intensity(): NodeMaterialConnectionPoint;
  141999. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142000. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142001. protected _buildBlock(state: NodeMaterialBuildState): this;
  142002. serialize(): any;
  142003. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142004. }
  142005. }
  142006. declare module BABYLON {
  142007. /**
  142008. * Block used to add image processing support to fragment shader
  142009. */
  142010. export class ImageProcessingBlock extends NodeMaterialBlock {
  142011. /**
  142012. * Create a new ImageProcessingBlock
  142013. * @param name defines the block name
  142014. */
  142015. constructor(name: string);
  142016. /**
  142017. * Gets the current class name
  142018. * @returns the class name
  142019. */
  142020. getClassName(): string;
  142021. /**
  142022. * Gets the color input component
  142023. */
  142024. get color(): NodeMaterialConnectionPoint;
  142025. /**
  142026. * Gets the output component
  142027. */
  142028. get output(): NodeMaterialConnectionPoint;
  142029. /**
  142030. * Initialize the block and prepare the context for build
  142031. * @param state defines the state that will be used for the build
  142032. */
  142033. initialize(state: NodeMaterialBuildState): void;
  142034. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  142035. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142036. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142037. protected _buildBlock(state: NodeMaterialBuildState): this;
  142038. }
  142039. }
  142040. declare module BABYLON {
  142041. /**
  142042. * Block used to pertub normals based on a normal map
  142043. */
  142044. export class PerturbNormalBlock extends NodeMaterialBlock {
  142045. private _tangentSpaceParameterName;
  142046. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  142047. invertX: boolean;
  142048. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  142049. invertY: boolean;
  142050. /**
  142051. * Create a new PerturbNormalBlock
  142052. * @param name defines the block name
  142053. */
  142054. constructor(name: string);
  142055. /**
  142056. * Gets the current class name
  142057. * @returns the class name
  142058. */
  142059. getClassName(): string;
  142060. /**
  142061. * Gets the world position input component
  142062. */
  142063. get worldPosition(): NodeMaterialConnectionPoint;
  142064. /**
  142065. * Gets the world normal input component
  142066. */
  142067. get worldNormal(): NodeMaterialConnectionPoint;
  142068. /**
  142069. * Gets the world tangent input component
  142070. */
  142071. get worldTangent(): NodeMaterialConnectionPoint;
  142072. /**
  142073. * Gets the uv input component
  142074. */
  142075. get uv(): NodeMaterialConnectionPoint;
  142076. /**
  142077. * Gets the normal map color input component
  142078. */
  142079. get normalMapColor(): NodeMaterialConnectionPoint;
  142080. /**
  142081. * Gets the strength input component
  142082. */
  142083. get strength(): NodeMaterialConnectionPoint;
  142084. /**
  142085. * Gets the output component
  142086. */
  142087. get output(): NodeMaterialConnectionPoint;
  142088. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142089. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142090. autoConfigure(material: NodeMaterial): void;
  142091. protected _buildBlock(state: NodeMaterialBuildState): this;
  142092. protected _dumpPropertiesCode(): string;
  142093. serialize(): any;
  142094. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142095. }
  142096. }
  142097. declare module BABYLON {
  142098. /**
  142099. * Block used to discard a pixel if a value is smaller than a cutoff
  142100. */
  142101. export class DiscardBlock extends NodeMaterialBlock {
  142102. /**
  142103. * Create a new DiscardBlock
  142104. * @param name defines the block name
  142105. */
  142106. constructor(name: string);
  142107. /**
  142108. * Gets the current class name
  142109. * @returns the class name
  142110. */
  142111. getClassName(): string;
  142112. /**
  142113. * Gets the color input component
  142114. */
  142115. get value(): NodeMaterialConnectionPoint;
  142116. /**
  142117. * Gets the cutoff input component
  142118. */
  142119. get cutoff(): NodeMaterialConnectionPoint;
  142120. protected _buildBlock(state: NodeMaterialBuildState): this;
  142121. }
  142122. }
  142123. declare module BABYLON {
  142124. /**
  142125. * Block used to test if the fragment shader is front facing
  142126. */
  142127. export class FrontFacingBlock extends NodeMaterialBlock {
  142128. /**
  142129. * Creates a new FrontFacingBlock
  142130. * @param name defines the block name
  142131. */
  142132. constructor(name: string);
  142133. /**
  142134. * Gets the current class name
  142135. * @returns the class name
  142136. */
  142137. getClassName(): string;
  142138. /**
  142139. * Gets the output component
  142140. */
  142141. get output(): NodeMaterialConnectionPoint;
  142142. protected _buildBlock(state: NodeMaterialBuildState): this;
  142143. }
  142144. }
  142145. declare module BABYLON {
  142146. /**
  142147. * Block used to get the derivative value on x and y of a given input
  142148. */
  142149. export class DerivativeBlock extends NodeMaterialBlock {
  142150. /**
  142151. * Create a new DerivativeBlock
  142152. * @param name defines the block name
  142153. */
  142154. constructor(name: string);
  142155. /**
  142156. * Gets the current class name
  142157. * @returns the class name
  142158. */
  142159. getClassName(): string;
  142160. /**
  142161. * Gets the input component
  142162. */
  142163. get input(): NodeMaterialConnectionPoint;
  142164. /**
  142165. * Gets the derivative output on x
  142166. */
  142167. get dx(): NodeMaterialConnectionPoint;
  142168. /**
  142169. * Gets the derivative output on y
  142170. */
  142171. get dy(): NodeMaterialConnectionPoint;
  142172. protected _buildBlock(state: NodeMaterialBuildState): this;
  142173. }
  142174. }
  142175. declare module BABYLON {
  142176. /**
  142177. * Block used to make gl_FragCoord available
  142178. */
  142179. export class FragCoordBlock extends NodeMaterialBlock {
  142180. /**
  142181. * Creates a new FragCoordBlock
  142182. * @param name defines the block name
  142183. */
  142184. constructor(name: string);
  142185. /**
  142186. * Gets the current class name
  142187. * @returns the class name
  142188. */
  142189. getClassName(): string;
  142190. /**
  142191. * Gets the xy component
  142192. */
  142193. get xy(): NodeMaterialConnectionPoint;
  142194. /**
  142195. * Gets the xyz component
  142196. */
  142197. get xyz(): NodeMaterialConnectionPoint;
  142198. /**
  142199. * Gets the xyzw component
  142200. */
  142201. get xyzw(): NodeMaterialConnectionPoint;
  142202. /**
  142203. * Gets the x component
  142204. */
  142205. get x(): NodeMaterialConnectionPoint;
  142206. /**
  142207. * Gets the y component
  142208. */
  142209. get y(): NodeMaterialConnectionPoint;
  142210. /**
  142211. * Gets the z component
  142212. */
  142213. get z(): NodeMaterialConnectionPoint;
  142214. /**
  142215. * Gets the w component
  142216. */
  142217. get output(): NodeMaterialConnectionPoint;
  142218. protected writeOutputs(state: NodeMaterialBuildState): string;
  142219. protected _buildBlock(state: NodeMaterialBuildState): this;
  142220. }
  142221. }
  142222. declare module BABYLON {
  142223. /**
  142224. * Block used to get the screen sizes
  142225. */
  142226. export class ScreenSizeBlock extends NodeMaterialBlock {
  142227. private _varName;
  142228. private _scene;
  142229. /**
  142230. * Creates a new ScreenSizeBlock
  142231. * @param name defines the block name
  142232. */
  142233. constructor(name: string);
  142234. /**
  142235. * Gets the current class name
  142236. * @returns the class name
  142237. */
  142238. getClassName(): string;
  142239. /**
  142240. * Gets the xy component
  142241. */
  142242. get xy(): NodeMaterialConnectionPoint;
  142243. /**
  142244. * Gets the x component
  142245. */
  142246. get x(): NodeMaterialConnectionPoint;
  142247. /**
  142248. * Gets the y component
  142249. */
  142250. get y(): NodeMaterialConnectionPoint;
  142251. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142252. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  142253. protected _buildBlock(state: NodeMaterialBuildState): this;
  142254. }
  142255. }
  142256. declare module BABYLON {
  142257. /**
  142258. * Block used to add support for scene fog
  142259. */
  142260. export class FogBlock extends NodeMaterialBlock {
  142261. private _fogDistanceName;
  142262. private _fogParameters;
  142263. /**
  142264. * Create a new FogBlock
  142265. * @param name defines the block name
  142266. */
  142267. constructor(name: string);
  142268. /**
  142269. * Gets the current class name
  142270. * @returns the class name
  142271. */
  142272. getClassName(): string;
  142273. /**
  142274. * Gets the world position input component
  142275. */
  142276. get worldPosition(): NodeMaterialConnectionPoint;
  142277. /**
  142278. * Gets the view input component
  142279. */
  142280. get view(): NodeMaterialConnectionPoint;
  142281. /**
  142282. * Gets the color input component
  142283. */
  142284. get input(): NodeMaterialConnectionPoint;
  142285. /**
  142286. * Gets the fog color input component
  142287. */
  142288. get fogColor(): NodeMaterialConnectionPoint;
  142289. /**
  142290. * Gets the output component
  142291. */
  142292. get output(): NodeMaterialConnectionPoint;
  142293. autoConfigure(material: NodeMaterial): void;
  142294. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142295. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142296. protected _buildBlock(state: NodeMaterialBuildState): this;
  142297. }
  142298. }
  142299. declare module BABYLON {
  142300. /**
  142301. * Block used to add light in the fragment shader
  142302. */
  142303. export class LightBlock extends NodeMaterialBlock {
  142304. private _lightId;
  142305. /**
  142306. * Gets or sets the light associated with this block
  142307. */
  142308. light: Nullable<Light>;
  142309. /**
  142310. * Create a new LightBlock
  142311. * @param name defines the block name
  142312. */
  142313. constructor(name: string);
  142314. /**
  142315. * Gets the current class name
  142316. * @returns the class name
  142317. */
  142318. getClassName(): string;
  142319. /**
  142320. * Gets the world position input component
  142321. */
  142322. get worldPosition(): NodeMaterialConnectionPoint;
  142323. /**
  142324. * Gets the world normal input component
  142325. */
  142326. get worldNormal(): NodeMaterialConnectionPoint;
  142327. /**
  142328. * Gets the camera (or eye) position component
  142329. */
  142330. get cameraPosition(): NodeMaterialConnectionPoint;
  142331. /**
  142332. * Gets the glossiness component
  142333. */
  142334. get glossiness(): NodeMaterialConnectionPoint;
  142335. /**
  142336. * Gets the glossinness power component
  142337. */
  142338. get glossPower(): NodeMaterialConnectionPoint;
  142339. /**
  142340. * Gets the diffuse color component
  142341. */
  142342. get diffuseColor(): NodeMaterialConnectionPoint;
  142343. /**
  142344. * Gets the specular color component
  142345. */
  142346. get specularColor(): NodeMaterialConnectionPoint;
  142347. /**
  142348. * Gets the diffuse output component
  142349. */
  142350. get diffuseOutput(): NodeMaterialConnectionPoint;
  142351. /**
  142352. * Gets the specular output component
  142353. */
  142354. get specularOutput(): NodeMaterialConnectionPoint;
  142355. /**
  142356. * Gets the shadow output component
  142357. */
  142358. get shadow(): NodeMaterialConnectionPoint;
  142359. autoConfigure(material: NodeMaterial): void;
  142360. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142361. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  142362. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142363. private _injectVertexCode;
  142364. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142365. serialize(): any;
  142366. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142367. }
  142368. }
  142369. declare module BABYLON {
  142370. /**
  142371. * Block used to read a reflection texture from a sampler
  142372. */
  142373. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  142374. /**
  142375. * Create a new ReflectionTextureBlock
  142376. * @param name defines the block name
  142377. */
  142378. constructor(name: string);
  142379. /**
  142380. * Gets the current class name
  142381. * @returns the class name
  142382. */
  142383. getClassName(): string;
  142384. /**
  142385. * Gets the world position input component
  142386. */
  142387. get position(): NodeMaterialConnectionPoint;
  142388. /**
  142389. * Gets the world position input component
  142390. */
  142391. get worldPosition(): NodeMaterialConnectionPoint;
  142392. /**
  142393. * Gets the world normal input component
  142394. */
  142395. get worldNormal(): NodeMaterialConnectionPoint;
  142396. /**
  142397. * Gets the world input component
  142398. */
  142399. get world(): NodeMaterialConnectionPoint;
  142400. /**
  142401. * Gets the camera (or eye) position component
  142402. */
  142403. get cameraPosition(): NodeMaterialConnectionPoint;
  142404. /**
  142405. * Gets the view input component
  142406. */
  142407. get view(): NodeMaterialConnectionPoint;
  142408. /**
  142409. * Gets the rgb output component
  142410. */
  142411. get rgb(): NodeMaterialConnectionPoint;
  142412. /**
  142413. * Gets the rgba output component
  142414. */
  142415. get rgba(): NodeMaterialConnectionPoint;
  142416. /**
  142417. * Gets the r output component
  142418. */
  142419. get r(): NodeMaterialConnectionPoint;
  142420. /**
  142421. * Gets the g output component
  142422. */
  142423. get g(): NodeMaterialConnectionPoint;
  142424. /**
  142425. * Gets the b output component
  142426. */
  142427. get b(): NodeMaterialConnectionPoint;
  142428. /**
  142429. * Gets the a output component
  142430. */
  142431. get a(): NodeMaterialConnectionPoint;
  142432. autoConfigure(material: NodeMaterial): void;
  142433. protected _buildBlock(state: NodeMaterialBuildState): this;
  142434. }
  142435. }
  142436. declare module BABYLON {
  142437. /**
  142438. * Block used to add 2 vectors
  142439. */
  142440. export class AddBlock extends NodeMaterialBlock {
  142441. /**
  142442. * Creates a new AddBlock
  142443. * @param name defines the block name
  142444. */
  142445. constructor(name: string);
  142446. /**
  142447. * Gets the current class name
  142448. * @returns the class name
  142449. */
  142450. getClassName(): string;
  142451. /**
  142452. * Gets the left operand input component
  142453. */
  142454. get left(): NodeMaterialConnectionPoint;
  142455. /**
  142456. * Gets the right operand input component
  142457. */
  142458. get right(): NodeMaterialConnectionPoint;
  142459. /**
  142460. * Gets the output component
  142461. */
  142462. get output(): NodeMaterialConnectionPoint;
  142463. protected _buildBlock(state: NodeMaterialBuildState): this;
  142464. }
  142465. }
  142466. declare module BABYLON {
  142467. /**
  142468. * Block used to scale a vector by a float
  142469. */
  142470. export class ScaleBlock extends NodeMaterialBlock {
  142471. /**
  142472. * Creates a new ScaleBlock
  142473. * @param name defines the block name
  142474. */
  142475. constructor(name: string);
  142476. /**
  142477. * Gets the current class name
  142478. * @returns the class name
  142479. */
  142480. getClassName(): string;
  142481. /**
  142482. * Gets the input component
  142483. */
  142484. get input(): NodeMaterialConnectionPoint;
  142485. /**
  142486. * Gets the factor input component
  142487. */
  142488. get factor(): NodeMaterialConnectionPoint;
  142489. /**
  142490. * Gets the output component
  142491. */
  142492. get output(): NodeMaterialConnectionPoint;
  142493. protected _buildBlock(state: NodeMaterialBuildState): this;
  142494. }
  142495. }
  142496. declare module BABYLON {
  142497. /**
  142498. * Block used to clamp a float
  142499. */
  142500. export class ClampBlock extends NodeMaterialBlock {
  142501. /** Gets or sets the minimum range */
  142502. minimum: number;
  142503. /** Gets or sets the maximum range */
  142504. maximum: number;
  142505. /**
  142506. * Creates a new ClampBlock
  142507. * @param name defines the block name
  142508. */
  142509. constructor(name: string);
  142510. /**
  142511. * Gets the current class name
  142512. * @returns the class name
  142513. */
  142514. getClassName(): string;
  142515. /**
  142516. * Gets the value input component
  142517. */
  142518. get value(): NodeMaterialConnectionPoint;
  142519. /**
  142520. * Gets the output component
  142521. */
  142522. get output(): NodeMaterialConnectionPoint;
  142523. protected _buildBlock(state: NodeMaterialBuildState): this;
  142524. protected _dumpPropertiesCode(): string;
  142525. serialize(): any;
  142526. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142527. }
  142528. }
  142529. declare module BABYLON {
  142530. /**
  142531. * Block used to apply a cross product between 2 vectors
  142532. */
  142533. export class CrossBlock extends NodeMaterialBlock {
  142534. /**
  142535. * Creates a new CrossBlock
  142536. * @param name defines the block name
  142537. */
  142538. constructor(name: string);
  142539. /**
  142540. * Gets the current class name
  142541. * @returns the class name
  142542. */
  142543. getClassName(): string;
  142544. /**
  142545. * Gets the left operand input component
  142546. */
  142547. get left(): NodeMaterialConnectionPoint;
  142548. /**
  142549. * Gets the right operand input component
  142550. */
  142551. get right(): NodeMaterialConnectionPoint;
  142552. /**
  142553. * Gets the output component
  142554. */
  142555. get output(): NodeMaterialConnectionPoint;
  142556. protected _buildBlock(state: NodeMaterialBuildState): this;
  142557. }
  142558. }
  142559. declare module BABYLON {
  142560. /**
  142561. * Block used to apply a dot product between 2 vectors
  142562. */
  142563. export class DotBlock extends NodeMaterialBlock {
  142564. /**
  142565. * Creates a new DotBlock
  142566. * @param name defines the block name
  142567. */
  142568. constructor(name: string);
  142569. /**
  142570. * Gets the current class name
  142571. * @returns the class name
  142572. */
  142573. getClassName(): string;
  142574. /**
  142575. * Gets the left operand input component
  142576. */
  142577. get left(): NodeMaterialConnectionPoint;
  142578. /**
  142579. * Gets the right operand input component
  142580. */
  142581. get right(): NodeMaterialConnectionPoint;
  142582. /**
  142583. * Gets the output component
  142584. */
  142585. get output(): NodeMaterialConnectionPoint;
  142586. protected _buildBlock(state: NodeMaterialBuildState): this;
  142587. }
  142588. }
  142589. declare module BABYLON {
  142590. /**
  142591. * Block used to normalize a vector
  142592. */
  142593. export class NormalizeBlock extends NodeMaterialBlock {
  142594. /**
  142595. * Creates a new NormalizeBlock
  142596. * @param name defines the block name
  142597. */
  142598. constructor(name: string);
  142599. /**
  142600. * Gets the current class name
  142601. * @returns the class name
  142602. */
  142603. getClassName(): string;
  142604. /**
  142605. * Gets the input component
  142606. */
  142607. get input(): NodeMaterialConnectionPoint;
  142608. /**
  142609. * Gets the output component
  142610. */
  142611. get output(): NodeMaterialConnectionPoint;
  142612. protected _buildBlock(state: NodeMaterialBuildState): this;
  142613. }
  142614. }
  142615. declare module BABYLON {
  142616. /**
  142617. * Operations supported by the Trigonometry block
  142618. */
  142619. export enum TrigonometryBlockOperations {
  142620. /** Cos */
  142621. Cos = 0,
  142622. /** Sin */
  142623. Sin = 1,
  142624. /** Abs */
  142625. Abs = 2,
  142626. /** Exp */
  142627. Exp = 3,
  142628. /** Exp2 */
  142629. Exp2 = 4,
  142630. /** Round */
  142631. Round = 5,
  142632. /** Floor */
  142633. Floor = 6,
  142634. /** Ceiling */
  142635. Ceiling = 7,
  142636. /** Square root */
  142637. Sqrt = 8,
  142638. /** Log */
  142639. Log = 9,
  142640. /** Tangent */
  142641. Tan = 10,
  142642. /** Arc tangent */
  142643. ArcTan = 11,
  142644. /** Arc cosinus */
  142645. ArcCos = 12,
  142646. /** Arc sinus */
  142647. ArcSin = 13,
  142648. /** Fraction */
  142649. Fract = 14,
  142650. /** Sign */
  142651. Sign = 15,
  142652. /** To radians (from degrees) */
  142653. Radians = 16,
  142654. /** To degrees (from radians) */
  142655. Degrees = 17
  142656. }
  142657. /**
  142658. * Block used to apply trigonometry operation to floats
  142659. */
  142660. export class TrigonometryBlock extends NodeMaterialBlock {
  142661. /**
  142662. * Gets or sets the operation applied by the block
  142663. */
  142664. operation: TrigonometryBlockOperations;
  142665. /**
  142666. * Creates a new TrigonometryBlock
  142667. * @param name defines the block name
  142668. */
  142669. constructor(name: string);
  142670. /**
  142671. * Gets the current class name
  142672. * @returns the class name
  142673. */
  142674. getClassName(): string;
  142675. /**
  142676. * Gets the input component
  142677. */
  142678. get input(): NodeMaterialConnectionPoint;
  142679. /**
  142680. * Gets the output component
  142681. */
  142682. get output(): NodeMaterialConnectionPoint;
  142683. protected _buildBlock(state: NodeMaterialBuildState): this;
  142684. serialize(): any;
  142685. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142686. protected _dumpPropertiesCode(): string;
  142687. }
  142688. }
  142689. declare module BABYLON {
  142690. /**
  142691. * Block used to create a Color3/4 out of individual inputs (one for each component)
  142692. */
  142693. export class ColorMergerBlock extends NodeMaterialBlock {
  142694. /**
  142695. * Create a new ColorMergerBlock
  142696. * @param name defines the block name
  142697. */
  142698. constructor(name: string);
  142699. /**
  142700. * Gets the current class name
  142701. * @returns the class name
  142702. */
  142703. getClassName(): string;
  142704. /**
  142705. * Gets the rgb component (input)
  142706. */
  142707. get rgbIn(): NodeMaterialConnectionPoint;
  142708. /**
  142709. * Gets the r component (input)
  142710. */
  142711. get r(): NodeMaterialConnectionPoint;
  142712. /**
  142713. * Gets the g component (input)
  142714. */
  142715. get g(): NodeMaterialConnectionPoint;
  142716. /**
  142717. * Gets the b component (input)
  142718. */
  142719. get b(): NodeMaterialConnectionPoint;
  142720. /**
  142721. * Gets the a component (input)
  142722. */
  142723. get a(): NodeMaterialConnectionPoint;
  142724. /**
  142725. * Gets the rgba component (output)
  142726. */
  142727. get rgba(): NodeMaterialConnectionPoint;
  142728. /**
  142729. * Gets the rgb component (output)
  142730. */
  142731. get rgbOut(): NodeMaterialConnectionPoint;
  142732. /**
  142733. * Gets the rgb component (output)
  142734. * @deprecated Please use rgbOut instead.
  142735. */
  142736. get rgb(): NodeMaterialConnectionPoint;
  142737. protected _buildBlock(state: NodeMaterialBuildState): this;
  142738. }
  142739. }
  142740. declare module BABYLON {
  142741. /**
  142742. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  142743. */
  142744. export class VectorSplitterBlock extends NodeMaterialBlock {
  142745. /**
  142746. * Create a new VectorSplitterBlock
  142747. * @param name defines the block name
  142748. */
  142749. constructor(name: string);
  142750. /**
  142751. * Gets the current class name
  142752. * @returns the class name
  142753. */
  142754. getClassName(): string;
  142755. /**
  142756. * Gets the xyzw component (input)
  142757. */
  142758. get xyzw(): NodeMaterialConnectionPoint;
  142759. /**
  142760. * Gets the xyz component (input)
  142761. */
  142762. get xyzIn(): NodeMaterialConnectionPoint;
  142763. /**
  142764. * Gets the xy component (input)
  142765. */
  142766. get xyIn(): NodeMaterialConnectionPoint;
  142767. /**
  142768. * Gets the xyz component (output)
  142769. */
  142770. get xyzOut(): NodeMaterialConnectionPoint;
  142771. /**
  142772. * Gets the xy component (output)
  142773. */
  142774. get xyOut(): NodeMaterialConnectionPoint;
  142775. /**
  142776. * Gets the x component (output)
  142777. */
  142778. get x(): NodeMaterialConnectionPoint;
  142779. /**
  142780. * Gets the y component (output)
  142781. */
  142782. get y(): NodeMaterialConnectionPoint;
  142783. /**
  142784. * Gets the z component (output)
  142785. */
  142786. get z(): NodeMaterialConnectionPoint;
  142787. /**
  142788. * Gets the w component (output)
  142789. */
  142790. get w(): NodeMaterialConnectionPoint;
  142791. protected _inputRename(name: string): string;
  142792. protected _outputRename(name: string): string;
  142793. protected _buildBlock(state: NodeMaterialBuildState): this;
  142794. }
  142795. }
  142796. declare module BABYLON {
  142797. /**
  142798. * Block used to lerp between 2 values
  142799. */
  142800. export class LerpBlock extends NodeMaterialBlock {
  142801. /**
  142802. * Creates a new LerpBlock
  142803. * @param name defines the block name
  142804. */
  142805. constructor(name: string);
  142806. /**
  142807. * Gets the current class name
  142808. * @returns the class name
  142809. */
  142810. getClassName(): string;
  142811. /**
  142812. * Gets the left operand input component
  142813. */
  142814. get left(): NodeMaterialConnectionPoint;
  142815. /**
  142816. * Gets the right operand input component
  142817. */
  142818. get right(): NodeMaterialConnectionPoint;
  142819. /**
  142820. * Gets the gradient operand input component
  142821. */
  142822. get gradient(): NodeMaterialConnectionPoint;
  142823. /**
  142824. * Gets the output component
  142825. */
  142826. get output(): NodeMaterialConnectionPoint;
  142827. protected _buildBlock(state: NodeMaterialBuildState): this;
  142828. }
  142829. }
  142830. declare module BABYLON {
  142831. /**
  142832. * Block used to divide 2 vectors
  142833. */
  142834. export class DivideBlock extends NodeMaterialBlock {
  142835. /**
  142836. * Creates a new DivideBlock
  142837. * @param name defines the block name
  142838. */
  142839. constructor(name: string);
  142840. /**
  142841. * Gets the current class name
  142842. * @returns the class name
  142843. */
  142844. getClassName(): string;
  142845. /**
  142846. * Gets the left operand input component
  142847. */
  142848. get left(): NodeMaterialConnectionPoint;
  142849. /**
  142850. * Gets the right operand input component
  142851. */
  142852. get right(): NodeMaterialConnectionPoint;
  142853. /**
  142854. * Gets the output component
  142855. */
  142856. get output(): NodeMaterialConnectionPoint;
  142857. protected _buildBlock(state: NodeMaterialBuildState): this;
  142858. }
  142859. }
  142860. declare module BABYLON {
  142861. /**
  142862. * Block used to subtract 2 vectors
  142863. */
  142864. export class SubtractBlock extends NodeMaterialBlock {
  142865. /**
  142866. * Creates a new SubtractBlock
  142867. * @param name defines the block name
  142868. */
  142869. constructor(name: string);
  142870. /**
  142871. * Gets the current class name
  142872. * @returns the class name
  142873. */
  142874. getClassName(): string;
  142875. /**
  142876. * Gets the left operand input component
  142877. */
  142878. get left(): NodeMaterialConnectionPoint;
  142879. /**
  142880. * Gets the right operand input component
  142881. */
  142882. get right(): NodeMaterialConnectionPoint;
  142883. /**
  142884. * Gets the output component
  142885. */
  142886. get output(): NodeMaterialConnectionPoint;
  142887. protected _buildBlock(state: NodeMaterialBuildState): this;
  142888. }
  142889. }
  142890. declare module BABYLON {
  142891. /**
  142892. * Block used to step a value
  142893. */
  142894. export class StepBlock extends NodeMaterialBlock {
  142895. /**
  142896. * Creates a new StepBlock
  142897. * @param name defines the block name
  142898. */
  142899. constructor(name: string);
  142900. /**
  142901. * Gets the current class name
  142902. * @returns the class name
  142903. */
  142904. getClassName(): string;
  142905. /**
  142906. * Gets the value operand input component
  142907. */
  142908. get value(): NodeMaterialConnectionPoint;
  142909. /**
  142910. * Gets the edge operand input component
  142911. */
  142912. get edge(): NodeMaterialConnectionPoint;
  142913. /**
  142914. * Gets the output component
  142915. */
  142916. get output(): NodeMaterialConnectionPoint;
  142917. protected _buildBlock(state: NodeMaterialBuildState): this;
  142918. }
  142919. }
  142920. declare module BABYLON {
  142921. /**
  142922. * Block used to get the opposite (1 - x) of a value
  142923. */
  142924. export class OneMinusBlock extends NodeMaterialBlock {
  142925. /**
  142926. * Creates a new OneMinusBlock
  142927. * @param name defines the block name
  142928. */
  142929. constructor(name: string);
  142930. /**
  142931. * Gets the current class name
  142932. * @returns the class name
  142933. */
  142934. getClassName(): string;
  142935. /**
  142936. * Gets the input component
  142937. */
  142938. get input(): NodeMaterialConnectionPoint;
  142939. /**
  142940. * Gets the output component
  142941. */
  142942. get output(): NodeMaterialConnectionPoint;
  142943. protected _buildBlock(state: NodeMaterialBuildState): this;
  142944. }
  142945. }
  142946. declare module BABYLON {
  142947. /**
  142948. * Block used to get the view direction
  142949. */
  142950. export class ViewDirectionBlock extends NodeMaterialBlock {
  142951. /**
  142952. * Creates a new ViewDirectionBlock
  142953. * @param name defines the block name
  142954. */
  142955. constructor(name: string);
  142956. /**
  142957. * Gets the current class name
  142958. * @returns the class name
  142959. */
  142960. getClassName(): string;
  142961. /**
  142962. * Gets the world position component
  142963. */
  142964. get worldPosition(): NodeMaterialConnectionPoint;
  142965. /**
  142966. * Gets the camera position component
  142967. */
  142968. get cameraPosition(): NodeMaterialConnectionPoint;
  142969. /**
  142970. * Gets the output component
  142971. */
  142972. get output(): NodeMaterialConnectionPoint;
  142973. autoConfigure(material: NodeMaterial): void;
  142974. protected _buildBlock(state: NodeMaterialBuildState): this;
  142975. }
  142976. }
  142977. declare module BABYLON {
  142978. /**
  142979. * Block used to compute fresnel value
  142980. */
  142981. export class FresnelBlock extends NodeMaterialBlock {
  142982. /**
  142983. * Create a new FresnelBlock
  142984. * @param name defines the block name
  142985. */
  142986. constructor(name: string);
  142987. /**
  142988. * Gets the current class name
  142989. * @returns the class name
  142990. */
  142991. getClassName(): string;
  142992. /**
  142993. * Gets the world normal input component
  142994. */
  142995. get worldNormal(): NodeMaterialConnectionPoint;
  142996. /**
  142997. * Gets the view direction input component
  142998. */
  142999. get viewDirection(): NodeMaterialConnectionPoint;
  143000. /**
  143001. * Gets the bias input component
  143002. */
  143003. get bias(): NodeMaterialConnectionPoint;
  143004. /**
  143005. * Gets the camera (or eye) position component
  143006. */
  143007. get power(): NodeMaterialConnectionPoint;
  143008. /**
  143009. * Gets the fresnel output component
  143010. */
  143011. get fresnel(): NodeMaterialConnectionPoint;
  143012. autoConfigure(material: NodeMaterial): void;
  143013. protected _buildBlock(state: NodeMaterialBuildState): this;
  143014. }
  143015. }
  143016. declare module BABYLON {
  143017. /**
  143018. * Block used to get the max of 2 values
  143019. */
  143020. export class MaxBlock extends NodeMaterialBlock {
  143021. /**
  143022. * Creates a new MaxBlock
  143023. * @param name defines the block name
  143024. */
  143025. constructor(name: string);
  143026. /**
  143027. * Gets the current class name
  143028. * @returns the class name
  143029. */
  143030. getClassName(): string;
  143031. /**
  143032. * Gets the left operand input component
  143033. */
  143034. get left(): NodeMaterialConnectionPoint;
  143035. /**
  143036. * Gets the right operand input component
  143037. */
  143038. get right(): NodeMaterialConnectionPoint;
  143039. /**
  143040. * Gets the output component
  143041. */
  143042. get output(): NodeMaterialConnectionPoint;
  143043. protected _buildBlock(state: NodeMaterialBuildState): this;
  143044. }
  143045. }
  143046. declare module BABYLON {
  143047. /**
  143048. * Block used to get the min of 2 values
  143049. */
  143050. export class MinBlock extends NodeMaterialBlock {
  143051. /**
  143052. * Creates a new MinBlock
  143053. * @param name defines the block name
  143054. */
  143055. constructor(name: string);
  143056. /**
  143057. * Gets the current class name
  143058. * @returns the class name
  143059. */
  143060. getClassName(): string;
  143061. /**
  143062. * Gets the left operand input component
  143063. */
  143064. get left(): NodeMaterialConnectionPoint;
  143065. /**
  143066. * Gets the right operand input component
  143067. */
  143068. get right(): NodeMaterialConnectionPoint;
  143069. /**
  143070. * Gets the output component
  143071. */
  143072. get output(): NodeMaterialConnectionPoint;
  143073. protected _buildBlock(state: NodeMaterialBuildState): this;
  143074. }
  143075. }
  143076. declare module BABYLON {
  143077. /**
  143078. * Block used to get the distance between 2 values
  143079. */
  143080. export class DistanceBlock extends NodeMaterialBlock {
  143081. /**
  143082. * Creates a new DistanceBlock
  143083. * @param name defines the block name
  143084. */
  143085. constructor(name: string);
  143086. /**
  143087. * Gets the current class name
  143088. * @returns the class name
  143089. */
  143090. getClassName(): string;
  143091. /**
  143092. * Gets the left operand input component
  143093. */
  143094. get left(): NodeMaterialConnectionPoint;
  143095. /**
  143096. * Gets the right operand input component
  143097. */
  143098. get right(): NodeMaterialConnectionPoint;
  143099. /**
  143100. * Gets the output component
  143101. */
  143102. get output(): NodeMaterialConnectionPoint;
  143103. protected _buildBlock(state: NodeMaterialBuildState): this;
  143104. }
  143105. }
  143106. declare module BABYLON {
  143107. /**
  143108. * Block used to get the length of a vector
  143109. */
  143110. export class LengthBlock extends NodeMaterialBlock {
  143111. /**
  143112. * Creates a new LengthBlock
  143113. * @param name defines the block name
  143114. */
  143115. constructor(name: string);
  143116. /**
  143117. * Gets the current class name
  143118. * @returns the class name
  143119. */
  143120. getClassName(): string;
  143121. /**
  143122. * Gets the value input component
  143123. */
  143124. get value(): NodeMaterialConnectionPoint;
  143125. /**
  143126. * Gets the output component
  143127. */
  143128. get output(): NodeMaterialConnectionPoint;
  143129. protected _buildBlock(state: NodeMaterialBuildState): this;
  143130. }
  143131. }
  143132. declare module BABYLON {
  143133. /**
  143134. * Block used to get negative version of a value (i.e. x * -1)
  143135. */
  143136. export class NegateBlock extends NodeMaterialBlock {
  143137. /**
  143138. * Creates a new NegateBlock
  143139. * @param name defines the block name
  143140. */
  143141. constructor(name: string);
  143142. /**
  143143. * Gets the current class name
  143144. * @returns the class name
  143145. */
  143146. getClassName(): string;
  143147. /**
  143148. * Gets the value input component
  143149. */
  143150. get value(): NodeMaterialConnectionPoint;
  143151. /**
  143152. * Gets the output component
  143153. */
  143154. get output(): NodeMaterialConnectionPoint;
  143155. protected _buildBlock(state: NodeMaterialBuildState): this;
  143156. }
  143157. }
  143158. declare module BABYLON {
  143159. /**
  143160. * Block used to get the value of the first parameter raised to the power of the second
  143161. */
  143162. export class PowBlock extends NodeMaterialBlock {
  143163. /**
  143164. * Creates a new PowBlock
  143165. * @param name defines the block name
  143166. */
  143167. constructor(name: string);
  143168. /**
  143169. * Gets the current class name
  143170. * @returns the class name
  143171. */
  143172. getClassName(): string;
  143173. /**
  143174. * Gets the value operand input component
  143175. */
  143176. get value(): NodeMaterialConnectionPoint;
  143177. /**
  143178. * Gets the power operand input component
  143179. */
  143180. get power(): NodeMaterialConnectionPoint;
  143181. /**
  143182. * Gets the output component
  143183. */
  143184. get output(): NodeMaterialConnectionPoint;
  143185. protected _buildBlock(state: NodeMaterialBuildState): this;
  143186. }
  143187. }
  143188. declare module BABYLON {
  143189. /**
  143190. * Block used to get a random number
  143191. */
  143192. export class RandomNumberBlock extends NodeMaterialBlock {
  143193. /**
  143194. * Creates a new RandomNumberBlock
  143195. * @param name defines the block name
  143196. */
  143197. constructor(name: string);
  143198. /**
  143199. * Gets the current class name
  143200. * @returns the class name
  143201. */
  143202. getClassName(): string;
  143203. /**
  143204. * Gets the seed input component
  143205. */
  143206. get seed(): NodeMaterialConnectionPoint;
  143207. /**
  143208. * Gets the output component
  143209. */
  143210. get output(): NodeMaterialConnectionPoint;
  143211. protected _buildBlock(state: NodeMaterialBuildState): this;
  143212. }
  143213. }
  143214. declare module BABYLON {
  143215. /**
  143216. * Block used to compute arc tangent of 2 values
  143217. */
  143218. export class ArcTan2Block extends NodeMaterialBlock {
  143219. /**
  143220. * Creates a new ArcTan2Block
  143221. * @param name defines the block name
  143222. */
  143223. constructor(name: string);
  143224. /**
  143225. * Gets the current class name
  143226. * @returns the class name
  143227. */
  143228. getClassName(): string;
  143229. /**
  143230. * Gets the x operand input component
  143231. */
  143232. get x(): NodeMaterialConnectionPoint;
  143233. /**
  143234. * Gets the y operand input component
  143235. */
  143236. get y(): NodeMaterialConnectionPoint;
  143237. /**
  143238. * Gets the output component
  143239. */
  143240. get output(): NodeMaterialConnectionPoint;
  143241. protected _buildBlock(state: NodeMaterialBuildState): this;
  143242. }
  143243. }
  143244. declare module BABYLON {
  143245. /**
  143246. * Block used to smooth step a value
  143247. */
  143248. export class SmoothStepBlock extends NodeMaterialBlock {
  143249. /**
  143250. * Creates a new SmoothStepBlock
  143251. * @param name defines the block name
  143252. */
  143253. constructor(name: string);
  143254. /**
  143255. * Gets the current class name
  143256. * @returns the class name
  143257. */
  143258. getClassName(): string;
  143259. /**
  143260. * Gets the value operand input component
  143261. */
  143262. get value(): NodeMaterialConnectionPoint;
  143263. /**
  143264. * Gets the first edge operand input component
  143265. */
  143266. get edge0(): NodeMaterialConnectionPoint;
  143267. /**
  143268. * Gets the second edge operand input component
  143269. */
  143270. get edge1(): NodeMaterialConnectionPoint;
  143271. /**
  143272. * Gets the output component
  143273. */
  143274. get output(): NodeMaterialConnectionPoint;
  143275. protected _buildBlock(state: NodeMaterialBuildState): this;
  143276. }
  143277. }
  143278. declare module BABYLON {
  143279. /**
  143280. * Block used to get the reciprocal (1 / x) of a value
  143281. */
  143282. export class ReciprocalBlock extends NodeMaterialBlock {
  143283. /**
  143284. * Creates a new ReciprocalBlock
  143285. * @param name defines the block name
  143286. */
  143287. constructor(name: string);
  143288. /**
  143289. * Gets the current class name
  143290. * @returns the class name
  143291. */
  143292. getClassName(): string;
  143293. /**
  143294. * Gets the input component
  143295. */
  143296. get input(): NodeMaterialConnectionPoint;
  143297. /**
  143298. * Gets the output component
  143299. */
  143300. get output(): NodeMaterialConnectionPoint;
  143301. protected _buildBlock(state: NodeMaterialBuildState): this;
  143302. }
  143303. }
  143304. declare module BABYLON {
  143305. /**
  143306. * Block used to replace a color by another one
  143307. */
  143308. export class ReplaceColorBlock extends NodeMaterialBlock {
  143309. /**
  143310. * Creates a new ReplaceColorBlock
  143311. * @param name defines the block name
  143312. */
  143313. constructor(name: string);
  143314. /**
  143315. * Gets the current class name
  143316. * @returns the class name
  143317. */
  143318. getClassName(): string;
  143319. /**
  143320. * Gets the value input component
  143321. */
  143322. get value(): NodeMaterialConnectionPoint;
  143323. /**
  143324. * Gets the reference input component
  143325. */
  143326. get reference(): NodeMaterialConnectionPoint;
  143327. /**
  143328. * Gets the distance input component
  143329. */
  143330. get distance(): NodeMaterialConnectionPoint;
  143331. /**
  143332. * Gets the replacement input component
  143333. */
  143334. get replacement(): NodeMaterialConnectionPoint;
  143335. /**
  143336. * Gets the output component
  143337. */
  143338. get output(): NodeMaterialConnectionPoint;
  143339. protected _buildBlock(state: NodeMaterialBuildState): this;
  143340. }
  143341. }
  143342. declare module BABYLON {
  143343. /**
  143344. * Block used to posterize a value
  143345. * @see https://en.wikipedia.org/wiki/Posterization
  143346. */
  143347. export class PosterizeBlock extends NodeMaterialBlock {
  143348. /**
  143349. * Creates a new PosterizeBlock
  143350. * @param name defines the block name
  143351. */
  143352. constructor(name: string);
  143353. /**
  143354. * Gets the current class name
  143355. * @returns the class name
  143356. */
  143357. getClassName(): string;
  143358. /**
  143359. * Gets the value input component
  143360. */
  143361. get value(): NodeMaterialConnectionPoint;
  143362. /**
  143363. * Gets the steps input component
  143364. */
  143365. get steps(): NodeMaterialConnectionPoint;
  143366. /**
  143367. * Gets the output component
  143368. */
  143369. get output(): NodeMaterialConnectionPoint;
  143370. protected _buildBlock(state: NodeMaterialBuildState): this;
  143371. }
  143372. }
  143373. declare module BABYLON {
  143374. /**
  143375. * Operations supported by the Wave block
  143376. */
  143377. export enum WaveBlockKind {
  143378. /** SawTooth */
  143379. SawTooth = 0,
  143380. /** Square */
  143381. Square = 1,
  143382. /** Triangle */
  143383. Triangle = 2
  143384. }
  143385. /**
  143386. * Block used to apply wave operation to floats
  143387. */
  143388. export class WaveBlock extends NodeMaterialBlock {
  143389. /**
  143390. * Gets or sets the kibnd of wave to be applied by the block
  143391. */
  143392. kind: WaveBlockKind;
  143393. /**
  143394. * Creates a new WaveBlock
  143395. * @param name defines the block name
  143396. */
  143397. constructor(name: string);
  143398. /**
  143399. * Gets the current class name
  143400. * @returns the class name
  143401. */
  143402. getClassName(): string;
  143403. /**
  143404. * Gets the input component
  143405. */
  143406. get input(): NodeMaterialConnectionPoint;
  143407. /**
  143408. * Gets the output component
  143409. */
  143410. get output(): NodeMaterialConnectionPoint;
  143411. protected _buildBlock(state: NodeMaterialBuildState): this;
  143412. serialize(): any;
  143413. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143414. }
  143415. }
  143416. declare module BABYLON {
  143417. /**
  143418. * Class used to store a color step for the GradientBlock
  143419. */
  143420. export class GradientBlockColorStep {
  143421. /**
  143422. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143423. */
  143424. step: number;
  143425. /**
  143426. * Gets or sets the color associated with this step
  143427. */
  143428. color: Color3;
  143429. /**
  143430. * Creates a new GradientBlockColorStep
  143431. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  143432. * @param color defines the color associated with this step
  143433. */
  143434. constructor(
  143435. /**
  143436. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143437. */
  143438. step: number,
  143439. /**
  143440. * Gets or sets the color associated with this step
  143441. */
  143442. color: Color3);
  143443. }
  143444. /**
  143445. * Block used to return a color from a gradient based on an input value between 0 and 1
  143446. */
  143447. export class GradientBlock extends NodeMaterialBlock {
  143448. /**
  143449. * Gets or sets the list of color steps
  143450. */
  143451. colorSteps: GradientBlockColorStep[];
  143452. /**
  143453. * Creates a new GradientBlock
  143454. * @param name defines the block name
  143455. */
  143456. constructor(name: string);
  143457. /**
  143458. * Gets the current class name
  143459. * @returns the class name
  143460. */
  143461. getClassName(): string;
  143462. /**
  143463. * Gets the gradient input component
  143464. */
  143465. get gradient(): NodeMaterialConnectionPoint;
  143466. /**
  143467. * Gets the output component
  143468. */
  143469. get output(): NodeMaterialConnectionPoint;
  143470. private _writeColorConstant;
  143471. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143472. serialize(): any;
  143473. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143474. protected _dumpPropertiesCode(): string;
  143475. }
  143476. }
  143477. declare module BABYLON {
  143478. /**
  143479. * Block used to normalize lerp between 2 values
  143480. */
  143481. export class NLerpBlock extends NodeMaterialBlock {
  143482. /**
  143483. * Creates a new NLerpBlock
  143484. * @param name defines the block name
  143485. */
  143486. constructor(name: string);
  143487. /**
  143488. * Gets the current class name
  143489. * @returns the class name
  143490. */
  143491. getClassName(): string;
  143492. /**
  143493. * Gets the left operand input component
  143494. */
  143495. get left(): NodeMaterialConnectionPoint;
  143496. /**
  143497. * Gets the right operand input component
  143498. */
  143499. get right(): NodeMaterialConnectionPoint;
  143500. /**
  143501. * Gets the gradient operand input component
  143502. */
  143503. get gradient(): NodeMaterialConnectionPoint;
  143504. /**
  143505. * Gets the output component
  143506. */
  143507. get output(): NodeMaterialConnectionPoint;
  143508. protected _buildBlock(state: NodeMaterialBuildState): this;
  143509. }
  143510. }
  143511. declare module BABYLON {
  143512. /**
  143513. * block used to Generate a Worley Noise 3D Noise Pattern
  143514. */
  143515. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  143516. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143517. manhattanDistance: boolean;
  143518. /**
  143519. * Creates a new WorleyNoise3DBlock
  143520. * @param name defines the block name
  143521. */
  143522. constructor(name: string);
  143523. /**
  143524. * Gets the current class name
  143525. * @returns the class name
  143526. */
  143527. getClassName(): string;
  143528. /**
  143529. * Gets the seed input component
  143530. */
  143531. get seed(): NodeMaterialConnectionPoint;
  143532. /**
  143533. * Gets the jitter input component
  143534. */
  143535. get jitter(): NodeMaterialConnectionPoint;
  143536. /**
  143537. * Gets the output component
  143538. */
  143539. get output(): NodeMaterialConnectionPoint;
  143540. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143541. /**
  143542. * Exposes the properties to the UI?
  143543. */
  143544. protected _dumpPropertiesCode(): string;
  143545. /**
  143546. * Exposes the properties to the Seralize?
  143547. */
  143548. serialize(): any;
  143549. /**
  143550. * Exposes the properties to the deseralize?
  143551. */
  143552. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143553. }
  143554. }
  143555. declare module BABYLON {
  143556. /**
  143557. * block used to Generate a Simplex Perlin 3d Noise Pattern
  143558. */
  143559. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  143560. /**
  143561. * Creates a new SimplexPerlin3DBlock
  143562. * @param name defines the block name
  143563. */
  143564. constructor(name: string);
  143565. /**
  143566. * Gets the current class name
  143567. * @returns the class name
  143568. */
  143569. getClassName(): string;
  143570. /**
  143571. * Gets the seed operand input component
  143572. */
  143573. get seed(): NodeMaterialConnectionPoint;
  143574. /**
  143575. * Gets the output component
  143576. */
  143577. get output(): NodeMaterialConnectionPoint;
  143578. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143579. }
  143580. }
  143581. declare module BABYLON {
  143582. /**
  143583. * Block used to blend normals
  143584. */
  143585. export class NormalBlendBlock extends NodeMaterialBlock {
  143586. /**
  143587. * Creates a new NormalBlendBlock
  143588. * @param name defines the block name
  143589. */
  143590. constructor(name: string);
  143591. /**
  143592. * Gets the current class name
  143593. * @returns the class name
  143594. */
  143595. getClassName(): string;
  143596. /**
  143597. * Gets the first input component
  143598. */
  143599. get normalMap0(): NodeMaterialConnectionPoint;
  143600. /**
  143601. * Gets the second input component
  143602. */
  143603. get normalMap1(): NodeMaterialConnectionPoint;
  143604. /**
  143605. * Gets the output component
  143606. */
  143607. get output(): NodeMaterialConnectionPoint;
  143608. protected _buildBlock(state: NodeMaterialBuildState): this;
  143609. }
  143610. }
  143611. declare module BABYLON {
  143612. /**
  143613. * Block used to rotate a 2d vector by a given angle
  143614. */
  143615. export class Rotate2dBlock extends NodeMaterialBlock {
  143616. /**
  143617. * Creates a new Rotate2dBlock
  143618. * @param name defines the block name
  143619. */
  143620. constructor(name: string);
  143621. /**
  143622. * Gets the current class name
  143623. * @returns the class name
  143624. */
  143625. getClassName(): string;
  143626. /**
  143627. * Gets the input vector
  143628. */
  143629. get input(): NodeMaterialConnectionPoint;
  143630. /**
  143631. * Gets the input angle
  143632. */
  143633. get angle(): NodeMaterialConnectionPoint;
  143634. /**
  143635. * Gets the output component
  143636. */
  143637. get output(): NodeMaterialConnectionPoint;
  143638. autoConfigure(material: NodeMaterial): void;
  143639. protected _buildBlock(state: NodeMaterialBuildState): this;
  143640. }
  143641. }
  143642. declare module BABYLON {
  143643. /**
  143644. * Block used to get the reflected vector from a direction and a normal
  143645. */
  143646. export class ReflectBlock extends NodeMaterialBlock {
  143647. /**
  143648. * Creates a new ReflectBlock
  143649. * @param name defines the block name
  143650. */
  143651. constructor(name: string);
  143652. /**
  143653. * Gets the current class name
  143654. * @returns the class name
  143655. */
  143656. getClassName(): string;
  143657. /**
  143658. * Gets the incident component
  143659. */
  143660. get incident(): NodeMaterialConnectionPoint;
  143661. /**
  143662. * Gets the normal component
  143663. */
  143664. get normal(): NodeMaterialConnectionPoint;
  143665. /**
  143666. * Gets the output component
  143667. */
  143668. get output(): NodeMaterialConnectionPoint;
  143669. protected _buildBlock(state: NodeMaterialBuildState): this;
  143670. }
  143671. }
  143672. declare module BABYLON {
  143673. /**
  143674. * Block used to get the refracted vector from a direction and a normal
  143675. */
  143676. export class RefractBlock extends NodeMaterialBlock {
  143677. /**
  143678. * Creates a new RefractBlock
  143679. * @param name defines the block name
  143680. */
  143681. constructor(name: string);
  143682. /**
  143683. * Gets the current class name
  143684. * @returns the class name
  143685. */
  143686. getClassName(): string;
  143687. /**
  143688. * Gets the incident component
  143689. */
  143690. get incident(): NodeMaterialConnectionPoint;
  143691. /**
  143692. * Gets the normal component
  143693. */
  143694. get normal(): NodeMaterialConnectionPoint;
  143695. /**
  143696. * Gets the index of refraction component
  143697. */
  143698. get ior(): NodeMaterialConnectionPoint;
  143699. /**
  143700. * Gets the output component
  143701. */
  143702. get output(): NodeMaterialConnectionPoint;
  143703. protected _buildBlock(state: NodeMaterialBuildState): this;
  143704. }
  143705. }
  143706. declare module BABYLON {
  143707. /**
  143708. * Block used to desaturate a color
  143709. */
  143710. export class DesaturateBlock extends NodeMaterialBlock {
  143711. /**
  143712. * Creates a new DesaturateBlock
  143713. * @param name defines the block name
  143714. */
  143715. constructor(name: string);
  143716. /**
  143717. * Gets the current class name
  143718. * @returns the class name
  143719. */
  143720. getClassName(): string;
  143721. /**
  143722. * Gets the color operand input component
  143723. */
  143724. get color(): NodeMaterialConnectionPoint;
  143725. /**
  143726. * Gets the level operand input component
  143727. */
  143728. get level(): NodeMaterialConnectionPoint;
  143729. /**
  143730. * Gets the output component
  143731. */
  143732. get output(): NodeMaterialConnectionPoint;
  143733. protected _buildBlock(state: NodeMaterialBuildState): this;
  143734. }
  143735. }
  143736. declare module BABYLON {
  143737. /**
  143738. * Block used to implement the ambient occlusion module of the PBR material
  143739. */
  143740. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  143741. /**
  143742. * Create a new AmbientOcclusionBlock
  143743. * @param name defines the block name
  143744. */
  143745. constructor(name: string);
  143746. /**
  143747. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  143748. */
  143749. useAmbientInGrayScale: boolean;
  143750. /**
  143751. * Initialize the block and prepare the context for build
  143752. * @param state defines the state that will be used for the build
  143753. */
  143754. initialize(state: NodeMaterialBuildState): void;
  143755. /**
  143756. * Gets the current class name
  143757. * @returns the class name
  143758. */
  143759. getClassName(): string;
  143760. /**
  143761. * Gets the texture input component
  143762. */
  143763. get texture(): NodeMaterialConnectionPoint;
  143764. /**
  143765. * Gets the texture intensity component
  143766. */
  143767. get intensity(): NodeMaterialConnectionPoint;
  143768. /**
  143769. * Gets the direct light intensity input component
  143770. */
  143771. get directLightIntensity(): NodeMaterialConnectionPoint;
  143772. /**
  143773. * Gets the ambient occlusion object output component
  143774. */
  143775. get ambientOcclusion(): NodeMaterialConnectionPoint;
  143776. /**
  143777. * Gets the main code of the block (fragment side)
  143778. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  143779. * @returns the shader code
  143780. */
  143781. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  143782. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143783. protected _buildBlock(state: NodeMaterialBuildState): this;
  143784. protected _dumpPropertiesCode(): string;
  143785. serialize(): any;
  143786. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143787. }
  143788. }
  143789. declare module BABYLON {
  143790. /**
  143791. * Block used to implement the reflection module of the PBR material
  143792. */
  143793. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  143794. /** @hidden */
  143795. _defineLODReflectionAlpha: string;
  143796. /** @hidden */
  143797. _defineLinearSpecularReflection: string;
  143798. private _vEnvironmentIrradianceName;
  143799. /** @hidden */
  143800. _vReflectionMicrosurfaceInfosName: string;
  143801. /** @hidden */
  143802. _vReflectionInfosName: string;
  143803. /** @hidden */
  143804. _vReflectionFilteringInfoName: string;
  143805. private _scene;
  143806. /**
  143807. * The three properties below are set by the main PBR block prior to calling methods of this class.
  143808. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  143809. * It's less burden on the user side in the editor part.
  143810. */
  143811. /** @hidden */
  143812. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  143813. /** @hidden */
  143814. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  143815. /** @hidden */
  143816. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  143817. /**
  143818. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  143819. * diffuse part of the IBL.
  143820. */
  143821. useSphericalHarmonics: boolean;
  143822. /**
  143823. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  143824. */
  143825. forceIrradianceInFragment: boolean;
  143826. /**
  143827. * Create a new ReflectionBlock
  143828. * @param name defines the block name
  143829. */
  143830. constructor(name: string);
  143831. /**
  143832. * Gets the current class name
  143833. * @returns the class name
  143834. */
  143835. getClassName(): string;
  143836. /**
  143837. * Gets the position input component
  143838. */
  143839. get position(): NodeMaterialConnectionPoint;
  143840. /**
  143841. * Gets the world position input component
  143842. */
  143843. get worldPosition(): NodeMaterialConnectionPoint;
  143844. /**
  143845. * Gets the world normal input component
  143846. */
  143847. get worldNormal(): NodeMaterialConnectionPoint;
  143848. /**
  143849. * Gets the world input component
  143850. */
  143851. get world(): NodeMaterialConnectionPoint;
  143852. /**
  143853. * Gets the camera (or eye) position component
  143854. */
  143855. get cameraPosition(): NodeMaterialConnectionPoint;
  143856. /**
  143857. * Gets the view input component
  143858. */
  143859. get view(): NodeMaterialConnectionPoint;
  143860. /**
  143861. * Gets the color input component
  143862. */
  143863. get color(): NodeMaterialConnectionPoint;
  143864. /**
  143865. * Gets the reflection object output component
  143866. */
  143867. get reflection(): NodeMaterialConnectionPoint;
  143868. /**
  143869. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  143870. */
  143871. get hasTexture(): boolean;
  143872. /**
  143873. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  143874. */
  143875. get reflectionColor(): string;
  143876. protected _getTexture(): Nullable<BaseTexture>;
  143877. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143878. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143879. /**
  143880. * Gets the code to inject in the vertex shader
  143881. * @param state current state of the node material building
  143882. * @returns the shader code
  143883. */
  143884. handleVertexSide(state: NodeMaterialBuildState): string;
  143885. /**
  143886. * Gets the main code of the block (fragment side)
  143887. * @param state current state of the node material building
  143888. * @param normalVarName name of the existing variable corresponding to the normal
  143889. * @returns the shader code
  143890. */
  143891. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  143892. protected _buildBlock(state: NodeMaterialBuildState): this;
  143893. protected _dumpPropertiesCode(): string;
  143894. serialize(): any;
  143895. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143896. }
  143897. }
  143898. declare module BABYLON {
  143899. /**
  143900. * Block used to implement the sheen module of the PBR material
  143901. */
  143902. export class SheenBlock extends NodeMaterialBlock {
  143903. /**
  143904. * Create a new SheenBlock
  143905. * @param name defines the block name
  143906. */
  143907. constructor(name: string);
  143908. /**
  143909. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  143910. * It allows the strength of the sheen effect to not depend on the base color of the material,
  143911. * making it easier to setup and tweak the effect
  143912. */
  143913. albedoScaling: boolean;
  143914. /**
  143915. * Defines if the sheen is linked to the sheen color.
  143916. */
  143917. linkSheenWithAlbedo: boolean;
  143918. /**
  143919. * Initialize the block and prepare the context for build
  143920. * @param state defines the state that will be used for the build
  143921. */
  143922. initialize(state: NodeMaterialBuildState): void;
  143923. /**
  143924. * Gets the current class name
  143925. * @returns the class name
  143926. */
  143927. getClassName(): string;
  143928. /**
  143929. * Gets the intensity input component
  143930. */
  143931. get intensity(): NodeMaterialConnectionPoint;
  143932. /**
  143933. * Gets the color input component
  143934. */
  143935. get color(): NodeMaterialConnectionPoint;
  143936. /**
  143937. * Gets the roughness input component
  143938. */
  143939. get roughness(): NodeMaterialConnectionPoint;
  143940. /**
  143941. * Gets the sheen object output component
  143942. */
  143943. get sheen(): NodeMaterialConnectionPoint;
  143944. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143945. /**
  143946. * Gets the main code of the block (fragment side)
  143947. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143948. * @returns the shader code
  143949. */
  143950. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  143951. protected _buildBlock(state: NodeMaterialBuildState): this;
  143952. protected _dumpPropertiesCode(): string;
  143953. serialize(): any;
  143954. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143955. }
  143956. }
  143957. declare module BABYLON {
  143958. /**
  143959. * Block used to implement the reflectivity module of the PBR material
  143960. */
  143961. export class ReflectivityBlock extends NodeMaterialBlock {
  143962. private _metallicReflectanceColor;
  143963. private _metallicF0Factor;
  143964. /** @hidden */
  143965. _vMetallicReflectanceFactorsName: string;
  143966. /**
  143967. * The property below is set by the main PBR block prior to calling methods of this class.
  143968. */
  143969. /** @hidden */
  143970. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  143971. /**
  143972. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  143973. */
  143974. useAmbientOcclusionFromMetallicTextureRed: boolean;
  143975. /**
  143976. * Specifies if the metallic texture contains the metallness information in its blue channel.
  143977. */
  143978. useMetallnessFromMetallicTextureBlue: boolean;
  143979. /**
  143980. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  143981. */
  143982. useRoughnessFromMetallicTextureAlpha: boolean;
  143983. /**
  143984. * Specifies if the metallic texture contains the roughness information in its green channel.
  143985. */
  143986. useRoughnessFromMetallicTextureGreen: boolean;
  143987. /**
  143988. * Create a new ReflectivityBlock
  143989. * @param name defines the block name
  143990. */
  143991. constructor(name: string);
  143992. /**
  143993. * Initialize the block and prepare the context for build
  143994. * @param state defines the state that will be used for the build
  143995. */
  143996. initialize(state: NodeMaterialBuildState): void;
  143997. /**
  143998. * Gets the current class name
  143999. * @returns the class name
  144000. */
  144001. getClassName(): string;
  144002. /**
  144003. * Gets the metallic input component
  144004. */
  144005. get metallic(): NodeMaterialConnectionPoint;
  144006. /**
  144007. * Gets the roughness input component
  144008. */
  144009. get roughness(): NodeMaterialConnectionPoint;
  144010. /**
  144011. * Gets the texture input component
  144012. */
  144013. get texture(): NodeMaterialConnectionPoint;
  144014. /**
  144015. * Gets the reflectivity object output component
  144016. */
  144017. get reflectivity(): NodeMaterialConnectionPoint;
  144018. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144019. /**
  144020. * Gets the main code of the block (fragment side)
  144021. * @param state current state of the node material building
  144022. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  144023. * @returns the shader code
  144024. */
  144025. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  144026. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144027. protected _buildBlock(state: NodeMaterialBuildState): this;
  144028. protected _dumpPropertiesCode(): string;
  144029. serialize(): any;
  144030. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144031. }
  144032. }
  144033. declare module BABYLON {
  144034. /**
  144035. * Block used to implement the anisotropy module of the PBR material
  144036. */
  144037. export class AnisotropyBlock extends NodeMaterialBlock {
  144038. /**
  144039. * The two properties below are set by the main PBR block prior to calling methods of this class.
  144040. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144041. * It's less burden on the user side in the editor part.
  144042. */
  144043. /** @hidden */
  144044. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144045. /** @hidden */
  144046. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144047. /**
  144048. * Create a new AnisotropyBlock
  144049. * @param name defines the block name
  144050. */
  144051. constructor(name: string);
  144052. /**
  144053. * Initialize the block and prepare the context for build
  144054. * @param state defines the state that will be used for the build
  144055. */
  144056. initialize(state: NodeMaterialBuildState): void;
  144057. /**
  144058. * Gets the current class name
  144059. * @returns the class name
  144060. */
  144061. getClassName(): string;
  144062. /**
  144063. * Gets the intensity input component
  144064. */
  144065. get intensity(): NodeMaterialConnectionPoint;
  144066. /**
  144067. * Gets the direction input component
  144068. */
  144069. get direction(): NodeMaterialConnectionPoint;
  144070. /**
  144071. * Gets the texture input component
  144072. */
  144073. get texture(): NodeMaterialConnectionPoint;
  144074. /**
  144075. * Gets the uv input component
  144076. */
  144077. get uv(): NodeMaterialConnectionPoint;
  144078. /**
  144079. * Gets the worldTangent input component
  144080. */
  144081. get worldTangent(): NodeMaterialConnectionPoint;
  144082. /**
  144083. * Gets the anisotropy object output component
  144084. */
  144085. get anisotropy(): NodeMaterialConnectionPoint;
  144086. private _generateTBNSpace;
  144087. /**
  144088. * Gets the main code of the block (fragment side)
  144089. * @param state current state of the node material building
  144090. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144091. * @returns the shader code
  144092. */
  144093. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  144094. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144095. protected _buildBlock(state: NodeMaterialBuildState): this;
  144096. }
  144097. }
  144098. declare module BABYLON {
  144099. /**
  144100. * Block used to implement the clear coat module of the PBR material
  144101. */
  144102. export class ClearCoatBlock extends NodeMaterialBlock {
  144103. private _scene;
  144104. /**
  144105. * Create a new ClearCoatBlock
  144106. * @param name defines the block name
  144107. */
  144108. constructor(name: string);
  144109. /**
  144110. * Initialize the block and prepare the context for build
  144111. * @param state defines the state that will be used for the build
  144112. */
  144113. initialize(state: NodeMaterialBuildState): void;
  144114. /**
  144115. * Gets the current class name
  144116. * @returns the class name
  144117. */
  144118. getClassName(): string;
  144119. /**
  144120. * Gets the intensity input component
  144121. */
  144122. get intensity(): NodeMaterialConnectionPoint;
  144123. /**
  144124. * Gets the roughness input component
  144125. */
  144126. get roughness(): NodeMaterialConnectionPoint;
  144127. /**
  144128. * Gets the ior input component
  144129. */
  144130. get ior(): NodeMaterialConnectionPoint;
  144131. /**
  144132. * Gets the texture input component
  144133. */
  144134. get texture(): NodeMaterialConnectionPoint;
  144135. /**
  144136. * Gets the bump texture input component
  144137. */
  144138. get bumpTexture(): NodeMaterialConnectionPoint;
  144139. /**
  144140. * Gets the uv input component
  144141. */
  144142. get uv(): NodeMaterialConnectionPoint;
  144143. /**
  144144. * Gets the tint color input component
  144145. */
  144146. get tintColor(): NodeMaterialConnectionPoint;
  144147. /**
  144148. * Gets the tint "at distance" input component
  144149. */
  144150. get tintAtDistance(): NodeMaterialConnectionPoint;
  144151. /**
  144152. * Gets the tint thickness input component
  144153. */
  144154. get tintThickness(): NodeMaterialConnectionPoint;
  144155. /**
  144156. * Gets the world tangent input component
  144157. */
  144158. get worldTangent(): NodeMaterialConnectionPoint;
  144159. /**
  144160. * Gets the clear coat object output component
  144161. */
  144162. get clearcoat(): NodeMaterialConnectionPoint;
  144163. autoConfigure(material: NodeMaterial): void;
  144164. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144165. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144166. private _generateTBNSpace;
  144167. /**
  144168. * Gets the main code of the block (fragment side)
  144169. * @param state current state of the node material building
  144170. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  144171. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144172. * @param worldPosVarName name of the variable holding the world position
  144173. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144174. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  144175. * @param worldNormalVarName name of the variable holding the world normal
  144176. * @returns the shader code
  144177. */
  144178. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  144179. protected _buildBlock(state: NodeMaterialBuildState): this;
  144180. }
  144181. }
  144182. declare module BABYLON {
  144183. /**
  144184. * Block used to implement the sub surface module of the PBR material
  144185. */
  144186. export class SubSurfaceBlock extends NodeMaterialBlock {
  144187. /**
  144188. * Create a new SubSurfaceBlock
  144189. * @param name defines the block name
  144190. */
  144191. constructor(name: string);
  144192. /**
  144193. * Stores the intensity of the different subsurface effects in the thickness texture.
  144194. * * the green channel is the translucency intensity.
  144195. * * the blue channel is the scattering intensity.
  144196. * * the alpha channel is the refraction intensity.
  144197. */
  144198. useMaskFromThicknessTexture: boolean;
  144199. /**
  144200. * Initialize the block and prepare the context for build
  144201. * @param state defines the state that will be used for the build
  144202. */
  144203. initialize(state: NodeMaterialBuildState): void;
  144204. /**
  144205. * Gets the current class name
  144206. * @returns the class name
  144207. */
  144208. getClassName(): string;
  144209. /**
  144210. * Gets the min thickness input component
  144211. */
  144212. get minThickness(): NodeMaterialConnectionPoint;
  144213. /**
  144214. * Gets the max thickness input component
  144215. */
  144216. get maxThickness(): NodeMaterialConnectionPoint;
  144217. /**
  144218. * Gets the thickness texture component
  144219. */
  144220. get thicknessTexture(): NodeMaterialConnectionPoint;
  144221. /**
  144222. * Gets the tint color input component
  144223. */
  144224. get tintColor(): NodeMaterialConnectionPoint;
  144225. /**
  144226. * Gets the translucency intensity input component
  144227. */
  144228. get translucencyIntensity(): NodeMaterialConnectionPoint;
  144229. /**
  144230. * Gets the translucency diffusion distance input component
  144231. */
  144232. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  144233. /**
  144234. * Gets the refraction object parameters
  144235. */
  144236. get refraction(): NodeMaterialConnectionPoint;
  144237. /**
  144238. * Gets the sub surface object output component
  144239. */
  144240. get subsurface(): NodeMaterialConnectionPoint;
  144241. autoConfigure(material: NodeMaterial): void;
  144242. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144243. /**
  144244. * Gets the main code of the block (fragment side)
  144245. * @param state current state of the node material building
  144246. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  144247. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144248. * @param worldPosVarName name of the variable holding the world position
  144249. * @returns the shader code
  144250. */
  144251. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  144252. protected _buildBlock(state: NodeMaterialBuildState): this;
  144253. }
  144254. }
  144255. declare module BABYLON {
  144256. /**
  144257. * Block used to implement the PBR metallic/roughness model
  144258. */
  144259. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  144260. /**
  144261. * Gets or sets the light associated with this block
  144262. */
  144263. light: Nullable<Light>;
  144264. private _lightId;
  144265. private _scene;
  144266. private _environmentBRDFTexture;
  144267. private _environmentBrdfSamplerName;
  144268. private _vNormalWName;
  144269. private _invertNormalName;
  144270. /**
  144271. * Create a new ReflectionBlock
  144272. * @param name defines the block name
  144273. */
  144274. constructor(name: string);
  144275. /**
  144276. * Intensity of the direct lights e.g. the four lights available in your scene.
  144277. * This impacts both the direct diffuse and specular highlights.
  144278. */
  144279. directIntensity: number;
  144280. /**
  144281. * Intensity of the environment e.g. how much the environment will light the object
  144282. * either through harmonics for rough material or through the refelction for shiny ones.
  144283. */
  144284. environmentIntensity: number;
  144285. /**
  144286. * This is a special control allowing the reduction of the specular highlights coming from the
  144287. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  144288. */
  144289. specularIntensity: number;
  144290. /**
  144291. * Defines the falloff type used in this material.
  144292. * It by default is Physical.
  144293. */
  144294. lightFalloff: number;
  144295. /**
  144296. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  144297. */
  144298. useAlphaFromAlbedoTexture: boolean;
  144299. /**
  144300. * Specifies that alpha test should be used
  144301. */
  144302. useAlphaTest: boolean;
  144303. /**
  144304. * Defines the alpha limits in alpha test mode.
  144305. */
  144306. alphaTestCutoff: number;
  144307. /**
  144308. * Specifies that alpha blending should be used
  144309. */
  144310. useAlphaBlending: boolean;
  144311. /**
  144312. * Defines if the alpha value should be determined via the rgb values.
  144313. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  144314. */
  144315. opacityRGB: boolean;
  144316. /**
  144317. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  144318. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  144319. */
  144320. useRadianceOverAlpha: boolean;
  144321. /**
  144322. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  144323. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  144324. */
  144325. useSpecularOverAlpha: boolean;
  144326. /**
  144327. * Enables specular anti aliasing in the PBR shader.
  144328. * It will both interacts on the Geometry for analytical and IBL lighting.
  144329. * It also prefilter the roughness map based on the bump values.
  144330. */
  144331. enableSpecularAntiAliasing: boolean;
  144332. /**
  144333. * Enables realtime filtering on the texture.
  144334. */
  144335. realTimeFiltering: boolean;
  144336. /**
  144337. * Quality switch for realtime filtering
  144338. */
  144339. realTimeFilteringQuality: number;
  144340. /**
  144341. * Defines if the material uses energy conservation.
  144342. */
  144343. useEnergyConservation: boolean;
  144344. /**
  144345. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  144346. * too much the area relying on ambient texture to define their ambient occlusion.
  144347. */
  144348. useRadianceOcclusion: boolean;
  144349. /**
  144350. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  144351. * makes the reflect vector face the model (under horizon).
  144352. */
  144353. useHorizonOcclusion: boolean;
  144354. /**
  144355. * If set to true, no lighting calculations will be applied.
  144356. */
  144357. unlit: boolean;
  144358. /**
  144359. * Force normal to face away from face.
  144360. */
  144361. forceNormalForward: boolean;
  144362. /**
  144363. * Defines the material debug mode.
  144364. * It helps seeing only some components of the material while troubleshooting.
  144365. */
  144366. debugMode: number;
  144367. /**
  144368. * Specify from where on screen the debug mode should start.
  144369. * The value goes from -1 (full screen) to 1 (not visible)
  144370. * It helps with side by side comparison against the final render
  144371. * This defaults to 0
  144372. */
  144373. debugLimit: number;
  144374. /**
  144375. * As the default viewing range might not be enough (if the ambient is really small for instance)
  144376. * You can use the factor to better multiply the final value.
  144377. */
  144378. debugFactor: number;
  144379. /**
  144380. * Initialize the block and prepare the context for build
  144381. * @param state defines the state that will be used for the build
  144382. */
  144383. initialize(state: NodeMaterialBuildState): void;
  144384. /**
  144385. * Gets the current class name
  144386. * @returns the class name
  144387. */
  144388. getClassName(): string;
  144389. /**
  144390. * Gets the world position input component
  144391. */
  144392. get worldPosition(): NodeMaterialConnectionPoint;
  144393. /**
  144394. * Gets the world normal input component
  144395. */
  144396. get worldNormal(): NodeMaterialConnectionPoint;
  144397. /**
  144398. * Gets the perturbed normal input component
  144399. */
  144400. get perturbedNormal(): NodeMaterialConnectionPoint;
  144401. /**
  144402. * Gets the camera position input component
  144403. */
  144404. get cameraPosition(): NodeMaterialConnectionPoint;
  144405. /**
  144406. * Gets the base color input component
  144407. */
  144408. get baseColor(): NodeMaterialConnectionPoint;
  144409. /**
  144410. * Gets the opacity texture input component
  144411. */
  144412. get opacityTexture(): NodeMaterialConnectionPoint;
  144413. /**
  144414. * Gets the ambient color input component
  144415. */
  144416. get ambientColor(): NodeMaterialConnectionPoint;
  144417. /**
  144418. * Gets the reflectivity object parameters
  144419. */
  144420. get reflectivity(): NodeMaterialConnectionPoint;
  144421. /**
  144422. * Gets the ambient occlusion object parameters
  144423. */
  144424. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144425. /**
  144426. * Gets the reflection object parameters
  144427. */
  144428. get reflection(): NodeMaterialConnectionPoint;
  144429. /**
  144430. * Gets the sheen object parameters
  144431. */
  144432. get sheen(): NodeMaterialConnectionPoint;
  144433. /**
  144434. * Gets the clear coat object parameters
  144435. */
  144436. get clearcoat(): NodeMaterialConnectionPoint;
  144437. /**
  144438. * Gets the sub surface object parameters
  144439. */
  144440. get subsurface(): NodeMaterialConnectionPoint;
  144441. /**
  144442. * Gets the anisotropy object parameters
  144443. */
  144444. get anisotropy(): NodeMaterialConnectionPoint;
  144445. /**
  144446. * Gets the ambient output component
  144447. */
  144448. get ambient(): NodeMaterialConnectionPoint;
  144449. /**
  144450. * Gets the diffuse output component
  144451. */
  144452. get diffuse(): NodeMaterialConnectionPoint;
  144453. /**
  144454. * Gets the specular output component
  144455. */
  144456. get specular(): NodeMaterialConnectionPoint;
  144457. /**
  144458. * Gets the sheen output component
  144459. */
  144460. get sheenDir(): NodeMaterialConnectionPoint;
  144461. /**
  144462. * Gets the clear coat output component
  144463. */
  144464. get clearcoatDir(): NodeMaterialConnectionPoint;
  144465. /**
  144466. * Gets the indirect diffuse output component
  144467. */
  144468. get diffuseIndirect(): NodeMaterialConnectionPoint;
  144469. /**
  144470. * Gets the indirect specular output component
  144471. */
  144472. get specularIndirect(): NodeMaterialConnectionPoint;
  144473. /**
  144474. * Gets the indirect sheen output component
  144475. */
  144476. get sheenIndirect(): NodeMaterialConnectionPoint;
  144477. /**
  144478. * Gets the indirect clear coat output component
  144479. */
  144480. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  144481. /**
  144482. * Gets the refraction output component
  144483. */
  144484. get refraction(): NodeMaterialConnectionPoint;
  144485. /**
  144486. * Gets the global lighting output component
  144487. */
  144488. get lighting(): NodeMaterialConnectionPoint;
  144489. /**
  144490. * Gets the shadow output component
  144491. */
  144492. get shadow(): NodeMaterialConnectionPoint;
  144493. /**
  144494. * Gets the alpha output component
  144495. */
  144496. get alpha(): NodeMaterialConnectionPoint;
  144497. autoConfigure(material: NodeMaterial): void;
  144498. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144499. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144500. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144501. private _injectVertexCode;
  144502. /**
  144503. * Gets the code corresponding to the albedo/opacity module
  144504. * @returns the shader code
  144505. */
  144506. getAlbedoOpacityCode(): string;
  144507. protected _buildBlock(state: NodeMaterialBuildState): this;
  144508. protected _dumpPropertiesCode(): string;
  144509. serialize(): any;
  144510. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144511. }
  144512. }
  144513. declare module BABYLON {
  144514. /**
  144515. * Block used to compute value of one parameter modulo another
  144516. */
  144517. export class ModBlock extends NodeMaterialBlock {
  144518. /**
  144519. * Creates a new ModBlock
  144520. * @param name defines the block name
  144521. */
  144522. constructor(name: string);
  144523. /**
  144524. * Gets the current class name
  144525. * @returns the class name
  144526. */
  144527. getClassName(): string;
  144528. /**
  144529. * Gets the left operand input component
  144530. */
  144531. get left(): NodeMaterialConnectionPoint;
  144532. /**
  144533. * Gets the right operand input component
  144534. */
  144535. get right(): NodeMaterialConnectionPoint;
  144536. /**
  144537. * Gets the output component
  144538. */
  144539. get output(): NodeMaterialConnectionPoint;
  144540. protected _buildBlock(state: NodeMaterialBuildState): this;
  144541. }
  144542. }
  144543. declare module BABYLON {
  144544. /**
  144545. * Helper class to push actions to a pool of workers.
  144546. */
  144547. export class WorkerPool implements IDisposable {
  144548. private _workerInfos;
  144549. private _pendingActions;
  144550. /**
  144551. * Constructor
  144552. * @param workers Array of workers to use for actions
  144553. */
  144554. constructor(workers: Array<Worker>);
  144555. /**
  144556. * Terminates all workers and clears any pending actions.
  144557. */
  144558. dispose(): void;
  144559. /**
  144560. * Pushes an action to the worker pool. If all the workers are active, the action will be
  144561. * pended until a worker has completed its action.
  144562. * @param action The action to perform. Call onComplete when the action is complete.
  144563. */
  144564. push(action: (worker: Worker, onComplete: () => void) => void): void;
  144565. private _execute;
  144566. }
  144567. }
  144568. declare module BABYLON {
  144569. /**
  144570. * Configuration for Draco compression
  144571. */
  144572. export interface IDracoCompressionConfiguration {
  144573. /**
  144574. * Configuration for the decoder.
  144575. */
  144576. decoder: {
  144577. /**
  144578. * The url to the WebAssembly module.
  144579. */
  144580. wasmUrl?: string;
  144581. /**
  144582. * The url to the WebAssembly binary.
  144583. */
  144584. wasmBinaryUrl?: string;
  144585. /**
  144586. * The url to the fallback JavaScript module.
  144587. */
  144588. fallbackUrl?: string;
  144589. };
  144590. }
  144591. /**
  144592. * Draco compression (https://google.github.io/draco/)
  144593. *
  144594. * This class wraps the Draco module.
  144595. *
  144596. * **Encoder**
  144597. *
  144598. * The encoder is not currently implemented.
  144599. *
  144600. * **Decoder**
  144601. *
  144602. * 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.
  144603. *
  144604. * To update the configuration, use the following code:
  144605. * ```javascript
  144606. * DracoCompression.Configuration = {
  144607. * decoder: {
  144608. * wasmUrl: "<url to the WebAssembly library>",
  144609. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  144610. * fallbackUrl: "<url to the fallback JavaScript library>",
  144611. * }
  144612. * };
  144613. * ```
  144614. *
  144615. * 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.
  144616. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  144617. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  144618. *
  144619. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  144620. * ```javascript
  144621. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  144622. * ```
  144623. *
  144624. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  144625. */
  144626. export class DracoCompression implements IDisposable {
  144627. private _workerPoolPromise?;
  144628. private _decoderModulePromise?;
  144629. /**
  144630. * The configuration. Defaults to the following urls:
  144631. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  144632. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  144633. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  144634. */
  144635. static Configuration: IDracoCompressionConfiguration;
  144636. /**
  144637. * Returns true if the decoder configuration is available.
  144638. */
  144639. static get DecoderAvailable(): boolean;
  144640. /**
  144641. * Default number of workers to create when creating the draco compression object.
  144642. */
  144643. static DefaultNumWorkers: number;
  144644. private static GetDefaultNumWorkers;
  144645. private static _Default;
  144646. /**
  144647. * Default instance for the draco compression object.
  144648. */
  144649. static get Default(): DracoCompression;
  144650. /**
  144651. * Constructor
  144652. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  144653. */
  144654. constructor(numWorkers?: number);
  144655. /**
  144656. * Stop all async operations and release resources.
  144657. */
  144658. dispose(): void;
  144659. /**
  144660. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  144661. * @returns a promise that resolves when ready
  144662. */
  144663. whenReadyAsync(): Promise<void>;
  144664. /**
  144665. * Decode Draco compressed mesh data to vertex data.
  144666. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  144667. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  144668. * @returns A promise that resolves with the decoded vertex data
  144669. */
  144670. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  144671. [kind: string]: number;
  144672. }): Promise<VertexData>;
  144673. }
  144674. }
  144675. declare module BABYLON {
  144676. /**
  144677. * Class for building Constructive Solid Geometry
  144678. */
  144679. export class CSG {
  144680. private polygons;
  144681. /**
  144682. * The world matrix
  144683. */
  144684. matrix: Matrix;
  144685. /**
  144686. * Stores the position
  144687. */
  144688. position: Vector3;
  144689. /**
  144690. * Stores the rotation
  144691. */
  144692. rotation: Vector3;
  144693. /**
  144694. * Stores the rotation quaternion
  144695. */
  144696. rotationQuaternion: Nullable<Quaternion>;
  144697. /**
  144698. * Stores the scaling vector
  144699. */
  144700. scaling: Vector3;
  144701. /**
  144702. * Convert the Mesh to CSG
  144703. * @param mesh The Mesh to convert to CSG
  144704. * @returns A new CSG from the Mesh
  144705. */
  144706. static FromMesh(mesh: Mesh): CSG;
  144707. /**
  144708. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  144709. * @param polygons Polygons used to construct a CSG solid
  144710. */
  144711. private static FromPolygons;
  144712. /**
  144713. * Clones, or makes a deep copy, of the CSG
  144714. * @returns A new CSG
  144715. */
  144716. clone(): CSG;
  144717. /**
  144718. * Unions this CSG with another CSG
  144719. * @param csg The CSG to union against this CSG
  144720. * @returns The unioned CSG
  144721. */
  144722. union(csg: CSG): CSG;
  144723. /**
  144724. * Unions this CSG with another CSG in place
  144725. * @param csg The CSG to union against this CSG
  144726. */
  144727. unionInPlace(csg: CSG): void;
  144728. /**
  144729. * Subtracts this CSG with another CSG
  144730. * @param csg The CSG to subtract against this CSG
  144731. * @returns A new CSG
  144732. */
  144733. subtract(csg: CSG): CSG;
  144734. /**
  144735. * Subtracts this CSG with another CSG in place
  144736. * @param csg The CSG to subtact against this CSG
  144737. */
  144738. subtractInPlace(csg: CSG): void;
  144739. /**
  144740. * Intersect this CSG with another CSG
  144741. * @param csg The CSG to intersect against this CSG
  144742. * @returns A new CSG
  144743. */
  144744. intersect(csg: CSG): CSG;
  144745. /**
  144746. * Intersects this CSG with another CSG in place
  144747. * @param csg The CSG to intersect against this CSG
  144748. */
  144749. intersectInPlace(csg: CSG): void;
  144750. /**
  144751. * Return a new CSG solid with solid and empty space switched. This solid is
  144752. * not modified.
  144753. * @returns A new CSG solid with solid and empty space switched
  144754. */
  144755. inverse(): CSG;
  144756. /**
  144757. * Inverses the CSG in place
  144758. */
  144759. inverseInPlace(): void;
  144760. /**
  144761. * This is used to keep meshes transformations so they can be restored
  144762. * when we build back a Babylon Mesh
  144763. * NB : All CSG operations are performed in world coordinates
  144764. * @param csg The CSG to copy the transform attributes from
  144765. * @returns This CSG
  144766. */
  144767. copyTransformAttributes(csg: CSG): CSG;
  144768. /**
  144769. * Build Raw mesh from CSG
  144770. * Coordinates here are in world space
  144771. * @param name The name of the mesh geometry
  144772. * @param scene The Scene
  144773. * @param keepSubMeshes Specifies if the submeshes should be kept
  144774. * @returns A new Mesh
  144775. */
  144776. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144777. /**
  144778. * Build Mesh from CSG taking material and transforms into account
  144779. * @param name The name of the Mesh
  144780. * @param material The material of the Mesh
  144781. * @param scene The Scene
  144782. * @param keepSubMeshes Specifies if submeshes should be kept
  144783. * @returns The new Mesh
  144784. */
  144785. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144786. }
  144787. }
  144788. declare module BABYLON {
  144789. /**
  144790. * Class used to create a trail following a mesh
  144791. */
  144792. export class TrailMesh extends Mesh {
  144793. private _generator;
  144794. private _autoStart;
  144795. private _running;
  144796. private _diameter;
  144797. private _length;
  144798. private _sectionPolygonPointsCount;
  144799. private _sectionVectors;
  144800. private _sectionNormalVectors;
  144801. private _beforeRenderObserver;
  144802. /**
  144803. * @constructor
  144804. * @param name The value used by scene.getMeshByName() to do a lookup.
  144805. * @param generator The mesh or transform node to generate a trail.
  144806. * @param scene The scene to add this mesh to.
  144807. * @param diameter Diameter of trailing mesh. Default is 1.
  144808. * @param length Length of trailing mesh. Default is 60.
  144809. * @param autoStart Automatically start trailing mesh. Default true.
  144810. */
  144811. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  144812. /**
  144813. * "TrailMesh"
  144814. * @returns "TrailMesh"
  144815. */
  144816. getClassName(): string;
  144817. private _createMesh;
  144818. /**
  144819. * Start trailing mesh.
  144820. */
  144821. start(): void;
  144822. /**
  144823. * Stop trailing mesh.
  144824. */
  144825. stop(): void;
  144826. /**
  144827. * Update trailing mesh geometry.
  144828. */
  144829. update(): void;
  144830. /**
  144831. * Returns a new TrailMesh object.
  144832. * @param name is a string, the name given to the new mesh
  144833. * @param newGenerator use new generator object for cloned trail mesh
  144834. * @returns a new mesh
  144835. */
  144836. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  144837. /**
  144838. * Serializes this trail mesh
  144839. * @param serializationObject object to write serialization to
  144840. */
  144841. serialize(serializationObject: any): void;
  144842. /**
  144843. * Parses a serialized trail mesh
  144844. * @param parsedMesh the serialized mesh
  144845. * @param scene the scene to create the trail mesh in
  144846. * @returns the created trail mesh
  144847. */
  144848. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  144849. }
  144850. }
  144851. declare module BABYLON {
  144852. /**
  144853. * Class containing static functions to help procedurally build meshes
  144854. */
  144855. export class TiledBoxBuilder {
  144856. /**
  144857. * Creates a box mesh
  144858. * 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)
  144859. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144860. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144861. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144862. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144863. * @param name defines the name of the mesh
  144864. * @param options defines the options used to create the mesh
  144865. * @param scene defines the hosting scene
  144866. * @returns the box mesh
  144867. */
  144868. static CreateTiledBox(name: string, options: {
  144869. pattern?: number;
  144870. width?: number;
  144871. height?: number;
  144872. depth?: number;
  144873. tileSize?: number;
  144874. tileWidth?: number;
  144875. tileHeight?: number;
  144876. alignHorizontal?: number;
  144877. alignVertical?: number;
  144878. faceUV?: Vector4[];
  144879. faceColors?: Color4[];
  144880. sideOrientation?: number;
  144881. updatable?: boolean;
  144882. }, scene?: Nullable<Scene>): Mesh;
  144883. }
  144884. }
  144885. declare module BABYLON {
  144886. /**
  144887. * Class containing static functions to help procedurally build meshes
  144888. */
  144889. export class TorusKnotBuilder {
  144890. /**
  144891. * Creates a torus knot mesh
  144892. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  144893. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  144894. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  144895. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  144896. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144897. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144898. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144899. * @param name defines the name of the mesh
  144900. * @param options defines the options used to create the mesh
  144901. * @param scene defines the hosting scene
  144902. * @returns the torus knot mesh
  144903. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  144904. */
  144905. static CreateTorusKnot(name: string, options: {
  144906. radius?: number;
  144907. tube?: number;
  144908. radialSegments?: number;
  144909. tubularSegments?: number;
  144910. p?: number;
  144911. q?: number;
  144912. updatable?: boolean;
  144913. sideOrientation?: number;
  144914. frontUVs?: Vector4;
  144915. backUVs?: Vector4;
  144916. }, scene: any): Mesh;
  144917. }
  144918. }
  144919. declare module BABYLON {
  144920. /**
  144921. * Polygon
  144922. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  144923. */
  144924. export class Polygon {
  144925. /**
  144926. * Creates a rectangle
  144927. * @param xmin bottom X coord
  144928. * @param ymin bottom Y coord
  144929. * @param xmax top X coord
  144930. * @param ymax top Y coord
  144931. * @returns points that make the resulting rectation
  144932. */
  144933. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  144934. /**
  144935. * Creates a circle
  144936. * @param radius radius of circle
  144937. * @param cx scale in x
  144938. * @param cy scale in y
  144939. * @param numberOfSides number of sides that make up the circle
  144940. * @returns points that make the resulting circle
  144941. */
  144942. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  144943. /**
  144944. * Creates a polygon from input string
  144945. * @param input Input polygon data
  144946. * @returns the parsed points
  144947. */
  144948. static Parse(input: string): Vector2[];
  144949. /**
  144950. * Starts building a polygon from x and y coordinates
  144951. * @param x x coordinate
  144952. * @param y y coordinate
  144953. * @returns the started path2
  144954. */
  144955. static StartingAt(x: number, y: number): Path2;
  144956. }
  144957. /**
  144958. * Builds a polygon
  144959. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  144960. */
  144961. export class PolygonMeshBuilder {
  144962. private _points;
  144963. private _outlinepoints;
  144964. private _holes;
  144965. private _name;
  144966. private _scene;
  144967. private _epoints;
  144968. private _eholes;
  144969. private _addToepoint;
  144970. /**
  144971. * Babylon reference to the earcut plugin.
  144972. */
  144973. bjsEarcut: any;
  144974. /**
  144975. * Creates a PolygonMeshBuilder
  144976. * @param name name of the builder
  144977. * @param contours Path of the polygon
  144978. * @param scene scene to add to when creating the mesh
  144979. * @param earcutInjection can be used to inject your own earcut reference
  144980. */
  144981. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  144982. /**
  144983. * Adds a whole within the polygon
  144984. * @param hole Array of points defining the hole
  144985. * @returns this
  144986. */
  144987. addHole(hole: Vector2[]): PolygonMeshBuilder;
  144988. /**
  144989. * Creates the polygon
  144990. * @param updatable If the mesh should be updatable
  144991. * @param depth The depth of the mesh created
  144992. * @returns the created mesh
  144993. */
  144994. build(updatable?: boolean, depth?: number): Mesh;
  144995. /**
  144996. * Creates the polygon
  144997. * @param depth The depth of the mesh created
  144998. * @returns the created VertexData
  144999. */
  145000. buildVertexData(depth?: number): VertexData;
  145001. /**
  145002. * Adds a side to the polygon
  145003. * @param positions points that make the polygon
  145004. * @param normals normals of the polygon
  145005. * @param uvs uvs of the polygon
  145006. * @param indices indices of the polygon
  145007. * @param bounds bounds of the polygon
  145008. * @param points points of the polygon
  145009. * @param depth depth of the polygon
  145010. * @param flip flip of the polygon
  145011. */
  145012. private addSide;
  145013. }
  145014. }
  145015. declare module BABYLON {
  145016. /**
  145017. * Class containing static functions to help procedurally build meshes
  145018. */
  145019. export class PolygonBuilder {
  145020. /**
  145021. * Creates a polygon mesh
  145022. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145023. * * 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
  145024. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145025. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145026. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145027. * * Remember you can only change the shape positions, not their number when updating a polygon
  145028. * @param name defines the name of the mesh
  145029. * @param options defines the options used to create the mesh
  145030. * @param scene defines the hosting scene
  145031. * @param earcutInjection can be used to inject your own earcut reference
  145032. * @returns the polygon mesh
  145033. */
  145034. static CreatePolygon(name: string, options: {
  145035. shape: Vector3[];
  145036. holes?: Vector3[][];
  145037. depth?: number;
  145038. faceUV?: Vector4[];
  145039. faceColors?: Color4[];
  145040. updatable?: boolean;
  145041. sideOrientation?: number;
  145042. frontUVs?: Vector4;
  145043. backUVs?: Vector4;
  145044. wrap?: boolean;
  145045. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145046. /**
  145047. * Creates an extruded polygon mesh, with depth in the Y direction.
  145048. * * 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)
  145049. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145050. * @param name defines the name of the mesh
  145051. * @param options defines the options used to create the mesh
  145052. * @param scene defines the hosting scene
  145053. * @param earcutInjection can be used to inject your own earcut reference
  145054. * @returns the polygon mesh
  145055. */
  145056. static ExtrudePolygon(name: string, options: {
  145057. shape: Vector3[];
  145058. holes?: Vector3[][];
  145059. depth?: number;
  145060. faceUV?: Vector4[];
  145061. faceColors?: Color4[];
  145062. updatable?: boolean;
  145063. sideOrientation?: number;
  145064. frontUVs?: Vector4;
  145065. backUVs?: Vector4;
  145066. wrap?: boolean;
  145067. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145068. }
  145069. }
  145070. declare module BABYLON {
  145071. /**
  145072. * Class containing static functions to help procedurally build meshes
  145073. */
  145074. export class LatheBuilder {
  145075. /**
  145076. * Creates lathe mesh.
  145077. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145078. * * 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
  145079. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145080. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145081. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145082. * * 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
  145083. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145084. * * 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
  145085. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145086. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145087. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145088. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145089. * @param name defines the name of the mesh
  145090. * @param options defines the options used to create the mesh
  145091. * @param scene defines the hosting scene
  145092. * @returns the lathe mesh
  145093. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145094. */
  145095. static CreateLathe(name: string, options: {
  145096. shape: Vector3[];
  145097. radius?: number;
  145098. tessellation?: number;
  145099. clip?: number;
  145100. arc?: number;
  145101. closed?: boolean;
  145102. updatable?: boolean;
  145103. sideOrientation?: number;
  145104. frontUVs?: Vector4;
  145105. backUVs?: Vector4;
  145106. cap?: number;
  145107. invertUV?: boolean;
  145108. }, scene?: Nullable<Scene>): Mesh;
  145109. }
  145110. }
  145111. declare module BABYLON {
  145112. /**
  145113. * Class containing static functions to help procedurally build meshes
  145114. */
  145115. export class TiledPlaneBuilder {
  145116. /**
  145117. * Creates a tiled plane mesh
  145118. * * The parameter `pattern` will, depending on value, do nothing or
  145119. * * * flip (reflect about central vertical) alternate tiles across and up
  145120. * * * flip every tile on alternate rows
  145121. * * * rotate (180 degs) alternate tiles across and up
  145122. * * * rotate every tile on alternate rows
  145123. * * * flip and rotate alternate tiles across and up
  145124. * * * flip and rotate every tile on alternate rows
  145125. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  145126. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  145127. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145128. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145129. * * 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)
  145130. * * 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)
  145131. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145132. * @param name defines the name of the mesh
  145133. * @param options defines the options used to create the mesh
  145134. * @param scene defines the hosting scene
  145135. * @returns the box mesh
  145136. */
  145137. static CreateTiledPlane(name: string, options: {
  145138. pattern?: number;
  145139. tileSize?: number;
  145140. tileWidth?: number;
  145141. tileHeight?: number;
  145142. size?: number;
  145143. width?: number;
  145144. height?: number;
  145145. alignHorizontal?: number;
  145146. alignVertical?: number;
  145147. sideOrientation?: number;
  145148. frontUVs?: Vector4;
  145149. backUVs?: Vector4;
  145150. updatable?: boolean;
  145151. }, scene?: Nullable<Scene>): Mesh;
  145152. }
  145153. }
  145154. declare module BABYLON {
  145155. /**
  145156. * Class containing static functions to help procedurally build meshes
  145157. */
  145158. export class TubeBuilder {
  145159. /**
  145160. * Creates a tube mesh.
  145161. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145162. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145163. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145164. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145165. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145166. * * 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)
  145167. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145168. * * 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
  145169. * * 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
  145170. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145171. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145172. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145173. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145174. * @param name defines the name of the mesh
  145175. * @param options defines the options used to create the mesh
  145176. * @param scene defines the hosting scene
  145177. * @returns the tube mesh
  145178. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145179. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145180. */
  145181. static CreateTube(name: string, options: {
  145182. path: Vector3[];
  145183. radius?: number;
  145184. tessellation?: number;
  145185. radiusFunction?: {
  145186. (i: number, distance: number): number;
  145187. };
  145188. cap?: number;
  145189. arc?: number;
  145190. updatable?: boolean;
  145191. sideOrientation?: number;
  145192. frontUVs?: Vector4;
  145193. backUVs?: Vector4;
  145194. instance?: Mesh;
  145195. invertUV?: boolean;
  145196. }, scene?: Nullable<Scene>): Mesh;
  145197. }
  145198. }
  145199. declare module BABYLON {
  145200. /**
  145201. * Class containing static functions to help procedurally build meshes
  145202. */
  145203. export class IcoSphereBuilder {
  145204. /**
  145205. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145206. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145207. * * 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`)
  145208. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145209. * * 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
  145210. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145211. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145212. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145213. * @param name defines the name of the mesh
  145214. * @param options defines the options used to create the mesh
  145215. * @param scene defines the hosting scene
  145216. * @returns the icosahedron mesh
  145217. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145218. */
  145219. static CreateIcoSphere(name: string, options: {
  145220. radius?: number;
  145221. radiusX?: number;
  145222. radiusY?: number;
  145223. radiusZ?: number;
  145224. flat?: boolean;
  145225. subdivisions?: number;
  145226. sideOrientation?: number;
  145227. frontUVs?: Vector4;
  145228. backUVs?: Vector4;
  145229. updatable?: boolean;
  145230. }, scene?: Nullable<Scene>): Mesh;
  145231. }
  145232. }
  145233. declare module BABYLON {
  145234. /**
  145235. * Class containing static functions to help procedurally build meshes
  145236. */
  145237. export class DecalBuilder {
  145238. /**
  145239. * Creates a decal mesh.
  145240. * 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
  145241. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145242. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145243. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145244. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145245. * @param name defines the name of the mesh
  145246. * @param sourceMesh defines the mesh where the decal must be applied
  145247. * @param options defines the options used to create the mesh
  145248. * @param scene defines the hosting scene
  145249. * @returns the decal mesh
  145250. * @see https://doc.babylonjs.com/how_to/decals
  145251. */
  145252. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145253. position?: Vector3;
  145254. normal?: Vector3;
  145255. size?: Vector3;
  145256. angle?: number;
  145257. }): Mesh;
  145258. }
  145259. }
  145260. declare module BABYLON {
  145261. /**
  145262. * Class containing static functions to help procedurally build meshes
  145263. */
  145264. export class MeshBuilder {
  145265. /**
  145266. * Creates a box mesh
  145267. * * The parameter `size` sets the size (float) of each box side (default 1)
  145268. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  145269. * * 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)
  145270. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145271. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145272. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145273. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145274. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145275. * @param name defines the name of the mesh
  145276. * @param options defines the options used to create the mesh
  145277. * @param scene defines the hosting scene
  145278. * @returns the box mesh
  145279. */
  145280. static CreateBox(name: string, options: {
  145281. size?: number;
  145282. width?: number;
  145283. height?: number;
  145284. depth?: number;
  145285. faceUV?: Vector4[];
  145286. faceColors?: Color4[];
  145287. sideOrientation?: number;
  145288. frontUVs?: Vector4;
  145289. backUVs?: Vector4;
  145290. wrap?: boolean;
  145291. topBaseAt?: number;
  145292. bottomBaseAt?: number;
  145293. updatable?: boolean;
  145294. }, scene?: Nullable<Scene>): Mesh;
  145295. /**
  145296. * Creates a tiled box mesh
  145297. * * faceTiles sets the pattern, tile size and number of tiles for a face
  145298. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145299. * @param name defines the name of the mesh
  145300. * @param options defines the options used to create the mesh
  145301. * @param scene defines the hosting scene
  145302. * @returns the tiled box mesh
  145303. */
  145304. static CreateTiledBox(name: string, options: {
  145305. pattern?: number;
  145306. size?: number;
  145307. width?: number;
  145308. height?: number;
  145309. depth: number;
  145310. tileSize?: number;
  145311. tileWidth?: number;
  145312. tileHeight?: number;
  145313. faceUV?: Vector4[];
  145314. faceColors?: Color4[];
  145315. alignHorizontal?: number;
  145316. alignVertical?: number;
  145317. sideOrientation?: number;
  145318. updatable?: boolean;
  145319. }, scene?: Nullable<Scene>): Mesh;
  145320. /**
  145321. * Creates a sphere mesh
  145322. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  145323. * * 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`)
  145324. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  145325. * * 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
  145326. * * 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)
  145327. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145328. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145329. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145330. * @param name defines the name of the mesh
  145331. * @param options defines the options used to create the mesh
  145332. * @param scene defines the hosting scene
  145333. * @returns the sphere mesh
  145334. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  145335. */
  145336. static CreateSphere(name: string, options: {
  145337. segments?: number;
  145338. diameter?: number;
  145339. diameterX?: number;
  145340. diameterY?: number;
  145341. diameterZ?: number;
  145342. arc?: number;
  145343. slice?: number;
  145344. sideOrientation?: number;
  145345. frontUVs?: Vector4;
  145346. backUVs?: Vector4;
  145347. updatable?: boolean;
  145348. }, scene?: Nullable<Scene>): Mesh;
  145349. /**
  145350. * Creates a plane polygonal mesh. By default, this is a disc
  145351. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  145352. * * 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
  145353. * * 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
  145354. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145355. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145356. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145357. * @param name defines the name of the mesh
  145358. * @param options defines the options used to create the mesh
  145359. * @param scene defines the hosting scene
  145360. * @returns the plane polygonal mesh
  145361. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  145362. */
  145363. static CreateDisc(name: string, options: {
  145364. radius?: number;
  145365. tessellation?: number;
  145366. arc?: number;
  145367. updatable?: boolean;
  145368. sideOrientation?: number;
  145369. frontUVs?: Vector4;
  145370. backUVs?: Vector4;
  145371. }, scene?: Nullable<Scene>): Mesh;
  145372. /**
  145373. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145374. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145375. * * 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`)
  145376. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145377. * * 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
  145378. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145379. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145380. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145381. * @param name defines the name of the mesh
  145382. * @param options defines the options used to create the mesh
  145383. * @param scene defines the hosting scene
  145384. * @returns the icosahedron mesh
  145385. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145386. */
  145387. static CreateIcoSphere(name: string, options: {
  145388. radius?: number;
  145389. radiusX?: number;
  145390. radiusY?: number;
  145391. radiusZ?: number;
  145392. flat?: boolean;
  145393. subdivisions?: number;
  145394. sideOrientation?: number;
  145395. frontUVs?: Vector4;
  145396. backUVs?: Vector4;
  145397. updatable?: boolean;
  145398. }, scene?: Nullable<Scene>): Mesh;
  145399. /**
  145400. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145401. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  145402. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  145403. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  145404. * * 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
  145405. * * 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
  145406. * * 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
  145407. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145408. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145409. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145410. * * 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
  145411. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  145412. * * 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
  145413. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  145414. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145415. * @param name defines the name of the mesh
  145416. * @param options defines the options used to create the mesh
  145417. * @param scene defines the hosting scene
  145418. * @returns the ribbon mesh
  145419. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  145420. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145421. */
  145422. static CreateRibbon(name: string, options: {
  145423. pathArray: Vector3[][];
  145424. closeArray?: boolean;
  145425. closePath?: boolean;
  145426. offset?: number;
  145427. updatable?: boolean;
  145428. sideOrientation?: number;
  145429. frontUVs?: Vector4;
  145430. backUVs?: Vector4;
  145431. instance?: Mesh;
  145432. invertUV?: boolean;
  145433. uvs?: Vector2[];
  145434. colors?: Color4[];
  145435. }, scene?: Nullable<Scene>): Mesh;
  145436. /**
  145437. * Creates a cylinder or a cone mesh
  145438. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  145439. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  145440. * * 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.
  145441. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  145442. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  145443. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  145444. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  145445. * * 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).
  145446. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  145447. * * 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).
  145448. * * 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
  145449. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  145450. * * 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
  145451. * * 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.
  145452. * * If `enclose` is false, a ring surface is one element.
  145453. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  145454. * * 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
  145455. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145456. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145457. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145458. * @param name defines the name of the mesh
  145459. * @param options defines the options used to create the mesh
  145460. * @param scene defines the hosting scene
  145461. * @returns the cylinder mesh
  145462. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  145463. */
  145464. static CreateCylinder(name: string, options: {
  145465. height?: number;
  145466. diameterTop?: number;
  145467. diameterBottom?: number;
  145468. diameter?: number;
  145469. tessellation?: number;
  145470. subdivisions?: number;
  145471. arc?: number;
  145472. faceColors?: Color4[];
  145473. faceUV?: Vector4[];
  145474. updatable?: boolean;
  145475. hasRings?: boolean;
  145476. enclose?: boolean;
  145477. cap?: number;
  145478. sideOrientation?: number;
  145479. frontUVs?: Vector4;
  145480. backUVs?: Vector4;
  145481. }, scene?: Nullable<Scene>): Mesh;
  145482. /**
  145483. * Creates a torus mesh
  145484. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  145485. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  145486. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  145487. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145488. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145489. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145490. * @param name defines the name of the mesh
  145491. * @param options defines the options used to create the mesh
  145492. * @param scene defines the hosting scene
  145493. * @returns the torus mesh
  145494. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  145495. */
  145496. static CreateTorus(name: string, options: {
  145497. diameter?: number;
  145498. thickness?: number;
  145499. tessellation?: number;
  145500. updatable?: boolean;
  145501. sideOrientation?: number;
  145502. frontUVs?: Vector4;
  145503. backUVs?: Vector4;
  145504. }, scene?: Nullable<Scene>): Mesh;
  145505. /**
  145506. * Creates a torus knot mesh
  145507. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145508. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145509. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145510. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145511. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145512. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145513. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145514. * @param name defines the name of the mesh
  145515. * @param options defines the options used to create the mesh
  145516. * @param scene defines the hosting scene
  145517. * @returns the torus knot mesh
  145518. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145519. */
  145520. static CreateTorusKnot(name: string, options: {
  145521. radius?: number;
  145522. tube?: number;
  145523. radialSegments?: number;
  145524. tubularSegments?: number;
  145525. p?: number;
  145526. q?: number;
  145527. updatable?: boolean;
  145528. sideOrientation?: number;
  145529. frontUVs?: Vector4;
  145530. backUVs?: Vector4;
  145531. }, scene?: Nullable<Scene>): Mesh;
  145532. /**
  145533. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  145534. * * 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
  145535. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  145536. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  145537. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  145538. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  145539. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  145540. * * 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
  145541. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  145542. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145543. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  145544. * @param name defines the name of the new line system
  145545. * @param options defines the options used to create the line system
  145546. * @param scene defines the hosting scene
  145547. * @returns a new line system mesh
  145548. */
  145549. static CreateLineSystem(name: string, options: {
  145550. lines: Vector3[][];
  145551. updatable?: boolean;
  145552. instance?: Nullable<LinesMesh>;
  145553. colors?: Nullable<Color4[][]>;
  145554. useVertexAlpha?: boolean;
  145555. }, scene: Nullable<Scene>): LinesMesh;
  145556. /**
  145557. * Creates a line mesh
  145558. * 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
  145559. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145560. * * The parameter `points` is an array successive Vector3
  145561. * * 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
  145562. * * The optional parameter `colors` is an array of successive Color4, one per line point
  145563. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  145564. * * When updating an instance, remember that only point positions can change, not the number of points
  145565. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145566. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  145567. * @param name defines the name of the new line system
  145568. * @param options defines the options used to create the line system
  145569. * @param scene defines the hosting scene
  145570. * @returns a new line mesh
  145571. */
  145572. static CreateLines(name: string, options: {
  145573. points: Vector3[];
  145574. updatable?: boolean;
  145575. instance?: Nullable<LinesMesh>;
  145576. colors?: Color4[];
  145577. useVertexAlpha?: boolean;
  145578. }, scene?: Nullable<Scene>): LinesMesh;
  145579. /**
  145580. * Creates a dashed line mesh
  145581. * * 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
  145582. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145583. * * The parameter `points` is an array successive Vector3
  145584. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  145585. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  145586. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  145587. * * 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
  145588. * * When updating an instance, remember that only point positions can change, not the number of points
  145589. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145590. * @param name defines the name of the mesh
  145591. * @param options defines the options used to create the mesh
  145592. * @param scene defines the hosting scene
  145593. * @returns the dashed line mesh
  145594. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  145595. */
  145596. static CreateDashedLines(name: string, options: {
  145597. points: Vector3[];
  145598. dashSize?: number;
  145599. gapSize?: number;
  145600. dashNb?: number;
  145601. updatable?: boolean;
  145602. instance?: LinesMesh;
  145603. }, scene?: Nullable<Scene>): LinesMesh;
  145604. /**
  145605. * 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.
  145606. * * 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.
  145607. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145608. * * 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.
  145609. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  145610. * * 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
  145611. * * 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
  145612. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  145613. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145614. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145615. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  145616. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145617. * @param name defines the name of the mesh
  145618. * @param options defines the options used to create the mesh
  145619. * @param scene defines the hosting scene
  145620. * @returns the extruded shape mesh
  145621. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145622. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145623. */
  145624. static ExtrudeShape(name: string, options: {
  145625. shape: Vector3[];
  145626. path: Vector3[];
  145627. scale?: number;
  145628. rotation?: number;
  145629. cap?: number;
  145630. updatable?: boolean;
  145631. sideOrientation?: number;
  145632. frontUVs?: Vector4;
  145633. backUVs?: Vector4;
  145634. instance?: Mesh;
  145635. invertUV?: boolean;
  145636. }, scene?: Nullable<Scene>): Mesh;
  145637. /**
  145638. * Creates an custom extruded shape mesh.
  145639. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  145640. * * 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.
  145641. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145642. * * 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
  145643. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  145644. * * 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
  145645. * * It must returns a float value that will be the scale value applied to the shape on each path point
  145646. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  145647. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  145648. * * 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
  145649. * * 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
  145650. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  145651. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145652. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145653. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145654. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145655. * @param name defines the name of the mesh
  145656. * @param options defines the options used to create the mesh
  145657. * @param scene defines the hosting scene
  145658. * @returns the custom extruded shape mesh
  145659. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  145660. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145661. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145662. */
  145663. static ExtrudeShapeCustom(name: string, options: {
  145664. shape: Vector3[];
  145665. path: Vector3[];
  145666. scaleFunction?: any;
  145667. rotationFunction?: any;
  145668. ribbonCloseArray?: boolean;
  145669. ribbonClosePath?: boolean;
  145670. cap?: number;
  145671. updatable?: boolean;
  145672. sideOrientation?: number;
  145673. frontUVs?: Vector4;
  145674. backUVs?: Vector4;
  145675. instance?: Mesh;
  145676. invertUV?: boolean;
  145677. }, scene?: Nullable<Scene>): Mesh;
  145678. /**
  145679. * Creates lathe mesh.
  145680. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145681. * * 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
  145682. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145683. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145684. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145685. * * 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
  145686. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145687. * * 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
  145688. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145689. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145690. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145691. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145692. * @param name defines the name of the mesh
  145693. * @param options defines the options used to create the mesh
  145694. * @param scene defines the hosting scene
  145695. * @returns the lathe mesh
  145696. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145697. */
  145698. static CreateLathe(name: string, options: {
  145699. shape: Vector3[];
  145700. radius?: number;
  145701. tessellation?: number;
  145702. clip?: number;
  145703. arc?: number;
  145704. closed?: boolean;
  145705. updatable?: boolean;
  145706. sideOrientation?: number;
  145707. frontUVs?: Vector4;
  145708. backUVs?: Vector4;
  145709. cap?: number;
  145710. invertUV?: boolean;
  145711. }, scene?: Nullable<Scene>): Mesh;
  145712. /**
  145713. * Creates a tiled plane mesh
  145714. * * You can set a limited pattern arrangement with the tiles
  145715. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145716. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145717. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145718. * @param name defines the name of the mesh
  145719. * @param options defines the options used to create the mesh
  145720. * @param scene defines the hosting scene
  145721. * @returns the plane mesh
  145722. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145723. */
  145724. static CreateTiledPlane(name: string, options: {
  145725. pattern?: number;
  145726. tileSize?: number;
  145727. tileWidth?: number;
  145728. tileHeight?: number;
  145729. size?: number;
  145730. width?: number;
  145731. height?: number;
  145732. alignHorizontal?: number;
  145733. alignVertical?: number;
  145734. sideOrientation?: number;
  145735. frontUVs?: Vector4;
  145736. backUVs?: Vector4;
  145737. updatable?: boolean;
  145738. }, scene?: Nullable<Scene>): Mesh;
  145739. /**
  145740. * Creates a plane mesh
  145741. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  145742. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  145743. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  145744. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145745. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145746. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145747. * @param name defines the name of the mesh
  145748. * @param options defines the options used to create the mesh
  145749. * @param scene defines the hosting scene
  145750. * @returns the plane mesh
  145751. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145752. */
  145753. static CreatePlane(name: string, options: {
  145754. size?: number;
  145755. width?: number;
  145756. height?: number;
  145757. sideOrientation?: number;
  145758. frontUVs?: Vector4;
  145759. backUVs?: Vector4;
  145760. updatable?: boolean;
  145761. sourcePlane?: Plane;
  145762. }, scene?: Nullable<Scene>): Mesh;
  145763. /**
  145764. * Creates a ground mesh
  145765. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  145766. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  145767. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145768. * @param name defines the name of the mesh
  145769. * @param options defines the options used to create the mesh
  145770. * @param scene defines the hosting scene
  145771. * @returns the ground mesh
  145772. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  145773. */
  145774. static CreateGround(name: string, options: {
  145775. width?: number;
  145776. height?: number;
  145777. subdivisions?: number;
  145778. subdivisionsX?: number;
  145779. subdivisionsY?: number;
  145780. updatable?: boolean;
  145781. }, scene?: Nullable<Scene>): Mesh;
  145782. /**
  145783. * Creates a tiled ground mesh
  145784. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  145785. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  145786. * * 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
  145787. * * 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
  145788. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145789. * @param name defines the name of the mesh
  145790. * @param options defines the options used to create the mesh
  145791. * @param scene defines the hosting scene
  145792. * @returns the tiled ground mesh
  145793. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  145794. */
  145795. static CreateTiledGround(name: string, options: {
  145796. xmin: number;
  145797. zmin: number;
  145798. xmax: number;
  145799. zmax: number;
  145800. subdivisions?: {
  145801. w: number;
  145802. h: number;
  145803. };
  145804. precision?: {
  145805. w: number;
  145806. h: number;
  145807. };
  145808. updatable?: boolean;
  145809. }, scene?: Nullable<Scene>): Mesh;
  145810. /**
  145811. * Creates a ground mesh from a height map
  145812. * * The parameter `url` sets the URL of the height map image resource.
  145813. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  145814. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  145815. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  145816. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  145817. * * 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.
  145818. * * 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).
  145819. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  145820. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145821. * @param name defines the name of the mesh
  145822. * @param url defines the url to the height map
  145823. * @param options defines the options used to create the mesh
  145824. * @param scene defines the hosting scene
  145825. * @returns the ground mesh
  145826. * @see https://doc.babylonjs.com/babylon101/height_map
  145827. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  145828. */
  145829. static CreateGroundFromHeightMap(name: string, url: string, options: {
  145830. width?: number;
  145831. height?: number;
  145832. subdivisions?: number;
  145833. minHeight?: number;
  145834. maxHeight?: number;
  145835. colorFilter?: Color3;
  145836. alphaFilter?: number;
  145837. updatable?: boolean;
  145838. onReady?: (mesh: GroundMesh) => void;
  145839. }, scene?: Nullable<Scene>): GroundMesh;
  145840. /**
  145841. * Creates a polygon mesh
  145842. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145843. * * 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
  145844. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145845. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145846. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145847. * * Remember you can only change the shape positions, not their number when updating a polygon
  145848. * @param name defines the name of the mesh
  145849. * @param options defines the options used to create the mesh
  145850. * @param scene defines the hosting scene
  145851. * @param earcutInjection can be used to inject your own earcut reference
  145852. * @returns the polygon mesh
  145853. */
  145854. static CreatePolygon(name: string, options: {
  145855. shape: Vector3[];
  145856. holes?: Vector3[][];
  145857. depth?: number;
  145858. faceUV?: Vector4[];
  145859. faceColors?: Color4[];
  145860. updatable?: boolean;
  145861. sideOrientation?: number;
  145862. frontUVs?: Vector4;
  145863. backUVs?: Vector4;
  145864. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145865. /**
  145866. * Creates an extruded polygon mesh, with depth in the Y direction.
  145867. * * 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)
  145868. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145869. * @param name defines the name of the mesh
  145870. * @param options defines the options used to create the mesh
  145871. * @param scene defines the hosting scene
  145872. * @param earcutInjection can be used to inject your own earcut reference
  145873. * @returns the polygon mesh
  145874. */
  145875. static ExtrudePolygon(name: string, options: {
  145876. shape: Vector3[];
  145877. holes?: Vector3[][];
  145878. depth?: number;
  145879. faceUV?: Vector4[];
  145880. faceColors?: Color4[];
  145881. updatable?: boolean;
  145882. sideOrientation?: number;
  145883. frontUVs?: Vector4;
  145884. backUVs?: Vector4;
  145885. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145886. /**
  145887. * Creates a tube mesh.
  145888. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145889. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145890. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145891. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145892. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145893. * * 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)
  145894. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145895. * * 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
  145896. * * 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
  145897. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145898. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145899. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  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. * @param name defines the name of the mesh
  145902. * @param options defines the options used to create the mesh
  145903. * @param scene defines the hosting scene
  145904. * @returns the tube mesh
  145905. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145906. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145907. */
  145908. static CreateTube(name: string, options: {
  145909. path: Vector3[];
  145910. radius?: number;
  145911. tessellation?: number;
  145912. radiusFunction?: {
  145913. (i: number, distance: number): number;
  145914. };
  145915. cap?: number;
  145916. arc?: number;
  145917. updatable?: boolean;
  145918. sideOrientation?: number;
  145919. frontUVs?: Vector4;
  145920. backUVs?: Vector4;
  145921. instance?: Mesh;
  145922. invertUV?: boolean;
  145923. }, scene?: Nullable<Scene>): Mesh;
  145924. /**
  145925. * Creates a polyhedron mesh
  145926. * * 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
  145927. * * The parameter `size` (positive float, default 1) sets the polygon size
  145928. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  145929. * * 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`
  145930. * * 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
  145931. * * 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)`)
  145932. * * 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
  145933. * * 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
  145934. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145935. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145936. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145937. * @param name defines the name of the mesh
  145938. * @param options defines the options used to create the mesh
  145939. * @param scene defines the hosting scene
  145940. * @returns the polyhedron mesh
  145941. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  145942. */
  145943. static CreatePolyhedron(name: string, options: {
  145944. type?: number;
  145945. size?: number;
  145946. sizeX?: number;
  145947. sizeY?: number;
  145948. sizeZ?: number;
  145949. custom?: any;
  145950. faceUV?: Vector4[];
  145951. faceColors?: Color4[];
  145952. flat?: boolean;
  145953. updatable?: boolean;
  145954. sideOrientation?: number;
  145955. frontUVs?: Vector4;
  145956. backUVs?: Vector4;
  145957. }, scene?: Nullable<Scene>): Mesh;
  145958. /**
  145959. * Creates a decal mesh.
  145960. * 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
  145961. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145962. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145963. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145964. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145965. * @param name defines the name of the mesh
  145966. * @param sourceMesh defines the mesh where the decal must be applied
  145967. * @param options defines the options used to create the mesh
  145968. * @param scene defines the hosting scene
  145969. * @returns the decal mesh
  145970. * @see https://doc.babylonjs.com/how_to/decals
  145971. */
  145972. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145973. position?: Vector3;
  145974. normal?: Vector3;
  145975. size?: Vector3;
  145976. angle?: number;
  145977. }): Mesh;
  145978. }
  145979. }
  145980. declare module BABYLON {
  145981. /**
  145982. * A simplifier interface for future simplification implementations
  145983. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145984. */
  145985. export interface ISimplifier {
  145986. /**
  145987. * Simplification of a given mesh according to the given settings.
  145988. * Since this requires computation, it is assumed that the function runs async.
  145989. * @param settings The settings of the simplification, including quality and distance
  145990. * @param successCallback A callback that will be called after the mesh was simplified.
  145991. * @param errorCallback in case of an error, this callback will be called. optional.
  145992. */
  145993. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  145994. }
  145995. /**
  145996. * Expected simplification settings.
  145997. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  145998. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145999. */
  146000. export interface ISimplificationSettings {
  146001. /**
  146002. * Gets or sets the expected quality
  146003. */
  146004. quality: number;
  146005. /**
  146006. * Gets or sets the distance when this optimized version should be used
  146007. */
  146008. distance: number;
  146009. /**
  146010. * Gets an already optimized mesh
  146011. */
  146012. optimizeMesh?: boolean;
  146013. }
  146014. /**
  146015. * Class used to specify simplification options
  146016. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146017. */
  146018. export class SimplificationSettings implements ISimplificationSettings {
  146019. /** expected quality */
  146020. quality: number;
  146021. /** distance when this optimized version should be used */
  146022. distance: number;
  146023. /** already optimized mesh */
  146024. optimizeMesh?: boolean | undefined;
  146025. /**
  146026. * Creates a SimplificationSettings
  146027. * @param quality expected quality
  146028. * @param distance distance when this optimized version should be used
  146029. * @param optimizeMesh already optimized mesh
  146030. */
  146031. constructor(
  146032. /** expected quality */
  146033. quality: number,
  146034. /** distance when this optimized version should be used */
  146035. distance: number,
  146036. /** already optimized mesh */
  146037. optimizeMesh?: boolean | undefined);
  146038. }
  146039. /**
  146040. * Interface used to define a simplification task
  146041. */
  146042. export interface ISimplificationTask {
  146043. /**
  146044. * Array of settings
  146045. */
  146046. settings: Array<ISimplificationSettings>;
  146047. /**
  146048. * Simplification type
  146049. */
  146050. simplificationType: SimplificationType;
  146051. /**
  146052. * Mesh to simplify
  146053. */
  146054. mesh: Mesh;
  146055. /**
  146056. * Callback called on success
  146057. */
  146058. successCallback?: () => void;
  146059. /**
  146060. * Defines if parallel processing can be used
  146061. */
  146062. parallelProcessing: boolean;
  146063. }
  146064. /**
  146065. * Queue used to order the simplification tasks
  146066. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146067. */
  146068. export class SimplificationQueue {
  146069. private _simplificationArray;
  146070. /**
  146071. * Gets a boolean indicating that the process is still running
  146072. */
  146073. running: boolean;
  146074. /**
  146075. * Creates a new queue
  146076. */
  146077. constructor();
  146078. /**
  146079. * Adds a new simplification task
  146080. * @param task defines a task to add
  146081. */
  146082. addTask(task: ISimplificationTask): void;
  146083. /**
  146084. * Execute next task
  146085. */
  146086. executeNext(): void;
  146087. /**
  146088. * Execute a simplification task
  146089. * @param task defines the task to run
  146090. */
  146091. runSimplification(task: ISimplificationTask): void;
  146092. private getSimplifier;
  146093. }
  146094. /**
  146095. * The implemented types of simplification
  146096. * At the moment only Quadratic Error Decimation is implemented
  146097. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146098. */
  146099. export enum SimplificationType {
  146100. /** Quadratic error decimation */
  146101. QUADRATIC = 0
  146102. }
  146103. /**
  146104. * An implementation of the Quadratic Error simplification algorithm.
  146105. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  146106. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  146107. * @author RaananW
  146108. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146109. */
  146110. export class QuadraticErrorSimplification implements ISimplifier {
  146111. private _mesh;
  146112. private triangles;
  146113. private vertices;
  146114. private references;
  146115. private _reconstructedMesh;
  146116. /** Gets or sets the number pf sync interations */
  146117. syncIterations: number;
  146118. /** Gets or sets the aggressiveness of the simplifier */
  146119. aggressiveness: number;
  146120. /** Gets or sets the number of allowed iterations for decimation */
  146121. decimationIterations: number;
  146122. /** Gets or sets the espilon to use for bounding box computation */
  146123. boundingBoxEpsilon: number;
  146124. /**
  146125. * Creates a new QuadraticErrorSimplification
  146126. * @param _mesh defines the target mesh
  146127. */
  146128. constructor(_mesh: Mesh);
  146129. /**
  146130. * Simplification of a given mesh according to the given settings.
  146131. * Since this requires computation, it is assumed that the function runs async.
  146132. * @param settings The settings of the simplification, including quality and distance
  146133. * @param successCallback A callback that will be called after the mesh was simplified.
  146134. */
  146135. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  146136. private runDecimation;
  146137. private initWithMesh;
  146138. private init;
  146139. private reconstructMesh;
  146140. private initDecimatedMesh;
  146141. private isFlipped;
  146142. private updateTriangles;
  146143. private identifyBorder;
  146144. private updateMesh;
  146145. private vertexError;
  146146. private calculateError;
  146147. }
  146148. }
  146149. declare module BABYLON {
  146150. interface Scene {
  146151. /** @hidden (Backing field) */
  146152. _simplificationQueue: SimplificationQueue;
  146153. /**
  146154. * Gets or sets the simplification queue attached to the scene
  146155. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146156. */
  146157. simplificationQueue: SimplificationQueue;
  146158. }
  146159. interface Mesh {
  146160. /**
  146161. * Simplify the mesh according to the given array of settings.
  146162. * Function will return immediately and will simplify async
  146163. * @param settings a collection of simplification settings
  146164. * @param parallelProcessing should all levels calculate parallel or one after the other
  146165. * @param simplificationType the type of simplification to run
  146166. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  146167. * @returns the current mesh
  146168. */
  146169. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  146170. }
  146171. /**
  146172. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  146173. * created in a scene
  146174. */
  146175. export class SimplicationQueueSceneComponent implements ISceneComponent {
  146176. /**
  146177. * The component name helpfull to identify the component in the list of scene components.
  146178. */
  146179. readonly name: string;
  146180. /**
  146181. * The scene the component belongs to.
  146182. */
  146183. scene: Scene;
  146184. /**
  146185. * Creates a new instance of the component for the given scene
  146186. * @param scene Defines the scene to register the component in
  146187. */
  146188. constructor(scene: Scene);
  146189. /**
  146190. * Registers the component in a given scene
  146191. */
  146192. register(): void;
  146193. /**
  146194. * Rebuilds the elements related to this component in case of
  146195. * context lost for instance.
  146196. */
  146197. rebuild(): void;
  146198. /**
  146199. * Disposes the component and the associated ressources
  146200. */
  146201. dispose(): void;
  146202. private _beforeCameraUpdate;
  146203. }
  146204. }
  146205. declare module BABYLON {
  146206. interface Mesh {
  146207. /**
  146208. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  146209. */
  146210. thinInstanceEnablePicking: boolean;
  146211. /**
  146212. * Creates a new thin instance
  146213. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  146214. * @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
  146215. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  146216. */
  146217. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  146218. /**
  146219. * Adds the transformation (matrix) of the current mesh as a thin instance
  146220. * @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
  146221. * @returns the thin instance index number
  146222. */
  146223. thinInstanceAddSelf(refresh: boolean): number;
  146224. /**
  146225. * Registers a custom attribute to be used with thin instances
  146226. * @param kind name of the attribute
  146227. * @param stride size in floats of the attribute
  146228. */
  146229. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  146230. /**
  146231. * Sets the matrix of a thin instance
  146232. * @param index index of the thin instance
  146233. * @param matrix matrix to set
  146234. * @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
  146235. */
  146236. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  146237. /**
  146238. * Sets the value of a custom attribute for a thin instance
  146239. * @param kind name of the attribute
  146240. * @param index index of the thin instance
  146241. * @param value value to set
  146242. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  146243. */
  146244. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  146245. /**
  146246. * 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.
  146247. */
  146248. thinInstanceCount: number;
  146249. /**
  146250. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  146251. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  146252. * @param buffer buffer to set
  146253. * @param stride size in floats of each value of the buffer
  146254. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  146255. */
  146256. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  146257. /**
  146258. * Gets the list of world matrices
  146259. * @return an array containing all the world matrices from the thin instances
  146260. */
  146261. thinInstanceGetWorldMatrices(): Matrix[];
  146262. /**
  146263. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  146264. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146265. */
  146266. thinInstanceBufferUpdated(kind: string): void;
  146267. /**
  146268. * Refreshes the bounding info, taking into account all the thin instances defined
  146269. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  146270. */
  146271. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  146272. /** @hidden */
  146273. _thinInstanceInitializeUserStorage(): void;
  146274. /** @hidden */
  146275. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  146276. /** @hidden */
  146277. _userThinInstanceBuffersStorage: {
  146278. data: {
  146279. [key: string]: Float32Array;
  146280. };
  146281. sizes: {
  146282. [key: string]: number;
  146283. };
  146284. vertexBuffers: {
  146285. [key: string]: Nullable<VertexBuffer>;
  146286. };
  146287. strides: {
  146288. [key: string]: number;
  146289. };
  146290. };
  146291. }
  146292. }
  146293. declare module BABYLON {
  146294. /**
  146295. * Navigation plugin interface to add navigation constrained by a navigation mesh
  146296. */
  146297. export interface INavigationEnginePlugin {
  146298. /**
  146299. * plugin name
  146300. */
  146301. name: string;
  146302. /**
  146303. * Creates a navigation mesh
  146304. * @param meshes array of all the geometry used to compute the navigatio mesh
  146305. * @param parameters bunch of parameters used to filter geometry
  146306. */
  146307. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146308. /**
  146309. * Create a navigation mesh debug mesh
  146310. * @param scene is where the mesh will be added
  146311. * @returns debug display mesh
  146312. */
  146313. createDebugNavMesh(scene: Scene): Mesh;
  146314. /**
  146315. * Get a navigation mesh constrained position, closest to the parameter position
  146316. * @param position world position
  146317. * @returns the closest point to position constrained by the navigation mesh
  146318. */
  146319. getClosestPoint(position: Vector3): Vector3;
  146320. /**
  146321. * Get a navigation mesh constrained position, closest to the parameter position
  146322. * @param position world position
  146323. * @param result output the closest point to position constrained by the navigation mesh
  146324. */
  146325. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146326. /**
  146327. * Get a navigation mesh constrained position, within a particular radius
  146328. * @param position world position
  146329. * @param maxRadius the maximum distance to the constrained world position
  146330. * @returns the closest point to position constrained by the navigation mesh
  146331. */
  146332. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146333. /**
  146334. * Get a navigation mesh constrained position, within a particular radius
  146335. * @param position world position
  146336. * @param maxRadius the maximum distance to the constrained world position
  146337. * @param result output the closest point to position constrained by the navigation mesh
  146338. */
  146339. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146340. /**
  146341. * Compute the final position from a segment made of destination-position
  146342. * @param position world position
  146343. * @param destination world position
  146344. * @returns the resulting point along the navmesh
  146345. */
  146346. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146347. /**
  146348. * Compute the final position from a segment made of destination-position
  146349. * @param position world position
  146350. * @param destination world position
  146351. * @param result output the resulting point along the navmesh
  146352. */
  146353. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146354. /**
  146355. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146356. * @param start world position
  146357. * @param end world position
  146358. * @returns array containing world position composing the path
  146359. */
  146360. computePath(start: Vector3, end: Vector3): Vector3[];
  146361. /**
  146362. * If this plugin is supported
  146363. * @returns true if plugin is supported
  146364. */
  146365. isSupported(): boolean;
  146366. /**
  146367. * Create a new Crowd so you can add agents
  146368. * @param maxAgents the maximum agent count in the crowd
  146369. * @param maxAgentRadius the maximum radius an agent can have
  146370. * @param scene to attach the crowd to
  146371. * @returns the crowd you can add agents to
  146372. */
  146373. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146374. /**
  146375. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146376. * The queries will try to find a solution within those bounds
  146377. * default is (1,1,1)
  146378. * @param extent x,y,z value that define the extent around the queries point of reference
  146379. */
  146380. setDefaultQueryExtent(extent: Vector3): void;
  146381. /**
  146382. * Get the Bounding box extent specified by setDefaultQueryExtent
  146383. * @returns the box extent values
  146384. */
  146385. getDefaultQueryExtent(): Vector3;
  146386. /**
  146387. * build the navmesh from a previously saved state using getNavmeshData
  146388. * @param data the Uint8Array returned by getNavmeshData
  146389. */
  146390. buildFromNavmeshData(data: Uint8Array): void;
  146391. /**
  146392. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146393. * @returns data the Uint8Array that can be saved and reused
  146394. */
  146395. getNavmeshData(): Uint8Array;
  146396. /**
  146397. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146398. * @param result output the box extent values
  146399. */
  146400. getDefaultQueryExtentToRef(result: Vector3): void;
  146401. /**
  146402. * Release all resources
  146403. */
  146404. dispose(): void;
  146405. }
  146406. /**
  146407. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  146408. */
  146409. export interface ICrowd {
  146410. /**
  146411. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146412. * You can attach anything to that node. The node position is updated in the scene update tick.
  146413. * @param pos world position that will be constrained by the navigation mesh
  146414. * @param parameters agent parameters
  146415. * @param transform hooked to the agent that will be update by the scene
  146416. * @returns agent index
  146417. */
  146418. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146419. /**
  146420. * Returns the agent position in world space
  146421. * @param index agent index returned by addAgent
  146422. * @returns world space position
  146423. */
  146424. getAgentPosition(index: number): Vector3;
  146425. /**
  146426. * Gets the agent position result in world space
  146427. * @param index agent index returned by addAgent
  146428. * @param result output world space position
  146429. */
  146430. getAgentPositionToRef(index: number, result: Vector3): void;
  146431. /**
  146432. * Gets the agent velocity in world space
  146433. * @param index agent index returned by addAgent
  146434. * @returns world space velocity
  146435. */
  146436. getAgentVelocity(index: number): Vector3;
  146437. /**
  146438. * Gets the agent velocity result in world space
  146439. * @param index agent index returned by addAgent
  146440. * @param result output world space velocity
  146441. */
  146442. getAgentVelocityToRef(index: number, result: Vector3): void;
  146443. /**
  146444. * remove a particular agent previously created
  146445. * @param index agent index returned by addAgent
  146446. */
  146447. removeAgent(index: number): void;
  146448. /**
  146449. * get the list of all agents attached to this crowd
  146450. * @returns list of agent indices
  146451. */
  146452. getAgents(): number[];
  146453. /**
  146454. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146455. * @param deltaTime in seconds
  146456. */
  146457. update(deltaTime: number): void;
  146458. /**
  146459. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146460. * @param index agent index returned by addAgent
  146461. * @param destination targeted world position
  146462. */
  146463. agentGoto(index: number, destination: Vector3): void;
  146464. /**
  146465. * Teleport the agent to a new position
  146466. * @param index agent index returned by addAgent
  146467. * @param destination targeted world position
  146468. */
  146469. agentTeleport(index: number, destination: Vector3): void;
  146470. /**
  146471. * Update agent parameters
  146472. * @param index agent index returned by addAgent
  146473. * @param parameters agent parameters
  146474. */
  146475. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146476. /**
  146477. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146478. * The queries will try to find a solution within those bounds
  146479. * default is (1,1,1)
  146480. * @param extent x,y,z value that define the extent around the queries point of reference
  146481. */
  146482. setDefaultQueryExtent(extent: Vector3): void;
  146483. /**
  146484. * Get the Bounding box extent specified by setDefaultQueryExtent
  146485. * @returns the box extent values
  146486. */
  146487. getDefaultQueryExtent(): Vector3;
  146488. /**
  146489. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146490. * @param result output the box extent values
  146491. */
  146492. getDefaultQueryExtentToRef(result: Vector3): void;
  146493. /**
  146494. * Release all resources
  146495. */
  146496. dispose(): void;
  146497. }
  146498. /**
  146499. * Configures an agent
  146500. */
  146501. export interface IAgentParameters {
  146502. /**
  146503. * Agent radius. [Limit: >= 0]
  146504. */
  146505. radius: number;
  146506. /**
  146507. * Agent height. [Limit: > 0]
  146508. */
  146509. height: number;
  146510. /**
  146511. * Maximum allowed acceleration. [Limit: >= 0]
  146512. */
  146513. maxAcceleration: number;
  146514. /**
  146515. * Maximum allowed speed. [Limit: >= 0]
  146516. */
  146517. maxSpeed: number;
  146518. /**
  146519. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  146520. */
  146521. collisionQueryRange: number;
  146522. /**
  146523. * The path visibility optimization range. [Limit: > 0]
  146524. */
  146525. pathOptimizationRange: number;
  146526. /**
  146527. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  146528. */
  146529. separationWeight: number;
  146530. }
  146531. /**
  146532. * Configures the navigation mesh creation
  146533. */
  146534. export interface INavMeshParameters {
  146535. /**
  146536. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  146537. */
  146538. cs: number;
  146539. /**
  146540. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  146541. */
  146542. ch: number;
  146543. /**
  146544. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  146545. */
  146546. walkableSlopeAngle: number;
  146547. /**
  146548. * Minimum floor to 'ceiling' height that will still allow the floor area to
  146549. * be considered walkable. [Limit: >= 3] [Units: vx]
  146550. */
  146551. walkableHeight: number;
  146552. /**
  146553. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  146554. */
  146555. walkableClimb: number;
  146556. /**
  146557. * The distance to erode/shrink the walkable area of the heightfield away from
  146558. * obstructions. [Limit: >=0] [Units: vx]
  146559. */
  146560. walkableRadius: number;
  146561. /**
  146562. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  146563. */
  146564. maxEdgeLen: number;
  146565. /**
  146566. * The maximum distance a simplfied contour's border edges should deviate
  146567. * the original raw contour. [Limit: >=0] [Units: vx]
  146568. */
  146569. maxSimplificationError: number;
  146570. /**
  146571. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  146572. */
  146573. minRegionArea: number;
  146574. /**
  146575. * Any regions with a span count smaller than this value will, if possible,
  146576. * be merged with larger regions. [Limit: >=0] [Units: vx]
  146577. */
  146578. mergeRegionArea: number;
  146579. /**
  146580. * The maximum number of vertices allowed for polygons generated during the
  146581. * contour to polygon conversion process. [Limit: >= 3]
  146582. */
  146583. maxVertsPerPoly: number;
  146584. /**
  146585. * Sets the sampling distance to use when generating the detail mesh.
  146586. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  146587. */
  146588. detailSampleDist: number;
  146589. /**
  146590. * The maximum distance the detail mesh surface should deviate from heightfield
  146591. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  146592. */
  146593. detailSampleMaxError: number;
  146594. }
  146595. }
  146596. declare module BABYLON {
  146597. /**
  146598. * RecastJS navigation plugin
  146599. */
  146600. export class RecastJSPlugin implements INavigationEnginePlugin {
  146601. /**
  146602. * Reference to the Recast library
  146603. */
  146604. bjsRECAST: any;
  146605. /**
  146606. * plugin name
  146607. */
  146608. name: string;
  146609. /**
  146610. * the first navmesh created. We might extend this to support multiple navmeshes
  146611. */
  146612. navMesh: any;
  146613. /**
  146614. * Initializes the recastJS plugin
  146615. * @param recastInjection can be used to inject your own recast reference
  146616. */
  146617. constructor(recastInjection?: any);
  146618. /**
  146619. * Creates a navigation mesh
  146620. * @param meshes array of all the geometry used to compute the navigatio mesh
  146621. * @param parameters bunch of parameters used to filter geometry
  146622. */
  146623. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146624. /**
  146625. * Create a navigation mesh debug mesh
  146626. * @param scene is where the mesh will be added
  146627. * @returns debug display mesh
  146628. */
  146629. createDebugNavMesh(scene: Scene): Mesh;
  146630. /**
  146631. * Get a navigation mesh constrained position, closest to the parameter position
  146632. * @param position world position
  146633. * @returns the closest point to position constrained by the navigation mesh
  146634. */
  146635. getClosestPoint(position: Vector3): Vector3;
  146636. /**
  146637. * Get a navigation mesh constrained position, closest to the parameter position
  146638. * @param position world position
  146639. * @param result output the closest point to position constrained by the navigation mesh
  146640. */
  146641. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146642. /**
  146643. * Get a navigation mesh constrained position, within a particular radius
  146644. * @param position world position
  146645. * @param maxRadius the maximum distance to the constrained world position
  146646. * @returns the closest point to position constrained by the navigation mesh
  146647. */
  146648. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146649. /**
  146650. * Get a navigation mesh constrained position, within a particular radius
  146651. * @param position world position
  146652. * @param maxRadius the maximum distance to the constrained world position
  146653. * @param result output the closest point to position constrained by the navigation mesh
  146654. */
  146655. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146656. /**
  146657. * Compute the final position from a segment made of destination-position
  146658. * @param position world position
  146659. * @param destination world position
  146660. * @returns the resulting point along the navmesh
  146661. */
  146662. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146663. /**
  146664. * Compute the final position from a segment made of destination-position
  146665. * @param position world position
  146666. * @param destination world position
  146667. * @param result output the resulting point along the navmesh
  146668. */
  146669. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146670. /**
  146671. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146672. * @param start world position
  146673. * @param end world position
  146674. * @returns array containing world position composing the path
  146675. */
  146676. computePath(start: Vector3, end: Vector3): Vector3[];
  146677. /**
  146678. * Create a new Crowd so you can add agents
  146679. * @param maxAgents the maximum agent count in the crowd
  146680. * @param maxAgentRadius the maximum radius an agent can have
  146681. * @param scene to attach the crowd to
  146682. * @returns the crowd you can add agents to
  146683. */
  146684. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146685. /**
  146686. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146687. * The queries will try to find a solution within those bounds
  146688. * default is (1,1,1)
  146689. * @param extent x,y,z value that define the extent around the queries point of reference
  146690. */
  146691. setDefaultQueryExtent(extent: Vector3): void;
  146692. /**
  146693. * Get the Bounding box extent specified by setDefaultQueryExtent
  146694. * @returns the box extent values
  146695. */
  146696. getDefaultQueryExtent(): Vector3;
  146697. /**
  146698. * build the navmesh from a previously saved state using getNavmeshData
  146699. * @param data the Uint8Array returned by getNavmeshData
  146700. */
  146701. buildFromNavmeshData(data: Uint8Array): void;
  146702. /**
  146703. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146704. * @returns data the Uint8Array that can be saved and reused
  146705. */
  146706. getNavmeshData(): Uint8Array;
  146707. /**
  146708. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146709. * @param result output the box extent values
  146710. */
  146711. getDefaultQueryExtentToRef(result: Vector3): void;
  146712. /**
  146713. * Disposes
  146714. */
  146715. dispose(): void;
  146716. /**
  146717. * If this plugin is supported
  146718. * @returns true if plugin is supported
  146719. */
  146720. isSupported(): boolean;
  146721. }
  146722. /**
  146723. * Recast detour crowd implementation
  146724. */
  146725. export class RecastJSCrowd implements ICrowd {
  146726. /**
  146727. * Recast/detour plugin
  146728. */
  146729. bjsRECASTPlugin: RecastJSPlugin;
  146730. /**
  146731. * Link to the detour crowd
  146732. */
  146733. recastCrowd: any;
  146734. /**
  146735. * One transform per agent
  146736. */
  146737. transforms: TransformNode[];
  146738. /**
  146739. * All agents created
  146740. */
  146741. agents: number[];
  146742. /**
  146743. * Link to the scene is kept to unregister the crowd from the scene
  146744. */
  146745. private _scene;
  146746. /**
  146747. * Observer for crowd updates
  146748. */
  146749. private _onBeforeAnimationsObserver;
  146750. /**
  146751. * Constructor
  146752. * @param plugin recastJS plugin
  146753. * @param maxAgents the maximum agent count in the crowd
  146754. * @param maxAgentRadius the maximum radius an agent can have
  146755. * @param scene to attach the crowd to
  146756. * @returns the crowd you can add agents to
  146757. */
  146758. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  146759. /**
  146760. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146761. * You can attach anything to that node. The node position is updated in the scene update tick.
  146762. * @param pos world position that will be constrained by the navigation mesh
  146763. * @param parameters agent parameters
  146764. * @param transform hooked to the agent that will be update by the scene
  146765. * @returns agent index
  146766. */
  146767. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146768. /**
  146769. * Returns the agent position in world space
  146770. * @param index agent index returned by addAgent
  146771. * @returns world space position
  146772. */
  146773. getAgentPosition(index: number): Vector3;
  146774. /**
  146775. * Returns the agent position result in world space
  146776. * @param index agent index returned by addAgent
  146777. * @param result output world space position
  146778. */
  146779. getAgentPositionToRef(index: number, result: Vector3): void;
  146780. /**
  146781. * Returns the agent velocity in world space
  146782. * @param index agent index returned by addAgent
  146783. * @returns world space velocity
  146784. */
  146785. getAgentVelocity(index: number): Vector3;
  146786. /**
  146787. * Returns the agent velocity result in world space
  146788. * @param index agent index returned by addAgent
  146789. * @param result output world space velocity
  146790. */
  146791. getAgentVelocityToRef(index: number, result: Vector3): void;
  146792. /**
  146793. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146794. * @param index agent index returned by addAgent
  146795. * @param destination targeted world position
  146796. */
  146797. agentGoto(index: number, destination: Vector3): void;
  146798. /**
  146799. * Teleport the agent to a new position
  146800. * @param index agent index returned by addAgent
  146801. * @param destination targeted world position
  146802. */
  146803. agentTeleport(index: number, destination: Vector3): void;
  146804. /**
  146805. * Update agent parameters
  146806. * @param index agent index returned by addAgent
  146807. * @param parameters agent parameters
  146808. */
  146809. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146810. /**
  146811. * remove a particular agent previously created
  146812. * @param index agent index returned by addAgent
  146813. */
  146814. removeAgent(index: number): void;
  146815. /**
  146816. * get the list of all agents attached to this crowd
  146817. * @returns list of agent indices
  146818. */
  146819. getAgents(): number[];
  146820. /**
  146821. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146822. * @param deltaTime in seconds
  146823. */
  146824. update(deltaTime: number): void;
  146825. /**
  146826. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146827. * The queries will try to find a solution within those bounds
  146828. * default is (1,1,1)
  146829. * @param extent x,y,z value that define the extent around the queries point of reference
  146830. */
  146831. setDefaultQueryExtent(extent: Vector3): void;
  146832. /**
  146833. * Get the Bounding box extent specified by setDefaultQueryExtent
  146834. * @returns the box extent values
  146835. */
  146836. getDefaultQueryExtent(): Vector3;
  146837. /**
  146838. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146839. * @param result output the box extent values
  146840. */
  146841. getDefaultQueryExtentToRef(result: Vector3): void;
  146842. /**
  146843. * Release all resources
  146844. */
  146845. dispose(): void;
  146846. }
  146847. }
  146848. declare module BABYLON {
  146849. /**
  146850. * Class used to enable access to IndexedDB
  146851. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  146852. */
  146853. export class Database implements IOfflineProvider {
  146854. private _callbackManifestChecked;
  146855. private _currentSceneUrl;
  146856. private _db;
  146857. private _enableSceneOffline;
  146858. private _enableTexturesOffline;
  146859. private _manifestVersionFound;
  146860. private _mustUpdateRessources;
  146861. private _hasReachedQuota;
  146862. private _isSupported;
  146863. private _idbFactory;
  146864. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  146865. private static IsUASupportingBlobStorage;
  146866. /**
  146867. * Gets a boolean indicating if Database storate is enabled (off by default)
  146868. */
  146869. static IDBStorageEnabled: boolean;
  146870. /**
  146871. * Gets a boolean indicating if scene must be saved in the database
  146872. */
  146873. get enableSceneOffline(): boolean;
  146874. /**
  146875. * Gets a boolean indicating if textures must be saved in the database
  146876. */
  146877. get enableTexturesOffline(): boolean;
  146878. /**
  146879. * Creates a new Database
  146880. * @param urlToScene defines the url to load the scene
  146881. * @param callbackManifestChecked defines the callback to use when manifest is checked
  146882. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  146883. */
  146884. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  146885. private static _ParseURL;
  146886. private static _ReturnFullUrlLocation;
  146887. private _checkManifestFile;
  146888. /**
  146889. * Open the database and make it available
  146890. * @param successCallback defines the callback to call on success
  146891. * @param errorCallback defines the callback to call on error
  146892. */
  146893. open(successCallback: () => void, errorCallback: () => void): void;
  146894. /**
  146895. * Loads an image from the database
  146896. * @param url defines the url to load from
  146897. * @param image defines the target DOM image
  146898. */
  146899. loadImage(url: string, image: HTMLImageElement): void;
  146900. private _loadImageFromDBAsync;
  146901. private _saveImageIntoDBAsync;
  146902. private _checkVersionFromDB;
  146903. private _loadVersionFromDBAsync;
  146904. private _saveVersionIntoDBAsync;
  146905. /**
  146906. * Loads a file from database
  146907. * @param url defines the URL to load from
  146908. * @param sceneLoaded defines a callback to call on success
  146909. * @param progressCallBack defines a callback to call when progress changed
  146910. * @param errorCallback defines a callback to call on error
  146911. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  146912. */
  146913. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  146914. private _loadFileAsync;
  146915. private _saveFileAsync;
  146916. /**
  146917. * Validates if xhr data is correct
  146918. * @param xhr defines the request to validate
  146919. * @param dataType defines the expected data type
  146920. * @returns true if data is correct
  146921. */
  146922. private static _ValidateXHRData;
  146923. }
  146924. }
  146925. declare module BABYLON {
  146926. /** @hidden */
  146927. export var gpuUpdateParticlesPixelShader: {
  146928. name: string;
  146929. shader: string;
  146930. };
  146931. }
  146932. declare module BABYLON {
  146933. /** @hidden */
  146934. export var gpuUpdateParticlesVertexShader: {
  146935. name: string;
  146936. shader: string;
  146937. };
  146938. }
  146939. declare module BABYLON {
  146940. /** @hidden */
  146941. export var clipPlaneFragmentDeclaration2: {
  146942. name: string;
  146943. shader: string;
  146944. };
  146945. }
  146946. declare module BABYLON {
  146947. /** @hidden */
  146948. export var gpuRenderParticlesPixelShader: {
  146949. name: string;
  146950. shader: string;
  146951. };
  146952. }
  146953. declare module BABYLON {
  146954. /** @hidden */
  146955. export var clipPlaneVertexDeclaration2: {
  146956. name: string;
  146957. shader: string;
  146958. };
  146959. }
  146960. declare module BABYLON {
  146961. /** @hidden */
  146962. export var gpuRenderParticlesVertexShader: {
  146963. name: string;
  146964. shader: string;
  146965. };
  146966. }
  146967. declare module BABYLON {
  146968. /**
  146969. * This represents a GPU particle system in Babylon
  146970. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  146971. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  146972. */
  146973. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  146974. /**
  146975. * The layer mask we are rendering the particles through.
  146976. */
  146977. layerMask: number;
  146978. private _capacity;
  146979. private _activeCount;
  146980. private _currentActiveCount;
  146981. private _accumulatedCount;
  146982. private _renderEffect;
  146983. private _updateEffect;
  146984. private _buffer0;
  146985. private _buffer1;
  146986. private _spriteBuffer;
  146987. private _updateVAO;
  146988. private _renderVAO;
  146989. private _targetIndex;
  146990. private _sourceBuffer;
  146991. private _targetBuffer;
  146992. private _currentRenderId;
  146993. private _started;
  146994. private _stopped;
  146995. private _timeDelta;
  146996. private _randomTexture;
  146997. private _randomTexture2;
  146998. private _attributesStrideSize;
  146999. private _updateEffectOptions;
  147000. private _randomTextureSize;
  147001. private _actualFrame;
  147002. private _customEffect;
  147003. private readonly _rawTextureWidth;
  147004. /**
  147005. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  147006. */
  147007. static get IsSupported(): boolean;
  147008. /**
  147009. * An event triggered when the system is disposed.
  147010. */
  147011. onDisposeObservable: Observable<IParticleSystem>;
  147012. /**
  147013. * Gets the maximum number of particles active at the same time.
  147014. * @returns The max number of active particles.
  147015. */
  147016. getCapacity(): number;
  147017. /**
  147018. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  147019. * to override the particles.
  147020. */
  147021. forceDepthWrite: boolean;
  147022. /**
  147023. * Gets or set the number of active particles
  147024. */
  147025. get activeParticleCount(): number;
  147026. set activeParticleCount(value: number);
  147027. private _preWarmDone;
  147028. /**
  147029. * Specifies if the particles are updated in emitter local space or world space.
  147030. */
  147031. isLocal: boolean;
  147032. /** Gets or sets a matrix to use to compute projection */
  147033. defaultProjectionMatrix: Matrix;
  147034. /**
  147035. * Is this system ready to be used/rendered
  147036. * @return true if the system is ready
  147037. */
  147038. isReady(): boolean;
  147039. /**
  147040. * Gets if the system has been started. (Note: this will still be true after stop is called)
  147041. * @returns True if it has been started, otherwise false.
  147042. */
  147043. isStarted(): boolean;
  147044. /**
  147045. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  147046. * @returns True if it has been stopped, otherwise false.
  147047. */
  147048. isStopped(): boolean;
  147049. /**
  147050. * Gets a boolean indicating that the system is stopping
  147051. * @returns true if the system is currently stopping
  147052. */
  147053. isStopping(): boolean;
  147054. /**
  147055. * Gets the number of particles active at the same time.
  147056. * @returns The number of active particles.
  147057. */
  147058. getActiveCount(): number;
  147059. /**
  147060. * Starts the particle system and begins to emit
  147061. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  147062. */
  147063. start(delay?: number): void;
  147064. /**
  147065. * Stops the particle system.
  147066. */
  147067. stop(): void;
  147068. /**
  147069. * Remove all active particles
  147070. */
  147071. reset(): void;
  147072. /**
  147073. * Returns the string "GPUParticleSystem"
  147074. * @returns a string containing the class name
  147075. */
  147076. getClassName(): string;
  147077. /**
  147078. * Gets the custom effect used to render the particles
  147079. * @param blendMode Blend mode for which the effect should be retrieved
  147080. * @returns The effect
  147081. */
  147082. getCustomEffect(blendMode?: number): Nullable<Effect>;
  147083. /**
  147084. * Sets the custom effect used to render the particles
  147085. * @param effect The effect to set
  147086. * @param blendMode Blend mode for which the effect should be set
  147087. */
  147088. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  147089. /** @hidden */
  147090. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  147091. /**
  147092. * Observable that will be called just before the particles are drawn
  147093. */
  147094. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  147095. /**
  147096. * Gets the name of the particle vertex shader
  147097. */
  147098. get vertexShaderName(): string;
  147099. private _colorGradientsTexture;
  147100. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  147101. /**
  147102. * Adds a new color gradient
  147103. * @param gradient defines the gradient to use (between 0 and 1)
  147104. * @param color1 defines the color to affect to the specified gradient
  147105. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  147106. * @returns the current particle system
  147107. */
  147108. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  147109. private _refreshColorGradient;
  147110. /** Force the system to rebuild all gradients that need to be resync */
  147111. forceRefreshGradients(): void;
  147112. /**
  147113. * Remove a specific color gradient
  147114. * @param gradient defines the gradient to remove
  147115. * @returns the current particle system
  147116. */
  147117. removeColorGradient(gradient: number): GPUParticleSystem;
  147118. private _angularSpeedGradientsTexture;
  147119. private _sizeGradientsTexture;
  147120. private _velocityGradientsTexture;
  147121. private _limitVelocityGradientsTexture;
  147122. private _dragGradientsTexture;
  147123. private _addFactorGradient;
  147124. /**
  147125. * Adds a new size gradient
  147126. * @param gradient defines the gradient to use (between 0 and 1)
  147127. * @param factor defines the size factor to affect to the specified gradient
  147128. * @returns the current particle system
  147129. */
  147130. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  147131. /**
  147132. * Remove a specific size gradient
  147133. * @param gradient defines the gradient to remove
  147134. * @returns the current particle system
  147135. */
  147136. removeSizeGradient(gradient: number): GPUParticleSystem;
  147137. private _refreshFactorGradient;
  147138. /**
  147139. * Adds a new angular speed gradient
  147140. * @param gradient defines the gradient to use (between 0 and 1)
  147141. * @param factor defines the angular speed to affect to the specified gradient
  147142. * @returns the current particle system
  147143. */
  147144. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  147145. /**
  147146. * Remove a specific angular speed gradient
  147147. * @param gradient defines the gradient to remove
  147148. * @returns the current particle system
  147149. */
  147150. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  147151. /**
  147152. * Adds a new velocity gradient
  147153. * @param gradient defines the gradient to use (between 0 and 1)
  147154. * @param factor defines the velocity to affect to the specified gradient
  147155. * @returns the current particle system
  147156. */
  147157. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147158. /**
  147159. * Remove a specific velocity gradient
  147160. * @param gradient defines the gradient to remove
  147161. * @returns the current particle system
  147162. */
  147163. removeVelocityGradient(gradient: number): GPUParticleSystem;
  147164. /**
  147165. * Adds a new limit velocity gradient
  147166. * @param gradient defines the gradient to use (between 0 and 1)
  147167. * @param factor defines the limit velocity value to affect to the specified gradient
  147168. * @returns the current particle system
  147169. */
  147170. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147171. /**
  147172. * Remove a specific limit velocity gradient
  147173. * @param gradient defines the gradient to remove
  147174. * @returns the current particle system
  147175. */
  147176. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  147177. /**
  147178. * Adds a new drag gradient
  147179. * @param gradient defines the gradient to use (between 0 and 1)
  147180. * @param factor defines the drag value to affect to the specified gradient
  147181. * @returns the current particle system
  147182. */
  147183. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  147184. /**
  147185. * Remove a specific drag gradient
  147186. * @param gradient defines the gradient to remove
  147187. * @returns the current particle system
  147188. */
  147189. removeDragGradient(gradient: number): GPUParticleSystem;
  147190. /**
  147191. * Not supported by GPUParticleSystem
  147192. * @param gradient defines the gradient to use (between 0 and 1)
  147193. * @param factor defines the emit rate value to affect to the specified gradient
  147194. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147195. * @returns the current particle system
  147196. */
  147197. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147198. /**
  147199. * Not supported by GPUParticleSystem
  147200. * @param gradient defines the gradient to remove
  147201. * @returns the current particle system
  147202. */
  147203. removeEmitRateGradient(gradient: number): IParticleSystem;
  147204. /**
  147205. * Not supported by GPUParticleSystem
  147206. * @param gradient defines the gradient to use (between 0 and 1)
  147207. * @param factor defines the start size value to affect to the specified gradient
  147208. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147209. * @returns the current particle system
  147210. */
  147211. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147212. /**
  147213. * Not supported by GPUParticleSystem
  147214. * @param gradient defines the gradient to remove
  147215. * @returns the current particle system
  147216. */
  147217. removeStartSizeGradient(gradient: number): IParticleSystem;
  147218. /**
  147219. * Not supported by GPUParticleSystem
  147220. * @param gradient defines the gradient to use (between 0 and 1)
  147221. * @param min defines the color remap minimal range
  147222. * @param max defines the color remap maximal range
  147223. * @returns the current particle system
  147224. */
  147225. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147226. /**
  147227. * Not supported by GPUParticleSystem
  147228. * @param gradient defines the gradient to remove
  147229. * @returns the current particle system
  147230. */
  147231. removeColorRemapGradient(): IParticleSystem;
  147232. /**
  147233. * Not supported by GPUParticleSystem
  147234. * @param gradient defines the gradient to use (between 0 and 1)
  147235. * @param min defines the alpha remap minimal range
  147236. * @param max defines the alpha remap maximal range
  147237. * @returns the current particle system
  147238. */
  147239. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147240. /**
  147241. * Not supported by GPUParticleSystem
  147242. * @param gradient defines the gradient to remove
  147243. * @returns the current particle system
  147244. */
  147245. removeAlphaRemapGradient(): IParticleSystem;
  147246. /**
  147247. * Not supported by GPUParticleSystem
  147248. * @param gradient defines the gradient to use (between 0 and 1)
  147249. * @param color defines the color to affect to the specified gradient
  147250. * @returns the current particle system
  147251. */
  147252. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  147253. /**
  147254. * Not supported by GPUParticleSystem
  147255. * @param gradient defines the gradient to remove
  147256. * @returns the current particle system
  147257. */
  147258. removeRampGradient(): IParticleSystem;
  147259. /**
  147260. * Not supported by GPUParticleSystem
  147261. * @returns the list of ramp gradients
  147262. */
  147263. getRampGradients(): Nullable<Array<Color3Gradient>>;
  147264. /**
  147265. * Not supported by GPUParticleSystem
  147266. * Gets or sets a boolean indicating that ramp gradients must be used
  147267. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  147268. */
  147269. get useRampGradients(): boolean;
  147270. set useRampGradients(value: boolean);
  147271. /**
  147272. * Not supported by GPUParticleSystem
  147273. * @param gradient defines the gradient to use (between 0 and 1)
  147274. * @param factor defines the life time factor to affect to the specified gradient
  147275. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147276. * @returns the current particle system
  147277. */
  147278. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147279. /**
  147280. * Not supported by GPUParticleSystem
  147281. * @param gradient defines the gradient to remove
  147282. * @returns the current particle system
  147283. */
  147284. removeLifeTimeGradient(gradient: number): IParticleSystem;
  147285. /**
  147286. * Instantiates a GPU particle system.
  147287. * 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.
  147288. * @param name The name of the particle system
  147289. * @param options The options used to create the system
  147290. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  147291. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  147292. * @param customEffect a custom effect used to change the way particles are rendered by default
  147293. */
  147294. constructor(name: string, options: Partial<{
  147295. capacity: number;
  147296. randomTextureSize: number;
  147297. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  147298. protected _reset(): void;
  147299. private _createUpdateVAO;
  147300. private _createRenderVAO;
  147301. private _initialize;
  147302. /** @hidden */
  147303. _recreateUpdateEffect(): void;
  147304. private _getEffect;
  147305. /**
  147306. * Fill the defines array according to the current settings of the particle system
  147307. * @param defines Array to be updated
  147308. * @param blendMode blend mode to take into account when updating the array
  147309. */
  147310. fillDefines(defines: Array<string>, blendMode?: number): void;
  147311. /**
  147312. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  147313. * @param uniforms Uniforms array to fill
  147314. * @param attributes Attributes array to fill
  147315. * @param samplers Samplers array to fill
  147316. */
  147317. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  147318. /** @hidden */
  147319. _recreateRenderEffect(): Effect;
  147320. /**
  147321. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  147322. * @param preWarm defines if we are in the pre-warmimg phase
  147323. */
  147324. animate(preWarm?: boolean): void;
  147325. private _createFactorGradientTexture;
  147326. private _createSizeGradientTexture;
  147327. private _createAngularSpeedGradientTexture;
  147328. private _createVelocityGradientTexture;
  147329. private _createLimitVelocityGradientTexture;
  147330. private _createDragGradientTexture;
  147331. private _createColorGradientTexture;
  147332. /**
  147333. * Renders the particle system in its current state
  147334. * @param preWarm defines if the system should only update the particles but not render them
  147335. * @returns the current number of particles
  147336. */
  147337. render(preWarm?: boolean): number;
  147338. /**
  147339. * Rebuilds the particle system
  147340. */
  147341. rebuild(): void;
  147342. private _releaseBuffers;
  147343. private _releaseVAOs;
  147344. /**
  147345. * Disposes the particle system and free the associated resources
  147346. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  147347. */
  147348. dispose(disposeTexture?: boolean): void;
  147349. /**
  147350. * Clones the particle system.
  147351. * @param name The name of the cloned object
  147352. * @param newEmitter The new emitter to use
  147353. * @returns the cloned particle system
  147354. */
  147355. clone(name: string, newEmitter: any): GPUParticleSystem;
  147356. /**
  147357. * Serializes the particle system to a JSON object
  147358. * @param serializeTexture defines if the texture must be serialized as well
  147359. * @returns the JSON object
  147360. */
  147361. serialize(serializeTexture?: boolean): any;
  147362. /**
  147363. * Parses a JSON object to create a GPU particle system.
  147364. * @param parsedParticleSystem The JSON object to parse
  147365. * @param sceneOrEngine The scene or the engine to create the particle system in
  147366. * @param rootUrl The root url to use to load external dependencies like texture
  147367. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  147368. * @returns the parsed GPU particle system
  147369. */
  147370. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  147371. }
  147372. }
  147373. declare module BABYLON {
  147374. /**
  147375. * Represents a set of particle systems working together to create a specific effect
  147376. */
  147377. export class ParticleSystemSet implements IDisposable {
  147378. /**
  147379. * Gets or sets base Assets URL
  147380. */
  147381. static BaseAssetsUrl: string;
  147382. private _emitterCreationOptions;
  147383. private _emitterNode;
  147384. /**
  147385. * Gets the particle system list
  147386. */
  147387. systems: IParticleSystem[];
  147388. /**
  147389. * Gets the emitter node used with this set
  147390. */
  147391. get emitterNode(): Nullable<TransformNode>;
  147392. /**
  147393. * Creates a new emitter mesh as a sphere
  147394. * @param options defines the options used to create the sphere
  147395. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  147396. * @param scene defines the hosting scene
  147397. */
  147398. setEmitterAsSphere(options: {
  147399. diameter: number;
  147400. segments: number;
  147401. color: Color3;
  147402. }, renderingGroupId: number, scene: Scene): void;
  147403. /**
  147404. * Starts all particle systems of the set
  147405. * @param emitter defines an optional mesh to use as emitter for the particle systems
  147406. */
  147407. start(emitter?: AbstractMesh): void;
  147408. /**
  147409. * Release all associated resources
  147410. */
  147411. dispose(): void;
  147412. /**
  147413. * Serialize the set into a JSON compatible object
  147414. * @param serializeTexture defines if the texture must be serialized as well
  147415. * @returns a JSON compatible representation of the set
  147416. */
  147417. serialize(serializeTexture?: boolean): any;
  147418. /**
  147419. * Parse a new ParticleSystemSet from a serialized source
  147420. * @param data defines a JSON compatible representation of the set
  147421. * @param scene defines the hosting scene
  147422. * @param gpu defines if we want GPU particles or CPU particles
  147423. * @returns a new ParticleSystemSet
  147424. */
  147425. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  147426. }
  147427. }
  147428. declare module BABYLON {
  147429. /**
  147430. * This class is made for on one-liner static method to help creating particle system set.
  147431. */
  147432. export class ParticleHelper {
  147433. /**
  147434. * Gets or sets base Assets URL
  147435. */
  147436. static BaseAssetsUrl: string;
  147437. /** Define the Url to load snippets */
  147438. static SnippetUrl: string;
  147439. /**
  147440. * Create a default particle system that you can tweak
  147441. * @param emitter defines the emitter to use
  147442. * @param capacity defines the system capacity (default is 500 particles)
  147443. * @param scene defines the hosting scene
  147444. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  147445. * @returns the new Particle system
  147446. */
  147447. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  147448. /**
  147449. * This is the main static method (one-liner) of this helper to create different particle systems
  147450. * @param type This string represents the type to the particle system to create
  147451. * @param scene The scene where the particle system should live
  147452. * @param gpu If the system will use gpu
  147453. * @returns the ParticleSystemSet created
  147454. */
  147455. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  147456. /**
  147457. * Static function used to export a particle system to a ParticleSystemSet variable.
  147458. * Please note that the emitter shape is not exported
  147459. * @param systems defines the particle systems to export
  147460. * @returns the created particle system set
  147461. */
  147462. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  147463. /**
  147464. * Creates a particle system from a snippet saved in a remote file
  147465. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  147466. * @param url defines the url to load from
  147467. * @param scene defines the hosting scene
  147468. * @param gpu If the system will use gpu
  147469. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147470. * @returns a promise that will resolve to the new particle system
  147471. */
  147472. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147473. /**
  147474. * Creates a particle system from a snippet saved by the particle system editor
  147475. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  147476. * @param scene defines the hosting scene
  147477. * @param gpu If the system will use gpu
  147478. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147479. * @returns a promise that will resolve to the new particle system
  147480. */
  147481. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147482. }
  147483. }
  147484. declare module BABYLON {
  147485. interface Engine {
  147486. /**
  147487. * Create an effect to use with particle systems.
  147488. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  147489. * the particle system for which you want to create a custom effect in the last parameter
  147490. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  147491. * @param uniformsNames defines a list of attribute names
  147492. * @param samplers defines an array of string used to represent textures
  147493. * @param defines defines the string containing the defines to use to compile the shaders
  147494. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  147495. * @param onCompiled defines a function to call when the effect creation is successful
  147496. * @param onError defines a function to call when the effect creation has failed
  147497. * @param particleSystem the particle system you want to create the effect for
  147498. * @returns the new Effect
  147499. */
  147500. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  147501. }
  147502. interface Mesh {
  147503. /**
  147504. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  147505. * @returns an array of IParticleSystem
  147506. */
  147507. getEmittedParticleSystems(): IParticleSystem[];
  147508. /**
  147509. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  147510. * @returns an array of IParticleSystem
  147511. */
  147512. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  147513. }
  147514. }
  147515. declare module BABYLON {
  147516. /** Defines the 4 color options */
  147517. export enum PointColor {
  147518. /** color value */
  147519. Color = 2,
  147520. /** uv value */
  147521. UV = 1,
  147522. /** random value */
  147523. Random = 0,
  147524. /** stated value */
  147525. Stated = 3
  147526. }
  147527. /**
  147528. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  147529. * 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.
  147530. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  147531. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  147532. *
  147533. * Full documentation here : TO BE ENTERED
  147534. */
  147535. export class PointsCloudSystem implements IDisposable {
  147536. /**
  147537. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  147538. * Example : var p = SPS.particles[i];
  147539. */
  147540. particles: CloudPoint[];
  147541. /**
  147542. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  147543. */
  147544. nbParticles: number;
  147545. /**
  147546. * This a counter for your own usage. It's not set by any SPS functions.
  147547. */
  147548. counter: number;
  147549. /**
  147550. * The PCS name. This name is also given to the underlying mesh.
  147551. */
  147552. name: string;
  147553. /**
  147554. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  147555. */
  147556. mesh: Mesh;
  147557. /**
  147558. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  147559. * Please read :
  147560. */
  147561. vars: any;
  147562. /**
  147563. * @hidden
  147564. */
  147565. _size: number;
  147566. private _scene;
  147567. private _promises;
  147568. private _positions;
  147569. private _indices;
  147570. private _normals;
  147571. private _colors;
  147572. private _uvs;
  147573. private _indices32;
  147574. private _positions32;
  147575. private _colors32;
  147576. private _uvs32;
  147577. private _updatable;
  147578. private _isVisibilityBoxLocked;
  147579. private _alwaysVisible;
  147580. private _groups;
  147581. private _groupCounter;
  147582. private _computeParticleColor;
  147583. private _computeParticleTexture;
  147584. private _computeParticleRotation;
  147585. private _computeBoundingBox;
  147586. private _isReady;
  147587. /**
  147588. * Creates a PCS (Points Cloud System) object
  147589. * @param name (String) is the PCS name, this will be the underlying mesh name
  147590. * @param pointSize (number) is the size for each point
  147591. * @param scene (Scene) is the scene in which the PCS is added
  147592. * @param options defines the options of the PCS e.g.
  147593. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  147594. */
  147595. constructor(name: string, pointSize: number, scene: Scene, options?: {
  147596. updatable?: boolean;
  147597. });
  147598. /**
  147599. * Builds the PCS underlying mesh. Returns a standard Mesh.
  147600. * If no points were added to the PCS, the returned mesh is just a single point.
  147601. * @returns a promise for the created mesh
  147602. */
  147603. buildMeshAsync(): Promise<Mesh>;
  147604. /**
  147605. * @hidden
  147606. */
  147607. private _buildMesh;
  147608. private _addParticle;
  147609. private _randomUnitVector;
  147610. private _getColorIndicesForCoord;
  147611. private _setPointsColorOrUV;
  147612. private _colorFromTexture;
  147613. private _calculateDensity;
  147614. /**
  147615. * Adds points to the PCS in random positions within a unit sphere
  147616. * @param nb (positive integer) the number of particles to be created from this model
  147617. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  147618. * @returns the number of groups in the system
  147619. */
  147620. addPoints(nb: number, pointFunction?: any): number;
  147621. /**
  147622. * Adds points to the PCS from the surface of the model shape
  147623. * @param mesh is any Mesh object that will be used as a surface model for the points
  147624. * @param nb (positive integer) the number of particles to be created from this model
  147625. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147626. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147627. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147628. * @returns the number of groups in the system
  147629. */
  147630. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147631. /**
  147632. * Adds points to the PCS inside the model shape
  147633. * @param mesh is any Mesh object that will be used as a surface model for the points
  147634. * @param nb (positive integer) the number of particles to be created from this model
  147635. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147636. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147637. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147638. * @returns the number of groups in the system
  147639. */
  147640. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147641. /**
  147642. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  147643. * This method calls `updateParticle()` for each particle of the SPS.
  147644. * For an animated SPS, it is usually called within the render loop.
  147645. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  147646. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  147647. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  147648. * @returns the PCS.
  147649. */
  147650. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  147651. /**
  147652. * Disposes the PCS.
  147653. */
  147654. dispose(): void;
  147655. /**
  147656. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  147657. * doc :
  147658. * @returns the PCS.
  147659. */
  147660. refreshVisibleSize(): PointsCloudSystem;
  147661. /**
  147662. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  147663. * @param size the size (float) of the visibility box
  147664. * note : this doesn't lock the PCS mesh bounding box.
  147665. * doc :
  147666. */
  147667. setVisibilityBox(size: number): void;
  147668. /**
  147669. * Gets whether the PCS is always visible or not
  147670. * doc :
  147671. */
  147672. get isAlwaysVisible(): boolean;
  147673. /**
  147674. * Sets the PCS as always visible or not
  147675. * doc :
  147676. */
  147677. set isAlwaysVisible(val: boolean);
  147678. /**
  147679. * Tells to `setParticles()` to compute the particle rotations or not
  147680. * Default value : false. The PCS is faster when it's set to false
  147681. * Note : particle rotations are only applied to parent particles
  147682. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  147683. */
  147684. set computeParticleRotation(val: boolean);
  147685. /**
  147686. * Tells to `setParticles()` to compute the particle colors or not.
  147687. * Default value : true. The PCS is faster when it's set to false.
  147688. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147689. */
  147690. set computeParticleColor(val: boolean);
  147691. set computeParticleTexture(val: boolean);
  147692. /**
  147693. * Gets if `setParticles()` computes the particle colors or not.
  147694. * Default value : false. The PCS is faster when it's set to false.
  147695. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147696. */
  147697. get computeParticleColor(): boolean;
  147698. /**
  147699. * Gets if `setParticles()` computes the particle textures or not.
  147700. * Default value : false. The PCS is faster when it's set to false.
  147701. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  147702. */
  147703. get computeParticleTexture(): boolean;
  147704. /**
  147705. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  147706. */
  147707. set computeBoundingBox(val: boolean);
  147708. /**
  147709. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  147710. */
  147711. get computeBoundingBox(): boolean;
  147712. /**
  147713. * This function does nothing. It may be overwritten to set all the particle first values.
  147714. * The PCS doesn't call this function, you may have to call it by your own.
  147715. * doc :
  147716. */
  147717. initParticles(): void;
  147718. /**
  147719. * This function does nothing. It may be overwritten to recycle a particle
  147720. * The PCS doesn't call this function, you can to call it
  147721. * doc :
  147722. * @param particle The particle to recycle
  147723. * @returns the recycled particle
  147724. */
  147725. recycleParticle(particle: CloudPoint): CloudPoint;
  147726. /**
  147727. * Updates a particle : this function should be overwritten by the user.
  147728. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  147729. * doc :
  147730. * @example : just set a particle position or velocity and recycle conditions
  147731. * @param particle The particle to update
  147732. * @returns the updated particle
  147733. */
  147734. updateParticle(particle: CloudPoint): CloudPoint;
  147735. /**
  147736. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  147737. * This does nothing and may be overwritten by the user.
  147738. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147739. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147740. * @param update the boolean update value actually passed to setParticles()
  147741. */
  147742. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147743. /**
  147744. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  147745. * This will be passed three parameters.
  147746. * This does nothing and may be overwritten by the user.
  147747. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147748. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147749. * @param update the boolean update value actually passed to setParticles()
  147750. */
  147751. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147752. }
  147753. }
  147754. declare module BABYLON {
  147755. /**
  147756. * Represents one particle of a points cloud system.
  147757. */
  147758. export class CloudPoint {
  147759. /**
  147760. * particle global index
  147761. */
  147762. idx: number;
  147763. /**
  147764. * The color of the particle
  147765. */
  147766. color: Nullable<Color4>;
  147767. /**
  147768. * The world space position of the particle.
  147769. */
  147770. position: Vector3;
  147771. /**
  147772. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  147773. */
  147774. rotation: Vector3;
  147775. /**
  147776. * The world space rotation quaternion of the particle.
  147777. */
  147778. rotationQuaternion: Nullable<Quaternion>;
  147779. /**
  147780. * The uv of the particle.
  147781. */
  147782. uv: Nullable<Vector2>;
  147783. /**
  147784. * The current speed of the particle.
  147785. */
  147786. velocity: Vector3;
  147787. /**
  147788. * The pivot point in the particle local space.
  147789. */
  147790. pivot: Vector3;
  147791. /**
  147792. * Must the particle be translated from its pivot point in its local space ?
  147793. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  147794. * Default : false
  147795. */
  147796. translateFromPivot: boolean;
  147797. /**
  147798. * Index of this particle in the global "positions" array (Internal use)
  147799. * @hidden
  147800. */
  147801. _pos: number;
  147802. /**
  147803. * @hidden Index of this particle in the global "indices" array (Internal use)
  147804. */
  147805. _ind: number;
  147806. /**
  147807. * Group this particle belongs to
  147808. */
  147809. _group: PointsGroup;
  147810. /**
  147811. * Group id of this particle
  147812. */
  147813. groupId: number;
  147814. /**
  147815. * Index of the particle in its group id (Internal use)
  147816. */
  147817. idxInGroup: number;
  147818. /**
  147819. * @hidden Particle BoundingInfo object (Internal use)
  147820. */
  147821. _boundingInfo: BoundingInfo;
  147822. /**
  147823. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  147824. */
  147825. _pcs: PointsCloudSystem;
  147826. /**
  147827. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  147828. */
  147829. _stillInvisible: boolean;
  147830. /**
  147831. * @hidden Last computed particle rotation matrix
  147832. */
  147833. _rotationMatrix: number[];
  147834. /**
  147835. * Parent particle Id, if any.
  147836. * Default null.
  147837. */
  147838. parentId: Nullable<number>;
  147839. /**
  147840. * @hidden Internal global position in the PCS.
  147841. */
  147842. _globalPosition: Vector3;
  147843. /**
  147844. * Creates a Point Cloud object.
  147845. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  147846. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  147847. * @param group (PointsGroup) is the group the particle belongs to
  147848. * @param groupId (integer) is the group identifier in the PCS.
  147849. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  147850. * @param pcs defines the PCS it is associated to
  147851. */
  147852. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  147853. /**
  147854. * get point size
  147855. */
  147856. get size(): Vector3;
  147857. /**
  147858. * Set point size
  147859. */
  147860. set size(scale: Vector3);
  147861. /**
  147862. * Legacy support, changed quaternion to rotationQuaternion
  147863. */
  147864. get quaternion(): Nullable<Quaternion>;
  147865. /**
  147866. * Legacy support, changed quaternion to rotationQuaternion
  147867. */
  147868. set quaternion(q: Nullable<Quaternion>);
  147869. /**
  147870. * Returns a boolean. True if the particle intersects a mesh, else false
  147871. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  147872. * @param target is the object (point or mesh) what the intersection is computed against
  147873. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  147874. * @returns true if it intersects
  147875. */
  147876. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  147877. /**
  147878. * get the rotation matrix of the particle
  147879. * @hidden
  147880. */
  147881. getRotationMatrix(m: Matrix): void;
  147882. }
  147883. /**
  147884. * Represents a group of points in a points cloud system
  147885. * * PCS internal tool, don't use it manually.
  147886. */
  147887. export class PointsGroup {
  147888. /**
  147889. * The group id
  147890. * @hidden
  147891. */
  147892. groupID: number;
  147893. /**
  147894. * image data for group (internal use)
  147895. * @hidden
  147896. */
  147897. _groupImageData: Nullable<ArrayBufferView>;
  147898. /**
  147899. * Image Width (internal use)
  147900. * @hidden
  147901. */
  147902. _groupImgWidth: number;
  147903. /**
  147904. * Image Height (internal use)
  147905. * @hidden
  147906. */
  147907. _groupImgHeight: number;
  147908. /**
  147909. * Custom position function (internal use)
  147910. * @hidden
  147911. */
  147912. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  147913. /**
  147914. * density per facet for surface points
  147915. * @hidden
  147916. */
  147917. _groupDensity: number[];
  147918. /**
  147919. * Only when points are colored by texture carries pointer to texture list array
  147920. * @hidden
  147921. */
  147922. _textureNb: number;
  147923. /**
  147924. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  147925. * PCS internal tool, don't use it manually.
  147926. * @hidden
  147927. */
  147928. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  147929. }
  147930. }
  147931. declare module BABYLON {
  147932. interface Scene {
  147933. /** @hidden (Backing field) */
  147934. _physicsEngine: Nullable<IPhysicsEngine>;
  147935. /** @hidden */
  147936. _physicsTimeAccumulator: number;
  147937. /**
  147938. * Gets the current physics engine
  147939. * @returns a IPhysicsEngine or null if none attached
  147940. */
  147941. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  147942. /**
  147943. * Enables physics to the current scene
  147944. * @param gravity defines the scene's gravity for the physics engine
  147945. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  147946. * @return a boolean indicating if the physics engine was initialized
  147947. */
  147948. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  147949. /**
  147950. * Disables and disposes the physics engine associated with the scene
  147951. */
  147952. disablePhysicsEngine(): void;
  147953. /**
  147954. * Gets a boolean indicating if there is an active physics engine
  147955. * @returns a boolean indicating if there is an active physics engine
  147956. */
  147957. isPhysicsEnabled(): boolean;
  147958. /**
  147959. * Deletes a physics compound impostor
  147960. * @param compound defines the compound to delete
  147961. */
  147962. deleteCompoundImpostor(compound: any): void;
  147963. /**
  147964. * An event triggered when physic simulation is about to be run
  147965. */
  147966. onBeforePhysicsObservable: Observable<Scene>;
  147967. /**
  147968. * An event triggered when physic simulation has been done
  147969. */
  147970. onAfterPhysicsObservable: Observable<Scene>;
  147971. }
  147972. interface AbstractMesh {
  147973. /** @hidden */
  147974. _physicsImpostor: Nullable<PhysicsImpostor>;
  147975. /**
  147976. * Gets or sets impostor used for physic simulation
  147977. * @see https://doc.babylonjs.com/features/physics_engine
  147978. */
  147979. physicsImpostor: Nullable<PhysicsImpostor>;
  147980. /**
  147981. * Gets the current physics impostor
  147982. * @see https://doc.babylonjs.com/features/physics_engine
  147983. * @returns a physics impostor or null
  147984. */
  147985. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  147986. /** Apply a physic impulse to the mesh
  147987. * @param force defines the force to apply
  147988. * @param contactPoint defines where to apply the force
  147989. * @returns the current mesh
  147990. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  147991. */
  147992. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  147993. /**
  147994. * Creates a physic joint between two meshes
  147995. * @param otherMesh defines the other mesh to use
  147996. * @param pivot1 defines the pivot to use on this mesh
  147997. * @param pivot2 defines the pivot to use on the other mesh
  147998. * @param options defines additional options (can be plugin dependent)
  147999. * @returns the current mesh
  148000. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  148001. */
  148002. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  148003. /** @hidden */
  148004. _disposePhysicsObserver: Nullable<Observer<Node>>;
  148005. }
  148006. /**
  148007. * Defines the physics engine scene component responsible to manage a physics engine
  148008. */
  148009. export class PhysicsEngineSceneComponent implements ISceneComponent {
  148010. /**
  148011. * The component name helpful to identify the component in the list of scene components.
  148012. */
  148013. readonly name: string;
  148014. /**
  148015. * The scene the component belongs to.
  148016. */
  148017. scene: Scene;
  148018. /**
  148019. * Creates a new instance of the component for the given scene
  148020. * @param scene Defines the scene to register the component in
  148021. */
  148022. constructor(scene: Scene);
  148023. /**
  148024. * Registers the component in a given scene
  148025. */
  148026. register(): void;
  148027. /**
  148028. * Rebuilds the elements related to this component in case of
  148029. * context lost for instance.
  148030. */
  148031. rebuild(): void;
  148032. /**
  148033. * Disposes the component and the associated ressources
  148034. */
  148035. dispose(): void;
  148036. }
  148037. }
  148038. declare module BABYLON {
  148039. /**
  148040. * A helper for physics simulations
  148041. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148042. */
  148043. export class PhysicsHelper {
  148044. private _scene;
  148045. private _physicsEngine;
  148046. /**
  148047. * Initializes the Physics helper
  148048. * @param scene Babylon.js scene
  148049. */
  148050. constructor(scene: Scene);
  148051. /**
  148052. * Applies a radial explosion impulse
  148053. * @param origin the origin of the explosion
  148054. * @param radiusOrEventOptions the radius or the options of radial explosion
  148055. * @param strength the explosion strength
  148056. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148057. * @returns A physics radial explosion event, or null
  148058. */
  148059. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148060. /**
  148061. * Applies a radial explosion force
  148062. * @param origin the origin of the explosion
  148063. * @param radiusOrEventOptions the radius or the options of radial explosion
  148064. * @param strength the explosion strength
  148065. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148066. * @returns A physics radial explosion event, or null
  148067. */
  148068. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148069. /**
  148070. * Creates a gravitational field
  148071. * @param origin the origin of the explosion
  148072. * @param radiusOrEventOptions the radius or the options of radial explosion
  148073. * @param strength the explosion strength
  148074. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148075. * @returns A physics gravitational field event, or null
  148076. */
  148077. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  148078. /**
  148079. * Creates a physics updraft event
  148080. * @param origin the origin of the updraft
  148081. * @param radiusOrEventOptions the radius or the options of the updraft
  148082. * @param strength the strength of the updraft
  148083. * @param height the height of the updraft
  148084. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  148085. * @returns A physics updraft event, or null
  148086. */
  148087. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  148088. /**
  148089. * Creates a physics vortex event
  148090. * @param origin the of the vortex
  148091. * @param radiusOrEventOptions the radius or the options of the vortex
  148092. * @param strength the strength of the vortex
  148093. * @param height the height of the vortex
  148094. * @returns a Physics vortex event, or null
  148095. * A physics vortex event or null
  148096. */
  148097. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  148098. }
  148099. /**
  148100. * Represents a physics radial explosion event
  148101. */
  148102. class PhysicsRadialExplosionEvent {
  148103. private _scene;
  148104. private _options;
  148105. private _sphere;
  148106. private _dataFetched;
  148107. /**
  148108. * Initializes a radial explosioin event
  148109. * @param _scene BabylonJS scene
  148110. * @param _options The options for the vortex event
  148111. */
  148112. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  148113. /**
  148114. * Returns the data related to the radial explosion event (sphere).
  148115. * @returns The radial explosion event data
  148116. */
  148117. getData(): PhysicsRadialExplosionEventData;
  148118. /**
  148119. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  148120. * @param impostor A physics imposter
  148121. * @param origin the origin of the explosion
  148122. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  148123. */
  148124. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  148125. /**
  148126. * Triggers affecterd impostors callbacks
  148127. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  148128. */
  148129. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  148130. /**
  148131. * Disposes the sphere.
  148132. * @param force Specifies if the sphere should be disposed by force
  148133. */
  148134. dispose(force?: boolean): void;
  148135. /*** Helpers ***/
  148136. private _prepareSphere;
  148137. private _intersectsWithSphere;
  148138. }
  148139. /**
  148140. * Represents a gravitational field event
  148141. */
  148142. class PhysicsGravitationalFieldEvent {
  148143. private _physicsHelper;
  148144. private _scene;
  148145. private _origin;
  148146. private _options;
  148147. private _tickCallback;
  148148. private _sphere;
  148149. private _dataFetched;
  148150. /**
  148151. * Initializes the physics gravitational field event
  148152. * @param _physicsHelper A physics helper
  148153. * @param _scene BabylonJS scene
  148154. * @param _origin The origin position of the gravitational field event
  148155. * @param _options The options for the vortex event
  148156. */
  148157. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  148158. /**
  148159. * Returns the data related to the gravitational field event (sphere).
  148160. * @returns A gravitational field event
  148161. */
  148162. getData(): PhysicsGravitationalFieldEventData;
  148163. /**
  148164. * Enables the gravitational field.
  148165. */
  148166. enable(): void;
  148167. /**
  148168. * Disables the gravitational field.
  148169. */
  148170. disable(): void;
  148171. /**
  148172. * Disposes the sphere.
  148173. * @param force The force to dispose from the gravitational field event
  148174. */
  148175. dispose(force?: boolean): void;
  148176. private _tick;
  148177. }
  148178. /**
  148179. * Represents a physics updraft event
  148180. */
  148181. class PhysicsUpdraftEvent {
  148182. private _scene;
  148183. private _origin;
  148184. private _options;
  148185. private _physicsEngine;
  148186. private _originTop;
  148187. private _originDirection;
  148188. private _tickCallback;
  148189. private _cylinder;
  148190. private _cylinderPosition;
  148191. private _dataFetched;
  148192. /**
  148193. * Initializes the physics updraft event
  148194. * @param _scene BabylonJS scene
  148195. * @param _origin The origin position of the updraft
  148196. * @param _options The options for the updraft event
  148197. */
  148198. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  148199. /**
  148200. * Returns the data related to the updraft event (cylinder).
  148201. * @returns A physics updraft event
  148202. */
  148203. getData(): PhysicsUpdraftEventData;
  148204. /**
  148205. * Enables the updraft.
  148206. */
  148207. enable(): void;
  148208. /**
  148209. * Disables the updraft.
  148210. */
  148211. disable(): void;
  148212. /**
  148213. * Disposes the cylinder.
  148214. * @param force Specifies if the updraft should be disposed by force
  148215. */
  148216. dispose(force?: boolean): void;
  148217. private getImpostorHitData;
  148218. private _tick;
  148219. /*** Helpers ***/
  148220. private _prepareCylinder;
  148221. private _intersectsWithCylinder;
  148222. }
  148223. /**
  148224. * Represents a physics vortex event
  148225. */
  148226. class PhysicsVortexEvent {
  148227. private _scene;
  148228. private _origin;
  148229. private _options;
  148230. private _physicsEngine;
  148231. private _originTop;
  148232. private _tickCallback;
  148233. private _cylinder;
  148234. private _cylinderPosition;
  148235. private _dataFetched;
  148236. /**
  148237. * Initializes the physics vortex event
  148238. * @param _scene The BabylonJS scene
  148239. * @param _origin The origin position of the vortex
  148240. * @param _options The options for the vortex event
  148241. */
  148242. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  148243. /**
  148244. * Returns the data related to the vortex event (cylinder).
  148245. * @returns The physics vortex event data
  148246. */
  148247. getData(): PhysicsVortexEventData;
  148248. /**
  148249. * Enables the vortex.
  148250. */
  148251. enable(): void;
  148252. /**
  148253. * Disables the cortex.
  148254. */
  148255. disable(): void;
  148256. /**
  148257. * Disposes the sphere.
  148258. * @param force
  148259. */
  148260. dispose(force?: boolean): void;
  148261. private getImpostorHitData;
  148262. private _tick;
  148263. /*** Helpers ***/
  148264. private _prepareCylinder;
  148265. private _intersectsWithCylinder;
  148266. }
  148267. /**
  148268. * Options fot the radial explosion event
  148269. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148270. */
  148271. export class PhysicsRadialExplosionEventOptions {
  148272. /**
  148273. * The radius of the sphere for the radial explosion.
  148274. */
  148275. radius: number;
  148276. /**
  148277. * The strenth of the explosion.
  148278. */
  148279. strength: number;
  148280. /**
  148281. * The strenght of the force in correspondence to the distance of the affected object
  148282. */
  148283. falloff: PhysicsRadialImpulseFalloff;
  148284. /**
  148285. * Sphere options for the radial explosion.
  148286. */
  148287. sphere: {
  148288. segments: number;
  148289. diameter: number;
  148290. };
  148291. /**
  148292. * Sphere options for the radial explosion.
  148293. */
  148294. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  148295. }
  148296. /**
  148297. * Options fot the updraft event
  148298. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148299. */
  148300. export class PhysicsUpdraftEventOptions {
  148301. /**
  148302. * The radius of the cylinder for the vortex
  148303. */
  148304. radius: number;
  148305. /**
  148306. * The strenth of the updraft.
  148307. */
  148308. strength: number;
  148309. /**
  148310. * The height of the cylinder for the updraft.
  148311. */
  148312. height: number;
  148313. /**
  148314. * The mode for the the updraft.
  148315. */
  148316. updraftMode: PhysicsUpdraftMode;
  148317. }
  148318. /**
  148319. * Options fot the vortex event
  148320. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148321. */
  148322. export class PhysicsVortexEventOptions {
  148323. /**
  148324. * The radius of the cylinder for the vortex
  148325. */
  148326. radius: number;
  148327. /**
  148328. * The strenth of the vortex.
  148329. */
  148330. strength: number;
  148331. /**
  148332. * The height of the cylinder for the vortex.
  148333. */
  148334. height: number;
  148335. /**
  148336. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  148337. */
  148338. centripetalForceThreshold: number;
  148339. /**
  148340. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  148341. */
  148342. centripetalForceMultiplier: number;
  148343. /**
  148344. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  148345. */
  148346. centrifugalForceMultiplier: number;
  148347. /**
  148348. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  148349. */
  148350. updraftForceMultiplier: number;
  148351. }
  148352. /**
  148353. * The strenght of the force in correspondence to the distance of the affected object
  148354. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148355. */
  148356. export enum PhysicsRadialImpulseFalloff {
  148357. /** Defines that impulse is constant in strength across it's whole radius */
  148358. Constant = 0,
  148359. /** Defines that impulse gets weaker if it's further from the origin */
  148360. Linear = 1
  148361. }
  148362. /**
  148363. * The strength of the force in correspondence to the distance of the affected object
  148364. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148365. */
  148366. export enum PhysicsUpdraftMode {
  148367. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  148368. Center = 0,
  148369. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  148370. Perpendicular = 1
  148371. }
  148372. /**
  148373. * Interface for a physics hit data
  148374. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148375. */
  148376. export interface PhysicsHitData {
  148377. /**
  148378. * The force applied at the contact point
  148379. */
  148380. force: Vector3;
  148381. /**
  148382. * The contact point
  148383. */
  148384. contactPoint: Vector3;
  148385. /**
  148386. * The distance from the origin to the contact point
  148387. */
  148388. distanceFromOrigin: number;
  148389. }
  148390. /**
  148391. * Interface for radial explosion event data
  148392. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148393. */
  148394. export interface PhysicsRadialExplosionEventData {
  148395. /**
  148396. * A sphere used for the radial explosion event
  148397. */
  148398. sphere: Mesh;
  148399. }
  148400. /**
  148401. * Interface for gravitational field event data
  148402. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148403. */
  148404. export interface PhysicsGravitationalFieldEventData {
  148405. /**
  148406. * A sphere mesh used for the gravitational field event
  148407. */
  148408. sphere: Mesh;
  148409. }
  148410. /**
  148411. * Interface for updraft event data
  148412. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148413. */
  148414. export interface PhysicsUpdraftEventData {
  148415. /**
  148416. * A cylinder used for the updraft event
  148417. */
  148418. cylinder: Mesh;
  148419. }
  148420. /**
  148421. * Interface for vortex event data
  148422. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148423. */
  148424. export interface PhysicsVortexEventData {
  148425. /**
  148426. * A cylinder used for the vortex event
  148427. */
  148428. cylinder: Mesh;
  148429. }
  148430. /**
  148431. * Interface for an affected physics impostor
  148432. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148433. */
  148434. export interface PhysicsAffectedImpostorWithData {
  148435. /**
  148436. * The impostor affected by the effect
  148437. */
  148438. impostor: PhysicsImpostor;
  148439. /**
  148440. * The data about the hit/horce from the explosion
  148441. */
  148442. hitData: PhysicsHitData;
  148443. }
  148444. }
  148445. declare module BABYLON {
  148446. /** @hidden */
  148447. export var blackAndWhitePixelShader: {
  148448. name: string;
  148449. shader: string;
  148450. };
  148451. }
  148452. declare module BABYLON {
  148453. /**
  148454. * Post process used to render in black and white
  148455. */
  148456. export class BlackAndWhitePostProcess extends PostProcess {
  148457. /**
  148458. * Linear about to convert he result to black and white (default: 1)
  148459. */
  148460. degree: number;
  148461. /**
  148462. * Gets a string identifying the name of the class
  148463. * @returns "BlackAndWhitePostProcess" string
  148464. */
  148465. getClassName(): string;
  148466. /**
  148467. * Creates a black and white post process
  148468. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  148469. * @param name The name of the effect.
  148470. * @param options The required width/height ratio to downsize to before computing the render pass.
  148471. * @param camera The camera to apply the render pass to.
  148472. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148473. * @param engine The engine which the post process will be applied. (default: current engine)
  148474. * @param reusable If the post process can be reused on the same frame. (default: false)
  148475. */
  148476. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148477. /** @hidden */
  148478. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  148479. }
  148480. }
  148481. declare module BABYLON {
  148482. /**
  148483. * This represents a set of one or more post processes in Babylon.
  148484. * A post process can be used to apply a shader to a texture after it is rendered.
  148485. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148486. */
  148487. export class PostProcessRenderEffect {
  148488. private _postProcesses;
  148489. private _getPostProcesses;
  148490. private _singleInstance;
  148491. private _cameras;
  148492. private _indicesForCamera;
  148493. /**
  148494. * Name of the effect
  148495. * @hidden
  148496. */
  148497. _name: string;
  148498. /**
  148499. * Instantiates a post process render effect.
  148500. * A post process can be used to apply a shader to a texture after it is rendered.
  148501. * @param engine The engine the effect is tied to
  148502. * @param name The name of the effect
  148503. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  148504. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  148505. */
  148506. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  148507. /**
  148508. * Checks if all the post processes in the effect are supported.
  148509. */
  148510. get isSupported(): boolean;
  148511. /**
  148512. * Updates the current state of the effect
  148513. * @hidden
  148514. */
  148515. _update(): void;
  148516. /**
  148517. * Attaches the effect on cameras
  148518. * @param cameras The camera to attach to.
  148519. * @hidden
  148520. */
  148521. _attachCameras(cameras: Camera): void;
  148522. /**
  148523. * Attaches the effect on cameras
  148524. * @param cameras The camera to attach to.
  148525. * @hidden
  148526. */
  148527. _attachCameras(cameras: Camera[]): void;
  148528. /**
  148529. * Detaches the effect on cameras
  148530. * @param cameras The camera to detatch from.
  148531. * @hidden
  148532. */
  148533. _detachCameras(cameras: Camera): void;
  148534. /**
  148535. * Detatches the effect on cameras
  148536. * @param cameras The camera to detatch from.
  148537. * @hidden
  148538. */
  148539. _detachCameras(cameras: Camera[]): void;
  148540. /**
  148541. * Enables the effect on given cameras
  148542. * @param cameras The camera to enable.
  148543. * @hidden
  148544. */
  148545. _enable(cameras: Camera): void;
  148546. /**
  148547. * Enables the effect on given cameras
  148548. * @param cameras The camera to enable.
  148549. * @hidden
  148550. */
  148551. _enable(cameras: Nullable<Camera[]>): void;
  148552. /**
  148553. * Disables the effect on the given cameras
  148554. * @param cameras The camera to disable.
  148555. * @hidden
  148556. */
  148557. _disable(cameras: Camera): void;
  148558. /**
  148559. * Disables the effect on the given cameras
  148560. * @param cameras The camera to disable.
  148561. * @hidden
  148562. */
  148563. _disable(cameras: Nullable<Camera[]>): void;
  148564. /**
  148565. * Gets a list of the post processes contained in the effect.
  148566. * @param camera The camera to get the post processes on.
  148567. * @returns The list of the post processes in the effect.
  148568. */
  148569. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  148570. }
  148571. }
  148572. declare module BABYLON {
  148573. /** @hidden */
  148574. export var extractHighlightsPixelShader: {
  148575. name: string;
  148576. shader: string;
  148577. };
  148578. }
  148579. declare module BABYLON {
  148580. /**
  148581. * 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.
  148582. */
  148583. export class ExtractHighlightsPostProcess extends PostProcess {
  148584. /**
  148585. * The luminance threshold, pixels below this value will be set to black.
  148586. */
  148587. threshold: number;
  148588. /** @hidden */
  148589. _exposure: number;
  148590. /**
  148591. * Post process which has the input texture to be used when performing highlight extraction
  148592. * @hidden
  148593. */
  148594. _inputPostProcess: Nullable<PostProcess>;
  148595. /**
  148596. * Gets a string identifying the name of the class
  148597. * @returns "ExtractHighlightsPostProcess" string
  148598. */
  148599. getClassName(): string;
  148600. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148601. }
  148602. }
  148603. declare module BABYLON {
  148604. /** @hidden */
  148605. export var bloomMergePixelShader: {
  148606. name: string;
  148607. shader: string;
  148608. };
  148609. }
  148610. declare module BABYLON {
  148611. /**
  148612. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148613. */
  148614. export class BloomMergePostProcess extends PostProcess {
  148615. /** Weight of the bloom to be added to the original input. */
  148616. weight: number;
  148617. /**
  148618. * Gets a string identifying the name of the class
  148619. * @returns "BloomMergePostProcess" string
  148620. */
  148621. getClassName(): string;
  148622. /**
  148623. * Creates a new instance of @see BloomMergePostProcess
  148624. * @param name The name of the effect.
  148625. * @param originalFromInput Post process which's input will be used for the merge.
  148626. * @param blurred Blurred highlights post process which's output will be used.
  148627. * @param weight Weight of the bloom to be added to the original input.
  148628. * @param options The required width/height ratio to downsize to before computing the render pass.
  148629. * @param camera The camera to apply the render pass to.
  148630. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148631. * @param engine The engine which the post process will be applied. (default: current engine)
  148632. * @param reusable If the post process can be reused on the same frame. (default: false)
  148633. * @param textureType Type of textures used when performing the post process. (default: 0)
  148634. * @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)
  148635. */
  148636. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  148637. /** Weight of the bloom to be added to the original input. */
  148638. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148639. }
  148640. }
  148641. declare module BABYLON {
  148642. /**
  148643. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  148644. */
  148645. export class BloomEffect extends PostProcessRenderEffect {
  148646. private bloomScale;
  148647. /**
  148648. * @hidden Internal
  148649. */
  148650. _effects: Array<PostProcess>;
  148651. /**
  148652. * @hidden Internal
  148653. */
  148654. _downscale: ExtractHighlightsPostProcess;
  148655. private _blurX;
  148656. private _blurY;
  148657. private _merge;
  148658. /**
  148659. * The luminance threshold to find bright areas of the image to bloom.
  148660. */
  148661. get threshold(): number;
  148662. set threshold(value: number);
  148663. /**
  148664. * The strength of the bloom.
  148665. */
  148666. get weight(): number;
  148667. set weight(value: number);
  148668. /**
  148669. * Specifies the size of the bloom blur kernel, relative to the final output size
  148670. */
  148671. get kernel(): number;
  148672. set kernel(value: number);
  148673. /**
  148674. * Creates a new instance of @see BloomEffect
  148675. * @param scene The scene the effect belongs to.
  148676. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  148677. * @param bloomKernel The size of the kernel to be used when applying the blur.
  148678. * @param bloomWeight The the strength of bloom.
  148679. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148680. * @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)
  148681. */
  148682. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  148683. /**
  148684. * Disposes each of the internal effects for a given camera.
  148685. * @param camera The camera to dispose the effect on.
  148686. */
  148687. disposeEffects(camera: Camera): void;
  148688. /**
  148689. * @hidden Internal
  148690. */
  148691. _updateEffects(): void;
  148692. /**
  148693. * Internal
  148694. * @returns if all the contained post processes are ready.
  148695. * @hidden
  148696. */
  148697. _isReady(): boolean;
  148698. }
  148699. }
  148700. declare module BABYLON {
  148701. /** @hidden */
  148702. export var chromaticAberrationPixelShader: {
  148703. name: string;
  148704. shader: string;
  148705. };
  148706. }
  148707. declare module BABYLON {
  148708. /**
  148709. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  148710. */
  148711. export class ChromaticAberrationPostProcess extends PostProcess {
  148712. /**
  148713. * The amount of seperation of rgb channels (default: 30)
  148714. */
  148715. aberrationAmount: number;
  148716. /**
  148717. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  148718. */
  148719. radialIntensity: number;
  148720. /**
  148721. * 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))
  148722. */
  148723. direction: Vector2;
  148724. /**
  148725. * 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))
  148726. */
  148727. centerPosition: Vector2;
  148728. /** The width of the screen to apply the effect on */
  148729. screenWidth: number;
  148730. /** The height of the screen to apply the effect on */
  148731. screenHeight: number;
  148732. /**
  148733. * Gets a string identifying the name of the class
  148734. * @returns "ChromaticAberrationPostProcess" string
  148735. */
  148736. getClassName(): string;
  148737. /**
  148738. * Creates a new instance ChromaticAberrationPostProcess
  148739. * @param name The name of the effect.
  148740. * @param screenWidth The width of the screen to apply the effect on.
  148741. * @param screenHeight The height of the screen to apply the effect on.
  148742. * @param options The required width/height ratio to downsize to before computing the render pass.
  148743. * @param camera The camera to apply the render pass to.
  148744. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148745. * @param engine The engine which the post process will be applied. (default: current engine)
  148746. * @param reusable If the post process can be reused on the same frame. (default: false)
  148747. * @param textureType Type of textures used when performing the post process. (default: 0)
  148748. * @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)
  148749. */
  148750. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148751. /** @hidden */
  148752. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  148753. }
  148754. }
  148755. declare module BABYLON {
  148756. /** @hidden */
  148757. export var circleOfConfusionPixelShader: {
  148758. name: string;
  148759. shader: string;
  148760. };
  148761. }
  148762. declare module BABYLON {
  148763. /**
  148764. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  148765. */
  148766. export class CircleOfConfusionPostProcess extends PostProcess {
  148767. /**
  148768. * 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.
  148769. */
  148770. lensSize: number;
  148771. /**
  148772. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148773. */
  148774. fStop: number;
  148775. /**
  148776. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148777. */
  148778. focusDistance: number;
  148779. /**
  148780. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  148781. */
  148782. focalLength: number;
  148783. /**
  148784. * Gets a string identifying the name of the class
  148785. * @returns "CircleOfConfusionPostProcess" string
  148786. */
  148787. getClassName(): string;
  148788. private _depthTexture;
  148789. /**
  148790. * Creates a new instance CircleOfConfusionPostProcess
  148791. * @param name The name of the effect.
  148792. * @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.
  148793. * @param options The required width/height ratio to downsize to before computing the render pass.
  148794. * @param camera The camera to apply the render pass to.
  148795. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148796. * @param engine The engine which the post process will be applied. (default: current engine)
  148797. * @param reusable If the post process can be reused on the same frame. (default: false)
  148798. * @param textureType Type of textures used when performing the post process. (default: 0)
  148799. * @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)
  148800. */
  148801. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148802. /**
  148803. * 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.
  148804. */
  148805. set depthTexture(value: RenderTargetTexture);
  148806. }
  148807. }
  148808. declare module BABYLON {
  148809. /** @hidden */
  148810. export var colorCorrectionPixelShader: {
  148811. name: string;
  148812. shader: string;
  148813. };
  148814. }
  148815. declare module BABYLON {
  148816. /**
  148817. *
  148818. * This post-process allows the modification of rendered colors by using
  148819. * a 'look-up table' (LUT). This effect is also called Color Grading.
  148820. *
  148821. * The object needs to be provided an url to a texture containing the color
  148822. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  148823. * Use an image editing software to tweak the LUT to match your needs.
  148824. *
  148825. * For an example of a color LUT, see here:
  148826. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  148827. * For explanations on color grading, see here:
  148828. * @see http://udn.epicgames.com/Three/ColorGrading.html
  148829. *
  148830. */
  148831. export class ColorCorrectionPostProcess extends PostProcess {
  148832. private _colorTableTexture;
  148833. /**
  148834. * Gets the color table url used to create the LUT texture
  148835. */
  148836. colorTableUrl: string;
  148837. /**
  148838. * Gets a string identifying the name of the class
  148839. * @returns "ColorCorrectionPostProcess" string
  148840. */
  148841. getClassName(): string;
  148842. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148843. /** @hidden */
  148844. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  148845. }
  148846. }
  148847. declare module BABYLON {
  148848. /** @hidden */
  148849. export var convolutionPixelShader: {
  148850. name: string;
  148851. shader: string;
  148852. };
  148853. }
  148854. declare module BABYLON {
  148855. /**
  148856. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  148857. * input texture to perform effects such as edge detection or sharpening
  148858. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  148859. */
  148860. export class ConvolutionPostProcess extends PostProcess {
  148861. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  148862. kernel: number[];
  148863. /**
  148864. * Gets a string identifying the name of the class
  148865. * @returns "ConvolutionPostProcess" string
  148866. */
  148867. getClassName(): string;
  148868. /**
  148869. * Creates a new instance ConvolutionPostProcess
  148870. * @param name The name of the effect.
  148871. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  148872. * @param options The required width/height ratio to downsize to before computing the render pass.
  148873. * @param camera The camera to apply the render pass to.
  148874. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148875. * @param engine The engine which the post process will be applied. (default: current engine)
  148876. * @param reusable If the post process can be reused on the same frame. (default: false)
  148877. * @param textureType Type of textures used when performing the post process. (default: 0)
  148878. */
  148879. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148880. /** @hidden */
  148881. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  148882. /**
  148883. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148884. */
  148885. static EdgeDetect0Kernel: number[];
  148886. /**
  148887. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148888. */
  148889. static EdgeDetect1Kernel: number[];
  148890. /**
  148891. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148892. */
  148893. static EdgeDetect2Kernel: number[];
  148894. /**
  148895. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148896. */
  148897. static SharpenKernel: number[];
  148898. /**
  148899. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148900. */
  148901. static EmbossKernel: number[];
  148902. /**
  148903. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148904. */
  148905. static GaussianKernel: number[];
  148906. }
  148907. }
  148908. declare module BABYLON {
  148909. /**
  148910. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  148911. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  148912. * based on samples that have a large difference in distance than the center pixel.
  148913. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  148914. */
  148915. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  148916. /**
  148917. * The direction the blur should be applied
  148918. */
  148919. direction: Vector2;
  148920. /**
  148921. * Gets a string identifying the name of the class
  148922. * @returns "DepthOfFieldBlurPostProcess" string
  148923. */
  148924. getClassName(): string;
  148925. /**
  148926. * Creates a new instance CircleOfConfusionPostProcess
  148927. * @param name The name of the effect.
  148928. * @param scene The scene the effect belongs to.
  148929. * @param direction The direction the blur should be applied.
  148930. * @param kernel The size of the kernel used to blur.
  148931. * @param options The required width/height ratio to downsize to before computing the render pass.
  148932. * @param camera The camera to apply the render pass to.
  148933. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  148934. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  148935. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148936. * @param engine The engine which the post process will be applied. (default: current engine)
  148937. * @param reusable If the post process can be reused on the same frame. (default: false)
  148938. * @param textureType Type of textures used when performing the post process. (default: 0)
  148939. * @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)
  148940. */
  148941. 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);
  148942. }
  148943. }
  148944. declare module BABYLON {
  148945. /** @hidden */
  148946. export var depthOfFieldMergePixelShader: {
  148947. name: string;
  148948. shader: string;
  148949. };
  148950. }
  148951. declare module BABYLON {
  148952. /**
  148953. * Options to be set when merging outputs from the default pipeline.
  148954. */
  148955. export class DepthOfFieldMergePostProcessOptions {
  148956. /**
  148957. * The original image to merge on top of
  148958. */
  148959. originalFromInput: PostProcess;
  148960. /**
  148961. * Parameters to perform the merge of the depth of field effect
  148962. */
  148963. depthOfField?: {
  148964. circleOfConfusion: PostProcess;
  148965. blurSteps: Array<PostProcess>;
  148966. };
  148967. /**
  148968. * Parameters to perform the merge of bloom effect
  148969. */
  148970. bloom?: {
  148971. blurred: PostProcess;
  148972. weight: number;
  148973. };
  148974. }
  148975. /**
  148976. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148977. */
  148978. export class DepthOfFieldMergePostProcess extends PostProcess {
  148979. private blurSteps;
  148980. /**
  148981. * Gets a string identifying the name of the class
  148982. * @returns "DepthOfFieldMergePostProcess" string
  148983. */
  148984. getClassName(): string;
  148985. /**
  148986. * Creates a new instance of DepthOfFieldMergePostProcess
  148987. * @param name The name of the effect.
  148988. * @param originalFromInput Post process which's input will be used for the merge.
  148989. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  148990. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  148991. * @param options The required width/height ratio to downsize to before computing the render pass.
  148992. * @param camera The camera to apply the render pass to.
  148993. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148994. * @param engine The engine which the post process will be applied. (default: current engine)
  148995. * @param reusable If the post process can be reused on the same frame. (default: false)
  148996. * @param textureType Type of textures used when performing the post process. (default: 0)
  148997. * @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)
  148998. */
  148999. 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);
  149000. /**
  149001. * Updates the effect with the current post process compile time values and recompiles the shader.
  149002. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  149003. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  149004. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  149005. * @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
  149006. * @param onCompiled Called when the shader has been compiled.
  149007. * @param onError Called if there is an error when compiling a shader.
  149008. */
  149009. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  149010. }
  149011. }
  149012. declare module BABYLON {
  149013. /**
  149014. * Specifies the level of max blur that should be applied when using the depth of field effect
  149015. */
  149016. export enum DepthOfFieldEffectBlurLevel {
  149017. /**
  149018. * Subtle blur
  149019. */
  149020. Low = 0,
  149021. /**
  149022. * Medium blur
  149023. */
  149024. Medium = 1,
  149025. /**
  149026. * Large blur
  149027. */
  149028. High = 2
  149029. }
  149030. /**
  149031. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  149032. */
  149033. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  149034. private _circleOfConfusion;
  149035. /**
  149036. * @hidden Internal, blurs from high to low
  149037. */
  149038. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  149039. private _depthOfFieldBlurY;
  149040. private _dofMerge;
  149041. /**
  149042. * @hidden Internal post processes in depth of field effect
  149043. */
  149044. _effects: Array<PostProcess>;
  149045. /**
  149046. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  149047. */
  149048. set focalLength(value: number);
  149049. get focalLength(): number;
  149050. /**
  149051. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149052. */
  149053. set fStop(value: number);
  149054. get fStop(): number;
  149055. /**
  149056. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149057. */
  149058. set focusDistance(value: number);
  149059. get focusDistance(): number;
  149060. /**
  149061. * 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.
  149062. */
  149063. set lensSize(value: number);
  149064. get lensSize(): number;
  149065. /**
  149066. * Creates a new instance DepthOfFieldEffect
  149067. * @param scene The scene the effect belongs to.
  149068. * @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.
  149069. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149070. * @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)
  149071. */
  149072. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  149073. /**
  149074. * Get the current class name of the current effet
  149075. * @returns "DepthOfFieldEffect"
  149076. */
  149077. getClassName(): string;
  149078. /**
  149079. * 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.
  149080. */
  149081. set depthTexture(value: RenderTargetTexture);
  149082. /**
  149083. * Disposes each of the internal effects for a given camera.
  149084. * @param camera The camera to dispose the effect on.
  149085. */
  149086. disposeEffects(camera: Camera): void;
  149087. /**
  149088. * @hidden Internal
  149089. */
  149090. _updateEffects(): void;
  149091. /**
  149092. * Internal
  149093. * @returns if all the contained post processes are ready.
  149094. * @hidden
  149095. */
  149096. _isReady(): boolean;
  149097. }
  149098. }
  149099. declare module BABYLON {
  149100. /** @hidden */
  149101. export var displayPassPixelShader: {
  149102. name: string;
  149103. shader: string;
  149104. };
  149105. }
  149106. declare module BABYLON {
  149107. /**
  149108. * DisplayPassPostProcess which produces an output the same as it's input
  149109. */
  149110. export class DisplayPassPostProcess extends PostProcess {
  149111. /**
  149112. * Gets a string identifying the name of the class
  149113. * @returns "DisplayPassPostProcess" string
  149114. */
  149115. getClassName(): string;
  149116. /**
  149117. * Creates the DisplayPassPostProcess
  149118. * @param name The name of the effect.
  149119. * @param options The required width/height ratio to downsize to before computing the render pass.
  149120. * @param camera The camera to apply the render pass to.
  149121. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149122. * @param engine The engine which the post process will be applied. (default: current engine)
  149123. * @param reusable If the post process can be reused on the same frame. (default: false)
  149124. */
  149125. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149126. /** @hidden */
  149127. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  149128. }
  149129. }
  149130. declare module BABYLON {
  149131. /** @hidden */
  149132. export var filterPixelShader: {
  149133. name: string;
  149134. shader: string;
  149135. };
  149136. }
  149137. declare module BABYLON {
  149138. /**
  149139. * Applies a kernel filter to the image
  149140. */
  149141. export class FilterPostProcess extends PostProcess {
  149142. /** The matrix to be applied to the image */
  149143. kernelMatrix: Matrix;
  149144. /**
  149145. * Gets a string identifying the name of the class
  149146. * @returns "FilterPostProcess" string
  149147. */
  149148. getClassName(): string;
  149149. /**
  149150. *
  149151. * @param name The name of the effect.
  149152. * @param kernelMatrix The matrix to be applied to the image
  149153. * @param options The required width/height ratio to downsize to before computing the render pass.
  149154. * @param camera The camera to apply the render pass to.
  149155. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149156. * @param engine The engine which the post process will be applied. (default: current engine)
  149157. * @param reusable If the post process can be reused on the same frame. (default: false)
  149158. */
  149159. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149160. /** @hidden */
  149161. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  149162. }
  149163. }
  149164. declare module BABYLON {
  149165. /** @hidden */
  149166. export var fxaaPixelShader: {
  149167. name: string;
  149168. shader: string;
  149169. };
  149170. }
  149171. declare module BABYLON {
  149172. /** @hidden */
  149173. export var fxaaVertexShader: {
  149174. name: string;
  149175. shader: string;
  149176. };
  149177. }
  149178. declare module BABYLON {
  149179. /**
  149180. * Fxaa post process
  149181. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  149182. */
  149183. export class FxaaPostProcess extends PostProcess {
  149184. /**
  149185. * Gets a string identifying the name of the class
  149186. * @returns "FxaaPostProcess" string
  149187. */
  149188. getClassName(): string;
  149189. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149190. private _getDefines;
  149191. /** @hidden */
  149192. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  149193. }
  149194. }
  149195. declare module BABYLON {
  149196. /** @hidden */
  149197. export var grainPixelShader: {
  149198. name: string;
  149199. shader: string;
  149200. };
  149201. }
  149202. declare module BABYLON {
  149203. /**
  149204. * The GrainPostProcess adds noise to the image at mid luminance levels
  149205. */
  149206. export class GrainPostProcess extends PostProcess {
  149207. /**
  149208. * The intensity of the grain added (default: 30)
  149209. */
  149210. intensity: number;
  149211. /**
  149212. * If the grain should be randomized on every frame
  149213. */
  149214. animated: boolean;
  149215. /**
  149216. * Gets a string identifying the name of the class
  149217. * @returns "GrainPostProcess" string
  149218. */
  149219. getClassName(): string;
  149220. /**
  149221. * Creates a new instance of @see GrainPostProcess
  149222. * @param name The name of the effect.
  149223. * @param options The required width/height ratio to downsize to before computing the render pass.
  149224. * @param camera The camera to apply the render pass to.
  149225. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149226. * @param engine The engine which the post process will be applied. (default: current engine)
  149227. * @param reusable If the post process can be reused on the same frame. (default: false)
  149228. * @param textureType Type of textures used when performing the post process. (default: 0)
  149229. * @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)
  149230. */
  149231. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149232. /** @hidden */
  149233. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  149234. }
  149235. }
  149236. declare module BABYLON {
  149237. /** @hidden */
  149238. export var highlightsPixelShader: {
  149239. name: string;
  149240. shader: string;
  149241. };
  149242. }
  149243. declare module BABYLON {
  149244. /**
  149245. * Extracts highlights from the image
  149246. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149247. */
  149248. export class HighlightsPostProcess extends PostProcess {
  149249. /**
  149250. * Gets a string identifying the name of the class
  149251. * @returns "HighlightsPostProcess" string
  149252. */
  149253. getClassName(): string;
  149254. /**
  149255. * Extracts highlights from the image
  149256. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149257. * @param name The name of the effect.
  149258. * @param options The required width/height ratio to downsize to before computing the render pass.
  149259. * @param camera The camera to apply the render pass to.
  149260. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149261. * @param engine The engine which the post process will be applied. (default: current engine)
  149262. * @param reusable If the post process can be reused on the same frame. (default: false)
  149263. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  149264. */
  149265. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149266. }
  149267. }
  149268. declare module BABYLON {
  149269. /** @hidden */
  149270. export var mrtFragmentDeclaration: {
  149271. name: string;
  149272. shader: string;
  149273. };
  149274. }
  149275. declare module BABYLON {
  149276. /** @hidden */
  149277. export var geometryPixelShader: {
  149278. name: string;
  149279. shader: string;
  149280. };
  149281. }
  149282. declare module BABYLON {
  149283. /** @hidden */
  149284. export var geometryVertexShader: {
  149285. name: string;
  149286. shader: string;
  149287. };
  149288. }
  149289. declare module BABYLON {
  149290. /** @hidden */
  149291. interface ISavedTransformationMatrix {
  149292. world: Matrix;
  149293. viewProjection: Matrix;
  149294. }
  149295. /**
  149296. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  149297. */
  149298. export class GeometryBufferRenderer {
  149299. /**
  149300. * Constant used to retrieve the position texture index in the G-Buffer textures array
  149301. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  149302. */
  149303. static readonly POSITION_TEXTURE_TYPE: number;
  149304. /**
  149305. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  149306. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  149307. */
  149308. static readonly VELOCITY_TEXTURE_TYPE: number;
  149309. /**
  149310. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  149311. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  149312. */
  149313. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  149314. /**
  149315. * Dictionary used to store the previous transformation matrices of each rendered mesh
  149316. * in order to compute objects velocities when enableVelocity is set to "true"
  149317. * @hidden
  149318. */
  149319. _previousTransformationMatrices: {
  149320. [index: number]: ISavedTransformationMatrix;
  149321. };
  149322. /**
  149323. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  149324. * in order to compute objects velocities when enableVelocity is set to "true"
  149325. * @hidden
  149326. */
  149327. _previousBonesTransformationMatrices: {
  149328. [index: number]: Float32Array;
  149329. };
  149330. /**
  149331. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  149332. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  149333. */
  149334. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  149335. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  149336. renderTransparentMeshes: boolean;
  149337. private _scene;
  149338. private _resizeObserver;
  149339. private _multiRenderTarget;
  149340. private _ratio;
  149341. private _enablePosition;
  149342. private _enableVelocity;
  149343. private _enableReflectivity;
  149344. private _positionIndex;
  149345. private _velocityIndex;
  149346. private _reflectivityIndex;
  149347. protected _effect: Effect;
  149348. protected _cachedDefines: string;
  149349. /**
  149350. * Set the render list (meshes to be rendered) used in the G buffer.
  149351. */
  149352. set renderList(meshes: Mesh[]);
  149353. /**
  149354. * Gets wether or not G buffer are supported by the running hardware.
  149355. * This requires draw buffer supports
  149356. */
  149357. get isSupported(): boolean;
  149358. /**
  149359. * Returns the index of the given texture type in the G-Buffer textures array
  149360. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  149361. * @returns the index of the given texture type in the G-Buffer textures array
  149362. */
  149363. getTextureIndex(textureType: number): number;
  149364. /**
  149365. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  149366. */
  149367. get enablePosition(): boolean;
  149368. /**
  149369. * Sets whether or not objects positions are enabled for the G buffer.
  149370. */
  149371. set enablePosition(enable: boolean);
  149372. /**
  149373. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  149374. */
  149375. get enableVelocity(): boolean;
  149376. /**
  149377. * Sets wether or not objects velocities are enabled for the G buffer.
  149378. */
  149379. set enableVelocity(enable: boolean);
  149380. /**
  149381. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  149382. */
  149383. get enableReflectivity(): boolean;
  149384. /**
  149385. * Sets wether or not objects roughness are enabled for the G buffer.
  149386. */
  149387. set enableReflectivity(enable: boolean);
  149388. /**
  149389. * Gets the scene associated with the buffer.
  149390. */
  149391. get scene(): Scene;
  149392. /**
  149393. * Gets the ratio used by the buffer during its creation.
  149394. * How big is the buffer related to the main canvas.
  149395. */
  149396. get ratio(): number;
  149397. /** @hidden */
  149398. static _SceneComponentInitialization: (scene: Scene) => void;
  149399. /**
  149400. * Creates a new G Buffer for the scene
  149401. * @param scene The scene the buffer belongs to
  149402. * @param ratio How big is the buffer related to the main canvas.
  149403. */
  149404. constructor(scene: Scene, ratio?: number);
  149405. /**
  149406. * Checks wether everything is ready to render a submesh to the G buffer.
  149407. * @param subMesh the submesh to check readiness for
  149408. * @param useInstances is the mesh drawn using instance or not
  149409. * @returns true if ready otherwise false
  149410. */
  149411. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149412. /**
  149413. * Gets the current underlying G Buffer.
  149414. * @returns the buffer
  149415. */
  149416. getGBuffer(): MultiRenderTarget;
  149417. /**
  149418. * Gets the number of samples used to render the buffer (anti aliasing).
  149419. */
  149420. get samples(): number;
  149421. /**
  149422. * Sets the number of samples used to render the buffer (anti aliasing).
  149423. */
  149424. set samples(value: number);
  149425. /**
  149426. * Disposes the renderer and frees up associated resources.
  149427. */
  149428. dispose(): void;
  149429. protected _createRenderTargets(): void;
  149430. private _copyBonesTransformationMatrices;
  149431. }
  149432. }
  149433. declare module BABYLON {
  149434. interface Scene {
  149435. /** @hidden (Backing field) */
  149436. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149437. /**
  149438. * Gets or Sets the current geometry buffer associated to the scene.
  149439. */
  149440. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149441. /**
  149442. * Enables a GeometryBufferRender and associates it with the scene
  149443. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  149444. * @returns the GeometryBufferRenderer
  149445. */
  149446. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  149447. /**
  149448. * Disables the GeometryBufferRender associated with the scene
  149449. */
  149450. disableGeometryBufferRenderer(): void;
  149451. }
  149452. /**
  149453. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149454. * in several rendering techniques.
  149455. */
  149456. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  149457. /**
  149458. * The component name helpful to identify the component in the list of scene components.
  149459. */
  149460. readonly name: string;
  149461. /**
  149462. * The scene the component belongs to.
  149463. */
  149464. scene: Scene;
  149465. /**
  149466. * Creates a new instance of the component for the given scene
  149467. * @param scene Defines the scene to register the component in
  149468. */
  149469. constructor(scene: Scene);
  149470. /**
  149471. * Registers the component in a given scene
  149472. */
  149473. register(): void;
  149474. /**
  149475. * Rebuilds the elements related to this component in case of
  149476. * context lost for instance.
  149477. */
  149478. rebuild(): void;
  149479. /**
  149480. * Disposes the component and the associated ressources
  149481. */
  149482. dispose(): void;
  149483. private _gatherRenderTargets;
  149484. }
  149485. }
  149486. declare module BABYLON {
  149487. /** @hidden */
  149488. export var motionBlurPixelShader: {
  149489. name: string;
  149490. shader: string;
  149491. };
  149492. }
  149493. declare module BABYLON {
  149494. /**
  149495. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  149496. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  149497. * As an example, all you have to do is to create the post-process:
  149498. * var mb = new BABYLON.MotionBlurPostProcess(
  149499. * 'mb', // The name of the effect.
  149500. * scene, // The scene containing the objects to blur according to their velocity.
  149501. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  149502. * camera // The camera to apply the render pass to.
  149503. * );
  149504. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  149505. */
  149506. export class MotionBlurPostProcess extends PostProcess {
  149507. /**
  149508. * Defines how much the image is blurred by the movement. Default value is equal to 1
  149509. */
  149510. motionStrength: number;
  149511. /**
  149512. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  149513. */
  149514. get motionBlurSamples(): number;
  149515. /**
  149516. * Sets the number of iterations to be used for motion blur quality
  149517. */
  149518. set motionBlurSamples(samples: number);
  149519. private _motionBlurSamples;
  149520. private _geometryBufferRenderer;
  149521. /**
  149522. * Gets a string identifying the name of the class
  149523. * @returns "MotionBlurPostProcess" string
  149524. */
  149525. getClassName(): string;
  149526. /**
  149527. * Creates a new instance MotionBlurPostProcess
  149528. * @param name The name of the effect.
  149529. * @param scene The scene containing the objects to blur according to their velocity.
  149530. * @param options The required width/height ratio to downsize to before computing the render pass.
  149531. * @param camera The camera to apply the render pass to.
  149532. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149533. * @param engine The engine which the post process will be applied. (default: current engine)
  149534. * @param reusable If the post process can be reused on the same frame. (default: false)
  149535. * @param textureType Type of textures used when performing the post process. (default: 0)
  149536. * @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)
  149537. */
  149538. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149539. /**
  149540. * Excludes the given skinned mesh from computing bones velocities.
  149541. * 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.
  149542. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  149543. */
  149544. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149545. /**
  149546. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  149547. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  149548. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  149549. */
  149550. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149551. /**
  149552. * Disposes the post process.
  149553. * @param camera The camera to dispose the post process on.
  149554. */
  149555. dispose(camera?: Camera): void;
  149556. /** @hidden */
  149557. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  149558. }
  149559. }
  149560. declare module BABYLON {
  149561. /** @hidden */
  149562. export var refractionPixelShader: {
  149563. name: string;
  149564. shader: string;
  149565. };
  149566. }
  149567. declare module BABYLON {
  149568. /**
  149569. * Post process which applies a refractin texture
  149570. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149571. */
  149572. export class RefractionPostProcess extends PostProcess {
  149573. private _refTexture;
  149574. private _ownRefractionTexture;
  149575. /** the base color of the refraction (used to taint the rendering) */
  149576. color: Color3;
  149577. /** simulated refraction depth */
  149578. depth: number;
  149579. /** the coefficient of the base color (0 to remove base color tainting) */
  149580. colorLevel: number;
  149581. /** Gets the url used to load the refraction texture */
  149582. refractionTextureUrl: string;
  149583. /**
  149584. * Gets or sets the refraction texture
  149585. * Please note that you are responsible for disposing the texture if you set it manually
  149586. */
  149587. get refractionTexture(): Texture;
  149588. set refractionTexture(value: Texture);
  149589. /**
  149590. * Gets a string identifying the name of the class
  149591. * @returns "RefractionPostProcess" string
  149592. */
  149593. getClassName(): string;
  149594. /**
  149595. * Initializes the RefractionPostProcess
  149596. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149597. * @param name The name of the effect.
  149598. * @param refractionTextureUrl Url of the refraction texture to use
  149599. * @param color the base color of the refraction (used to taint the rendering)
  149600. * @param depth simulated refraction depth
  149601. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  149602. * @param camera The camera to apply the render pass to.
  149603. * @param options The required width/height ratio to downsize to before computing the render pass.
  149604. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149605. * @param engine The engine which the post process will be applied. (default: current engine)
  149606. * @param reusable If the post process can be reused on the same frame. (default: false)
  149607. */
  149608. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149609. /**
  149610. * Disposes of the post process
  149611. * @param camera Camera to dispose post process on
  149612. */
  149613. dispose(camera: Camera): void;
  149614. /** @hidden */
  149615. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  149616. }
  149617. }
  149618. declare module BABYLON {
  149619. /** @hidden */
  149620. export var sharpenPixelShader: {
  149621. name: string;
  149622. shader: string;
  149623. };
  149624. }
  149625. declare module BABYLON {
  149626. /**
  149627. * The SharpenPostProcess applies a sharpen kernel to every pixel
  149628. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149629. */
  149630. export class SharpenPostProcess extends PostProcess {
  149631. /**
  149632. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  149633. */
  149634. colorAmount: number;
  149635. /**
  149636. * How much sharpness should be applied (default: 0.3)
  149637. */
  149638. edgeAmount: number;
  149639. /**
  149640. * Gets a string identifying the name of the class
  149641. * @returns "SharpenPostProcess" string
  149642. */
  149643. getClassName(): string;
  149644. /**
  149645. * Creates a new instance ConvolutionPostProcess
  149646. * @param name The name of the effect.
  149647. * @param options The required width/height ratio to downsize to before computing the render pass.
  149648. * @param camera The camera to apply the render pass to.
  149649. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149650. * @param engine The engine which the post process will be applied. (default: current engine)
  149651. * @param reusable If the post process can be reused on the same frame. (default: false)
  149652. * @param textureType Type of textures used when performing the post process. (default: 0)
  149653. * @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)
  149654. */
  149655. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149656. /** @hidden */
  149657. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  149658. }
  149659. }
  149660. declare module BABYLON {
  149661. /**
  149662. * PostProcessRenderPipeline
  149663. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149664. */
  149665. export class PostProcessRenderPipeline {
  149666. private engine;
  149667. private _renderEffects;
  149668. private _renderEffectsForIsolatedPass;
  149669. /**
  149670. * List of inspectable custom properties (used by the Inspector)
  149671. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  149672. */
  149673. inspectableCustomProperties: IInspectable[];
  149674. /**
  149675. * @hidden
  149676. */
  149677. protected _cameras: Camera[];
  149678. /** @hidden */
  149679. _name: string;
  149680. /**
  149681. * Gets pipeline name
  149682. */
  149683. get name(): string;
  149684. /** Gets the list of attached cameras */
  149685. get cameras(): Camera[];
  149686. /**
  149687. * Initializes a PostProcessRenderPipeline
  149688. * @param engine engine to add the pipeline to
  149689. * @param name name of the pipeline
  149690. */
  149691. constructor(engine: Engine, name: string);
  149692. /**
  149693. * Gets the class name
  149694. * @returns "PostProcessRenderPipeline"
  149695. */
  149696. getClassName(): string;
  149697. /**
  149698. * If all the render effects in the pipeline are supported
  149699. */
  149700. get isSupported(): boolean;
  149701. /**
  149702. * Adds an effect to the pipeline
  149703. * @param renderEffect the effect to add
  149704. */
  149705. addEffect(renderEffect: PostProcessRenderEffect): void;
  149706. /** @hidden */
  149707. _rebuild(): void;
  149708. /** @hidden */
  149709. _enableEffect(renderEffectName: string, cameras: Camera): void;
  149710. /** @hidden */
  149711. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  149712. /** @hidden */
  149713. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149714. /** @hidden */
  149715. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149716. /** @hidden */
  149717. _attachCameras(cameras: Camera, unique: boolean): void;
  149718. /** @hidden */
  149719. _attachCameras(cameras: Camera[], unique: boolean): void;
  149720. /** @hidden */
  149721. _detachCameras(cameras: Camera): void;
  149722. /** @hidden */
  149723. _detachCameras(cameras: Nullable<Camera[]>): void;
  149724. /** @hidden */
  149725. _update(): void;
  149726. /** @hidden */
  149727. _reset(): void;
  149728. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  149729. /**
  149730. * Sets the required values to the prepass renderer.
  149731. * @param prePassRenderer defines the prepass renderer to setup.
  149732. * @returns true if the pre pass is needed.
  149733. */
  149734. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149735. /**
  149736. * Disposes of the pipeline
  149737. */
  149738. dispose(): void;
  149739. }
  149740. }
  149741. declare module BABYLON {
  149742. /**
  149743. * PostProcessRenderPipelineManager class
  149744. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149745. */
  149746. export class PostProcessRenderPipelineManager {
  149747. private _renderPipelines;
  149748. /**
  149749. * Initializes a PostProcessRenderPipelineManager
  149750. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149751. */
  149752. constructor();
  149753. /**
  149754. * Gets the list of supported render pipelines
  149755. */
  149756. get supportedPipelines(): PostProcessRenderPipeline[];
  149757. /**
  149758. * Adds a pipeline to the manager
  149759. * @param renderPipeline The pipeline to add
  149760. */
  149761. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  149762. /**
  149763. * Attaches a camera to the pipeline
  149764. * @param renderPipelineName The name of the pipeline to attach to
  149765. * @param cameras the camera to attach
  149766. * @param unique if the camera can be attached multiple times to the pipeline
  149767. */
  149768. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  149769. /**
  149770. * Detaches a camera from the pipeline
  149771. * @param renderPipelineName The name of the pipeline to detach from
  149772. * @param cameras the camera to detach
  149773. */
  149774. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  149775. /**
  149776. * Enables an effect by name on a pipeline
  149777. * @param renderPipelineName the name of the pipeline to enable the effect in
  149778. * @param renderEffectName the name of the effect to enable
  149779. * @param cameras the cameras that the effect should be enabled on
  149780. */
  149781. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149782. /**
  149783. * Disables an effect by name on a pipeline
  149784. * @param renderPipelineName the name of the pipeline to disable the effect in
  149785. * @param renderEffectName the name of the effect to disable
  149786. * @param cameras the cameras that the effect should be disabled on
  149787. */
  149788. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149789. /**
  149790. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  149791. */
  149792. update(): void;
  149793. /** @hidden */
  149794. _rebuild(): void;
  149795. /**
  149796. * Disposes of the manager and pipelines
  149797. */
  149798. dispose(): void;
  149799. }
  149800. }
  149801. declare module BABYLON {
  149802. interface Scene {
  149803. /** @hidden (Backing field) */
  149804. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149805. /**
  149806. * Gets the postprocess render pipeline manager
  149807. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149808. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149809. */
  149810. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149811. }
  149812. /**
  149813. * Defines the Render Pipeline scene component responsible to rendering pipelines
  149814. */
  149815. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  149816. /**
  149817. * The component name helpfull to identify the component in the list of scene components.
  149818. */
  149819. readonly name: string;
  149820. /**
  149821. * The scene the component belongs to.
  149822. */
  149823. scene: Scene;
  149824. /**
  149825. * Creates a new instance of the component for the given scene
  149826. * @param scene Defines the scene to register the component in
  149827. */
  149828. constructor(scene: Scene);
  149829. /**
  149830. * Registers the component in a given scene
  149831. */
  149832. register(): void;
  149833. /**
  149834. * Rebuilds the elements related to this component in case of
  149835. * context lost for instance.
  149836. */
  149837. rebuild(): void;
  149838. /**
  149839. * Disposes the component and the associated ressources
  149840. */
  149841. dispose(): void;
  149842. private _gatherRenderTargets;
  149843. }
  149844. }
  149845. declare module BABYLON {
  149846. /**
  149847. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  149848. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149849. */
  149850. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  149851. private _scene;
  149852. private _camerasToBeAttached;
  149853. /**
  149854. * ID of the sharpen post process,
  149855. */
  149856. private readonly SharpenPostProcessId;
  149857. /**
  149858. * @ignore
  149859. * ID of the image processing post process;
  149860. */
  149861. readonly ImageProcessingPostProcessId: string;
  149862. /**
  149863. * @ignore
  149864. * ID of the Fast Approximate Anti-Aliasing post process;
  149865. */
  149866. readonly FxaaPostProcessId: string;
  149867. /**
  149868. * ID of the chromatic aberration post process,
  149869. */
  149870. private readonly ChromaticAberrationPostProcessId;
  149871. /**
  149872. * ID of the grain post process
  149873. */
  149874. private readonly GrainPostProcessId;
  149875. /**
  149876. * Sharpen post process which will apply a sharpen convolution to enhance edges
  149877. */
  149878. sharpen: SharpenPostProcess;
  149879. private _sharpenEffect;
  149880. private bloom;
  149881. /**
  149882. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  149883. */
  149884. depthOfField: DepthOfFieldEffect;
  149885. /**
  149886. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  149887. */
  149888. fxaa: FxaaPostProcess;
  149889. /**
  149890. * Image post processing pass used to perform operations such as tone mapping or color grading.
  149891. */
  149892. imageProcessing: ImageProcessingPostProcess;
  149893. /**
  149894. * Chromatic aberration post process which will shift rgb colors in the image
  149895. */
  149896. chromaticAberration: ChromaticAberrationPostProcess;
  149897. private _chromaticAberrationEffect;
  149898. /**
  149899. * Grain post process which add noise to the image
  149900. */
  149901. grain: GrainPostProcess;
  149902. private _grainEffect;
  149903. /**
  149904. * Glow post process which adds a glow to emissive areas of the image
  149905. */
  149906. private _glowLayer;
  149907. /**
  149908. * Animations which can be used to tweak settings over a period of time
  149909. */
  149910. animations: Animation[];
  149911. private _imageProcessingConfigurationObserver;
  149912. private _sharpenEnabled;
  149913. private _bloomEnabled;
  149914. private _depthOfFieldEnabled;
  149915. private _depthOfFieldBlurLevel;
  149916. private _fxaaEnabled;
  149917. private _imageProcessingEnabled;
  149918. private _defaultPipelineTextureType;
  149919. private _bloomScale;
  149920. private _chromaticAberrationEnabled;
  149921. private _grainEnabled;
  149922. private _buildAllowed;
  149923. /**
  149924. * Gets active scene
  149925. */
  149926. get scene(): Scene;
  149927. /**
  149928. * Enable or disable the sharpen process from the pipeline
  149929. */
  149930. set sharpenEnabled(enabled: boolean);
  149931. get sharpenEnabled(): boolean;
  149932. private _resizeObserver;
  149933. private _hardwareScaleLevel;
  149934. private _bloomKernel;
  149935. /**
  149936. * Specifies the size of the bloom blur kernel, relative to the final output size
  149937. */
  149938. get bloomKernel(): number;
  149939. set bloomKernel(value: number);
  149940. /**
  149941. * Specifies the weight of the bloom in the final rendering
  149942. */
  149943. private _bloomWeight;
  149944. /**
  149945. * Specifies the luma threshold for the area that will be blurred by the bloom
  149946. */
  149947. private _bloomThreshold;
  149948. private _hdr;
  149949. /**
  149950. * The strength of the bloom.
  149951. */
  149952. set bloomWeight(value: number);
  149953. get bloomWeight(): number;
  149954. /**
  149955. * The strength of the bloom.
  149956. */
  149957. set bloomThreshold(value: number);
  149958. get bloomThreshold(): number;
  149959. /**
  149960. * The scale of the bloom, lower value will provide better performance.
  149961. */
  149962. set bloomScale(value: number);
  149963. get bloomScale(): number;
  149964. /**
  149965. * Enable or disable the bloom from the pipeline
  149966. */
  149967. set bloomEnabled(enabled: boolean);
  149968. get bloomEnabled(): boolean;
  149969. private _rebuildBloom;
  149970. /**
  149971. * If the depth of field is enabled.
  149972. */
  149973. get depthOfFieldEnabled(): boolean;
  149974. set depthOfFieldEnabled(enabled: boolean);
  149975. /**
  149976. * Blur level of the depth of field effect. (Higher blur will effect performance)
  149977. */
  149978. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  149979. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  149980. /**
  149981. * If the anti aliasing is enabled.
  149982. */
  149983. set fxaaEnabled(enabled: boolean);
  149984. get fxaaEnabled(): boolean;
  149985. private _samples;
  149986. /**
  149987. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  149988. */
  149989. set samples(sampleCount: number);
  149990. get samples(): number;
  149991. /**
  149992. * If image processing is enabled.
  149993. */
  149994. set imageProcessingEnabled(enabled: boolean);
  149995. get imageProcessingEnabled(): boolean;
  149996. /**
  149997. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  149998. */
  149999. set glowLayerEnabled(enabled: boolean);
  150000. get glowLayerEnabled(): boolean;
  150001. /**
  150002. * Gets the glow layer (or null if not defined)
  150003. */
  150004. get glowLayer(): Nullable<GlowLayer>;
  150005. /**
  150006. * Enable or disable the chromaticAberration process from the pipeline
  150007. */
  150008. set chromaticAberrationEnabled(enabled: boolean);
  150009. get chromaticAberrationEnabled(): boolean;
  150010. /**
  150011. * Enable or disable the grain process from the pipeline
  150012. */
  150013. set grainEnabled(enabled: boolean);
  150014. get grainEnabled(): boolean;
  150015. /**
  150016. * @constructor
  150017. * @param name - The rendering pipeline name (default: "")
  150018. * @param hdr - If high dynamic range textures should be used (default: true)
  150019. * @param scene - The scene linked to this pipeline (default: the last created scene)
  150020. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  150021. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  150022. */
  150023. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  150024. /**
  150025. * Get the class name
  150026. * @returns "DefaultRenderingPipeline"
  150027. */
  150028. getClassName(): string;
  150029. /**
  150030. * Force the compilation of the entire pipeline.
  150031. */
  150032. prepare(): void;
  150033. private _hasCleared;
  150034. private _prevPostProcess;
  150035. private _prevPrevPostProcess;
  150036. private _setAutoClearAndTextureSharing;
  150037. private _depthOfFieldSceneObserver;
  150038. private _buildPipeline;
  150039. private _disposePostProcesses;
  150040. /**
  150041. * Adds a camera to the pipeline
  150042. * @param camera the camera to be added
  150043. */
  150044. addCamera(camera: Camera): void;
  150045. /**
  150046. * Removes a camera from the pipeline
  150047. * @param camera the camera to remove
  150048. */
  150049. removeCamera(camera: Camera): void;
  150050. /**
  150051. * Dispose of the pipeline and stop all post processes
  150052. */
  150053. dispose(): void;
  150054. /**
  150055. * Serialize the rendering pipeline (Used when exporting)
  150056. * @returns the serialized object
  150057. */
  150058. serialize(): any;
  150059. /**
  150060. * Parse the serialized pipeline
  150061. * @param source Source pipeline.
  150062. * @param scene The scene to load the pipeline to.
  150063. * @param rootUrl The URL of the serialized pipeline.
  150064. * @returns An instantiated pipeline from the serialized object.
  150065. */
  150066. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  150067. }
  150068. }
  150069. declare module BABYLON {
  150070. /** @hidden */
  150071. export var lensHighlightsPixelShader: {
  150072. name: string;
  150073. shader: string;
  150074. };
  150075. }
  150076. declare module BABYLON {
  150077. /** @hidden */
  150078. export var depthOfFieldPixelShader: {
  150079. name: string;
  150080. shader: string;
  150081. };
  150082. }
  150083. declare module BABYLON {
  150084. /**
  150085. * BABYLON.JS Chromatic Aberration GLSL Shader
  150086. * Author: Olivier Guyot
  150087. * Separates very slightly R, G and B colors on the edges of the screen
  150088. * Inspired by Francois Tarlier & Martins Upitis
  150089. */
  150090. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  150091. /**
  150092. * @ignore
  150093. * The chromatic aberration PostProcess id in the pipeline
  150094. */
  150095. LensChromaticAberrationEffect: string;
  150096. /**
  150097. * @ignore
  150098. * The highlights enhancing PostProcess id in the pipeline
  150099. */
  150100. HighlightsEnhancingEffect: string;
  150101. /**
  150102. * @ignore
  150103. * The depth-of-field PostProcess id in the pipeline
  150104. */
  150105. LensDepthOfFieldEffect: string;
  150106. private _scene;
  150107. private _depthTexture;
  150108. private _grainTexture;
  150109. private _chromaticAberrationPostProcess;
  150110. private _highlightsPostProcess;
  150111. private _depthOfFieldPostProcess;
  150112. private _edgeBlur;
  150113. private _grainAmount;
  150114. private _chromaticAberration;
  150115. private _distortion;
  150116. private _highlightsGain;
  150117. private _highlightsThreshold;
  150118. private _dofDistance;
  150119. private _dofAperture;
  150120. private _dofDarken;
  150121. private _dofPentagon;
  150122. private _blurNoise;
  150123. /**
  150124. * @constructor
  150125. *
  150126. * Effect parameters are as follow:
  150127. * {
  150128. * chromatic_aberration: number; // from 0 to x (1 for realism)
  150129. * edge_blur: number; // from 0 to x (1 for realism)
  150130. * distortion: number; // from 0 to x (1 for realism)
  150131. * grain_amount: number; // from 0 to 1
  150132. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  150133. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  150134. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  150135. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  150136. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  150137. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  150138. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  150139. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  150140. * }
  150141. * Note: if an effect parameter is unset, effect is disabled
  150142. *
  150143. * @param name The rendering pipeline name
  150144. * @param parameters - An object containing all parameters (see above)
  150145. * @param scene The scene linked to this pipeline
  150146. * @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)
  150147. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150148. */
  150149. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  150150. /**
  150151. * Get the class name
  150152. * @returns "LensRenderingPipeline"
  150153. */
  150154. getClassName(): string;
  150155. /**
  150156. * Gets associated scene
  150157. */
  150158. get scene(): Scene;
  150159. /**
  150160. * Gets or sets the edge blur
  150161. */
  150162. get edgeBlur(): number;
  150163. set edgeBlur(value: number);
  150164. /**
  150165. * Gets or sets the grain amount
  150166. */
  150167. get grainAmount(): number;
  150168. set grainAmount(value: number);
  150169. /**
  150170. * Gets or sets the chromatic aberration amount
  150171. */
  150172. get chromaticAberration(): number;
  150173. set chromaticAberration(value: number);
  150174. /**
  150175. * Gets or sets the depth of field aperture
  150176. */
  150177. get dofAperture(): number;
  150178. set dofAperture(value: number);
  150179. /**
  150180. * Gets or sets the edge distortion
  150181. */
  150182. get edgeDistortion(): number;
  150183. set edgeDistortion(value: number);
  150184. /**
  150185. * Gets or sets the depth of field distortion
  150186. */
  150187. get dofDistortion(): number;
  150188. set dofDistortion(value: number);
  150189. /**
  150190. * Gets or sets the darken out of focus amount
  150191. */
  150192. get darkenOutOfFocus(): number;
  150193. set darkenOutOfFocus(value: number);
  150194. /**
  150195. * Gets or sets a boolean indicating if blur noise is enabled
  150196. */
  150197. get blurNoise(): boolean;
  150198. set blurNoise(value: boolean);
  150199. /**
  150200. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  150201. */
  150202. get pentagonBokeh(): boolean;
  150203. set pentagonBokeh(value: boolean);
  150204. /**
  150205. * Gets or sets the highlight grain amount
  150206. */
  150207. get highlightsGain(): number;
  150208. set highlightsGain(value: number);
  150209. /**
  150210. * Gets or sets the highlight threshold
  150211. */
  150212. get highlightsThreshold(): number;
  150213. set highlightsThreshold(value: number);
  150214. /**
  150215. * Sets the amount of blur at the edges
  150216. * @param amount blur amount
  150217. */
  150218. setEdgeBlur(amount: number): void;
  150219. /**
  150220. * Sets edge blur to 0
  150221. */
  150222. disableEdgeBlur(): void;
  150223. /**
  150224. * Sets the amout of grain
  150225. * @param amount Amount of grain
  150226. */
  150227. setGrainAmount(amount: number): void;
  150228. /**
  150229. * Set grain amount to 0
  150230. */
  150231. disableGrain(): void;
  150232. /**
  150233. * Sets the chromatic aberration amount
  150234. * @param amount amount of chromatic aberration
  150235. */
  150236. setChromaticAberration(amount: number): void;
  150237. /**
  150238. * Sets chromatic aberration amount to 0
  150239. */
  150240. disableChromaticAberration(): void;
  150241. /**
  150242. * Sets the EdgeDistortion amount
  150243. * @param amount amount of EdgeDistortion
  150244. */
  150245. setEdgeDistortion(amount: number): void;
  150246. /**
  150247. * Sets edge distortion to 0
  150248. */
  150249. disableEdgeDistortion(): void;
  150250. /**
  150251. * Sets the FocusDistance amount
  150252. * @param amount amount of FocusDistance
  150253. */
  150254. setFocusDistance(amount: number): void;
  150255. /**
  150256. * Disables depth of field
  150257. */
  150258. disableDepthOfField(): void;
  150259. /**
  150260. * Sets the Aperture amount
  150261. * @param amount amount of Aperture
  150262. */
  150263. setAperture(amount: number): void;
  150264. /**
  150265. * Sets the DarkenOutOfFocus amount
  150266. * @param amount amount of DarkenOutOfFocus
  150267. */
  150268. setDarkenOutOfFocus(amount: number): void;
  150269. private _pentagonBokehIsEnabled;
  150270. /**
  150271. * Creates a pentagon bokeh effect
  150272. */
  150273. enablePentagonBokeh(): void;
  150274. /**
  150275. * Disables the pentagon bokeh effect
  150276. */
  150277. disablePentagonBokeh(): void;
  150278. /**
  150279. * Enables noise blur
  150280. */
  150281. enableNoiseBlur(): void;
  150282. /**
  150283. * Disables noise blur
  150284. */
  150285. disableNoiseBlur(): void;
  150286. /**
  150287. * Sets the HighlightsGain amount
  150288. * @param amount amount of HighlightsGain
  150289. */
  150290. setHighlightsGain(amount: number): void;
  150291. /**
  150292. * Sets the HighlightsThreshold amount
  150293. * @param amount amount of HighlightsThreshold
  150294. */
  150295. setHighlightsThreshold(amount: number): void;
  150296. /**
  150297. * Disables highlights
  150298. */
  150299. disableHighlights(): void;
  150300. /**
  150301. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  150302. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  150303. */
  150304. dispose(disableDepthRender?: boolean): void;
  150305. private _createChromaticAberrationPostProcess;
  150306. private _createHighlightsPostProcess;
  150307. private _createDepthOfFieldPostProcess;
  150308. private _createGrainTexture;
  150309. }
  150310. }
  150311. declare module BABYLON {
  150312. /** @hidden */
  150313. export var ssao2PixelShader: {
  150314. name: string;
  150315. shader: string;
  150316. };
  150317. }
  150318. declare module BABYLON {
  150319. /** @hidden */
  150320. export var ssaoCombinePixelShader: {
  150321. name: string;
  150322. shader: string;
  150323. };
  150324. }
  150325. declare module BABYLON {
  150326. /**
  150327. * Render pipeline to produce ssao effect
  150328. */
  150329. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  150330. /**
  150331. * @ignore
  150332. * The PassPostProcess id in the pipeline that contains the original scene color
  150333. */
  150334. SSAOOriginalSceneColorEffect: string;
  150335. /**
  150336. * @ignore
  150337. * The SSAO PostProcess id in the pipeline
  150338. */
  150339. SSAORenderEffect: string;
  150340. /**
  150341. * @ignore
  150342. * The horizontal blur PostProcess id in the pipeline
  150343. */
  150344. SSAOBlurHRenderEffect: string;
  150345. /**
  150346. * @ignore
  150347. * The vertical blur PostProcess id in the pipeline
  150348. */
  150349. SSAOBlurVRenderEffect: string;
  150350. /**
  150351. * @ignore
  150352. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150353. */
  150354. SSAOCombineRenderEffect: string;
  150355. /**
  150356. * The output strength of the SSAO post-process. Default value is 1.0.
  150357. */
  150358. totalStrength: number;
  150359. /**
  150360. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  150361. */
  150362. maxZ: number;
  150363. /**
  150364. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  150365. */
  150366. minZAspect: number;
  150367. private _samples;
  150368. /**
  150369. * Number of samples used for the SSAO calculations. Default value is 8
  150370. */
  150371. set samples(n: number);
  150372. get samples(): number;
  150373. private _textureSamples;
  150374. /**
  150375. * Number of samples to use for antialiasing
  150376. */
  150377. set textureSamples(n: number);
  150378. get textureSamples(): number;
  150379. /**
  150380. * Force rendering the geometry through geometry buffer
  150381. */
  150382. private _forceGeometryBuffer;
  150383. /**
  150384. * Ratio object used for SSAO ratio and blur ratio
  150385. */
  150386. private _ratio;
  150387. /**
  150388. * Dynamically generated sphere sampler.
  150389. */
  150390. private _sampleSphere;
  150391. /**
  150392. * Blur filter offsets
  150393. */
  150394. private _samplerOffsets;
  150395. private _expensiveBlur;
  150396. /**
  150397. * If bilateral blur should be used
  150398. */
  150399. set expensiveBlur(b: boolean);
  150400. get expensiveBlur(): boolean;
  150401. /**
  150402. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  150403. */
  150404. radius: number;
  150405. /**
  150406. * The base color of the SSAO post-process
  150407. * The final result is "base + ssao" between [0, 1]
  150408. */
  150409. base: number;
  150410. /**
  150411. * Support test.
  150412. */
  150413. static get IsSupported(): boolean;
  150414. private _scene;
  150415. private _randomTexture;
  150416. private _originalColorPostProcess;
  150417. private _ssaoPostProcess;
  150418. private _blurHPostProcess;
  150419. private _blurVPostProcess;
  150420. private _ssaoCombinePostProcess;
  150421. private _prePassRenderer;
  150422. /**
  150423. * Gets active scene
  150424. */
  150425. get scene(): Scene;
  150426. /**
  150427. * @constructor
  150428. * @param name The rendering pipeline name
  150429. * @param scene The scene linked to this pipeline
  150430. * @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 }
  150431. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150432. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  150433. */
  150434. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  150435. /**
  150436. * Get the class name
  150437. * @returns "SSAO2RenderingPipeline"
  150438. */
  150439. getClassName(): string;
  150440. /**
  150441. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150442. */
  150443. dispose(disableGeometryBufferRenderer?: boolean): void;
  150444. private _createBlurPostProcess;
  150445. /** @hidden */
  150446. _rebuild(): void;
  150447. private _bits;
  150448. private _radicalInverse_VdC;
  150449. private _hammersley;
  150450. private _hemisphereSample_uniform;
  150451. private _generateHemisphere;
  150452. private _getDefinesForSSAO;
  150453. private _createSSAOPostProcess;
  150454. private _createSSAOCombinePostProcess;
  150455. private _createRandomTexture;
  150456. /**
  150457. * Serialize the rendering pipeline (Used when exporting)
  150458. * @returns the serialized object
  150459. */
  150460. serialize(): any;
  150461. /**
  150462. * Parse the serialized pipeline
  150463. * @param source Source pipeline.
  150464. * @param scene The scene to load the pipeline to.
  150465. * @param rootUrl The URL of the serialized pipeline.
  150466. * @returns An instantiated pipeline from the serialized object.
  150467. */
  150468. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  150469. /**
  150470. * Sets the required values to the prepass renderer.
  150471. * @param prePassRenderer defines the prepass renderer to setup
  150472. * @returns true if the pre pass is needed.
  150473. */
  150474. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150475. }
  150476. }
  150477. declare module BABYLON {
  150478. /** @hidden */
  150479. export var ssaoPixelShader: {
  150480. name: string;
  150481. shader: string;
  150482. };
  150483. }
  150484. declare module BABYLON {
  150485. /**
  150486. * Render pipeline to produce ssao effect
  150487. */
  150488. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  150489. /**
  150490. * @ignore
  150491. * The PassPostProcess id in the pipeline that contains the original scene color
  150492. */
  150493. SSAOOriginalSceneColorEffect: string;
  150494. /**
  150495. * @ignore
  150496. * The SSAO PostProcess id in the pipeline
  150497. */
  150498. SSAORenderEffect: string;
  150499. /**
  150500. * @ignore
  150501. * The horizontal blur PostProcess id in the pipeline
  150502. */
  150503. SSAOBlurHRenderEffect: string;
  150504. /**
  150505. * @ignore
  150506. * The vertical blur PostProcess id in the pipeline
  150507. */
  150508. SSAOBlurVRenderEffect: string;
  150509. /**
  150510. * @ignore
  150511. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150512. */
  150513. SSAOCombineRenderEffect: string;
  150514. /**
  150515. * The output strength of the SSAO post-process. Default value is 1.0.
  150516. */
  150517. totalStrength: number;
  150518. /**
  150519. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  150520. */
  150521. radius: number;
  150522. /**
  150523. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  150524. * Must not be equal to fallOff and superior to fallOff.
  150525. * Default value is 0.0075
  150526. */
  150527. area: number;
  150528. /**
  150529. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  150530. * Must not be equal to area and inferior to area.
  150531. * Default value is 0.000001
  150532. */
  150533. fallOff: number;
  150534. /**
  150535. * The base color of the SSAO post-process
  150536. * The final result is "base + ssao" between [0, 1]
  150537. */
  150538. base: number;
  150539. private _scene;
  150540. private _depthTexture;
  150541. private _randomTexture;
  150542. private _originalColorPostProcess;
  150543. private _ssaoPostProcess;
  150544. private _blurHPostProcess;
  150545. private _blurVPostProcess;
  150546. private _ssaoCombinePostProcess;
  150547. private _firstUpdate;
  150548. /**
  150549. * Gets active scene
  150550. */
  150551. get scene(): Scene;
  150552. /**
  150553. * @constructor
  150554. * @param name - The rendering pipeline name
  150555. * @param scene - The scene linked to this pipeline
  150556. * @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 }
  150557. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  150558. */
  150559. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  150560. /**
  150561. * Get the class name
  150562. * @returns "SSAORenderingPipeline"
  150563. */
  150564. getClassName(): string;
  150565. /**
  150566. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150567. */
  150568. dispose(disableDepthRender?: boolean): void;
  150569. private _createBlurPostProcess;
  150570. /** @hidden */
  150571. _rebuild(): void;
  150572. private _createSSAOPostProcess;
  150573. private _createSSAOCombinePostProcess;
  150574. private _createRandomTexture;
  150575. }
  150576. }
  150577. declare module BABYLON {
  150578. /** @hidden */
  150579. export var screenSpaceReflectionPixelShader: {
  150580. name: string;
  150581. shader: string;
  150582. };
  150583. }
  150584. declare module BABYLON {
  150585. /**
  150586. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  150587. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  150588. */
  150589. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  150590. /**
  150591. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  150592. */
  150593. threshold: number;
  150594. /**
  150595. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  150596. */
  150597. strength: number;
  150598. /**
  150599. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  150600. */
  150601. reflectionSpecularFalloffExponent: number;
  150602. /**
  150603. * 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]
  150604. */
  150605. step: number;
  150606. /**
  150607. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  150608. */
  150609. roughnessFactor: number;
  150610. private _geometryBufferRenderer;
  150611. private _enableSmoothReflections;
  150612. private _reflectionSamples;
  150613. private _smoothSteps;
  150614. /**
  150615. * Gets a string identifying the name of the class
  150616. * @returns "ScreenSpaceReflectionPostProcess" string
  150617. */
  150618. getClassName(): string;
  150619. /**
  150620. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  150621. * @param name The name of the effect.
  150622. * @param scene The scene containing the objects to calculate reflections.
  150623. * @param options The required width/height ratio to downsize to before computing the render pass.
  150624. * @param camera The camera to apply the render pass to.
  150625. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150626. * @param engine The engine which the post process will be applied. (default: current engine)
  150627. * @param reusable If the post process can be reused on the same frame. (default: false)
  150628. * @param textureType Type of textures used when performing the post process. (default: 0)
  150629. * @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)
  150630. */
  150631. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150632. /**
  150633. * Gets wether or not smoothing reflections is enabled.
  150634. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150635. */
  150636. get enableSmoothReflections(): boolean;
  150637. /**
  150638. * Sets wether or not smoothing reflections is enabled.
  150639. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150640. */
  150641. set enableSmoothReflections(enabled: boolean);
  150642. /**
  150643. * Gets the number of samples taken while computing reflections. More samples count is high,
  150644. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150645. */
  150646. get reflectionSamples(): number;
  150647. /**
  150648. * Sets the number of samples taken while computing reflections. More samples count is high,
  150649. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150650. */
  150651. set reflectionSamples(samples: number);
  150652. /**
  150653. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  150654. * more the post-process will require GPU power and can generate a drop in FPS.
  150655. * Default value (5.0) work pretty well in all cases but can be adjusted.
  150656. */
  150657. get smoothSteps(): number;
  150658. set smoothSteps(steps: number);
  150659. private _updateEffectDefines;
  150660. /** @hidden */
  150661. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  150662. }
  150663. }
  150664. declare module BABYLON {
  150665. /** @hidden */
  150666. export var standardPixelShader: {
  150667. name: string;
  150668. shader: string;
  150669. };
  150670. }
  150671. declare module BABYLON {
  150672. /**
  150673. * Standard rendering pipeline
  150674. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150675. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  150676. */
  150677. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150678. /**
  150679. * Public members
  150680. */
  150681. /**
  150682. * Post-process which contains the original scene color before the pipeline applies all the effects
  150683. */
  150684. originalPostProcess: Nullable<PostProcess>;
  150685. /**
  150686. * Post-process used to down scale an image x4
  150687. */
  150688. downSampleX4PostProcess: Nullable<PostProcess>;
  150689. /**
  150690. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  150691. */
  150692. brightPassPostProcess: Nullable<PostProcess>;
  150693. /**
  150694. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  150695. */
  150696. blurHPostProcesses: PostProcess[];
  150697. /**
  150698. * Post-process array storing all the vertical blur post-processes used by the pipeline
  150699. */
  150700. blurVPostProcesses: PostProcess[];
  150701. /**
  150702. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  150703. */
  150704. textureAdderPostProcess: Nullable<PostProcess>;
  150705. /**
  150706. * Post-process used to create volumetric lighting effect
  150707. */
  150708. volumetricLightPostProcess: Nullable<PostProcess>;
  150709. /**
  150710. * Post-process used to smooth the previous volumetric light post-process on the X axis
  150711. */
  150712. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  150713. /**
  150714. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  150715. */
  150716. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  150717. /**
  150718. * Post-process used to merge the volumetric light effect and the real scene color
  150719. */
  150720. volumetricLightMergePostProces: Nullable<PostProcess>;
  150721. /**
  150722. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  150723. */
  150724. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  150725. /**
  150726. * Base post-process used to calculate the average luminance of the final image for HDR
  150727. */
  150728. luminancePostProcess: Nullable<PostProcess>;
  150729. /**
  150730. * Post-processes used to create down sample post-processes in order to get
  150731. * the average luminance of the final image for HDR
  150732. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  150733. */
  150734. luminanceDownSamplePostProcesses: PostProcess[];
  150735. /**
  150736. * Post-process used to create a HDR effect (light adaptation)
  150737. */
  150738. hdrPostProcess: Nullable<PostProcess>;
  150739. /**
  150740. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  150741. */
  150742. textureAdderFinalPostProcess: Nullable<PostProcess>;
  150743. /**
  150744. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  150745. */
  150746. lensFlareFinalPostProcess: Nullable<PostProcess>;
  150747. /**
  150748. * Post-process used to merge the final HDR post-process and the real scene color
  150749. */
  150750. hdrFinalPostProcess: Nullable<PostProcess>;
  150751. /**
  150752. * Post-process used to create a lens flare effect
  150753. */
  150754. lensFlarePostProcess: Nullable<PostProcess>;
  150755. /**
  150756. * Post-process that merges the result of the lens flare post-process and the real scene color
  150757. */
  150758. lensFlareComposePostProcess: Nullable<PostProcess>;
  150759. /**
  150760. * Post-process used to create a motion blur effect
  150761. */
  150762. motionBlurPostProcess: Nullable<PostProcess>;
  150763. /**
  150764. * Post-process used to create a depth of field effect
  150765. */
  150766. depthOfFieldPostProcess: Nullable<PostProcess>;
  150767. /**
  150768. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150769. */
  150770. fxaaPostProcess: Nullable<FxaaPostProcess>;
  150771. /**
  150772. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  150773. */
  150774. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  150775. /**
  150776. * Represents the brightness threshold in order to configure the illuminated surfaces
  150777. */
  150778. brightThreshold: number;
  150779. /**
  150780. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  150781. */
  150782. blurWidth: number;
  150783. /**
  150784. * Sets if the blur for highlighted surfaces must be only horizontal
  150785. */
  150786. horizontalBlur: boolean;
  150787. /**
  150788. * Gets the overall exposure used by the pipeline
  150789. */
  150790. get exposure(): number;
  150791. /**
  150792. * Sets the overall exposure used by the pipeline
  150793. */
  150794. set exposure(value: number);
  150795. /**
  150796. * Texture used typically to simulate "dirty" on camera lens
  150797. */
  150798. lensTexture: Nullable<Texture>;
  150799. /**
  150800. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  150801. */
  150802. volumetricLightCoefficient: number;
  150803. /**
  150804. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  150805. */
  150806. volumetricLightPower: number;
  150807. /**
  150808. * Used the set the blur intensity to smooth the volumetric lights
  150809. */
  150810. volumetricLightBlurScale: number;
  150811. /**
  150812. * Light (spot or directional) used to generate the volumetric lights rays
  150813. * The source light must have a shadow generate so the pipeline can get its
  150814. * depth map
  150815. */
  150816. sourceLight: Nullable<SpotLight | DirectionalLight>;
  150817. /**
  150818. * For eye adaptation, represents the minimum luminance the eye can see
  150819. */
  150820. hdrMinimumLuminance: number;
  150821. /**
  150822. * For eye adaptation, represents the decrease luminance speed
  150823. */
  150824. hdrDecreaseRate: number;
  150825. /**
  150826. * For eye adaptation, represents the increase luminance speed
  150827. */
  150828. hdrIncreaseRate: number;
  150829. /**
  150830. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150831. */
  150832. get hdrAutoExposure(): boolean;
  150833. /**
  150834. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150835. */
  150836. set hdrAutoExposure(value: boolean);
  150837. /**
  150838. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  150839. */
  150840. lensColorTexture: Nullable<Texture>;
  150841. /**
  150842. * The overall strengh for the lens flare effect
  150843. */
  150844. lensFlareStrength: number;
  150845. /**
  150846. * Dispersion coefficient for lens flare ghosts
  150847. */
  150848. lensFlareGhostDispersal: number;
  150849. /**
  150850. * Main lens flare halo width
  150851. */
  150852. lensFlareHaloWidth: number;
  150853. /**
  150854. * Based on the lens distortion effect, defines how much the lens flare result
  150855. * is distorted
  150856. */
  150857. lensFlareDistortionStrength: number;
  150858. /**
  150859. * Configures the blur intensity used for for lens flare (halo)
  150860. */
  150861. lensFlareBlurWidth: number;
  150862. /**
  150863. * Lens star texture must be used to simulate rays on the flares and is available
  150864. * in the documentation
  150865. */
  150866. lensStarTexture: Nullable<Texture>;
  150867. /**
  150868. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  150869. * flare effect by taking account of the dirt texture
  150870. */
  150871. lensFlareDirtTexture: Nullable<Texture>;
  150872. /**
  150873. * Represents the focal length for the depth of field effect
  150874. */
  150875. depthOfFieldDistance: number;
  150876. /**
  150877. * Represents the blur intensity for the blurred part of the depth of field effect
  150878. */
  150879. depthOfFieldBlurWidth: number;
  150880. /**
  150881. * Gets how much the image is blurred by the movement while using the motion blur post-process
  150882. */
  150883. get motionStrength(): number;
  150884. /**
  150885. * Sets how much the image is blurred by the movement while using the motion blur post-process
  150886. */
  150887. set motionStrength(strength: number);
  150888. /**
  150889. * Gets wether or not the motion blur post-process is object based or screen based.
  150890. */
  150891. get objectBasedMotionBlur(): boolean;
  150892. /**
  150893. * Sets wether or not the motion blur post-process should be object based or screen based
  150894. */
  150895. set objectBasedMotionBlur(value: boolean);
  150896. /**
  150897. * List of animations for the pipeline (IAnimatable implementation)
  150898. */
  150899. animations: Animation[];
  150900. /**
  150901. * Private members
  150902. */
  150903. private _scene;
  150904. private _currentDepthOfFieldSource;
  150905. private _basePostProcess;
  150906. private _fixedExposure;
  150907. private _currentExposure;
  150908. private _hdrAutoExposure;
  150909. private _hdrCurrentLuminance;
  150910. private _motionStrength;
  150911. private _isObjectBasedMotionBlur;
  150912. private _floatTextureType;
  150913. private _camerasToBeAttached;
  150914. private _ratio;
  150915. private _bloomEnabled;
  150916. private _depthOfFieldEnabled;
  150917. private _vlsEnabled;
  150918. private _lensFlareEnabled;
  150919. private _hdrEnabled;
  150920. private _motionBlurEnabled;
  150921. private _fxaaEnabled;
  150922. private _screenSpaceReflectionsEnabled;
  150923. private _motionBlurSamples;
  150924. private _volumetricLightStepsCount;
  150925. private _samples;
  150926. /**
  150927. * @ignore
  150928. * Specifies if the bloom pipeline is enabled
  150929. */
  150930. get BloomEnabled(): boolean;
  150931. set BloomEnabled(enabled: boolean);
  150932. /**
  150933. * @ignore
  150934. * Specifies if the depth of field pipeline is enabed
  150935. */
  150936. get DepthOfFieldEnabled(): boolean;
  150937. set DepthOfFieldEnabled(enabled: boolean);
  150938. /**
  150939. * @ignore
  150940. * Specifies if the lens flare pipeline is enabed
  150941. */
  150942. get LensFlareEnabled(): boolean;
  150943. set LensFlareEnabled(enabled: boolean);
  150944. /**
  150945. * @ignore
  150946. * Specifies if the HDR pipeline is enabled
  150947. */
  150948. get HDREnabled(): boolean;
  150949. set HDREnabled(enabled: boolean);
  150950. /**
  150951. * @ignore
  150952. * Specifies if the volumetric lights scattering effect is enabled
  150953. */
  150954. get VLSEnabled(): boolean;
  150955. set VLSEnabled(enabled: boolean);
  150956. /**
  150957. * @ignore
  150958. * Specifies if the motion blur effect is enabled
  150959. */
  150960. get MotionBlurEnabled(): boolean;
  150961. set MotionBlurEnabled(enabled: boolean);
  150962. /**
  150963. * Specifies if anti-aliasing is enabled
  150964. */
  150965. get fxaaEnabled(): boolean;
  150966. set fxaaEnabled(enabled: boolean);
  150967. /**
  150968. * Specifies if screen space reflections are enabled.
  150969. */
  150970. get screenSpaceReflectionsEnabled(): boolean;
  150971. set screenSpaceReflectionsEnabled(enabled: boolean);
  150972. /**
  150973. * Specifies the number of steps used to calculate the volumetric lights
  150974. * Typically in interval [50, 200]
  150975. */
  150976. get volumetricLightStepsCount(): number;
  150977. set volumetricLightStepsCount(count: number);
  150978. /**
  150979. * Specifies the number of samples used for the motion blur effect
  150980. * Typically in interval [16, 64]
  150981. */
  150982. get motionBlurSamples(): number;
  150983. set motionBlurSamples(samples: number);
  150984. /**
  150985. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150986. */
  150987. get samples(): number;
  150988. set samples(sampleCount: number);
  150989. /**
  150990. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150991. * @constructor
  150992. * @param name The rendering pipeline name
  150993. * @param scene The scene linked to this pipeline
  150994. * @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)
  150995. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  150996. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150997. */
  150998. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  150999. private _buildPipeline;
  151000. private _createDownSampleX4PostProcess;
  151001. private _createBrightPassPostProcess;
  151002. private _createBlurPostProcesses;
  151003. private _createTextureAdderPostProcess;
  151004. private _createVolumetricLightPostProcess;
  151005. private _createLuminancePostProcesses;
  151006. private _createHdrPostProcess;
  151007. private _createLensFlarePostProcess;
  151008. private _createDepthOfFieldPostProcess;
  151009. private _createMotionBlurPostProcess;
  151010. private _getDepthTexture;
  151011. private _disposePostProcesses;
  151012. /**
  151013. * Dispose of the pipeline and stop all post processes
  151014. */
  151015. dispose(): void;
  151016. /**
  151017. * Serialize the rendering pipeline (Used when exporting)
  151018. * @returns the serialized object
  151019. */
  151020. serialize(): any;
  151021. /**
  151022. * Parse the serialized pipeline
  151023. * @param source Source pipeline.
  151024. * @param scene The scene to load the pipeline to.
  151025. * @param rootUrl The URL of the serialized pipeline.
  151026. * @returns An instantiated pipeline from the serialized object.
  151027. */
  151028. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  151029. /**
  151030. * Luminance steps
  151031. */
  151032. static LuminanceSteps: number;
  151033. }
  151034. }
  151035. declare module BABYLON {
  151036. /** @hidden */
  151037. export var stereoscopicInterlacePixelShader: {
  151038. name: string;
  151039. shader: string;
  151040. };
  151041. }
  151042. declare module BABYLON {
  151043. /**
  151044. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  151045. */
  151046. export class StereoscopicInterlacePostProcessI extends PostProcess {
  151047. private _stepSize;
  151048. private _passedProcess;
  151049. /**
  151050. * Gets a string identifying the name of the class
  151051. * @returns "StereoscopicInterlacePostProcessI" string
  151052. */
  151053. getClassName(): string;
  151054. /**
  151055. * Initializes a StereoscopicInterlacePostProcessI
  151056. * @param name The name of the effect.
  151057. * @param rigCameras The rig cameras to be appled to the post process
  151058. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  151059. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  151060. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151061. * @param engine The engine which the post process will be applied. (default: current engine)
  151062. * @param reusable If the post process can be reused on the same frame. (default: false)
  151063. */
  151064. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151065. }
  151066. /**
  151067. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  151068. */
  151069. export class StereoscopicInterlacePostProcess extends PostProcess {
  151070. private _stepSize;
  151071. private _passedProcess;
  151072. /**
  151073. * Gets a string identifying the name of the class
  151074. * @returns "StereoscopicInterlacePostProcess" string
  151075. */
  151076. getClassName(): string;
  151077. /**
  151078. * Initializes a StereoscopicInterlacePostProcess
  151079. * @param name The name of the effect.
  151080. * @param rigCameras The rig cameras to be appled to the post process
  151081. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  151082. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151083. * @param engine The engine which the post process will be applied. (default: current engine)
  151084. * @param reusable If the post process can be reused on the same frame. (default: false)
  151085. */
  151086. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151087. }
  151088. }
  151089. declare module BABYLON {
  151090. /** @hidden */
  151091. export var tonemapPixelShader: {
  151092. name: string;
  151093. shader: string;
  151094. };
  151095. }
  151096. declare module BABYLON {
  151097. /** Defines operator used for tonemapping */
  151098. export enum TonemappingOperator {
  151099. /** Hable */
  151100. Hable = 0,
  151101. /** Reinhard */
  151102. Reinhard = 1,
  151103. /** HejiDawson */
  151104. HejiDawson = 2,
  151105. /** Photographic */
  151106. Photographic = 3
  151107. }
  151108. /**
  151109. * Defines a post process to apply tone mapping
  151110. */
  151111. export class TonemapPostProcess extends PostProcess {
  151112. private _operator;
  151113. /** Defines the required exposure adjustement */
  151114. exposureAdjustment: number;
  151115. /**
  151116. * Gets a string identifying the name of the class
  151117. * @returns "TonemapPostProcess" string
  151118. */
  151119. getClassName(): string;
  151120. /**
  151121. * Creates a new TonemapPostProcess
  151122. * @param name defines the name of the postprocess
  151123. * @param _operator defines the operator to use
  151124. * @param exposureAdjustment defines the required exposure adjustement
  151125. * @param camera defines the camera to use (can be null)
  151126. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  151127. * @param engine defines the hosting engine (can be ignore if camera is set)
  151128. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  151129. */
  151130. constructor(name: string, _operator: TonemappingOperator,
  151131. /** Defines the required exposure adjustement */
  151132. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  151133. }
  151134. }
  151135. declare module BABYLON {
  151136. /** @hidden */
  151137. export var volumetricLightScatteringPixelShader: {
  151138. name: string;
  151139. shader: string;
  151140. };
  151141. }
  151142. declare module BABYLON {
  151143. /** @hidden */
  151144. export var volumetricLightScatteringPassVertexShader: {
  151145. name: string;
  151146. shader: string;
  151147. };
  151148. }
  151149. declare module BABYLON {
  151150. /** @hidden */
  151151. export var volumetricLightScatteringPassPixelShader: {
  151152. name: string;
  151153. shader: string;
  151154. };
  151155. }
  151156. declare module BABYLON {
  151157. /**
  151158. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  151159. */
  151160. export class VolumetricLightScatteringPostProcess extends PostProcess {
  151161. private _volumetricLightScatteringPass;
  151162. private _volumetricLightScatteringRTT;
  151163. private _viewPort;
  151164. private _screenCoordinates;
  151165. private _cachedDefines;
  151166. /**
  151167. * If not undefined, the mesh position is computed from the attached node position
  151168. */
  151169. attachedNode: {
  151170. position: Vector3;
  151171. };
  151172. /**
  151173. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  151174. */
  151175. customMeshPosition: Vector3;
  151176. /**
  151177. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  151178. */
  151179. useCustomMeshPosition: boolean;
  151180. /**
  151181. * If the post-process should inverse the light scattering direction
  151182. */
  151183. invert: boolean;
  151184. /**
  151185. * The internal mesh used by the post-process
  151186. */
  151187. mesh: Mesh;
  151188. /**
  151189. * @hidden
  151190. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  151191. */
  151192. get useDiffuseColor(): boolean;
  151193. set useDiffuseColor(useDiffuseColor: boolean);
  151194. /**
  151195. * Array containing the excluded meshes not rendered in the internal pass
  151196. */
  151197. excludedMeshes: AbstractMesh[];
  151198. /**
  151199. * Controls the overall intensity of the post-process
  151200. */
  151201. exposure: number;
  151202. /**
  151203. * Dissipates each sample's contribution in range [0, 1]
  151204. */
  151205. decay: number;
  151206. /**
  151207. * Controls the overall intensity of each sample
  151208. */
  151209. weight: number;
  151210. /**
  151211. * Controls the density of each sample
  151212. */
  151213. density: number;
  151214. /**
  151215. * @constructor
  151216. * @param name The post-process name
  151217. * @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)
  151218. * @param camera The camera that the post-process will be attached to
  151219. * @param mesh The mesh used to create the light scattering
  151220. * @param samples The post-process quality, default 100
  151221. * @param samplingModeThe post-process filtering mode
  151222. * @param engine The babylon engine
  151223. * @param reusable If the post-process is reusable
  151224. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  151225. */
  151226. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  151227. /**
  151228. * Returns the string "VolumetricLightScatteringPostProcess"
  151229. * @returns "VolumetricLightScatteringPostProcess"
  151230. */
  151231. getClassName(): string;
  151232. private _isReady;
  151233. /**
  151234. * Sets the new light position for light scattering effect
  151235. * @param position The new custom light position
  151236. */
  151237. setCustomMeshPosition(position: Vector3): void;
  151238. /**
  151239. * Returns the light position for light scattering effect
  151240. * @return Vector3 The custom light position
  151241. */
  151242. getCustomMeshPosition(): Vector3;
  151243. /**
  151244. * Disposes the internal assets and detaches the post-process from the camera
  151245. */
  151246. dispose(camera: Camera): void;
  151247. /**
  151248. * Returns the render target texture used by the post-process
  151249. * @return the render target texture used by the post-process
  151250. */
  151251. getPass(): RenderTargetTexture;
  151252. private _meshExcluded;
  151253. private _createPass;
  151254. private _updateMeshScreenCoordinates;
  151255. /**
  151256. * Creates a default mesh for the Volumeric Light Scattering post-process
  151257. * @param name The mesh name
  151258. * @param scene The scene where to create the mesh
  151259. * @return the default mesh
  151260. */
  151261. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  151262. }
  151263. }
  151264. declare module BABYLON {
  151265. /** @hidden */
  151266. export var screenSpaceCurvaturePixelShader: {
  151267. name: string;
  151268. shader: string;
  151269. };
  151270. }
  151271. declare module BABYLON {
  151272. /**
  151273. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  151274. */
  151275. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  151276. /**
  151277. * Defines how much ridge the curvature effect displays.
  151278. */
  151279. ridge: number;
  151280. /**
  151281. * Defines how much valley the curvature effect displays.
  151282. */
  151283. valley: number;
  151284. private _geometryBufferRenderer;
  151285. /**
  151286. * Gets a string identifying the name of the class
  151287. * @returns "ScreenSpaceCurvaturePostProcess" string
  151288. */
  151289. getClassName(): string;
  151290. /**
  151291. * Creates a new instance ScreenSpaceCurvaturePostProcess
  151292. * @param name The name of the effect.
  151293. * @param scene The scene containing the objects to blur according to their velocity.
  151294. * @param options The required width/height ratio to downsize to before computing the render pass.
  151295. * @param camera The camera to apply the render pass to.
  151296. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151297. * @param engine The engine which the post process will be applied. (default: current engine)
  151298. * @param reusable If the post process can be reused on the same frame. (default: false)
  151299. * @param textureType Type of textures used when performing the post process. (default: 0)
  151300. * @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)
  151301. */
  151302. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151303. /**
  151304. * Support test.
  151305. */
  151306. static get IsSupported(): boolean;
  151307. /** @hidden */
  151308. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  151309. }
  151310. }
  151311. declare module BABYLON {
  151312. interface Scene {
  151313. /** @hidden (Backing field) */
  151314. _boundingBoxRenderer: BoundingBoxRenderer;
  151315. /** @hidden (Backing field) */
  151316. _forceShowBoundingBoxes: boolean;
  151317. /**
  151318. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  151319. */
  151320. forceShowBoundingBoxes: boolean;
  151321. /**
  151322. * Gets the bounding box renderer associated with the scene
  151323. * @returns a BoundingBoxRenderer
  151324. */
  151325. getBoundingBoxRenderer(): BoundingBoxRenderer;
  151326. }
  151327. interface AbstractMesh {
  151328. /** @hidden (Backing field) */
  151329. _showBoundingBox: boolean;
  151330. /**
  151331. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  151332. */
  151333. showBoundingBox: boolean;
  151334. }
  151335. /**
  151336. * Component responsible of rendering the bounding box of the meshes in a scene.
  151337. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  151338. */
  151339. export class BoundingBoxRenderer implements ISceneComponent {
  151340. /**
  151341. * The component name helpfull to identify the component in the list of scene components.
  151342. */
  151343. readonly name: string;
  151344. /**
  151345. * The scene the component belongs to.
  151346. */
  151347. scene: Scene;
  151348. /**
  151349. * Color of the bounding box lines placed in front of an object
  151350. */
  151351. frontColor: Color3;
  151352. /**
  151353. * Color of the bounding box lines placed behind an object
  151354. */
  151355. backColor: Color3;
  151356. /**
  151357. * Defines if the renderer should show the back lines or not
  151358. */
  151359. showBackLines: boolean;
  151360. /**
  151361. * Observable raised before rendering a bounding box
  151362. */
  151363. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  151364. /**
  151365. * Observable raised after rendering a bounding box
  151366. */
  151367. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  151368. /**
  151369. * @hidden
  151370. */
  151371. renderList: SmartArray<BoundingBox>;
  151372. private _colorShader;
  151373. private _vertexBuffers;
  151374. private _indexBuffer;
  151375. private _fillIndexBuffer;
  151376. private _fillIndexData;
  151377. /**
  151378. * Instantiates a new bounding box renderer in a scene.
  151379. * @param scene the scene the renderer renders in
  151380. */
  151381. constructor(scene: Scene);
  151382. /**
  151383. * Registers the component in a given scene
  151384. */
  151385. register(): void;
  151386. private _evaluateSubMesh;
  151387. private _activeMesh;
  151388. private _prepareRessources;
  151389. private _createIndexBuffer;
  151390. /**
  151391. * Rebuilds the elements related to this component in case of
  151392. * context lost for instance.
  151393. */
  151394. rebuild(): void;
  151395. /**
  151396. * @hidden
  151397. */
  151398. reset(): void;
  151399. /**
  151400. * Render the bounding boxes of a specific rendering group
  151401. * @param renderingGroupId defines the rendering group to render
  151402. */
  151403. render(renderingGroupId: number): void;
  151404. /**
  151405. * In case of occlusion queries, we can render the occlusion bounding box through this method
  151406. * @param mesh Define the mesh to render the occlusion bounding box for
  151407. */
  151408. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  151409. /**
  151410. * Dispose and release the resources attached to this renderer.
  151411. */
  151412. dispose(): void;
  151413. }
  151414. }
  151415. declare module BABYLON {
  151416. interface Scene {
  151417. /** @hidden (Backing field) */
  151418. _depthRenderer: {
  151419. [id: string]: DepthRenderer;
  151420. };
  151421. /**
  151422. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  151423. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  151424. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  151425. * @returns the created depth renderer
  151426. */
  151427. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  151428. /**
  151429. * Disables a depth renderer for a given camera
  151430. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  151431. */
  151432. disableDepthRenderer(camera?: Nullable<Camera>): void;
  151433. }
  151434. /**
  151435. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  151436. * in several rendering techniques.
  151437. */
  151438. export class DepthRendererSceneComponent implements ISceneComponent {
  151439. /**
  151440. * The component name helpfull to identify the component in the list of scene components.
  151441. */
  151442. readonly name: string;
  151443. /**
  151444. * The scene the component belongs to.
  151445. */
  151446. scene: Scene;
  151447. /**
  151448. * Creates a new instance of the component for the given scene
  151449. * @param scene Defines the scene to register the component in
  151450. */
  151451. constructor(scene: Scene);
  151452. /**
  151453. * Registers the component in a given scene
  151454. */
  151455. register(): void;
  151456. /**
  151457. * Rebuilds the elements related to this component in case of
  151458. * context lost for instance.
  151459. */
  151460. rebuild(): void;
  151461. /**
  151462. * Disposes the component and the associated ressources
  151463. */
  151464. dispose(): void;
  151465. private _gatherRenderTargets;
  151466. private _gatherActiveCameraRenderTargets;
  151467. }
  151468. }
  151469. declare module BABYLON {
  151470. interface AbstractScene {
  151471. /** @hidden (Backing field) */
  151472. _prePassRenderer: Nullable<PrePassRenderer>;
  151473. /**
  151474. * Gets or Sets the current prepass renderer associated to the scene.
  151475. */
  151476. prePassRenderer: Nullable<PrePassRenderer>;
  151477. /**
  151478. * Enables the prepass and associates it with the scene
  151479. * @returns the PrePassRenderer
  151480. */
  151481. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  151482. /**
  151483. * Disables the prepass associated with the scene
  151484. */
  151485. disablePrePassRenderer(): void;
  151486. }
  151487. /**
  151488. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151489. * in several rendering techniques.
  151490. */
  151491. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  151492. /**
  151493. * The component name helpful to identify the component in the list of scene components.
  151494. */
  151495. readonly name: string;
  151496. /**
  151497. * The scene the component belongs to.
  151498. */
  151499. scene: Scene;
  151500. /**
  151501. * Creates a new instance of the component for the given scene
  151502. * @param scene Defines the scene to register the component in
  151503. */
  151504. constructor(scene: Scene);
  151505. /**
  151506. * Registers the component in a given scene
  151507. */
  151508. register(): void;
  151509. private _beforeCameraDraw;
  151510. private _afterCameraDraw;
  151511. private _beforeClearStage;
  151512. /**
  151513. * Serializes the component data to the specified json object
  151514. * @param serializationObject The object to serialize to
  151515. */
  151516. serialize(serializationObject: any): void;
  151517. /**
  151518. * Adds all the elements from the container to the scene
  151519. * @param container the container holding the elements
  151520. */
  151521. addFromContainer(container: AbstractScene): void;
  151522. /**
  151523. * Removes all the elements in the container from the scene
  151524. * @param container contains the elements to remove
  151525. * @param dispose if the removed element should be disposed (default: false)
  151526. */
  151527. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  151528. /**
  151529. * Rebuilds the elements related to this component in case of
  151530. * context lost for instance.
  151531. */
  151532. rebuild(): void;
  151533. /**
  151534. * Disposes the component and the associated ressources
  151535. */
  151536. dispose(): void;
  151537. }
  151538. }
  151539. declare module BABYLON {
  151540. /** @hidden */
  151541. export var outlinePixelShader: {
  151542. name: string;
  151543. shader: string;
  151544. };
  151545. }
  151546. declare module BABYLON {
  151547. /** @hidden */
  151548. export var outlineVertexShader: {
  151549. name: string;
  151550. shader: string;
  151551. };
  151552. }
  151553. declare module BABYLON {
  151554. interface Scene {
  151555. /** @hidden */
  151556. _outlineRenderer: OutlineRenderer;
  151557. /**
  151558. * Gets the outline renderer associated with the scene
  151559. * @returns a OutlineRenderer
  151560. */
  151561. getOutlineRenderer(): OutlineRenderer;
  151562. }
  151563. interface AbstractMesh {
  151564. /** @hidden (Backing field) */
  151565. _renderOutline: boolean;
  151566. /**
  151567. * Gets or sets a boolean indicating if the outline must be rendered as well
  151568. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  151569. */
  151570. renderOutline: boolean;
  151571. /** @hidden (Backing field) */
  151572. _renderOverlay: boolean;
  151573. /**
  151574. * Gets or sets a boolean indicating if the overlay must be rendered as well
  151575. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  151576. */
  151577. renderOverlay: boolean;
  151578. }
  151579. /**
  151580. * This class is responsible to draw bothe outline/overlay of meshes.
  151581. * It should not be used directly but through the available method on mesh.
  151582. */
  151583. export class OutlineRenderer implements ISceneComponent {
  151584. /**
  151585. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  151586. */
  151587. private static _StencilReference;
  151588. /**
  151589. * The name of the component. Each component must have a unique name.
  151590. */
  151591. name: string;
  151592. /**
  151593. * The scene the component belongs to.
  151594. */
  151595. scene: Scene;
  151596. /**
  151597. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  151598. */
  151599. zOffset: number;
  151600. private _engine;
  151601. private _effect;
  151602. private _cachedDefines;
  151603. private _savedDepthWrite;
  151604. /**
  151605. * Instantiates a new outline renderer. (There could be only one per scene).
  151606. * @param scene Defines the scene it belongs to
  151607. */
  151608. constructor(scene: Scene);
  151609. /**
  151610. * Register the component to one instance of a scene.
  151611. */
  151612. register(): void;
  151613. /**
  151614. * Rebuilds the elements related to this component in case of
  151615. * context lost for instance.
  151616. */
  151617. rebuild(): void;
  151618. /**
  151619. * Disposes the component and the associated ressources.
  151620. */
  151621. dispose(): void;
  151622. /**
  151623. * Renders the outline in the canvas.
  151624. * @param subMesh Defines the sumesh to render
  151625. * @param batch Defines the batch of meshes in case of instances
  151626. * @param useOverlay Defines if the rendering is for the overlay or the outline
  151627. */
  151628. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  151629. /**
  151630. * Returns whether or not the outline renderer is ready for a given submesh.
  151631. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  151632. * @param subMesh Defines the submesh to check readyness for
  151633. * @param useInstances Defines wheter wee are trying to render instances or not
  151634. * @returns true if ready otherwise false
  151635. */
  151636. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  151637. private _beforeRenderingMesh;
  151638. private _afterRenderingMesh;
  151639. }
  151640. }
  151641. declare module BABYLON {
  151642. /**
  151643. * Defines the basic options interface of a Sprite Frame Source Size.
  151644. */
  151645. export interface ISpriteJSONSpriteSourceSize {
  151646. /**
  151647. * number of the original width of the Frame
  151648. */
  151649. w: number;
  151650. /**
  151651. * number of the original height of the Frame
  151652. */
  151653. h: number;
  151654. }
  151655. /**
  151656. * Defines the basic options interface of a Sprite Frame Data.
  151657. */
  151658. export interface ISpriteJSONSpriteFrameData {
  151659. /**
  151660. * number of the x offset of the Frame
  151661. */
  151662. x: number;
  151663. /**
  151664. * number of the y offset of the Frame
  151665. */
  151666. y: number;
  151667. /**
  151668. * number of the width of the Frame
  151669. */
  151670. w: number;
  151671. /**
  151672. * number of the height of the Frame
  151673. */
  151674. h: number;
  151675. }
  151676. /**
  151677. * Defines the basic options interface of a JSON Sprite.
  151678. */
  151679. export interface ISpriteJSONSprite {
  151680. /**
  151681. * string name of the Frame
  151682. */
  151683. filename: string;
  151684. /**
  151685. * ISpriteJSONSpriteFrame basic object of the frame data
  151686. */
  151687. frame: ISpriteJSONSpriteFrameData;
  151688. /**
  151689. * boolean to flag is the frame was rotated.
  151690. */
  151691. rotated: boolean;
  151692. /**
  151693. * boolean to flag is the frame was trimmed.
  151694. */
  151695. trimmed: boolean;
  151696. /**
  151697. * ISpriteJSONSpriteFrame basic object of the source data
  151698. */
  151699. spriteSourceSize: ISpriteJSONSpriteFrameData;
  151700. /**
  151701. * ISpriteJSONSpriteFrame basic object of the source data
  151702. */
  151703. sourceSize: ISpriteJSONSpriteSourceSize;
  151704. }
  151705. /**
  151706. * Defines the basic options interface of a JSON atlas.
  151707. */
  151708. export interface ISpriteJSONAtlas {
  151709. /**
  151710. * Array of objects that contain the frame data.
  151711. */
  151712. frames: Array<ISpriteJSONSprite>;
  151713. /**
  151714. * object basic object containing the sprite meta data.
  151715. */
  151716. meta?: object;
  151717. }
  151718. }
  151719. declare module BABYLON {
  151720. /** @hidden */
  151721. export var spriteMapPixelShader: {
  151722. name: string;
  151723. shader: string;
  151724. };
  151725. }
  151726. declare module BABYLON {
  151727. /** @hidden */
  151728. export var spriteMapVertexShader: {
  151729. name: string;
  151730. shader: string;
  151731. };
  151732. }
  151733. declare module BABYLON {
  151734. /**
  151735. * Defines the basic options interface of a SpriteMap
  151736. */
  151737. export interface ISpriteMapOptions {
  151738. /**
  151739. * Vector2 of the number of cells in the grid.
  151740. */
  151741. stageSize?: Vector2;
  151742. /**
  151743. * Vector2 of the size of the output plane in World Units.
  151744. */
  151745. outputSize?: Vector2;
  151746. /**
  151747. * Vector3 of the position of the output plane in World Units.
  151748. */
  151749. outputPosition?: Vector3;
  151750. /**
  151751. * Vector3 of the rotation of the output plane.
  151752. */
  151753. outputRotation?: Vector3;
  151754. /**
  151755. * number of layers that the system will reserve in resources.
  151756. */
  151757. layerCount?: number;
  151758. /**
  151759. * number of max animation frames a single cell will reserve in resources.
  151760. */
  151761. maxAnimationFrames?: number;
  151762. /**
  151763. * number cell index of the base tile when the system compiles.
  151764. */
  151765. baseTile?: number;
  151766. /**
  151767. * boolean flip the sprite after its been repositioned by the framing data.
  151768. */
  151769. flipU?: boolean;
  151770. /**
  151771. * Vector3 scalar of the global RGB values of the SpriteMap.
  151772. */
  151773. colorMultiply?: Vector3;
  151774. }
  151775. /**
  151776. * Defines the IDisposable interface in order to be cleanable from resources.
  151777. */
  151778. export interface ISpriteMap extends IDisposable {
  151779. /**
  151780. * String name of the SpriteMap.
  151781. */
  151782. name: string;
  151783. /**
  151784. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  151785. */
  151786. atlasJSON: ISpriteJSONAtlas;
  151787. /**
  151788. * Texture of the SpriteMap.
  151789. */
  151790. spriteSheet: Texture;
  151791. /**
  151792. * The parameters to initialize the SpriteMap with.
  151793. */
  151794. options: ISpriteMapOptions;
  151795. }
  151796. /**
  151797. * Class used to manage a grid restricted sprite deployment on an Output plane.
  151798. */
  151799. export class SpriteMap implements ISpriteMap {
  151800. /** The Name of the spriteMap */
  151801. name: string;
  151802. /** The JSON file with the frame and meta data */
  151803. atlasJSON: ISpriteJSONAtlas;
  151804. /** The systems Sprite Sheet Texture */
  151805. spriteSheet: Texture;
  151806. /** Arguments passed with the Constructor */
  151807. options: ISpriteMapOptions;
  151808. /** Public Sprite Storage array, parsed from atlasJSON */
  151809. sprites: Array<ISpriteJSONSprite>;
  151810. /** Returns the Number of Sprites in the System */
  151811. get spriteCount(): number;
  151812. /** Returns the Position of Output Plane*/
  151813. get position(): Vector3;
  151814. /** Returns the Position of Output Plane*/
  151815. set position(v: Vector3);
  151816. /** Returns the Rotation of Output Plane*/
  151817. get rotation(): Vector3;
  151818. /** Returns the Rotation of Output Plane*/
  151819. set rotation(v: Vector3);
  151820. /** Sets the AnimationMap*/
  151821. get animationMap(): RawTexture;
  151822. /** Sets the AnimationMap*/
  151823. set animationMap(v: RawTexture);
  151824. /** Scene that the SpriteMap was created in */
  151825. private _scene;
  151826. /** Texture Buffer of Float32 that holds tile frame data*/
  151827. private _frameMap;
  151828. /** Texture Buffers of Float32 that holds tileMap data*/
  151829. private _tileMaps;
  151830. /** Texture Buffer of Float32 that holds Animation Data*/
  151831. private _animationMap;
  151832. /** Custom ShaderMaterial Central to the System*/
  151833. private _material;
  151834. /** Custom ShaderMaterial Central to the System*/
  151835. private _output;
  151836. /** Systems Time Ticker*/
  151837. private _time;
  151838. /**
  151839. * Creates a new SpriteMap
  151840. * @param name defines the SpriteMaps Name
  151841. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  151842. * @param spriteSheet is the Texture that the Sprites are on.
  151843. * @param options a basic deployment configuration
  151844. * @param scene The Scene that the map is deployed on
  151845. */
  151846. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  151847. /**
  151848. * Returns tileID location
  151849. * @returns Vector2 the cell position ID
  151850. */
  151851. getTileID(): Vector2;
  151852. /**
  151853. * Gets the UV location of the mouse over the SpriteMap.
  151854. * @returns Vector2 the UV position of the mouse interaction
  151855. */
  151856. getMousePosition(): Vector2;
  151857. /**
  151858. * Creates the "frame" texture Buffer
  151859. * -------------------------------------
  151860. * Structure of frames
  151861. * "filename": "Falling-Water-2.png",
  151862. * "frame": {"x":69,"y":103,"w":24,"h":32},
  151863. * "rotated": true,
  151864. * "trimmed": true,
  151865. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  151866. * "sourceSize": {"w":32,"h":32}
  151867. * @returns RawTexture of the frameMap
  151868. */
  151869. private _createFrameBuffer;
  151870. /**
  151871. * Creates the tileMap texture Buffer
  151872. * @param buffer normally and array of numbers, or a false to generate from scratch
  151873. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  151874. * @returns RawTexture of the tileMap
  151875. */
  151876. private _createTileBuffer;
  151877. /**
  151878. * Modifies the data of the tileMaps
  151879. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  151880. * @param pos is the iVector2 Coordinates of the Tile
  151881. * @param tile The SpriteIndex of the new Tile
  151882. */
  151883. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  151884. /**
  151885. * Creates the animationMap texture Buffer
  151886. * @param buffer normally and array of numbers, or a false to generate from scratch
  151887. * @returns RawTexture of the animationMap
  151888. */
  151889. private _createTileAnimationBuffer;
  151890. /**
  151891. * Modifies the data of the animationMap
  151892. * @param cellID is the Index of the Sprite
  151893. * @param _frame is the target Animation frame
  151894. * @param toCell is the Target Index of the next frame of the animation
  151895. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  151896. * @param speed is a global scalar of the time variable on the map.
  151897. */
  151898. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  151899. /**
  151900. * Exports the .tilemaps file
  151901. */
  151902. saveTileMaps(): void;
  151903. /**
  151904. * Imports the .tilemaps file
  151905. * @param url of the .tilemaps file
  151906. */
  151907. loadTileMaps(url: string): void;
  151908. /**
  151909. * Release associated resources
  151910. */
  151911. dispose(): void;
  151912. }
  151913. }
  151914. declare module BABYLON {
  151915. /**
  151916. * Class used to manage multiple sprites of different sizes on the same spritesheet
  151917. * @see https://doc.babylonjs.com/babylon101/sprites
  151918. */
  151919. export class SpritePackedManager extends SpriteManager {
  151920. /** defines the packed manager's name */
  151921. name: string;
  151922. /**
  151923. * Creates a new sprite manager from a packed sprite sheet
  151924. * @param name defines the manager's name
  151925. * @param imgUrl defines the sprite sheet url
  151926. * @param capacity defines the maximum allowed number of sprites
  151927. * @param scene defines the hosting scene
  151928. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  151929. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  151930. * @param samplingMode defines the smapling mode to use with spritesheet
  151931. * @param fromPacked set to true; do not alter
  151932. */
  151933. constructor(
  151934. /** defines the packed manager's name */
  151935. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  151936. }
  151937. }
  151938. declare module BABYLON {
  151939. /**
  151940. * Defines the list of states available for a task inside a AssetsManager
  151941. */
  151942. export enum AssetTaskState {
  151943. /**
  151944. * Initialization
  151945. */
  151946. INIT = 0,
  151947. /**
  151948. * Running
  151949. */
  151950. RUNNING = 1,
  151951. /**
  151952. * Done
  151953. */
  151954. DONE = 2,
  151955. /**
  151956. * Error
  151957. */
  151958. ERROR = 3
  151959. }
  151960. /**
  151961. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  151962. */
  151963. export abstract class AbstractAssetTask {
  151964. /**
  151965. * Task name
  151966. */ name: string;
  151967. /**
  151968. * Callback called when the task is successful
  151969. */
  151970. onSuccess: (task: any) => void;
  151971. /**
  151972. * Callback called when the task is not successful
  151973. */
  151974. onError: (task: any, message?: string, exception?: any) => void;
  151975. /**
  151976. * Creates a new AssetsManager
  151977. * @param name defines the name of the task
  151978. */
  151979. constructor(
  151980. /**
  151981. * Task name
  151982. */ name: string);
  151983. private _isCompleted;
  151984. private _taskState;
  151985. private _errorObject;
  151986. /**
  151987. * Get if the task is completed
  151988. */
  151989. get isCompleted(): boolean;
  151990. /**
  151991. * Gets the current state of the task
  151992. */
  151993. get taskState(): AssetTaskState;
  151994. /**
  151995. * Gets the current error object (if task is in error)
  151996. */
  151997. get errorObject(): {
  151998. message?: string;
  151999. exception?: any;
  152000. };
  152001. /**
  152002. * Internal only
  152003. * @hidden
  152004. */
  152005. _setErrorObject(message?: string, exception?: any): void;
  152006. /**
  152007. * Execute the current task
  152008. * @param scene defines the scene where you want your assets to be loaded
  152009. * @param onSuccess is a callback called when the task is successfully executed
  152010. * @param onError is a callback called if an error occurs
  152011. */
  152012. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152013. /**
  152014. * Execute the current task
  152015. * @param scene defines the scene where you want your assets to be loaded
  152016. * @param onSuccess is a callback called when the task is successfully executed
  152017. * @param onError is a callback called if an error occurs
  152018. */
  152019. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152020. /**
  152021. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  152022. * This can be used with failed tasks that have the reason for failure fixed.
  152023. */
  152024. reset(): void;
  152025. private onErrorCallback;
  152026. private onDoneCallback;
  152027. }
  152028. /**
  152029. * Define the interface used by progress events raised during assets loading
  152030. */
  152031. export interface IAssetsProgressEvent {
  152032. /**
  152033. * Defines the number of remaining tasks to process
  152034. */
  152035. remainingCount: number;
  152036. /**
  152037. * Defines the total number of tasks
  152038. */
  152039. totalCount: number;
  152040. /**
  152041. * Defines the task that was just processed
  152042. */
  152043. task: AbstractAssetTask;
  152044. }
  152045. /**
  152046. * Class used to share progress information about assets loading
  152047. */
  152048. export class AssetsProgressEvent implements IAssetsProgressEvent {
  152049. /**
  152050. * Defines the number of remaining tasks to process
  152051. */
  152052. remainingCount: number;
  152053. /**
  152054. * Defines the total number of tasks
  152055. */
  152056. totalCount: number;
  152057. /**
  152058. * Defines the task that was just processed
  152059. */
  152060. task: AbstractAssetTask;
  152061. /**
  152062. * Creates a AssetsProgressEvent
  152063. * @param remainingCount defines the number of remaining tasks to process
  152064. * @param totalCount defines the total number of tasks
  152065. * @param task defines the task that was just processed
  152066. */
  152067. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  152068. }
  152069. /**
  152070. * Define a task used by AssetsManager to load assets into a container
  152071. */
  152072. export class ContainerAssetTask extends AbstractAssetTask {
  152073. /**
  152074. * Defines the name of the task
  152075. */
  152076. name: string;
  152077. /**
  152078. * Defines the list of mesh's names you want to load
  152079. */
  152080. meshesNames: any;
  152081. /**
  152082. * Defines the root url to use as a base to load your meshes and associated resources
  152083. */
  152084. rootUrl: string;
  152085. /**
  152086. * Defines the filename or File of the scene to load from
  152087. */
  152088. sceneFilename: string | File;
  152089. /**
  152090. * Get the loaded asset container
  152091. */
  152092. loadedContainer: AssetContainer;
  152093. /**
  152094. * Gets the list of loaded meshes
  152095. */
  152096. loadedMeshes: Array<AbstractMesh>;
  152097. /**
  152098. * Gets the list of loaded particle systems
  152099. */
  152100. loadedParticleSystems: Array<IParticleSystem>;
  152101. /**
  152102. * Gets the list of loaded skeletons
  152103. */
  152104. loadedSkeletons: Array<Skeleton>;
  152105. /**
  152106. * Gets the list of loaded animation groups
  152107. */
  152108. loadedAnimationGroups: Array<AnimationGroup>;
  152109. /**
  152110. * Callback called when the task is successful
  152111. */
  152112. onSuccess: (task: ContainerAssetTask) => void;
  152113. /**
  152114. * Callback called when the task is successful
  152115. */
  152116. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  152117. /**
  152118. * Creates a new ContainerAssetTask
  152119. * @param name defines the name of the task
  152120. * @param meshesNames defines the list of mesh's names you want to load
  152121. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152122. * @param sceneFilename defines the filename or File of the scene to load from
  152123. */
  152124. constructor(
  152125. /**
  152126. * Defines the name of the task
  152127. */
  152128. name: string,
  152129. /**
  152130. * Defines the list of mesh's names you want to load
  152131. */
  152132. meshesNames: any,
  152133. /**
  152134. * Defines the root url to use as a base to load your meshes and associated resources
  152135. */
  152136. rootUrl: string,
  152137. /**
  152138. * Defines the filename or File of the scene to load from
  152139. */
  152140. sceneFilename: string | File);
  152141. /**
  152142. * Execute the current task
  152143. * @param scene defines the scene where you want your assets to be loaded
  152144. * @param onSuccess is a callback called when the task is successfully executed
  152145. * @param onError is a callback called if an error occurs
  152146. */
  152147. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152148. }
  152149. /**
  152150. * Define a task used by AssetsManager to load meshes
  152151. */
  152152. export class MeshAssetTask extends AbstractAssetTask {
  152153. /**
  152154. * Defines the name of the task
  152155. */
  152156. name: string;
  152157. /**
  152158. * Defines the list of mesh's names you want to load
  152159. */
  152160. meshesNames: any;
  152161. /**
  152162. * Defines the root url to use as a base to load your meshes and associated resources
  152163. */
  152164. rootUrl: string;
  152165. /**
  152166. * Defines the filename or File of the scene to load from
  152167. */
  152168. sceneFilename: string | File;
  152169. /**
  152170. * Gets the list of loaded meshes
  152171. */
  152172. loadedMeshes: Array<AbstractMesh>;
  152173. /**
  152174. * Gets the list of loaded particle systems
  152175. */
  152176. loadedParticleSystems: Array<IParticleSystem>;
  152177. /**
  152178. * Gets the list of loaded skeletons
  152179. */
  152180. loadedSkeletons: Array<Skeleton>;
  152181. /**
  152182. * Gets the list of loaded animation groups
  152183. */
  152184. loadedAnimationGroups: Array<AnimationGroup>;
  152185. /**
  152186. * Callback called when the task is successful
  152187. */
  152188. onSuccess: (task: MeshAssetTask) => void;
  152189. /**
  152190. * Callback called when the task is successful
  152191. */
  152192. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  152193. /**
  152194. * Creates a new MeshAssetTask
  152195. * @param name defines the name of the task
  152196. * @param meshesNames defines the list of mesh's names you want to load
  152197. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152198. * @param sceneFilename defines the filename or File of the scene to load from
  152199. */
  152200. constructor(
  152201. /**
  152202. * Defines the name of the task
  152203. */
  152204. name: string,
  152205. /**
  152206. * Defines the list of mesh's names you want to load
  152207. */
  152208. meshesNames: any,
  152209. /**
  152210. * Defines the root url to use as a base to load your meshes and associated resources
  152211. */
  152212. rootUrl: string,
  152213. /**
  152214. * Defines the filename or File of the scene to load from
  152215. */
  152216. sceneFilename: string | File);
  152217. /**
  152218. * Execute the current task
  152219. * @param scene defines the scene where you want your assets to be loaded
  152220. * @param onSuccess is a callback called when the task is successfully executed
  152221. * @param onError is a callback called if an error occurs
  152222. */
  152223. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152224. }
  152225. /**
  152226. * Define a task used by AssetsManager to load text content
  152227. */
  152228. export class TextFileAssetTask extends AbstractAssetTask {
  152229. /**
  152230. * Defines the name of the task
  152231. */
  152232. name: string;
  152233. /**
  152234. * Defines the location of the file to load
  152235. */
  152236. url: string;
  152237. /**
  152238. * Gets the loaded text string
  152239. */
  152240. text: string;
  152241. /**
  152242. * Callback called when the task is successful
  152243. */
  152244. onSuccess: (task: TextFileAssetTask) => void;
  152245. /**
  152246. * Callback called when the task is successful
  152247. */
  152248. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  152249. /**
  152250. * Creates a new TextFileAssetTask object
  152251. * @param name defines the name of the task
  152252. * @param url defines the location of the file to load
  152253. */
  152254. constructor(
  152255. /**
  152256. * Defines the name of the task
  152257. */
  152258. name: string,
  152259. /**
  152260. * Defines the location of the file to load
  152261. */
  152262. url: string);
  152263. /**
  152264. * Execute the current task
  152265. * @param scene defines the scene where you want your assets to be loaded
  152266. * @param onSuccess is a callback called when the task is successfully executed
  152267. * @param onError is a callback called if an error occurs
  152268. */
  152269. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152270. }
  152271. /**
  152272. * Define a task used by AssetsManager to load binary data
  152273. */
  152274. export class BinaryFileAssetTask extends AbstractAssetTask {
  152275. /**
  152276. * Defines the name of the task
  152277. */
  152278. name: string;
  152279. /**
  152280. * Defines the location of the file to load
  152281. */
  152282. url: string;
  152283. /**
  152284. * Gets the lodaded data (as an array buffer)
  152285. */
  152286. data: ArrayBuffer;
  152287. /**
  152288. * Callback called when the task is successful
  152289. */
  152290. onSuccess: (task: BinaryFileAssetTask) => void;
  152291. /**
  152292. * Callback called when the task is successful
  152293. */
  152294. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  152295. /**
  152296. * Creates a new BinaryFileAssetTask object
  152297. * @param name defines the name of the new task
  152298. * @param url defines the location of the file to load
  152299. */
  152300. constructor(
  152301. /**
  152302. * Defines the name of the task
  152303. */
  152304. name: string,
  152305. /**
  152306. * Defines the location of the file to load
  152307. */
  152308. url: string);
  152309. /**
  152310. * Execute the current task
  152311. * @param scene defines the scene where you want your assets to be loaded
  152312. * @param onSuccess is a callback called when the task is successfully executed
  152313. * @param onError is a callback called if an error occurs
  152314. */
  152315. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152316. }
  152317. /**
  152318. * Define a task used by AssetsManager to load images
  152319. */
  152320. export class ImageAssetTask extends AbstractAssetTask {
  152321. /**
  152322. * Defines the name of the task
  152323. */
  152324. name: string;
  152325. /**
  152326. * Defines the location of the image to load
  152327. */
  152328. url: string;
  152329. /**
  152330. * Gets the loaded images
  152331. */
  152332. image: HTMLImageElement;
  152333. /**
  152334. * Callback called when the task is successful
  152335. */
  152336. onSuccess: (task: ImageAssetTask) => void;
  152337. /**
  152338. * Callback called when the task is successful
  152339. */
  152340. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  152341. /**
  152342. * Creates a new ImageAssetTask
  152343. * @param name defines the name of the task
  152344. * @param url defines the location of the image to load
  152345. */
  152346. constructor(
  152347. /**
  152348. * Defines the name of the task
  152349. */
  152350. name: string,
  152351. /**
  152352. * Defines the location of the image to load
  152353. */
  152354. url: string);
  152355. /**
  152356. * Execute the current task
  152357. * @param scene defines the scene where you want your assets to be loaded
  152358. * @param onSuccess is a callback called when the task is successfully executed
  152359. * @param onError is a callback called if an error occurs
  152360. */
  152361. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152362. }
  152363. /**
  152364. * Defines the interface used by texture loading tasks
  152365. */
  152366. export interface ITextureAssetTask<TEX extends BaseTexture> {
  152367. /**
  152368. * Gets the loaded texture
  152369. */
  152370. texture: TEX;
  152371. }
  152372. /**
  152373. * Define a task used by AssetsManager to load 2D textures
  152374. */
  152375. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  152376. /**
  152377. * Defines the name of the task
  152378. */
  152379. name: string;
  152380. /**
  152381. * Defines the location of the file to load
  152382. */
  152383. url: string;
  152384. /**
  152385. * Defines if mipmap should not be generated (default is false)
  152386. */
  152387. noMipmap?: boolean | undefined;
  152388. /**
  152389. * Defines if texture must be inverted on Y axis (default is true)
  152390. */
  152391. invertY: boolean;
  152392. /**
  152393. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152394. */
  152395. samplingMode: number;
  152396. /**
  152397. * Gets the loaded texture
  152398. */
  152399. texture: Texture;
  152400. /**
  152401. * Callback called when the task is successful
  152402. */
  152403. onSuccess: (task: TextureAssetTask) => void;
  152404. /**
  152405. * Callback called when the task is successful
  152406. */
  152407. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  152408. /**
  152409. * Creates a new TextureAssetTask object
  152410. * @param name defines the name of the task
  152411. * @param url defines the location of the file to load
  152412. * @param noMipmap defines if mipmap should not be generated (default is false)
  152413. * @param invertY defines if texture must be inverted on Y axis (default is true)
  152414. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152415. */
  152416. constructor(
  152417. /**
  152418. * Defines the name of the task
  152419. */
  152420. name: string,
  152421. /**
  152422. * Defines the location of the file to load
  152423. */
  152424. url: string,
  152425. /**
  152426. * Defines if mipmap should not be generated (default is false)
  152427. */
  152428. noMipmap?: boolean | undefined,
  152429. /**
  152430. * Defines if texture must be inverted on Y axis (default is true)
  152431. */
  152432. invertY?: boolean,
  152433. /**
  152434. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152435. */
  152436. samplingMode?: number);
  152437. /**
  152438. * Execute the current task
  152439. * @param scene defines the scene where you want your assets to be loaded
  152440. * @param onSuccess is a callback called when the task is successfully executed
  152441. * @param onError is a callback called if an error occurs
  152442. */
  152443. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152444. }
  152445. /**
  152446. * Define a task used by AssetsManager to load cube textures
  152447. */
  152448. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  152449. /**
  152450. * Defines the name of the task
  152451. */
  152452. name: string;
  152453. /**
  152454. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152455. */
  152456. url: string;
  152457. /**
  152458. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152459. */
  152460. extensions?: string[] | undefined;
  152461. /**
  152462. * Defines if mipmaps should not be generated (default is false)
  152463. */
  152464. noMipmap?: boolean | undefined;
  152465. /**
  152466. * Defines the explicit list of files (undefined by default)
  152467. */
  152468. files?: string[] | undefined;
  152469. /**
  152470. * Gets the loaded texture
  152471. */
  152472. texture: CubeTexture;
  152473. /**
  152474. * Callback called when the task is successful
  152475. */
  152476. onSuccess: (task: CubeTextureAssetTask) => void;
  152477. /**
  152478. * Callback called when the task is successful
  152479. */
  152480. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  152481. /**
  152482. * Creates a new CubeTextureAssetTask
  152483. * @param name defines the name of the task
  152484. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152485. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152486. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152487. * @param files defines the explicit list of files (undefined by default)
  152488. */
  152489. constructor(
  152490. /**
  152491. * Defines the name of the task
  152492. */
  152493. name: string,
  152494. /**
  152495. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152496. */
  152497. url: string,
  152498. /**
  152499. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152500. */
  152501. extensions?: string[] | undefined,
  152502. /**
  152503. * Defines if mipmaps should not be generated (default is false)
  152504. */
  152505. noMipmap?: boolean | undefined,
  152506. /**
  152507. * Defines the explicit list of files (undefined by default)
  152508. */
  152509. files?: string[] | undefined);
  152510. /**
  152511. * Execute the current task
  152512. * @param scene defines the scene where you want your assets to be loaded
  152513. * @param onSuccess is a callback called when the task is successfully executed
  152514. * @param onError is a callback called if an error occurs
  152515. */
  152516. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152517. }
  152518. /**
  152519. * Define a task used by AssetsManager to load HDR cube textures
  152520. */
  152521. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  152522. /**
  152523. * Defines the name of the task
  152524. */
  152525. name: string;
  152526. /**
  152527. * Defines the location of the file to load
  152528. */
  152529. url: string;
  152530. /**
  152531. * Defines the desired size (the more it increases the longer the generation will be)
  152532. */
  152533. size: number;
  152534. /**
  152535. * Defines if mipmaps should not be generated (default is false)
  152536. */
  152537. noMipmap: boolean;
  152538. /**
  152539. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152540. */
  152541. generateHarmonics: boolean;
  152542. /**
  152543. * 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)
  152544. */
  152545. gammaSpace: boolean;
  152546. /**
  152547. * Internal Use Only
  152548. */
  152549. reserved: boolean;
  152550. /**
  152551. * Gets the loaded texture
  152552. */
  152553. texture: HDRCubeTexture;
  152554. /**
  152555. * Callback called when the task is successful
  152556. */
  152557. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  152558. /**
  152559. * Callback called when the task is successful
  152560. */
  152561. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  152562. /**
  152563. * Creates a new HDRCubeTextureAssetTask object
  152564. * @param name defines the name of the task
  152565. * @param url defines the location of the file to load
  152566. * @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.
  152567. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152568. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152569. * @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)
  152570. * @param reserved Internal use only
  152571. */
  152572. constructor(
  152573. /**
  152574. * Defines the name of the task
  152575. */
  152576. name: string,
  152577. /**
  152578. * Defines the location of the file to load
  152579. */
  152580. url: string,
  152581. /**
  152582. * Defines the desired size (the more it increases the longer the generation will be)
  152583. */
  152584. size: number,
  152585. /**
  152586. * Defines if mipmaps should not be generated (default is false)
  152587. */
  152588. noMipmap?: boolean,
  152589. /**
  152590. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152591. */
  152592. generateHarmonics?: boolean,
  152593. /**
  152594. * 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)
  152595. */
  152596. gammaSpace?: boolean,
  152597. /**
  152598. * Internal Use Only
  152599. */
  152600. reserved?: boolean);
  152601. /**
  152602. * Execute the current task
  152603. * @param scene defines the scene where you want your assets to be loaded
  152604. * @param onSuccess is a callback called when the task is successfully executed
  152605. * @param onError is a callback called if an error occurs
  152606. */
  152607. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152608. }
  152609. /**
  152610. * Define a task used by AssetsManager to load Equirectangular cube textures
  152611. */
  152612. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  152613. /**
  152614. * Defines the name of the task
  152615. */
  152616. name: string;
  152617. /**
  152618. * Defines the location of the file to load
  152619. */
  152620. url: string;
  152621. /**
  152622. * Defines the desired size (the more it increases the longer the generation will be)
  152623. */
  152624. size: number;
  152625. /**
  152626. * Defines if mipmaps should not be generated (default is false)
  152627. */
  152628. noMipmap: boolean;
  152629. /**
  152630. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152631. * but the standard material would require them in Gamma space) (default is true)
  152632. */
  152633. gammaSpace: boolean;
  152634. /**
  152635. * Gets the loaded texture
  152636. */
  152637. texture: EquiRectangularCubeTexture;
  152638. /**
  152639. * Callback called when the task is successful
  152640. */
  152641. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  152642. /**
  152643. * Callback called when the task is successful
  152644. */
  152645. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  152646. /**
  152647. * Creates a new EquiRectangularCubeTextureAssetTask object
  152648. * @param name defines the name of the task
  152649. * @param url defines the location of the file to load
  152650. * @param size defines the desired size (the more it increases the longer the generation will be)
  152651. * If the size is omitted this implies you are using a preprocessed cubemap.
  152652. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152653. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  152654. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  152655. * (default is true)
  152656. */
  152657. constructor(
  152658. /**
  152659. * Defines the name of the task
  152660. */
  152661. name: string,
  152662. /**
  152663. * Defines the location of the file to load
  152664. */
  152665. url: string,
  152666. /**
  152667. * Defines the desired size (the more it increases the longer the generation will be)
  152668. */
  152669. size: number,
  152670. /**
  152671. * Defines if mipmaps should not be generated (default is false)
  152672. */
  152673. noMipmap?: boolean,
  152674. /**
  152675. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152676. * but the standard material would require them in Gamma space) (default is true)
  152677. */
  152678. gammaSpace?: boolean);
  152679. /**
  152680. * Execute the current task
  152681. * @param scene defines the scene where you want your assets to be loaded
  152682. * @param onSuccess is a callback called when the task is successfully executed
  152683. * @param onError is a callback called if an error occurs
  152684. */
  152685. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152686. }
  152687. /**
  152688. * This class can be used to easily import assets into a scene
  152689. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  152690. */
  152691. export class AssetsManager {
  152692. private _scene;
  152693. private _isLoading;
  152694. protected _tasks: AbstractAssetTask[];
  152695. protected _waitingTasksCount: number;
  152696. protected _totalTasksCount: number;
  152697. /**
  152698. * Callback called when all tasks are processed
  152699. */
  152700. onFinish: (tasks: AbstractAssetTask[]) => void;
  152701. /**
  152702. * Callback called when a task is successful
  152703. */
  152704. onTaskSuccess: (task: AbstractAssetTask) => void;
  152705. /**
  152706. * Callback called when a task had an error
  152707. */
  152708. onTaskError: (task: AbstractAssetTask) => void;
  152709. /**
  152710. * Callback called when a task is done (whatever the result is)
  152711. */
  152712. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  152713. /**
  152714. * Observable called when all tasks are processed
  152715. */
  152716. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  152717. /**
  152718. * Observable called when a task had an error
  152719. */
  152720. onTaskErrorObservable: Observable<AbstractAssetTask>;
  152721. /**
  152722. * Observable called when all tasks were executed
  152723. */
  152724. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  152725. /**
  152726. * Observable called when a task is done (whatever the result is)
  152727. */
  152728. onProgressObservable: Observable<IAssetsProgressEvent>;
  152729. /**
  152730. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  152731. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  152732. */
  152733. useDefaultLoadingScreen: boolean;
  152734. /**
  152735. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  152736. * when all assets have been downloaded.
  152737. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  152738. */
  152739. autoHideLoadingUI: boolean;
  152740. /**
  152741. * Creates a new AssetsManager
  152742. * @param scene defines the scene to work on
  152743. */
  152744. constructor(scene: Scene);
  152745. /**
  152746. * Add a ContainerAssetTask to the list of active tasks
  152747. * @param taskName defines the name of the new task
  152748. * @param meshesNames defines the name of meshes to load
  152749. * @param rootUrl defines the root url to use to locate files
  152750. * @param sceneFilename defines the filename of the scene file
  152751. * @returns a new ContainerAssetTask object
  152752. */
  152753. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  152754. /**
  152755. * Add a MeshAssetTask to the list of active tasks
  152756. * @param taskName defines the name of the new task
  152757. * @param meshesNames defines the name of meshes to load
  152758. * @param rootUrl defines the root url to use to locate files
  152759. * @param sceneFilename defines the filename of the scene file
  152760. * @returns a new MeshAssetTask object
  152761. */
  152762. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  152763. /**
  152764. * Add a TextFileAssetTask to the list of active tasks
  152765. * @param taskName defines the name of the new task
  152766. * @param url defines the url of the file to load
  152767. * @returns a new TextFileAssetTask object
  152768. */
  152769. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  152770. /**
  152771. * Add a BinaryFileAssetTask to the list of active tasks
  152772. * @param taskName defines the name of the new task
  152773. * @param url defines the url of the file to load
  152774. * @returns a new BinaryFileAssetTask object
  152775. */
  152776. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  152777. /**
  152778. * Add a ImageAssetTask to the list of active tasks
  152779. * @param taskName defines the name of the new task
  152780. * @param url defines the url of the file to load
  152781. * @returns a new ImageAssetTask object
  152782. */
  152783. addImageTask(taskName: string, url: string): ImageAssetTask;
  152784. /**
  152785. * Add a TextureAssetTask to the list of active tasks
  152786. * @param taskName defines the name of the new task
  152787. * @param url defines the url of the file to load
  152788. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152789. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  152790. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  152791. * @returns a new TextureAssetTask object
  152792. */
  152793. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  152794. /**
  152795. * Add a CubeTextureAssetTask to the list of active tasks
  152796. * @param taskName defines the name of the new task
  152797. * @param url defines the url of the file to load
  152798. * @param extensions defines the extension to use to load the cube map (can be null)
  152799. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152800. * @param files defines the list of files to load (can be null)
  152801. * @returns a new CubeTextureAssetTask object
  152802. */
  152803. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  152804. /**
  152805. *
  152806. * Add a HDRCubeTextureAssetTask to the list of active tasks
  152807. * @param taskName defines the name of the new task
  152808. * @param url defines the url of the file to load
  152809. * @param size defines the size you want for the cubemap (can be null)
  152810. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152811. * @param generateHarmonics defines if you want to automatically generate (true by default)
  152812. * @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)
  152813. * @param reserved Internal use only
  152814. * @returns a new HDRCubeTextureAssetTask object
  152815. */
  152816. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  152817. /**
  152818. *
  152819. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  152820. * @param taskName defines the name of the new task
  152821. * @param url defines the url of the file to load
  152822. * @param size defines the size you want for the cubemap (can be null)
  152823. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152824. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  152825. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  152826. * @returns a new EquiRectangularCubeTextureAssetTask object
  152827. */
  152828. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  152829. /**
  152830. * Remove a task from the assets manager.
  152831. * @param task the task to remove
  152832. */
  152833. removeTask(task: AbstractAssetTask): void;
  152834. private _decreaseWaitingTasksCount;
  152835. private _runTask;
  152836. /**
  152837. * Reset the AssetsManager and remove all tasks
  152838. * @return the current instance of the AssetsManager
  152839. */
  152840. reset(): AssetsManager;
  152841. /**
  152842. * Start the loading process
  152843. * @return the current instance of the AssetsManager
  152844. */
  152845. load(): AssetsManager;
  152846. /**
  152847. * Start the loading process as an async operation
  152848. * @return a promise returning the list of failed tasks
  152849. */
  152850. loadAsync(): Promise<void>;
  152851. }
  152852. }
  152853. declare module BABYLON {
  152854. /**
  152855. * Wrapper class for promise with external resolve and reject.
  152856. */
  152857. export class Deferred<T> {
  152858. /**
  152859. * The promise associated with this deferred object.
  152860. */
  152861. readonly promise: Promise<T>;
  152862. private _resolve;
  152863. private _reject;
  152864. /**
  152865. * The resolve method of the promise associated with this deferred object.
  152866. */
  152867. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  152868. /**
  152869. * The reject method of the promise associated with this deferred object.
  152870. */
  152871. get reject(): (reason?: any) => void;
  152872. /**
  152873. * Constructor for this deferred object.
  152874. */
  152875. constructor();
  152876. }
  152877. }
  152878. declare module BABYLON {
  152879. /**
  152880. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  152881. */
  152882. export class MeshExploder {
  152883. private _centerMesh;
  152884. private _meshes;
  152885. private _meshesOrigins;
  152886. private _toCenterVectors;
  152887. private _scaledDirection;
  152888. private _newPosition;
  152889. private _centerPosition;
  152890. /**
  152891. * Explodes meshes from a center mesh.
  152892. * @param meshes The meshes to explode.
  152893. * @param centerMesh The mesh to be center of explosion.
  152894. */
  152895. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  152896. private _setCenterMesh;
  152897. /**
  152898. * Get class name
  152899. * @returns "MeshExploder"
  152900. */
  152901. getClassName(): string;
  152902. /**
  152903. * "Exploded meshes"
  152904. * @returns Array of meshes with the centerMesh at index 0.
  152905. */
  152906. getMeshes(): Array<Mesh>;
  152907. /**
  152908. * Explodes meshes giving a specific direction
  152909. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  152910. */
  152911. explode(direction?: number): void;
  152912. }
  152913. }
  152914. declare module BABYLON {
  152915. /**
  152916. * Class used to help managing file picking and drag'n'drop
  152917. */
  152918. export class FilesInput {
  152919. /**
  152920. * List of files ready to be loaded
  152921. */
  152922. static get FilesToLoad(): {
  152923. [key: string]: File;
  152924. };
  152925. /**
  152926. * Callback called when a file is processed
  152927. */
  152928. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  152929. private _engine;
  152930. private _currentScene;
  152931. private _sceneLoadedCallback;
  152932. private _progressCallback;
  152933. private _additionalRenderLoopLogicCallback;
  152934. private _textureLoadingCallback;
  152935. private _startingProcessingFilesCallback;
  152936. private _onReloadCallback;
  152937. private _errorCallback;
  152938. private _elementToMonitor;
  152939. private _sceneFileToLoad;
  152940. private _filesToLoad;
  152941. /**
  152942. * Creates a new FilesInput
  152943. * @param engine defines the rendering engine
  152944. * @param scene defines the hosting scene
  152945. * @param sceneLoadedCallback callback called when scene is loaded
  152946. * @param progressCallback callback called to track progress
  152947. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  152948. * @param textureLoadingCallback callback called when a texture is loading
  152949. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  152950. * @param onReloadCallback callback called when a reload is requested
  152951. * @param errorCallback callback call if an error occurs
  152952. */
  152953. 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>);
  152954. private _dragEnterHandler;
  152955. private _dragOverHandler;
  152956. private _dropHandler;
  152957. /**
  152958. * Calls this function to listen to drag'n'drop events on a specific DOM element
  152959. * @param elementToMonitor defines the DOM element to track
  152960. */
  152961. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  152962. /** Gets the current list of files to load */
  152963. get filesToLoad(): File[];
  152964. /**
  152965. * Release all associated resources
  152966. */
  152967. dispose(): void;
  152968. private renderFunction;
  152969. private drag;
  152970. private drop;
  152971. private _traverseFolder;
  152972. private _processFiles;
  152973. /**
  152974. * Load files from a drop event
  152975. * @param event defines the drop event to use as source
  152976. */
  152977. loadFiles(event: any): void;
  152978. private _processReload;
  152979. /**
  152980. * Reload the current scene from the loaded files
  152981. */
  152982. reload(): void;
  152983. }
  152984. }
  152985. declare module BABYLON {
  152986. /**
  152987. * Defines the root class used to create scene optimization to use with SceneOptimizer
  152988. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152989. */
  152990. export class SceneOptimization {
  152991. /**
  152992. * Defines the priority of this optimization (0 by default which means first in the list)
  152993. */
  152994. priority: number;
  152995. /**
  152996. * Gets a string describing the action executed by the current optimization
  152997. * @returns description string
  152998. */
  152999. getDescription(): string;
  153000. /**
  153001. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153002. * @param scene defines the current scene where to apply this optimization
  153003. * @param optimizer defines the current optimizer
  153004. * @returns true if everything that can be done was applied
  153005. */
  153006. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153007. /**
  153008. * Creates the SceneOptimization object
  153009. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153010. * @param desc defines the description associated with the optimization
  153011. */
  153012. constructor(
  153013. /**
  153014. * Defines the priority of this optimization (0 by default which means first in the list)
  153015. */
  153016. priority?: number);
  153017. }
  153018. /**
  153019. * Defines an optimization used to reduce the size of render target textures
  153020. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153021. */
  153022. export class TextureOptimization extends SceneOptimization {
  153023. /**
  153024. * Defines the priority of this optimization (0 by default which means first in the list)
  153025. */
  153026. priority: number;
  153027. /**
  153028. * 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
  153029. */
  153030. maximumSize: number;
  153031. /**
  153032. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153033. */
  153034. step: number;
  153035. /**
  153036. * Gets a string describing the action executed by the current optimization
  153037. * @returns description string
  153038. */
  153039. getDescription(): string;
  153040. /**
  153041. * Creates the TextureOptimization object
  153042. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153043. * @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
  153044. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153045. */
  153046. constructor(
  153047. /**
  153048. * Defines the priority of this optimization (0 by default which means first in the list)
  153049. */
  153050. priority?: number,
  153051. /**
  153052. * 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
  153053. */
  153054. maximumSize?: number,
  153055. /**
  153056. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153057. */
  153058. step?: number);
  153059. /**
  153060. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153061. * @param scene defines the current scene where to apply this optimization
  153062. * @param optimizer defines the current optimizer
  153063. * @returns true if everything that can be done was applied
  153064. */
  153065. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153066. }
  153067. /**
  153068. * Defines an optimization used to increase or decrease the rendering resolution
  153069. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153070. */
  153071. export class HardwareScalingOptimization extends SceneOptimization {
  153072. /**
  153073. * Defines the priority of this optimization (0 by default which means first in the list)
  153074. */
  153075. priority: number;
  153076. /**
  153077. * Defines the maximum scale to use (2 by default)
  153078. */
  153079. maximumScale: number;
  153080. /**
  153081. * Defines the step to use between two passes (0.5 by default)
  153082. */
  153083. step: number;
  153084. private _currentScale;
  153085. private _directionOffset;
  153086. /**
  153087. * Gets a string describing the action executed by the current optimization
  153088. * @return description string
  153089. */
  153090. getDescription(): string;
  153091. /**
  153092. * Creates the HardwareScalingOptimization object
  153093. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153094. * @param maximumScale defines the maximum scale to use (2 by default)
  153095. * @param step defines the step to use between two passes (0.5 by default)
  153096. */
  153097. constructor(
  153098. /**
  153099. * Defines the priority of this optimization (0 by default which means first in the list)
  153100. */
  153101. priority?: number,
  153102. /**
  153103. * Defines the maximum scale to use (2 by default)
  153104. */
  153105. maximumScale?: number,
  153106. /**
  153107. * Defines the step to use between two passes (0.5 by default)
  153108. */
  153109. step?: number);
  153110. /**
  153111. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153112. * @param scene defines the current scene where to apply this optimization
  153113. * @param optimizer defines the current optimizer
  153114. * @returns true if everything that can be done was applied
  153115. */
  153116. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153117. }
  153118. /**
  153119. * Defines an optimization used to remove shadows
  153120. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153121. */
  153122. export class ShadowsOptimization extends SceneOptimization {
  153123. /**
  153124. * Gets a string describing the action executed by the current optimization
  153125. * @return description string
  153126. */
  153127. getDescription(): string;
  153128. /**
  153129. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153130. * @param scene defines the current scene where to apply this optimization
  153131. * @param optimizer defines the current optimizer
  153132. * @returns true if everything that can be done was applied
  153133. */
  153134. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153135. }
  153136. /**
  153137. * Defines an optimization used to turn post-processes off
  153138. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153139. */
  153140. export class PostProcessesOptimization extends SceneOptimization {
  153141. /**
  153142. * Gets a string describing the action executed by the current optimization
  153143. * @return description string
  153144. */
  153145. getDescription(): string;
  153146. /**
  153147. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153148. * @param scene defines the current scene where to apply this optimization
  153149. * @param optimizer defines the current optimizer
  153150. * @returns true if everything that can be done was applied
  153151. */
  153152. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153153. }
  153154. /**
  153155. * Defines an optimization used to turn lens flares off
  153156. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153157. */
  153158. export class LensFlaresOptimization extends SceneOptimization {
  153159. /**
  153160. * Gets a string describing the action executed by the current optimization
  153161. * @return description string
  153162. */
  153163. getDescription(): string;
  153164. /**
  153165. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153166. * @param scene defines the current scene where to apply this optimization
  153167. * @param optimizer defines the current optimizer
  153168. * @returns true if everything that can be done was applied
  153169. */
  153170. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153171. }
  153172. /**
  153173. * Defines an optimization based on user defined callback.
  153174. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153175. */
  153176. export class CustomOptimization extends SceneOptimization {
  153177. /**
  153178. * Callback called to apply the custom optimization.
  153179. */
  153180. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  153181. /**
  153182. * Callback called to get custom description
  153183. */
  153184. onGetDescription: () => string;
  153185. /**
  153186. * Gets a string describing the action executed by the current optimization
  153187. * @returns description string
  153188. */
  153189. getDescription(): string;
  153190. /**
  153191. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153192. * @param scene defines the current scene where to apply this optimization
  153193. * @param optimizer defines the current optimizer
  153194. * @returns true if everything that can be done was applied
  153195. */
  153196. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153197. }
  153198. /**
  153199. * Defines an optimization used to turn particles off
  153200. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153201. */
  153202. export class ParticlesOptimization extends SceneOptimization {
  153203. /**
  153204. * Gets a string describing the action executed by the current optimization
  153205. * @return description string
  153206. */
  153207. getDescription(): string;
  153208. /**
  153209. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153210. * @param scene defines the current scene where to apply this optimization
  153211. * @param optimizer defines the current optimizer
  153212. * @returns true if everything that can be done was applied
  153213. */
  153214. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153215. }
  153216. /**
  153217. * Defines an optimization used to turn render targets off
  153218. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153219. */
  153220. export class RenderTargetsOptimization extends SceneOptimization {
  153221. /**
  153222. * Gets a string describing the action executed by the current optimization
  153223. * @return description string
  153224. */
  153225. getDescription(): string;
  153226. /**
  153227. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153228. * @param scene defines the current scene where to apply this optimization
  153229. * @param optimizer defines the current optimizer
  153230. * @returns true if everything that can be done was applied
  153231. */
  153232. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153233. }
  153234. /**
  153235. * Defines an optimization used to merge meshes with compatible materials
  153236. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153237. */
  153238. export class MergeMeshesOptimization extends SceneOptimization {
  153239. private static _UpdateSelectionTree;
  153240. /**
  153241. * Gets or sets a boolean which defines if optimization octree has to be updated
  153242. */
  153243. static get UpdateSelectionTree(): boolean;
  153244. /**
  153245. * Gets or sets a boolean which defines if optimization octree has to be updated
  153246. */
  153247. static set UpdateSelectionTree(value: boolean);
  153248. /**
  153249. * Gets a string describing the action executed by the current optimization
  153250. * @return description string
  153251. */
  153252. getDescription(): string;
  153253. private _canBeMerged;
  153254. /**
  153255. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153256. * @param scene defines the current scene where to apply this optimization
  153257. * @param optimizer defines the current optimizer
  153258. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  153259. * @returns true if everything that can be done was applied
  153260. */
  153261. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  153262. }
  153263. /**
  153264. * Defines a list of options used by SceneOptimizer
  153265. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153266. */
  153267. export class SceneOptimizerOptions {
  153268. /**
  153269. * Defines the target frame rate to reach (60 by default)
  153270. */
  153271. targetFrameRate: number;
  153272. /**
  153273. * Defines the interval between two checkes (2000ms by default)
  153274. */
  153275. trackerDuration: number;
  153276. /**
  153277. * Gets the list of optimizations to apply
  153278. */
  153279. optimizations: SceneOptimization[];
  153280. /**
  153281. * Creates a new list of options used by SceneOptimizer
  153282. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  153283. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  153284. */
  153285. constructor(
  153286. /**
  153287. * Defines the target frame rate to reach (60 by default)
  153288. */
  153289. targetFrameRate?: number,
  153290. /**
  153291. * Defines the interval between two checkes (2000ms by default)
  153292. */
  153293. trackerDuration?: number);
  153294. /**
  153295. * Add a new optimization
  153296. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  153297. * @returns the current SceneOptimizerOptions
  153298. */
  153299. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  153300. /**
  153301. * Add a new custom optimization
  153302. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  153303. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  153304. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153305. * @returns the current SceneOptimizerOptions
  153306. */
  153307. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  153308. /**
  153309. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  153310. * @param targetFrameRate defines the target frame rate (60 by default)
  153311. * @returns a SceneOptimizerOptions object
  153312. */
  153313. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153314. /**
  153315. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  153316. * @param targetFrameRate defines the target frame rate (60 by default)
  153317. * @returns a SceneOptimizerOptions object
  153318. */
  153319. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153320. /**
  153321. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  153322. * @param targetFrameRate defines the target frame rate (60 by default)
  153323. * @returns a SceneOptimizerOptions object
  153324. */
  153325. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153326. }
  153327. /**
  153328. * Class used to run optimizations in order to reach a target frame rate
  153329. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153330. */
  153331. export class SceneOptimizer implements IDisposable {
  153332. private _isRunning;
  153333. private _options;
  153334. private _scene;
  153335. private _currentPriorityLevel;
  153336. private _targetFrameRate;
  153337. private _trackerDuration;
  153338. private _currentFrameRate;
  153339. private _sceneDisposeObserver;
  153340. private _improvementMode;
  153341. /**
  153342. * Defines an observable called when the optimizer reaches the target frame rate
  153343. */
  153344. onSuccessObservable: Observable<SceneOptimizer>;
  153345. /**
  153346. * Defines an observable called when the optimizer enables an optimization
  153347. */
  153348. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  153349. /**
  153350. * Defines an observable called when the optimizer is not able to reach the target frame rate
  153351. */
  153352. onFailureObservable: Observable<SceneOptimizer>;
  153353. /**
  153354. * Gets a boolean indicating if the optimizer is in improvement mode
  153355. */
  153356. get isInImprovementMode(): boolean;
  153357. /**
  153358. * Gets the current priority level (0 at start)
  153359. */
  153360. get currentPriorityLevel(): number;
  153361. /**
  153362. * Gets the current frame rate checked by the SceneOptimizer
  153363. */
  153364. get currentFrameRate(): number;
  153365. /**
  153366. * Gets or sets the current target frame rate (60 by default)
  153367. */
  153368. get targetFrameRate(): number;
  153369. /**
  153370. * Gets or sets the current target frame rate (60 by default)
  153371. */
  153372. set targetFrameRate(value: number);
  153373. /**
  153374. * Gets or sets the current interval between two checks (every 2000ms by default)
  153375. */
  153376. get trackerDuration(): number;
  153377. /**
  153378. * Gets or sets the current interval between two checks (every 2000ms by default)
  153379. */
  153380. set trackerDuration(value: number);
  153381. /**
  153382. * Gets the list of active optimizations
  153383. */
  153384. get optimizations(): SceneOptimization[];
  153385. /**
  153386. * Creates a new SceneOptimizer
  153387. * @param scene defines the scene to work on
  153388. * @param options defines the options to use with the SceneOptimizer
  153389. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  153390. * @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)
  153391. */
  153392. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  153393. /**
  153394. * Stops the current optimizer
  153395. */
  153396. stop(): void;
  153397. /**
  153398. * Reset the optimizer to initial step (current priority level = 0)
  153399. */
  153400. reset(): void;
  153401. /**
  153402. * Start the optimizer. By default it will try to reach a specific framerate
  153403. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  153404. */
  153405. start(): void;
  153406. private _checkCurrentState;
  153407. /**
  153408. * Release all resources
  153409. */
  153410. dispose(): void;
  153411. /**
  153412. * Helper function to create a SceneOptimizer with one single line of code
  153413. * @param scene defines the scene to work on
  153414. * @param options defines the options to use with the SceneOptimizer
  153415. * @param onSuccess defines a callback to call on success
  153416. * @param onFailure defines a callback to call on failure
  153417. * @returns the new SceneOptimizer object
  153418. */
  153419. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  153420. }
  153421. }
  153422. declare module BABYLON {
  153423. /**
  153424. * Class used to serialize a scene into a string
  153425. */
  153426. export class SceneSerializer {
  153427. /**
  153428. * Clear cache used by a previous serialization
  153429. */
  153430. static ClearCache(): void;
  153431. /**
  153432. * Serialize a scene into a JSON compatible object
  153433. * @param scene defines the scene to serialize
  153434. * @returns a JSON compatible object
  153435. */
  153436. static Serialize(scene: Scene): any;
  153437. /**
  153438. * Serialize a mesh into a JSON compatible object
  153439. * @param toSerialize defines the mesh to serialize
  153440. * @param withParents defines if parents must be serialized as well
  153441. * @param withChildren defines if children must be serialized as well
  153442. * @returns a JSON compatible object
  153443. */
  153444. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  153445. }
  153446. }
  153447. declare module BABYLON {
  153448. /**
  153449. * Class used to host texture specific utilities
  153450. */
  153451. export class TextureTools {
  153452. /**
  153453. * Uses the GPU to create a copy texture rescaled at a given size
  153454. * @param texture Texture to copy from
  153455. * @param width defines the desired width
  153456. * @param height defines the desired height
  153457. * @param useBilinearMode defines if bilinear mode has to be used
  153458. * @return the generated texture
  153459. */
  153460. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  153461. }
  153462. }
  153463. declare module BABYLON {
  153464. /**
  153465. * This represents the different options available for the video capture.
  153466. */
  153467. export interface VideoRecorderOptions {
  153468. /** Defines the mime type of the video. */
  153469. mimeType: string;
  153470. /** Defines the FPS the video should be recorded at. */
  153471. fps: number;
  153472. /** Defines the chunk size for the recording data. */
  153473. recordChunckSize: number;
  153474. /** The audio tracks to attach to the recording. */
  153475. audioTracks?: MediaStreamTrack[];
  153476. }
  153477. /**
  153478. * This can help with recording videos from BabylonJS.
  153479. * This is based on the available WebRTC functionalities of the browser.
  153480. *
  153481. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  153482. */
  153483. export class VideoRecorder {
  153484. private static readonly _defaultOptions;
  153485. /**
  153486. * Returns whether or not the VideoRecorder is available in your browser.
  153487. * @param engine Defines the Babylon Engine.
  153488. * @returns true if supported otherwise false.
  153489. */
  153490. static IsSupported(engine: Engine): boolean;
  153491. private readonly _options;
  153492. private _canvas;
  153493. private _mediaRecorder;
  153494. private _recordedChunks;
  153495. private _fileName;
  153496. private _resolve;
  153497. private _reject;
  153498. /**
  153499. * True when a recording is already in progress.
  153500. */
  153501. get isRecording(): boolean;
  153502. /**
  153503. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  153504. * @param engine Defines the BabylonJS Engine you wish to record.
  153505. * @param options Defines options that can be used to customize the capture.
  153506. */
  153507. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  153508. /**
  153509. * Stops the current recording before the default capture timeout passed in the startRecording function.
  153510. */
  153511. stopRecording(): void;
  153512. /**
  153513. * Starts recording the canvas for a max duration specified in parameters.
  153514. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  153515. * If null no automatic download will start and you can rely on the promise to get the data back.
  153516. * @param maxDuration Defines the maximum recording time in seconds.
  153517. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  153518. * @return A promise callback at the end of the recording with the video data in Blob.
  153519. */
  153520. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  153521. /**
  153522. * Releases internal resources used during the recording.
  153523. */
  153524. dispose(): void;
  153525. private _handleDataAvailable;
  153526. private _handleError;
  153527. private _handleStop;
  153528. }
  153529. }
  153530. declare module BABYLON {
  153531. /**
  153532. * Class containing a set of static utilities functions for screenshots
  153533. */
  153534. export class ScreenshotTools {
  153535. /**
  153536. * Captures a screenshot of the current rendering
  153537. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153538. * @param engine defines the rendering engine
  153539. * @param camera defines the source camera
  153540. * @param size This parameter can be set to a single number or to an object with the
  153541. * following (optional) properties: precision, width, height. If a single number is passed,
  153542. * it will be used for both width and height. If an object is passed, the screenshot size
  153543. * will be derived from the parameters. The precision property is a multiplier allowing
  153544. * rendering at a higher or lower resolution
  153545. * @param successCallback defines the callback receives a single parameter which contains the
  153546. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153547. * src parameter of an <img> to display it
  153548. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153549. * Check your browser for supported MIME types
  153550. */
  153551. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  153552. /**
  153553. * Captures a screenshot of the current rendering
  153554. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153555. * @param engine defines the rendering engine
  153556. * @param camera defines the source camera
  153557. * @param size This parameter can be set to a single number or to an object with the
  153558. * following (optional) properties: precision, width, height. If a single number is passed,
  153559. * it will be used for both width and height. If an object is passed, the screenshot size
  153560. * will be derived from the parameters. The precision property is a multiplier allowing
  153561. * rendering at a higher or lower resolution
  153562. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153563. * Check your browser for supported MIME types
  153564. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153565. * to the src parameter of an <img> to display it
  153566. */
  153567. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  153568. /**
  153569. * Generates an image screenshot from the specified camera.
  153570. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153571. * @param engine The engine to use for rendering
  153572. * @param camera The camera to use for rendering
  153573. * @param size This parameter can be set to a single number or to an object with the
  153574. * following (optional) properties: precision, width, height. If a single number is passed,
  153575. * it will be used for both width and height. If an object is passed, the screenshot size
  153576. * will be derived from the parameters. The precision property is a multiplier allowing
  153577. * rendering at a higher or lower resolution
  153578. * @param successCallback The callback receives a single parameter which contains the
  153579. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153580. * src parameter of an <img> to display it
  153581. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153582. * Check your browser for supported MIME types
  153583. * @param samples Texture samples (default: 1)
  153584. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153585. * @param fileName A name for for the downloaded file.
  153586. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153587. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  153588. */
  153589. 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;
  153590. /**
  153591. * Generates an image screenshot from the specified camera.
  153592. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153593. * @param engine The engine to use for rendering
  153594. * @param camera The camera to use for rendering
  153595. * @param size This parameter can be set to a single number or to an object with the
  153596. * following (optional) properties: precision, width, height. If a single number is passed,
  153597. * it will be used for both width and height. If an object is passed, the screenshot size
  153598. * will be derived from the parameters. The precision property is a multiplier allowing
  153599. * rendering at a higher or lower resolution
  153600. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153601. * Check your browser for supported MIME types
  153602. * @param samples Texture samples (default: 1)
  153603. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153604. * @param fileName A name for for the downloaded file.
  153605. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153606. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153607. * to the src parameter of an <img> to display it
  153608. */
  153609. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  153610. /**
  153611. * Gets height and width for screenshot size
  153612. * @private
  153613. */
  153614. private static _getScreenshotSize;
  153615. }
  153616. }
  153617. declare module BABYLON {
  153618. /**
  153619. * Interface for a data buffer
  153620. */
  153621. export interface IDataBuffer {
  153622. /**
  153623. * Reads bytes from the data buffer.
  153624. * @param byteOffset The byte offset to read
  153625. * @param byteLength The byte length to read
  153626. * @returns A promise that resolves when the bytes are read
  153627. */
  153628. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  153629. /**
  153630. * The byte length of the buffer.
  153631. */
  153632. readonly byteLength: number;
  153633. }
  153634. /**
  153635. * Utility class for reading from a data buffer
  153636. */
  153637. export class DataReader {
  153638. /**
  153639. * The data buffer associated with this data reader.
  153640. */
  153641. readonly buffer: IDataBuffer;
  153642. /**
  153643. * The current byte offset from the beginning of the data buffer.
  153644. */
  153645. byteOffset: number;
  153646. private _dataView;
  153647. private _dataByteOffset;
  153648. /**
  153649. * Constructor
  153650. * @param buffer The buffer to read
  153651. */
  153652. constructor(buffer: IDataBuffer);
  153653. /**
  153654. * Loads the given byte length.
  153655. * @param byteLength The byte length to load
  153656. * @returns A promise that resolves when the load is complete
  153657. */
  153658. loadAsync(byteLength: number): Promise<void>;
  153659. /**
  153660. * Read a unsigned 32-bit integer from the currently loaded data range.
  153661. * @returns The 32-bit integer read
  153662. */
  153663. readUint32(): number;
  153664. /**
  153665. * Read a byte array from the currently loaded data range.
  153666. * @param byteLength The byte length to read
  153667. * @returns The byte array read
  153668. */
  153669. readUint8Array(byteLength: number): Uint8Array;
  153670. /**
  153671. * Read a string from the currently loaded data range.
  153672. * @param byteLength The byte length to read
  153673. * @returns The string read
  153674. */
  153675. readString(byteLength: number): string;
  153676. /**
  153677. * Skips the given byte length the currently loaded data range.
  153678. * @param byteLength The byte length to skip
  153679. */
  153680. skipBytes(byteLength: number): void;
  153681. }
  153682. }
  153683. declare module BABYLON {
  153684. /**
  153685. * Class for storing data to local storage if available or in-memory storage otherwise
  153686. */
  153687. export class DataStorage {
  153688. private static _Storage;
  153689. private static _GetStorage;
  153690. /**
  153691. * Reads a string from the data storage
  153692. * @param key The key to read
  153693. * @param defaultValue The value if the key doesn't exist
  153694. * @returns The string value
  153695. */
  153696. static ReadString(key: string, defaultValue: string): string;
  153697. /**
  153698. * Writes a string to the data storage
  153699. * @param key The key to write
  153700. * @param value The value to write
  153701. */
  153702. static WriteString(key: string, value: string): void;
  153703. /**
  153704. * Reads a boolean from the data storage
  153705. * @param key The key to read
  153706. * @param defaultValue The value if the key doesn't exist
  153707. * @returns The boolean value
  153708. */
  153709. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  153710. /**
  153711. * Writes a boolean to the data storage
  153712. * @param key The key to write
  153713. * @param value The value to write
  153714. */
  153715. static WriteBoolean(key: string, value: boolean): void;
  153716. /**
  153717. * Reads a number from the data storage
  153718. * @param key The key to read
  153719. * @param defaultValue The value if the key doesn't exist
  153720. * @returns The number value
  153721. */
  153722. static ReadNumber(key: string, defaultValue: number): number;
  153723. /**
  153724. * Writes a number to the data storage
  153725. * @param key The key to write
  153726. * @param value The value to write
  153727. */
  153728. static WriteNumber(key: string, value: number): void;
  153729. }
  153730. }
  153731. declare module BABYLON {
  153732. /**
  153733. * Class used to record delta files between 2 scene states
  153734. */
  153735. export class SceneRecorder {
  153736. private _trackedScene;
  153737. private _savedJSON;
  153738. /**
  153739. * Track a given scene. This means the current scene state will be considered the original state
  153740. * @param scene defines the scene to track
  153741. */
  153742. track(scene: Scene): void;
  153743. /**
  153744. * Get the delta between current state and original state
  153745. * @returns a string containing the delta
  153746. */
  153747. getDelta(): any;
  153748. private _compareArray;
  153749. private _compareObjects;
  153750. private _compareCollections;
  153751. private static GetShadowGeneratorById;
  153752. /**
  153753. * Apply a given delta to a given scene
  153754. * @param deltaJSON defines the JSON containing the delta
  153755. * @param scene defines the scene to apply the delta to
  153756. */
  153757. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  153758. private static _ApplyPropertiesToEntity;
  153759. private static _ApplyDeltaForEntity;
  153760. }
  153761. }
  153762. declare module BABYLON {
  153763. /**
  153764. * An interface for all Hit test features
  153765. */
  153766. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  153767. /**
  153768. * Triggered when new babylon (transformed) hit test results are available
  153769. */
  153770. onHitTestResultObservable: Observable<T[]>;
  153771. }
  153772. /**
  153773. * Options used for hit testing
  153774. */
  153775. export interface IWebXRLegacyHitTestOptions {
  153776. /**
  153777. * Only test when user interacted with the scene. Default - hit test every frame
  153778. */
  153779. testOnPointerDownOnly?: boolean;
  153780. /**
  153781. * The node to use to transform the local results to world coordinates
  153782. */
  153783. worldParentNode?: TransformNode;
  153784. }
  153785. /**
  153786. * Interface defining the babylon result of raycasting/hit-test
  153787. */
  153788. export interface IWebXRLegacyHitResult {
  153789. /**
  153790. * Transformation matrix that can be applied to a node that will put it in the hit point location
  153791. */
  153792. transformationMatrix: Matrix;
  153793. /**
  153794. * The native hit test result
  153795. */
  153796. xrHitResult: XRHitResult | XRHitTestResult;
  153797. }
  153798. /**
  153799. * The currently-working hit-test module.
  153800. * Hit test (or Ray-casting) is used to interact with the real world.
  153801. * For further information read here - https://github.com/immersive-web/hit-test
  153802. */
  153803. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  153804. /**
  153805. * options to use when constructing this feature
  153806. */
  153807. readonly options: IWebXRLegacyHitTestOptions;
  153808. private _direction;
  153809. private _mat;
  153810. private _onSelectEnabled;
  153811. private _origin;
  153812. /**
  153813. * The module's name
  153814. */
  153815. static readonly Name: string;
  153816. /**
  153817. * The (Babylon) version of this module.
  153818. * This is an integer representing the implementation version.
  153819. * This number does not correspond to the WebXR specs version
  153820. */
  153821. static readonly Version: number;
  153822. /**
  153823. * Populated with the last native XR Hit Results
  153824. */
  153825. lastNativeXRHitResults: XRHitResult[];
  153826. /**
  153827. * Triggered when new babylon (transformed) hit test results are available
  153828. */
  153829. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  153830. /**
  153831. * Creates a new instance of the (legacy version) hit test feature
  153832. * @param _xrSessionManager an instance of WebXRSessionManager
  153833. * @param options options to use when constructing this feature
  153834. */
  153835. constructor(_xrSessionManager: WebXRSessionManager,
  153836. /**
  153837. * options to use when constructing this feature
  153838. */
  153839. options?: IWebXRLegacyHitTestOptions);
  153840. /**
  153841. * execute a hit test with an XR Ray
  153842. *
  153843. * @param xrSession a native xrSession that will execute this hit test
  153844. * @param xrRay the ray (position and direction) to use for ray-casting
  153845. * @param referenceSpace native XR reference space to use for the hit-test
  153846. * @param filter filter function that will filter the results
  153847. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153848. */
  153849. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  153850. /**
  153851. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  153852. * @param event the (select) event to use to select with
  153853. * @param referenceSpace the reference space to use for this hit test
  153854. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153855. */
  153856. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  153857. /**
  153858. * attach this feature
  153859. * Will usually be called by the features manager
  153860. *
  153861. * @returns true if successful.
  153862. */
  153863. attach(): boolean;
  153864. /**
  153865. * detach this feature.
  153866. * Will usually be called by the features manager
  153867. *
  153868. * @returns true if successful.
  153869. */
  153870. detach(): boolean;
  153871. /**
  153872. * Dispose this feature and all of the resources attached
  153873. */
  153874. dispose(): void;
  153875. protected _onXRFrame(frame: XRFrame): void;
  153876. private _onHitTestResults;
  153877. private _onSelect;
  153878. }
  153879. }
  153880. declare module BABYLON {
  153881. /**
  153882. * Options used for hit testing (version 2)
  153883. */
  153884. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  153885. /**
  153886. * Do not create a permanent hit test. Will usually be used when only
  153887. * transient inputs are needed.
  153888. */
  153889. disablePermanentHitTest?: boolean;
  153890. /**
  153891. * Enable transient (for example touch-based) hit test inspections
  153892. */
  153893. enableTransientHitTest?: boolean;
  153894. /**
  153895. * Offset ray for the permanent hit test
  153896. */
  153897. offsetRay?: Vector3;
  153898. /**
  153899. * Offset ray for the transient hit test
  153900. */
  153901. transientOffsetRay?: Vector3;
  153902. /**
  153903. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  153904. */
  153905. useReferenceSpace?: boolean;
  153906. /**
  153907. * Override the default entity type(s) of the hit-test result
  153908. */
  153909. entityTypes?: XRHitTestTrackableType[];
  153910. }
  153911. /**
  153912. * Interface defining the babylon result of hit-test
  153913. */
  153914. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  153915. /**
  153916. * The input source that generated this hit test (if transient)
  153917. */
  153918. inputSource?: XRInputSource;
  153919. /**
  153920. * Is this a transient hit test
  153921. */
  153922. isTransient?: boolean;
  153923. /**
  153924. * Position of the hit test result
  153925. */
  153926. position: Vector3;
  153927. /**
  153928. * Rotation of the hit test result
  153929. */
  153930. rotationQuaternion: Quaternion;
  153931. /**
  153932. * The native hit test result
  153933. */
  153934. xrHitResult: XRHitTestResult;
  153935. }
  153936. /**
  153937. * The currently-working hit-test module.
  153938. * Hit test (or Ray-casting) is used to interact with the real world.
  153939. * For further information read here - https://github.com/immersive-web/hit-test
  153940. *
  153941. * Tested on chrome (mobile) 80.
  153942. */
  153943. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  153944. /**
  153945. * options to use when constructing this feature
  153946. */
  153947. readonly options: IWebXRHitTestOptions;
  153948. private _tmpMat;
  153949. private _tmpPos;
  153950. private _tmpQuat;
  153951. private _transientXrHitTestSource;
  153952. private _xrHitTestSource;
  153953. private initHitTestSource;
  153954. /**
  153955. * The module's name
  153956. */
  153957. static readonly Name: string;
  153958. /**
  153959. * The (Babylon) version of this module.
  153960. * This is an integer representing the implementation version.
  153961. * This number does not correspond to the WebXR specs version
  153962. */
  153963. static readonly Version: number;
  153964. /**
  153965. * When set to true, each hit test will have its own position/rotation objects
  153966. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  153967. * the developers will clone them or copy them as they see fit.
  153968. */
  153969. autoCloneTransformation: boolean;
  153970. /**
  153971. * Triggered when new babylon (transformed) hit test results are available
  153972. */
  153973. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  153974. /**
  153975. * Use this to temporarily pause hit test checks.
  153976. */
  153977. paused: boolean;
  153978. /**
  153979. * Creates a new instance of the hit test feature
  153980. * @param _xrSessionManager an instance of WebXRSessionManager
  153981. * @param options options to use when constructing this feature
  153982. */
  153983. constructor(_xrSessionManager: WebXRSessionManager,
  153984. /**
  153985. * options to use when constructing this feature
  153986. */
  153987. options?: IWebXRHitTestOptions);
  153988. /**
  153989. * attach this feature
  153990. * Will usually be called by the features manager
  153991. *
  153992. * @returns true if successful.
  153993. */
  153994. attach(): boolean;
  153995. /**
  153996. * detach this feature.
  153997. * Will usually be called by the features manager
  153998. *
  153999. * @returns true if successful.
  154000. */
  154001. detach(): boolean;
  154002. /**
  154003. * Dispose this feature and all of the resources attached
  154004. */
  154005. dispose(): void;
  154006. protected _onXRFrame(frame: XRFrame): void;
  154007. private _processWebXRHitTestResult;
  154008. }
  154009. }
  154010. declare module BABYLON {
  154011. /**
  154012. * Configuration options of the anchor system
  154013. */
  154014. export interface IWebXRAnchorSystemOptions {
  154015. /**
  154016. * a node that will be used to convert local to world coordinates
  154017. */
  154018. worldParentNode?: TransformNode;
  154019. /**
  154020. * If set to true a reference of the created anchors will be kept until the next session starts
  154021. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  154022. */
  154023. doNotRemoveAnchorsOnSessionEnded?: boolean;
  154024. }
  154025. /**
  154026. * A babylon container for an XR Anchor
  154027. */
  154028. export interface IWebXRAnchor {
  154029. /**
  154030. * A babylon-assigned ID for this anchor
  154031. */
  154032. id: number;
  154033. /**
  154034. * Transformation matrix to apply to an object attached to this anchor
  154035. */
  154036. transformationMatrix: Matrix;
  154037. /**
  154038. * The native anchor object
  154039. */
  154040. xrAnchor: XRAnchor;
  154041. /**
  154042. * if defined, this object will be constantly updated by the anchor's position and rotation
  154043. */
  154044. attachedNode?: TransformNode;
  154045. }
  154046. /**
  154047. * An implementation of the anchor system for WebXR.
  154048. * For further information see https://github.com/immersive-web/anchors/
  154049. */
  154050. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  154051. private _options;
  154052. private _lastFrameDetected;
  154053. private _trackedAnchors;
  154054. private _referenceSpaceForFrameAnchors;
  154055. private _futureAnchors;
  154056. /**
  154057. * The module's name
  154058. */
  154059. static readonly Name: string;
  154060. /**
  154061. * The (Babylon) version of this module.
  154062. * This is an integer representing the implementation version.
  154063. * This number does not correspond to the WebXR specs version
  154064. */
  154065. static readonly Version: number;
  154066. /**
  154067. * Observers registered here will be executed when a new anchor was added to the session
  154068. */
  154069. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  154070. /**
  154071. * Observers registered here will be executed when an anchor was removed from the session
  154072. */
  154073. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  154074. /**
  154075. * Observers registered here will be executed when an existing anchor updates
  154076. * This can execute N times every frame
  154077. */
  154078. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  154079. /**
  154080. * Set the reference space to use for anchor creation, when not using a hit test.
  154081. * Will default to the session's reference space if not defined
  154082. */
  154083. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  154084. /**
  154085. * constructs a new anchor system
  154086. * @param _xrSessionManager an instance of WebXRSessionManager
  154087. * @param _options configuration object for this feature
  154088. */
  154089. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  154090. private _tmpVector;
  154091. private _tmpQuaternion;
  154092. private _populateTmpTransformation;
  154093. /**
  154094. * Create a new anchor point using a hit test result at a specific point in the scene
  154095. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154096. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154097. *
  154098. * @param hitTestResult The hit test result to use for this anchor creation
  154099. * @param position an optional position offset for this anchor
  154100. * @param rotationQuaternion an optional rotation offset for this anchor
  154101. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154102. */
  154103. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  154104. /**
  154105. * Add a new anchor at a specific position and rotation
  154106. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  154107. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  154108. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154109. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154110. *
  154111. * @param position the position in which to add an anchor
  154112. * @param rotationQuaternion an optional rotation for the anchor transformation
  154113. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  154114. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154115. */
  154116. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  154117. /**
  154118. * detach this feature.
  154119. * Will usually be called by the features manager
  154120. *
  154121. * @returns true if successful.
  154122. */
  154123. detach(): boolean;
  154124. /**
  154125. * Dispose this feature and all of the resources attached
  154126. */
  154127. dispose(): void;
  154128. protected _onXRFrame(frame: XRFrame): void;
  154129. /**
  154130. * avoiding using Array.find for global support.
  154131. * @param xrAnchor the plane to find in the array
  154132. */
  154133. private _findIndexInAnchorArray;
  154134. private _updateAnchorWithXRFrame;
  154135. private _createAnchorAtTransformation;
  154136. }
  154137. }
  154138. declare module BABYLON {
  154139. /**
  154140. * Options used in the plane detector module
  154141. */
  154142. export interface IWebXRPlaneDetectorOptions {
  154143. /**
  154144. * The node to use to transform the local results to world coordinates
  154145. */
  154146. worldParentNode?: TransformNode;
  154147. /**
  154148. * If set to true a reference of the created planes will be kept until the next session starts
  154149. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  154150. */
  154151. doNotRemovePlanesOnSessionEnded?: boolean;
  154152. }
  154153. /**
  154154. * A babylon interface for a WebXR plane.
  154155. * A Plane is actually a polygon, built from N points in space
  154156. *
  154157. * Supported in chrome 79, not supported in canary 81 ATM
  154158. */
  154159. export interface IWebXRPlane {
  154160. /**
  154161. * a babylon-assigned ID for this polygon
  154162. */
  154163. id: number;
  154164. /**
  154165. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  154166. */
  154167. polygonDefinition: Array<Vector3>;
  154168. /**
  154169. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  154170. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  154171. */
  154172. transformationMatrix: Matrix;
  154173. /**
  154174. * the native xr-plane object
  154175. */
  154176. xrPlane: XRPlane;
  154177. }
  154178. /**
  154179. * The plane detector is used to detect planes in the real world when in AR
  154180. * For more information see https://github.com/immersive-web/real-world-geometry/
  154181. */
  154182. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  154183. private _options;
  154184. private _detectedPlanes;
  154185. private _enabled;
  154186. private _lastFrameDetected;
  154187. /**
  154188. * The module's name
  154189. */
  154190. static readonly Name: string;
  154191. /**
  154192. * The (Babylon) version of this module.
  154193. * This is an integer representing the implementation version.
  154194. * This number does not correspond to the WebXR specs version
  154195. */
  154196. static readonly Version: number;
  154197. /**
  154198. * Observers registered here will be executed when a new plane was added to the session
  154199. */
  154200. onPlaneAddedObservable: Observable<IWebXRPlane>;
  154201. /**
  154202. * Observers registered here will be executed when a plane is no longer detected in the session
  154203. */
  154204. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  154205. /**
  154206. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  154207. * This can execute N times every frame
  154208. */
  154209. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  154210. /**
  154211. * construct a new Plane Detector
  154212. * @param _xrSessionManager an instance of xr Session manager
  154213. * @param _options configuration to use when constructing this feature
  154214. */
  154215. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  154216. /**
  154217. * detach this feature.
  154218. * Will usually be called by the features manager
  154219. *
  154220. * @returns true if successful.
  154221. */
  154222. detach(): boolean;
  154223. /**
  154224. * Dispose this feature and all of the resources attached
  154225. */
  154226. dispose(): void;
  154227. protected _onXRFrame(frame: XRFrame): void;
  154228. private _init;
  154229. private _updatePlaneWithXRPlane;
  154230. /**
  154231. * avoiding using Array.find for global support.
  154232. * @param xrPlane the plane to find in the array
  154233. */
  154234. private findIndexInPlaneArray;
  154235. }
  154236. }
  154237. declare module BABYLON {
  154238. /**
  154239. * Options interface for the background remover plugin
  154240. */
  154241. export interface IWebXRBackgroundRemoverOptions {
  154242. /**
  154243. * Further background meshes to disable when entering AR
  154244. */
  154245. backgroundMeshes?: AbstractMesh[];
  154246. /**
  154247. * flags to configure the removal of the environment helper.
  154248. * If not set, the entire background will be removed. If set, flags should be set as well.
  154249. */
  154250. environmentHelperRemovalFlags?: {
  154251. /**
  154252. * Should the skybox be removed (default false)
  154253. */
  154254. skyBox?: boolean;
  154255. /**
  154256. * Should the ground be removed (default false)
  154257. */
  154258. ground?: boolean;
  154259. };
  154260. /**
  154261. * don't disable the environment helper
  154262. */
  154263. ignoreEnvironmentHelper?: boolean;
  154264. }
  154265. /**
  154266. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  154267. */
  154268. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  154269. /**
  154270. * read-only options to be used in this module
  154271. */
  154272. readonly options: IWebXRBackgroundRemoverOptions;
  154273. /**
  154274. * The module's name
  154275. */
  154276. static readonly Name: string;
  154277. /**
  154278. * The (Babylon) version of this module.
  154279. * This is an integer representing the implementation version.
  154280. * This number does not correspond to the WebXR specs version
  154281. */
  154282. static readonly Version: number;
  154283. /**
  154284. * registered observers will be triggered when the background state changes
  154285. */
  154286. onBackgroundStateChangedObservable: Observable<boolean>;
  154287. /**
  154288. * constructs a new background remover module
  154289. * @param _xrSessionManager the session manager for this module
  154290. * @param options read-only options to be used in this module
  154291. */
  154292. constructor(_xrSessionManager: WebXRSessionManager,
  154293. /**
  154294. * read-only options to be used in this module
  154295. */
  154296. options?: IWebXRBackgroundRemoverOptions);
  154297. /**
  154298. * attach this feature
  154299. * Will usually be called by the features manager
  154300. *
  154301. * @returns true if successful.
  154302. */
  154303. attach(): boolean;
  154304. /**
  154305. * detach this feature.
  154306. * Will usually be called by the features manager
  154307. *
  154308. * @returns true if successful.
  154309. */
  154310. detach(): boolean;
  154311. /**
  154312. * Dispose this feature and all of the resources attached
  154313. */
  154314. dispose(): void;
  154315. protected _onXRFrame(_xrFrame: XRFrame): void;
  154316. private _setBackgroundState;
  154317. }
  154318. }
  154319. declare module BABYLON {
  154320. /**
  154321. * Options for the controller physics feature
  154322. */
  154323. export class IWebXRControllerPhysicsOptions {
  154324. /**
  154325. * Should the headset get its own impostor
  154326. */
  154327. enableHeadsetImpostor?: boolean;
  154328. /**
  154329. * Optional parameters for the headset impostor
  154330. */
  154331. headsetImpostorParams?: {
  154332. /**
  154333. * The type of impostor to create. Default is sphere
  154334. */
  154335. impostorType: number;
  154336. /**
  154337. * the size of the impostor. Defaults to 10cm
  154338. */
  154339. impostorSize?: number | {
  154340. width: number;
  154341. height: number;
  154342. depth: number;
  154343. };
  154344. /**
  154345. * Friction definitions
  154346. */
  154347. friction?: number;
  154348. /**
  154349. * Restitution
  154350. */
  154351. restitution?: number;
  154352. };
  154353. /**
  154354. * The physics properties of the future impostors
  154355. */
  154356. physicsProperties?: {
  154357. /**
  154358. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  154359. * Note that this requires a physics engine that supports mesh impostors!
  154360. */
  154361. useControllerMesh?: boolean;
  154362. /**
  154363. * The type of impostor to create. Default is sphere
  154364. */
  154365. impostorType?: number;
  154366. /**
  154367. * the size of the impostor. Defaults to 10cm
  154368. */
  154369. impostorSize?: number | {
  154370. width: number;
  154371. height: number;
  154372. depth: number;
  154373. };
  154374. /**
  154375. * Friction definitions
  154376. */
  154377. friction?: number;
  154378. /**
  154379. * Restitution
  154380. */
  154381. restitution?: number;
  154382. };
  154383. /**
  154384. * the xr input to use with this pointer selection
  154385. */
  154386. xrInput: WebXRInput;
  154387. }
  154388. /**
  154389. * Add physics impostor to your webxr controllers,
  154390. * including naive calculation of their linear and angular velocity
  154391. */
  154392. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  154393. private readonly _options;
  154394. private _attachController;
  154395. private _controllers;
  154396. private _debugMode;
  154397. private _delta;
  154398. private _headsetImpostor?;
  154399. private _headsetMesh?;
  154400. private _lastTimestamp;
  154401. private _tmpQuaternion;
  154402. private _tmpVector;
  154403. /**
  154404. * The module's name
  154405. */
  154406. static readonly Name: string;
  154407. /**
  154408. * The (Babylon) version of this module.
  154409. * This is an integer representing the implementation version.
  154410. * This number does not correspond to the webxr specs version
  154411. */
  154412. static readonly Version: number;
  154413. /**
  154414. * Construct a new Controller Physics Feature
  154415. * @param _xrSessionManager the corresponding xr session manager
  154416. * @param _options options to create this feature with
  154417. */
  154418. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  154419. /**
  154420. * @hidden
  154421. * enable debugging - will show console outputs and the impostor mesh
  154422. */
  154423. _enablePhysicsDebug(): void;
  154424. /**
  154425. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  154426. * @param xrController the controller to add
  154427. */
  154428. addController(xrController: WebXRInputSource): void;
  154429. /**
  154430. * attach this feature
  154431. * Will usually be called by the features manager
  154432. *
  154433. * @returns true if successful.
  154434. */
  154435. attach(): boolean;
  154436. /**
  154437. * detach this feature.
  154438. * Will usually be called by the features manager
  154439. *
  154440. * @returns true if successful.
  154441. */
  154442. detach(): boolean;
  154443. /**
  154444. * Get the headset impostor, if enabled
  154445. * @returns the impostor
  154446. */
  154447. getHeadsetImpostor(): PhysicsImpostor | undefined;
  154448. /**
  154449. * Get the physics impostor of a specific controller.
  154450. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  154451. * @param controller the controller or the controller id of which to get the impostor
  154452. * @returns the impostor or null
  154453. */
  154454. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  154455. /**
  154456. * Update the physics properties provided in the constructor
  154457. * @param newProperties the new properties object
  154458. */
  154459. setPhysicsProperties(newProperties: {
  154460. impostorType?: number;
  154461. impostorSize?: number | {
  154462. width: number;
  154463. height: number;
  154464. depth: number;
  154465. };
  154466. friction?: number;
  154467. restitution?: number;
  154468. }): void;
  154469. protected _onXRFrame(_xrFrame: any): void;
  154470. private _detachController;
  154471. }
  154472. }
  154473. declare module BABYLON {
  154474. /**
  154475. * A babylon interface for a "WebXR" feature point.
  154476. * Represents the position and confidence value of a given feature point.
  154477. */
  154478. export interface IWebXRFeaturePoint {
  154479. /**
  154480. * Represents the position of the feature point in world space.
  154481. */
  154482. position: Vector3;
  154483. /**
  154484. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  154485. */
  154486. confidenceValue: number;
  154487. }
  154488. /**
  154489. * The feature point system is used to detect feature points from real world geometry.
  154490. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  154491. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  154492. */
  154493. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  154494. private _enabled;
  154495. private _featurePointCloud;
  154496. /**
  154497. * The module's name
  154498. */
  154499. static readonly Name: string;
  154500. /**
  154501. * The (Babylon) version of this module.
  154502. * This is an integer representing the implementation version.
  154503. * This number does not correspond to the WebXR specs version
  154504. */
  154505. static readonly Version: number;
  154506. /**
  154507. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  154508. * Will notify the observers about which feature points have been added.
  154509. */
  154510. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  154511. /**
  154512. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  154513. * Will notify the observers about which feature points have been updated.
  154514. */
  154515. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  154516. /**
  154517. * The current feature point cloud maintained across frames.
  154518. */
  154519. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  154520. /**
  154521. * construct the feature point system
  154522. * @param _xrSessionManager an instance of xr Session manager
  154523. */
  154524. constructor(_xrSessionManager: WebXRSessionManager);
  154525. /**
  154526. * Detach this feature.
  154527. * Will usually be called by the features manager
  154528. *
  154529. * @returns true if successful.
  154530. */
  154531. detach(): boolean;
  154532. /**
  154533. * Dispose this feature and all of the resources attached
  154534. */
  154535. dispose(): void;
  154536. /**
  154537. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  154538. */
  154539. protected _onXRFrame(frame: XRFrame): void;
  154540. /**
  154541. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  154542. */
  154543. private _init;
  154544. }
  154545. }
  154546. declare module BABYLON {
  154547. /**
  154548. * Configuration interface for the hand tracking feature
  154549. */
  154550. export interface IWebXRHandTrackingOptions {
  154551. /**
  154552. * The xrInput that will be used as source for new hands
  154553. */
  154554. xrInput: WebXRInput;
  154555. /**
  154556. * Configuration object for the joint meshes
  154557. */
  154558. jointMeshes?: {
  154559. /**
  154560. * Should the meshes created be invisible (defaults to false)
  154561. */
  154562. invisible?: boolean;
  154563. /**
  154564. * A source mesh to be used to create instances. Defaults to a sphere.
  154565. * This mesh will be the source for all other (25) meshes.
  154566. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  154567. */
  154568. sourceMesh?: Mesh;
  154569. /**
  154570. * Should the source mesh stay visible. Defaults to false
  154571. */
  154572. keepOriginalVisible?: boolean;
  154573. /**
  154574. * Scale factor for all instances (defaults to 2)
  154575. */
  154576. scaleFactor?: number;
  154577. /**
  154578. * Should each instance have its own physics impostor
  154579. */
  154580. enablePhysics?: boolean;
  154581. /**
  154582. * If enabled, override default physics properties
  154583. */
  154584. physicsProps?: {
  154585. friction?: number;
  154586. restitution?: number;
  154587. impostorType?: number;
  154588. };
  154589. /**
  154590. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  154591. */
  154592. handMesh?: AbstractMesh;
  154593. };
  154594. }
  154595. /**
  154596. * Parts of the hands divided to writs and finger names
  154597. */
  154598. export const enum HandPart {
  154599. /**
  154600. * HandPart - Wrist
  154601. */
  154602. WRIST = "wrist",
  154603. /**
  154604. * HandPart - The THumb
  154605. */
  154606. THUMB = "thumb",
  154607. /**
  154608. * HandPart - Index finger
  154609. */
  154610. INDEX = "index",
  154611. /**
  154612. * HandPart - Middle finger
  154613. */
  154614. MIDDLE = "middle",
  154615. /**
  154616. * HandPart - Ring finger
  154617. */
  154618. RING = "ring",
  154619. /**
  154620. * HandPart - Little finger
  154621. */
  154622. LITTLE = "little"
  154623. }
  154624. /**
  154625. * Representing a single hand (with its corresponding native XRHand object)
  154626. */
  154627. export class WebXRHand implements IDisposable {
  154628. /** the controller to which the hand correlates */
  154629. readonly xrController: WebXRInputSource;
  154630. /** the meshes to be used to track the hand joints */
  154631. readonly trackedMeshes: AbstractMesh[];
  154632. /**
  154633. * Hand-parts definition (key is HandPart)
  154634. */
  154635. static HandPartsDefinition: {
  154636. [key: string]: number[];
  154637. };
  154638. /**
  154639. * Populate the HandPartsDefinition object.
  154640. * This is called as a side effect since certain browsers don't have XRHand defined.
  154641. */
  154642. static _PopulateHandPartsDefinition(): void;
  154643. /**
  154644. * Construct a new hand object
  154645. * @param xrController the controller to which the hand correlates
  154646. * @param trackedMeshes the meshes to be used to track the hand joints
  154647. */
  154648. constructor(
  154649. /** the controller to which the hand correlates */
  154650. xrController: WebXRInputSource,
  154651. /** the meshes to be used to track the hand joints */
  154652. trackedMeshes: AbstractMesh[]);
  154653. /**
  154654. * Update this hand from the latest xr frame
  154655. * @param xrFrame xrFrame to update from
  154656. * @param referenceSpace The current viewer reference space
  154657. * @param scaleFactor optional scale factor for the meshes
  154658. */
  154659. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  154660. /**
  154661. * Get meshes of part of the hand
  154662. * @param part the part of hand to get
  154663. * @returns An array of meshes that correlate to the hand part requested
  154664. */
  154665. getHandPartMeshes(part: HandPart): AbstractMesh[];
  154666. /**
  154667. * Dispose this Hand object
  154668. */
  154669. dispose(): void;
  154670. }
  154671. /**
  154672. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  154673. */
  154674. export class WebXRHandTracking extends WebXRAbstractFeature {
  154675. /**
  154676. * options to use when constructing this feature
  154677. */
  154678. readonly options: IWebXRHandTrackingOptions;
  154679. private static _idCounter;
  154680. /**
  154681. * The module's name
  154682. */
  154683. static readonly Name: string;
  154684. /**
  154685. * The (Babylon) version of this module.
  154686. * This is an integer representing the implementation version.
  154687. * This number does not correspond to the WebXR specs version
  154688. */
  154689. static readonly Version: number;
  154690. /**
  154691. * This observable will notify registered observers when a new hand object was added and initialized
  154692. */
  154693. onHandAddedObservable: Observable<WebXRHand>;
  154694. /**
  154695. * This observable will notify its observers right before the hand object is disposed
  154696. */
  154697. onHandRemovedObservable: Observable<WebXRHand>;
  154698. private _hands;
  154699. /**
  154700. * Creates a new instance of the hit test feature
  154701. * @param _xrSessionManager an instance of WebXRSessionManager
  154702. * @param options options to use when constructing this feature
  154703. */
  154704. constructor(_xrSessionManager: WebXRSessionManager,
  154705. /**
  154706. * options to use when constructing this feature
  154707. */
  154708. options: IWebXRHandTrackingOptions);
  154709. /**
  154710. * Check if the needed objects are defined.
  154711. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  154712. */
  154713. isCompatible(): boolean;
  154714. /**
  154715. * attach this feature
  154716. * Will usually be called by the features manager
  154717. *
  154718. * @returns true if successful.
  154719. */
  154720. attach(): boolean;
  154721. /**
  154722. * detach this feature.
  154723. * Will usually be called by the features manager
  154724. *
  154725. * @returns true if successful.
  154726. */
  154727. detach(): boolean;
  154728. /**
  154729. * Dispose this feature and all of the resources attached
  154730. */
  154731. dispose(): void;
  154732. /**
  154733. * Get the hand object according to the controller id
  154734. * @param controllerId the controller id to which we want to get the hand
  154735. * @returns null if not found or the WebXRHand object if found
  154736. */
  154737. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  154738. /**
  154739. * Get a hand object according to the requested handedness
  154740. * @param handedness the handedness to request
  154741. * @returns null if not found or the WebXRHand object if found
  154742. */
  154743. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  154744. protected _onXRFrame(_xrFrame: XRFrame): void;
  154745. private _attachHand;
  154746. private _detachHand;
  154747. }
  154748. }
  154749. declare module BABYLON {
  154750. /**
  154751. * The motion controller class for all microsoft mixed reality controllers
  154752. */
  154753. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  154754. protected readonly _mapping: {
  154755. defaultButton: {
  154756. valueNodeName: string;
  154757. unpressedNodeName: string;
  154758. pressedNodeName: string;
  154759. };
  154760. defaultAxis: {
  154761. valueNodeName: string;
  154762. minNodeName: string;
  154763. maxNodeName: string;
  154764. };
  154765. buttons: {
  154766. "xr-standard-trigger": {
  154767. rootNodeName: string;
  154768. componentProperty: string;
  154769. states: string[];
  154770. };
  154771. "xr-standard-squeeze": {
  154772. rootNodeName: string;
  154773. componentProperty: string;
  154774. states: string[];
  154775. };
  154776. "xr-standard-touchpad": {
  154777. rootNodeName: string;
  154778. labelAnchorNodeName: string;
  154779. touchPointNodeName: string;
  154780. };
  154781. "xr-standard-thumbstick": {
  154782. rootNodeName: string;
  154783. componentProperty: string;
  154784. states: string[];
  154785. };
  154786. };
  154787. axes: {
  154788. "xr-standard-touchpad": {
  154789. "x-axis": {
  154790. rootNodeName: string;
  154791. };
  154792. "y-axis": {
  154793. rootNodeName: string;
  154794. };
  154795. };
  154796. "xr-standard-thumbstick": {
  154797. "x-axis": {
  154798. rootNodeName: string;
  154799. };
  154800. "y-axis": {
  154801. rootNodeName: string;
  154802. };
  154803. };
  154804. };
  154805. };
  154806. /**
  154807. * The base url used to load the left and right controller models
  154808. */
  154809. static MODEL_BASE_URL: string;
  154810. /**
  154811. * The name of the left controller model file
  154812. */
  154813. static MODEL_LEFT_FILENAME: string;
  154814. /**
  154815. * The name of the right controller model file
  154816. */
  154817. static MODEL_RIGHT_FILENAME: string;
  154818. profileId: string;
  154819. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154820. protected _getFilenameAndPath(): {
  154821. filename: string;
  154822. path: string;
  154823. };
  154824. protected _getModelLoadingConstraints(): boolean;
  154825. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154826. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154827. protected _updateModel(): void;
  154828. }
  154829. }
  154830. declare module BABYLON {
  154831. /**
  154832. * The motion controller class for oculus touch (quest, rift).
  154833. * This class supports legacy mapping as well the standard xr mapping
  154834. */
  154835. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  154836. private _forceLegacyControllers;
  154837. private _modelRootNode;
  154838. /**
  154839. * The base url used to load the left and right controller models
  154840. */
  154841. static MODEL_BASE_URL: string;
  154842. /**
  154843. * The name of the left controller model file
  154844. */
  154845. static MODEL_LEFT_FILENAME: string;
  154846. /**
  154847. * The name of the right controller model file
  154848. */
  154849. static MODEL_RIGHT_FILENAME: string;
  154850. /**
  154851. * Base Url for the Quest controller model.
  154852. */
  154853. static QUEST_MODEL_BASE_URL: string;
  154854. profileId: string;
  154855. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  154856. protected _getFilenameAndPath(): {
  154857. filename: string;
  154858. path: string;
  154859. };
  154860. protected _getModelLoadingConstraints(): boolean;
  154861. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154862. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154863. protected _updateModel(): void;
  154864. /**
  154865. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  154866. * between the touch and touch 2.
  154867. */
  154868. private _isQuest;
  154869. }
  154870. }
  154871. declare module BABYLON {
  154872. /**
  154873. * The motion controller class for the standard HTC-Vive controllers
  154874. */
  154875. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  154876. private _modelRootNode;
  154877. /**
  154878. * The base url used to load the left and right controller models
  154879. */
  154880. static MODEL_BASE_URL: string;
  154881. /**
  154882. * File name for the controller model.
  154883. */
  154884. static MODEL_FILENAME: string;
  154885. profileId: string;
  154886. /**
  154887. * Create a new Vive motion controller object
  154888. * @param scene the scene to use to create this controller
  154889. * @param gamepadObject the corresponding gamepad object
  154890. * @param handedness the handedness of the controller
  154891. */
  154892. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154893. protected _getFilenameAndPath(): {
  154894. filename: string;
  154895. path: string;
  154896. };
  154897. protected _getModelLoadingConstraints(): boolean;
  154898. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154899. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154900. protected _updateModel(): void;
  154901. }
  154902. }
  154903. declare module BABYLON {
  154904. /**
  154905. * A cursor which tracks a point on a path
  154906. */
  154907. export class PathCursor {
  154908. private path;
  154909. /**
  154910. * Stores path cursor callbacks for when an onchange event is triggered
  154911. */
  154912. private _onchange;
  154913. /**
  154914. * The value of the path cursor
  154915. */
  154916. value: number;
  154917. /**
  154918. * The animation array of the path cursor
  154919. */
  154920. animations: Animation[];
  154921. /**
  154922. * Initializes the path cursor
  154923. * @param path The path to track
  154924. */
  154925. constructor(path: Path2);
  154926. /**
  154927. * Gets the cursor point on the path
  154928. * @returns A point on the path cursor at the cursor location
  154929. */
  154930. getPoint(): Vector3;
  154931. /**
  154932. * Moves the cursor ahead by the step amount
  154933. * @param step The amount to move the cursor forward
  154934. * @returns This path cursor
  154935. */
  154936. moveAhead(step?: number): PathCursor;
  154937. /**
  154938. * Moves the cursor behind by the step amount
  154939. * @param step The amount to move the cursor back
  154940. * @returns This path cursor
  154941. */
  154942. moveBack(step?: number): PathCursor;
  154943. /**
  154944. * Moves the cursor by the step amount
  154945. * If the step amount is greater than one, an exception is thrown
  154946. * @param step The amount to move the cursor
  154947. * @returns This path cursor
  154948. */
  154949. move(step: number): PathCursor;
  154950. /**
  154951. * Ensures that the value is limited between zero and one
  154952. * @returns This path cursor
  154953. */
  154954. private ensureLimits;
  154955. /**
  154956. * Runs onchange callbacks on change (used by the animation engine)
  154957. * @returns This path cursor
  154958. */
  154959. private raiseOnChange;
  154960. /**
  154961. * Executes a function on change
  154962. * @param f A path cursor onchange callback
  154963. * @returns This path cursor
  154964. */
  154965. onchange(f: (cursor: PathCursor) => void): PathCursor;
  154966. }
  154967. }
  154968. declare module BABYLON {
  154969. /** @hidden */
  154970. export var blurPixelShader: {
  154971. name: string;
  154972. shader: string;
  154973. };
  154974. }
  154975. declare module BABYLON {
  154976. /** @hidden */
  154977. export var pointCloudVertexDeclaration: {
  154978. name: string;
  154979. shader: string;
  154980. };
  154981. }
  154982. // Mixins
  154983. interface Window {
  154984. mozIndexedDB: IDBFactory;
  154985. webkitIndexedDB: IDBFactory;
  154986. msIndexedDB: IDBFactory;
  154987. webkitURL: typeof URL;
  154988. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  154989. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  154990. WebGLRenderingContext: WebGLRenderingContext;
  154991. MSGesture: MSGesture;
  154992. CANNON: any;
  154993. AudioContext: AudioContext;
  154994. webkitAudioContext: AudioContext;
  154995. PointerEvent: any;
  154996. Math: Math;
  154997. Uint8Array: Uint8ArrayConstructor;
  154998. Float32Array: Float32ArrayConstructor;
  154999. mozURL: typeof URL;
  155000. msURL: typeof URL;
  155001. VRFrameData: any; // WebVR, from specs 1.1
  155002. DracoDecoderModule: any;
  155003. setImmediate(handler: (...args: any[]) => void): number;
  155004. }
  155005. interface HTMLCanvasElement {
  155006. requestPointerLock(): void;
  155007. msRequestPointerLock?(): void;
  155008. mozRequestPointerLock?(): void;
  155009. webkitRequestPointerLock?(): void;
  155010. /** Track wether a record is in progress */
  155011. isRecording: boolean;
  155012. /** Capture Stream method defined by some browsers */
  155013. captureStream(fps?: number): MediaStream;
  155014. }
  155015. interface CanvasRenderingContext2D {
  155016. msImageSmoothingEnabled: boolean;
  155017. }
  155018. interface MouseEvent {
  155019. mozMovementX: number;
  155020. mozMovementY: number;
  155021. webkitMovementX: number;
  155022. webkitMovementY: number;
  155023. msMovementX: number;
  155024. msMovementY: number;
  155025. }
  155026. interface Navigator {
  155027. mozGetVRDevices: (any: any) => any;
  155028. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155029. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155030. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155031. webkitGetGamepads(): Gamepad[];
  155032. msGetGamepads(): Gamepad[];
  155033. webkitGamepads(): Gamepad[];
  155034. }
  155035. interface HTMLVideoElement {
  155036. mozSrcObject: any;
  155037. }
  155038. interface Math {
  155039. fround(x: number): number;
  155040. imul(a: number, b: number): number;
  155041. }
  155042. interface WebGLRenderingContext {
  155043. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  155044. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  155045. vertexAttribDivisor(index: number, divisor: number): void;
  155046. createVertexArray(): any;
  155047. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  155048. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  155049. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  155050. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  155051. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  155052. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  155053. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  155054. // Queries
  155055. createQuery(): WebGLQuery;
  155056. deleteQuery(query: WebGLQuery): void;
  155057. beginQuery(target: number, query: WebGLQuery): void;
  155058. endQuery(target: number): void;
  155059. getQueryParameter(query: WebGLQuery, pname: number): any;
  155060. getQuery(target: number, pname: number): any;
  155061. MAX_SAMPLES: number;
  155062. RGBA8: number;
  155063. READ_FRAMEBUFFER: number;
  155064. DRAW_FRAMEBUFFER: number;
  155065. UNIFORM_BUFFER: number;
  155066. HALF_FLOAT_OES: number;
  155067. RGBA16F: number;
  155068. RGBA32F: number;
  155069. R32F: number;
  155070. RG32F: number;
  155071. RGB32F: number;
  155072. R16F: number;
  155073. RG16F: number;
  155074. RGB16F: number;
  155075. RED: number;
  155076. RG: number;
  155077. R8: number;
  155078. RG8: number;
  155079. UNSIGNED_INT_24_8: number;
  155080. DEPTH24_STENCIL8: number;
  155081. MIN: number;
  155082. MAX: number;
  155083. /* Multiple Render Targets */
  155084. drawBuffers(buffers: number[]): void;
  155085. readBuffer(src: number): void;
  155086. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  155087. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  155088. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  155089. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  155090. // Occlusion Query
  155091. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  155092. ANY_SAMPLES_PASSED: number;
  155093. QUERY_RESULT_AVAILABLE: number;
  155094. QUERY_RESULT: number;
  155095. }
  155096. interface WebGLProgram {
  155097. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  155098. }
  155099. interface EXT_disjoint_timer_query {
  155100. QUERY_COUNTER_BITS_EXT: number;
  155101. TIME_ELAPSED_EXT: number;
  155102. TIMESTAMP_EXT: number;
  155103. GPU_DISJOINT_EXT: number;
  155104. QUERY_RESULT_EXT: number;
  155105. QUERY_RESULT_AVAILABLE_EXT: number;
  155106. queryCounterEXT(query: WebGLQuery, target: number): void;
  155107. createQueryEXT(): WebGLQuery;
  155108. beginQueryEXT(target: number, query: WebGLQuery): void;
  155109. endQueryEXT(target: number): void;
  155110. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  155111. deleteQueryEXT(query: WebGLQuery): void;
  155112. }
  155113. interface WebGLUniformLocation {
  155114. _currentState: any;
  155115. }
  155116. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  155117. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  155118. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  155119. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155120. interface WebGLRenderingContext {
  155121. readonly RASTERIZER_DISCARD: number;
  155122. readonly DEPTH_COMPONENT24: number;
  155123. readonly TEXTURE_3D: number;
  155124. readonly TEXTURE_2D_ARRAY: number;
  155125. readonly TEXTURE_COMPARE_FUNC: number;
  155126. readonly TEXTURE_COMPARE_MODE: number;
  155127. readonly COMPARE_REF_TO_TEXTURE: number;
  155128. readonly TEXTURE_WRAP_R: number;
  155129. readonly HALF_FLOAT: number;
  155130. readonly RGB8: number;
  155131. readonly RED_INTEGER: number;
  155132. readonly RG_INTEGER: number;
  155133. readonly RGB_INTEGER: number;
  155134. readonly RGBA_INTEGER: number;
  155135. readonly R8_SNORM: number;
  155136. readonly RG8_SNORM: number;
  155137. readonly RGB8_SNORM: number;
  155138. readonly RGBA8_SNORM: number;
  155139. readonly R8I: number;
  155140. readonly RG8I: number;
  155141. readonly RGB8I: number;
  155142. readonly RGBA8I: number;
  155143. readonly R8UI: number;
  155144. readonly RG8UI: number;
  155145. readonly RGB8UI: number;
  155146. readonly RGBA8UI: number;
  155147. readonly R16I: number;
  155148. readonly RG16I: number;
  155149. readonly RGB16I: number;
  155150. readonly RGBA16I: number;
  155151. readonly R16UI: number;
  155152. readonly RG16UI: number;
  155153. readonly RGB16UI: number;
  155154. readonly RGBA16UI: number;
  155155. readonly R32I: number;
  155156. readonly RG32I: number;
  155157. readonly RGB32I: number;
  155158. readonly RGBA32I: number;
  155159. readonly R32UI: number;
  155160. readonly RG32UI: number;
  155161. readonly RGB32UI: number;
  155162. readonly RGBA32UI: number;
  155163. readonly RGB10_A2UI: number;
  155164. readonly R11F_G11F_B10F: number;
  155165. readonly RGB9_E5: number;
  155166. readonly RGB10_A2: number;
  155167. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  155168. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  155169. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  155170. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  155171. readonly DEPTH_COMPONENT32F: number;
  155172. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  155173. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  155174. 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;
  155175. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  155176. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  155177. readonly TRANSFORM_FEEDBACK: number;
  155178. readonly INTERLEAVED_ATTRIBS: number;
  155179. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  155180. createTransformFeedback(): WebGLTransformFeedback;
  155181. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  155182. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  155183. beginTransformFeedback(primitiveMode: number): void;
  155184. endTransformFeedback(): void;
  155185. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  155186. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155187. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155188. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155189. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  155190. }
  155191. interface ImageBitmap {
  155192. readonly width: number;
  155193. readonly height: number;
  155194. close(): void;
  155195. }
  155196. interface WebGLQuery extends WebGLObject {
  155197. }
  155198. declare var WebGLQuery: {
  155199. prototype: WebGLQuery;
  155200. new(): WebGLQuery;
  155201. };
  155202. interface WebGLSampler extends WebGLObject {
  155203. }
  155204. declare var WebGLSampler: {
  155205. prototype: WebGLSampler;
  155206. new(): WebGLSampler;
  155207. };
  155208. interface WebGLSync extends WebGLObject {
  155209. }
  155210. declare var WebGLSync: {
  155211. prototype: WebGLSync;
  155212. new(): WebGLSync;
  155213. };
  155214. interface WebGLTransformFeedback extends WebGLObject {
  155215. }
  155216. declare var WebGLTransformFeedback: {
  155217. prototype: WebGLTransformFeedback;
  155218. new(): WebGLTransformFeedback;
  155219. };
  155220. interface WebGLVertexArrayObject extends WebGLObject {
  155221. }
  155222. declare var WebGLVertexArrayObject: {
  155223. prototype: WebGLVertexArrayObject;
  155224. new(): WebGLVertexArrayObject;
  155225. };
  155226. // Type definitions for WebVR API
  155227. // Project: https://w3c.github.io/webvr/
  155228. // Definitions by: six a <https://github.com/lostfictions>
  155229. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155230. interface VRDisplay extends EventTarget {
  155231. /**
  155232. * Dictionary of capabilities describing the VRDisplay.
  155233. */
  155234. readonly capabilities: VRDisplayCapabilities;
  155235. /**
  155236. * z-depth defining the far plane of the eye view frustum
  155237. * enables mapping of values in the render target depth
  155238. * attachment to scene coordinates. Initially set to 10000.0.
  155239. */
  155240. depthFar: number;
  155241. /**
  155242. * z-depth defining the near plane of the eye view frustum
  155243. * enables mapping of values in the render target depth
  155244. * attachment to scene coordinates. Initially set to 0.01.
  155245. */
  155246. depthNear: number;
  155247. /**
  155248. * An identifier for this distinct VRDisplay. Used as an
  155249. * association point in the Gamepad API.
  155250. */
  155251. readonly displayId: number;
  155252. /**
  155253. * A display name, a user-readable name identifying it.
  155254. */
  155255. readonly displayName: string;
  155256. readonly isConnected: boolean;
  155257. readonly isPresenting: boolean;
  155258. /**
  155259. * If this VRDisplay supports room-scale experiences, the optional
  155260. * stage attribute contains details on the room-scale parameters.
  155261. */
  155262. readonly stageParameters: VRStageParameters | null;
  155263. /**
  155264. * Passing the value returned by `requestAnimationFrame` to
  155265. * `cancelAnimationFrame` will unregister the callback.
  155266. * @param handle Define the hanle of the request to cancel
  155267. */
  155268. cancelAnimationFrame(handle: number): void;
  155269. /**
  155270. * Stops presenting to the VRDisplay.
  155271. * @returns a promise to know when it stopped
  155272. */
  155273. exitPresent(): Promise<void>;
  155274. /**
  155275. * Return the current VREyeParameters for the given eye.
  155276. * @param whichEye Define the eye we want the parameter for
  155277. * @returns the eye parameters
  155278. */
  155279. getEyeParameters(whichEye: string): VREyeParameters;
  155280. /**
  155281. * Populates the passed VRFrameData with the information required to render
  155282. * the current frame.
  155283. * @param frameData Define the data structure to populate
  155284. * @returns true if ok otherwise false
  155285. */
  155286. getFrameData(frameData: VRFrameData): boolean;
  155287. /**
  155288. * Get the layers currently being presented.
  155289. * @returns the list of VR layers
  155290. */
  155291. getLayers(): VRLayer[];
  155292. /**
  155293. * Return a VRPose containing the future predicted pose of the VRDisplay
  155294. * when the current frame will be presented. The value returned will not
  155295. * change until JavaScript has returned control to the browser.
  155296. *
  155297. * The VRPose will contain the position, orientation, velocity,
  155298. * and acceleration of each of these properties.
  155299. * @returns the pose object
  155300. */
  155301. getPose(): VRPose;
  155302. /**
  155303. * Return the current instantaneous pose of the VRDisplay, with no
  155304. * prediction applied.
  155305. * @returns the current instantaneous pose
  155306. */
  155307. getImmediatePose(): VRPose;
  155308. /**
  155309. * The callback passed to `requestAnimationFrame` will be called
  155310. * any time a new frame should be rendered. When the VRDisplay is
  155311. * presenting the callback will be called at the native refresh
  155312. * rate of the HMD. When not presenting this function acts
  155313. * identically to how window.requestAnimationFrame acts. Content should
  155314. * make no assumptions of frame rate or vsync behavior as the HMD runs
  155315. * asynchronously from other displays and at differing refresh rates.
  155316. * @param callback Define the eaction to run next frame
  155317. * @returns the request handle it
  155318. */
  155319. requestAnimationFrame(callback: FrameRequestCallback): number;
  155320. /**
  155321. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  155322. * Repeat calls while already presenting will update the VRLayers being displayed.
  155323. * @param layers Define the list of layer to present
  155324. * @returns a promise to know when the request has been fulfilled
  155325. */
  155326. requestPresent(layers: VRLayer[]): Promise<void>;
  155327. /**
  155328. * Reset the pose for this display, treating its current position and
  155329. * orientation as the "origin/zero" values. VRPose.position,
  155330. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  155331. * updated when calling resetPose(). This should be called in only
  155332. * sitting-space experiences.
  155333. */
  155334. resetPose(): void;
  155335. /**
  155336. * The VRLayer provided to the VRDisplay will be captured and presented
  155337. * in the HMD. Calling this function has the same effect on the source
  155338. * canvas as any other operation that uses its source image, and canvases
  155339. * created without preserveDrawingBuffer set to true will be cleared.
  155340. * @param pose Define the pose to submit
  155341. */
  155342. submitFrame(pose?: VRPose): void;
  155343. }
  155344. declare var VRDisplay: {
  155345. prototype: VRDisplay;
  155346. new(): VRDisplay;
  155347. };
  155348. interface VRLayer {
  155349. leftBounds?: number[] | Float32Array | null;
  155350. rightBounds?: number[] | Float32Array | null;
  155351. source?: HTMLCanvasElement | null;
  155352. }
  155353. interface VRDisplayCapabilities {
  155354. readonly canPresent: boolean;
  155355. readonly hasExternalDisplay: boolean;
  155356. readonly hasOrientation: boolean;
  155357. readonly hasPosition: boolean;
  155358. readonly maxLayers: number;
  155359. }
  155360. interface VREyeParameters {
  155361. /** @deprecated */
  155362. readonly fieldOfView: VRFieldOfView;
  155363. readonly offset: Float32Array;
  155364. readonly renderHeight: number;
  155365. readonly renderWidth: number;
  155366. }
  155367. interface VRFieldOfView {
  155368. readonly downDegrees: number;
  155369. readonly leftDegrees: number;
  155370. readonly rightDegrees: number;
  155371. readonly upDegrees: number;
  155372. }
  155373. interface VRFrameData {
  155374. readonly leftProjectionMatrix: Float32Array;
  155375. readonly leftViewMatrix: Float32Array;
  155376. readonly pose: VRPose;
  155377. readonly rightProjectionMatrix: Float32Array;
  155378. readonly rightViewMatrix: Float32Array;
  155379. readonly timestamp: number;
  155380. }
  155381. interface VRPose {
  155382. readonly angularAcceleration: Float32Array | null;
  155383. readonly angularVelocity: Float32Array | null;
  155384. readonly linearAcceleration: Float32Array | null;
  155385. readonly linearVelocity: Float32Array | null;
  155386. readonly orientation: Float32Array | null;
  155387. readonly position: Float32Array | null;
  155388. readonly timestamp: number;
  155389. }
  155390. interface VRStageParameters {
  155391. sittingToStandingTransform?: Float32Array;
  155392. sizeX?: number;
  155393. sizeY?: number;
  155394. }
  155395. interface Navigator {
  155396. getVRDisplays(): Promise<VRDisplay[]>;
  155397. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  155398. }
  155399. interface Window {
  155400. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  155401. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  155402. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  155403. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155404. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155405. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  155406. }
  155407. interface Gamepad {
  155408. readonly displayId: number;
  155409. }
  155410. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  155411. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  155412. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  155413. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  155414. type XRHandedness = "none" | "left" | "right";
  155415. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  155416. type XREye = "none" | "left" | "right";
  155417. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  155418. interface XRSpace extends EventTarget {}
  155419. interface XRRenderState {
  155420. depthNear?: number;
  155421. depthFar?: number;
  155422. inlineVerticalFieldOfView?: number;
  155423. baseLayer?: XRWebGLLayer;
  155424. }
  155425. interface XRInputSource {
  155426. handedness: XRHandedness;
  155427. targetRayMode: XRTargetRayMode;
  155428. targetRaySpace: XRSpace;
  155429. gripSpace: XRSpace | undefined;
  155430. gamepad: Gamepad | undefined;
  155431. profiles: Array<string>;
  155432. hand: XRHand | undefined;
  155433. }
  155434. interface XRSessionInit {
  155435. optionalFeatures?: string[];
  155436. requiredFeatures?: string[];
  155437. }
  155438. interface XRSession {
  155439. addEventListener: Function;
  155440. removeEventListener: Function;
  155441. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  155442. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  155443. requestAnimationFrame: Function;
  155444. end(): Promise<void>;
  155445. renderState: XRRenderState;
  155446. inputSources: Array<XRInputSource>;
  155447. // hit test
  155448. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  155449. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  155450. // legacy AR hit test
  155451. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  155452. // legacy plane detection
  155453. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  155454. }
  155455. interface XRReferenceSpace extends XRSpace {
  155456. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  155457. onreset: any;
  155458. }
  155459. type XRPlaneSet = Set<XRPlane>;
  155460. type XRAnchorSet = Set<XRAnchor>;
  155461. interface XRFrame {
  155462. session: XRSession;
  155463. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  155464. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  155465. // AR
  155466. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  155467. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  155468. // Anchors
  155469. trackedAnchors?: XRAnchorSet;
  155470. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  155471. // Planes
  155472. worldInformation: {
  155473. detectedPlanes?: XRPlaneSet;
  155474. };
  155475. // Hand tracking
  155476. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  155477. }
  155478. interface XRViewerPose extends XRPose {
  155479. views: Array<XRView>;
  155480. }
  155481. interface XRPose {
  155482. transform: XRRigidTransform;
  155483. emulatedPosition: boolean;
  155484. }
  155485. interface XRWebGLLayerOptions {
  155486. antialias?: boolean;
  155487. depth?: boolean;
  155488. stencil?: boolean;
  155489. alpha?: boolean;
  155490. multiview?: boolean;
  155491. framebufferScaleFactor?: number;
  155492. }
  155493. declare var XRWebGLLayer: {
  155494. prototype: XRWebGLLayer;
  155495. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  155496. };
  155497. interface XRWebGLLayer {
  155498. framebuffer: WebGLFramebuffer;
  155499. framebufferWidth: number;
  155500. framebufferHeight: number;
  155501. getViewport: Function;
  155502. }
  155503. declare class XRRigidTransform {
  155504. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  155505. position: DOMPointReadOnly;
  155506. orientation: DOMPointReadOnly;
  155507. matrix: Float32Array;
  155508. inverse: XRRigidTransform;
  155509. }
  155510. interface XRView {
  155511. eye: XREye;
  155512. projectionMatrix: Float32Array;
  155513. transform: XRRigidTransform;
  155514. }
  155515. interface XRInputSourceChangeEvent {
  155516. session: XRSession;
  155517. removed: Array<XRInputSource>;
  155518. added: Array<XRInputSource>;
  155519. }
  155520. interface XRInputSourceEvent extends Event {
  155521. readonly frame: XRFrame;
  155522. readonly inputSource: XRInputSource;
  155523. }
  155524. // Experimental(er) features
  155525. declare class XRRay {
  155526. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  155527. origin: DOMPointReadOnly;
  155528. direction: DOMPointReadOnly;
  155529. matrix: Float32Array;
  155530. }
  155531. declare enum XRHitTestTrackableType {
  155532. "point",
  155533. "plane",
  155534. "mesh",
  155535. }
  155536. interface XRHitResult {
  155537. hitMatrix: Float32Array;
  155538. }
  155539. interface XRTransientInputHitTestResult {
  155540. readonly inputSource: XRInputSource;
  155541. readonly results: Array<XRHitTestResult>;
  155542. }
  155543. interface XRHitTestResult {
  155544. getPose(baseSpace: XRSpace): XRPose | undefined;
  155545. // When anchor system is enabled
  155546. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  155547. }
  155548. interface XRHitTestSource {
  155549. cancel(): void;
  155550. }
  155551. interface XRTransientInputHitTestSource {
  155552. cancel(): void;
  155553. }
  155554. interface XRHitTestOptionsInit {
  155555. space: XRSpace;
  155556. entityTypes?: Array<XRHitTestTrackableType>;
  155557. offsetRay?: XRRay;
  155558. }
  155559. interface XRTransientInputHitTestOptionsInit {
  155560. profile: string;
  155561. entityTypes?: Array<XRHitTestTrackableType>;
  155562. offsetRay?: XRRay;
  155563. }
  155564. interface XRAnchor {
  155565. anchorSpace: XRSpace;
  155566. delete(): void;
  155567. }
  155568. interface XRPlane {
  155569. orientation: "Horizontal" | "Vertical";
  155570. planeSpace: XRSpace;
  155571. polygon: Array<DOMPointReadOnly>;
  155572. lastChangedTime: number;
  155573. }
  155574. interface XRJointSpace extends XRSpace {}
  155575. interface XRJointPose extends XRPose {
  155576. radius: number | undefined;
  155577. }
  155578. declare class XRHand extends Array<XRJointSpace> {
  155579. readonly length: number;
  155580. static readonly WRIST = 0;
  155581. static readonly THUMB_METACARPAL = 1;
  155582. static readonly THUMB_PHALANX_PROXIMAL = 2;
  155583. static readonly THUMB_PHALANX_DISTAL = 3;
  155584. static readonly THUMB_PHALANX_TIP = 4;
  155585. static readonly INDEX_METACARPAL = 5;
  155586. static readonly INDEX_PHALANX_PROXIMAL = 6;
  155587. static readonly INDEX_PHALANX_INTERMEDIATE = 7;
  155588. static readonly INDEX_PHALANX_DISTAL = 8;
  155589. static readonly INDEX_PHALANX_TIP = 9;
  155590. static readonly MIDDLE_METACARPAL = 10;
  155591. static readonly MIDDLE_PHALANX_PROXIMAL = 11;
  155592. static readonly MIDDLE_PHALANX_INTERMEDIATE = 12;
  155593. static readonly MIDDLE_PHALANX_DISTAL = 13;
  155594. static readonly MIDDLE_PHALANX_TIP = 14;
  155595. static readonly RING_METACARPAL = 15;
  155596. static readonly RING_PHALANX_PROXIMAL = 16;
  155597. static readonly RING_PHALANX_INTERMEDIATE = 17;
  155598. static readonly RING_PHALANX_DISTAL = 18;
  155599. static readonly RING_PHALANX_TIP = 19;
  155600. static readonly LITTLE_METACARPAL = 20;
  155601. static readonly LITTLE_PHALANX_PROXIMAL = 21;
  155602. static readonly LITTLE_PHALANX_INTERMEDIATE = 22;
  155603. static readonly LITTLE_PHALANX_DISTAL = 23;
  155604. static readonly LITTLE_PHALANX_TIP = 24;
  155605. }
  155606. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  155607. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  155608. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  155609. interface XRSession {
  155610. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  155611. }
  155612. interface XRFrame {
  155613. featurePointCloud? : Array<number>;
  155614. }